tests/testthat/test-autonewsmd.R

In autonewsmd: Auto-Generate Changelog using Conventional Commits

# Auto-Generate Changelog using Conventional Commits
# Copyright (C) 2022 Lorenz A. Kapsner
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

test_that("correct functioning of autonewsmd", {

  # (Example is based on the public examples from the `git2r` R package)
  ## Initialize a repository
  path <- file.path(tempdir(), "autonewsmd")
  dir.create(path)

  if (!requireNamespace("git2r", quietly = TRUE)) {
    expect_error(
      autonewsmd$new(repo_name = "TestRepo", repo_path = path),
      regexp = 'Package "git2r" must be installed to use "autonewsmd".'
    )
  } else {


    # check behaviour, if no git repo
    expect_error(
      autonewsmd$new(repo_name = "TestRepo", repo_path = path),
      regexp = "The 'path' is not in a git repository"
    )

    # test wrong type
    expect_error(
      autonewsmd$new(repo_name = 1, repo_path = path)
    )
    expect_error(
      autonewsmd$new(repo_name = "TestRepo", repo_path = 1)
    )

    # init repo
    repo <- git2r::init(path)

    ## Config user
    git2r::config(repo, user.name = "Alice", user.email = "alice@example.org")
    git2r::remote_set_url(repo, "foobar", "https://example.org/git2r/foobar")


    ## Write to a file and commit
    lines <- "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do"
    writeLines(lines, file.path(path, "example.txt"))

    git2r::add(repo, "example.txt")
    git2r::commit(repo, "feat: new file")

    ## Write again to a file and commit
    lines2 <- paste0(
      "eiusmod tempor incididunt ut labore et dolore magna aliqua. ",
      "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris ",
      "nisi ut aliquip ex ea commodo consequat."
    )
    write(lines2, file.path(path, "example.txt"), append = TRUE)

    git2r::add(repo, "example.txt")
    Sys.sleep(2) # wait two seconds, otherwise, commit messages have same
    # time stamp
    git2r::commit(repo, "refactor: added second phrase")

    #### work with autonewsmd
    an <- autonewsmd$new(
      repo_name = "TestRepo",
      repo_remotes = "foobar",
      repo_path = path
    )

    # test for write() before generate()
    expect_error(
      an$write(force = TRUE)
    )
    an$generate()

    expect_type(an$repo_list, "list")
    expect_length(an$repo_list, 1)
    expect_length(an$repo_list[["Unreleased"]], 7)

    # check for presence of quarto
    if (is.null(quarto::quarto_path()) || quarto::quarto_path() == "") {
      expect_error(
        an$write(force = TRUE)
      )
    } else {

      an$write(force = TRUE)

      expect_true(all(sapply(
        X = list.files(path),
        FUN = function(x) {
          x %in% c("example.txt", "NEWS.md")
        })
      ))

      # test interactive (https://debruine.github.io/post/interactive-test/)
      # yes
      f <- file()
      ans <- "y"
      write(ans, f, append = FALSE)
      out <- capture_output_lines({
        an$write(con = f)
      })
      expect_true(length(out) > 0)
      close(f) # close the file

      # no
      f <- file()
      ans <- "no"
      write(ans, f, append = FALSE)
      out <- capture_output_lines({
        an$write(con = f)
      })
      expect_length(out, 0)
      close(f) # close the file

      # invalid connection
      f <- 1
      expect_error(
        an$write(con = f),
        regexp = "Please provide a valid connection containing the answer"
      )

      ## check tags
      git2r::tag(repo, "r1.2.3")
      an <- autonewsmd$new(repo_name = "TestRepo", repo_path = path)

      expect_error(
        an$generate(),
        regexp = "No tags found that match the provided tag pattern"
      )

      ## check file endings
      an <- autonewsmd$new(repo_name = "TestRepo", repo_path = path)
      an$file_ending <- ".txt"
      an$tag_pattern <- "^r(\\d+\\.){2}\\d+(\\.\\d+)?$"
      an$generate()
      an$write(force = TRUE)
      expect_length(list.files(path = path, pattern = "^NEWS\\.txt$"), 1)

      an <- autonewsmd$new(repo_name = "TestRepo", repo_path = path)
      an$file_ending <- ""
      an$tag_pattern <- "^r(\\d+\\.){2}\\d+(\\.\\d+)?$"
      an$generate()
      an$write(force = TRUE)
      expect_length(list.files(path = path, pattern = "^NEWS$"), 1)

      if (dir.exists(".git")) {
        expect_message(
          object = autonewsmd$new(repo_name = "TestRepo"),
          regexp = "No 'repo_path' provided. Setting "
        )
      }

      path2 <- file.path(tempdir(), "new_folder")
      dir.create(path2)

      expect_error(
        object = autonewsmd$new(repo_name = "TestRepo", repo_path = path2),
        regexp = "The 'path' is not in a git repository"
      )

      # check breaking changes
      lines3 <- paste0(
        "Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris ",
        "nisi ut aliquip ex ea commodo consequat."
      )
      write(lines3, file.path(path, "example.txt"), append = TRUE)

      git2r::add(repo, "example.txt")
      Sys.sleep(2) # wait two seconds, otherwise, commit messages have same
      # time stamp
      git2r::commit(repo, "fix!: added third phrase")
      an <- autonewsmd$new(
        repo_name = "TestRepo",
        repo_remotes = "foobar",
        repo_path = path
      )
      an$tag_pattern <- "^r(\\d+\\.){2}\\d+(\\.\\d+)?$"
      an$generate()

      expect_equal(
        object = an$repo_list$Unreleased$commits[
          grepl("third", get("clean_summary")),
          get("type")
        ][[1]],
        expected = "Breaking changes"
      )


      write(lines3, file.path(path, "example.txt"), append = TRUE)

      git2r::add(repo, "example.txt")
      Sys.sleep(2) # wait two seconds, otherwise, commit messages have same
      # time stamp
      git2r::commit(repo, "fix(deps)!: added fourth phrase")
      an$generate()

      expect_equal(
        object = an$repo_list$Unreleased$commits[
          grepl("fourth", get("clean_summary")),
          get("type")
        ][[1]],
        expected = "Breaking changes"
      )

      # clean up
      unlink(path2, recursive = TRUE)
    }
    do.call(
      file.remove,
      list(list.files(path, full.names = TRUE))
    )
    unlink(path, recursive = TRUE)
  }
})