tests/testthat/test_b_check_filename.R

In inbo/checklist: A Thorough and Strict Set of Checks for R Packages and Source Code

library(mockery)
test_that("check_filename() works", {
  path <- tempfile("check_filename")
  dir_create(path)
  defer(unlink(path, recursive = TRUE))
  checklist$new(path, language = "en-GB", package = FALSE) |>
    write_checklist()

  # fail on white space in folder names
  dir_create(path(path, "with space"))
  expect_is(suppressMessages(x <- check_filename(path)), "checklist")
  expect_false(x$fail)
  x$set_required("filename conventions")
  write_checklist(x)
  x <- check_filename(x)
  expect_true(x$fail)
  unlink(path(path, "with space"))

  # fail on upper case in folder names
  dir_create(path(path, "UPPERCASE"))
  expect_true(check_filename(path)$fail)
  unlink(path(path, "UPPERCASE"))

  # fail on dash in folder names
  dir_create(path(path, "dash-separated"))
  expect_true(check_filename(path)$fail)
  unlink(path(path, "dash-separated"))

  # fail on dash in file names
  dir_create(path(path, "source"))
  writeLines("sessionInfo()", path(path, "source", "correct.R"))
  git_init(path = path)
  git_config_set(name = "user.name", value = "junk", repo = path)
  git_config_set(name = "user.email", value = "junk@inbo.be", repo = path)
  git_add(path("source", "correct.R"), repo = path)
  gert::git_commit("initial commit", repo = path)
  wrong_file <- path(path, "source", "this Is wrong.R")
  writeLines("sessionInfo()", wrong_file)
  expect_false(check_filename(path)$fail)
  git_add(path_rel(wrong_file, path), repo = path)
  gert::git_commit("initial commit", repo = path)
  expect_true(check_filename(path)$fail)
  unlink(wrong_file)
})