tests/testthat/test-createTrainingProject.R

In stephlocke/pRojects: One-Liners to Setup R Projects

project_name <- "trainingProject2"

test_that("createTrainingProject() errors if name missing or not correct", {

  tmp <- temp_folder("ttt")

  expect_error(createTrainingProject(
    folder = tmp,
    packagedeps = "renv",
    git = TRUE,
    external_setup = NULL
  ))

  expect_error(createTrainingProject(
    name = 1,
    folder = tmp,
    packagedeps = "renv",
    git = TRUE,
    external_setup = NULL
  ))

  expect_error(createTrainingProject(
    name = "a",
    folder = tmp,
    packagedeps = "renv",
    git = TRUE,
    external_setup = NULL
  ))
})


test_that("createTrainingProject() creates as expected when using defaults", {

  tmp <- temp_folder("ttt")

  createTrainingProject(project_name,
    folder = tmp,
    packagedeps = "none",
    external_setup = NULL
  )
  expect_true(file.exists(file.path(
    tmp, project_name,
    paste0(project_name, ".Rproj")
  )))
  expect_true(file.exists(file.path(tmp, project_name, "DESCRIPTION")))
  expect_true(file.exists(file.path(tmp, project_name, "R")))
  expect_true(file.exists(file.path(tmp, project_name, "README.Rmd")))
  expect_true(file.exists(file.path(tmp, project_name, ".git")))
  expect_true(file.exists(file.path(tmp, project_name, ".gitignore")))
  expect_true(file.exists(file.path(tmp, project_name, "data")))
  expect_true(file.exists(file.path(tmp, project_name, "handouts")))
  expect_true(file.exists(file.path(tmp, project_name, "slides")))
})

test_that("createTrainingProject() creates as expected when using bookdown and revealjs", { # nolint

  tmp <- temp_folder("ttt")

  createTrainingProject(project_name,
    folder = tmp,
    handoutEngine = "bookdown", slideEngine = "revealjs",
    packagedeps = "none",
    external_setup = NULL
  )
  expect_true(file.exists(file.path(
    tmp, project_name,
    paste0(project_name, ".Rproj")
  )))
  expect_true(file.exists(file.path(tmp, project_name, "DESCRIPTION")))
  expect_true(file.exists(file.path(tmp, project_name, "R")))
  expect_true(file.exists(file.path(tmp, project_name, "README.Rmd")))
  expect_true(file.exists(file.path(tmp, project_name, ".git")))
  expect_true(file.exists(file.path(tmp, project_name, ".gitignore")))
  expect_true(file.exists(file.path(tmp, project_name, "data")))
  expect_true(file.exists(file.path(tmp, project_name, "handouts")))
  expect_true(file.exists(file.path(
    tmp, project_name, "handouts",
    "index.Rmd"
  )))
  expect_true(file.exists(file.path(
    tmp, project_name, "slides",
    "revealjs_slides.Rmd"
  )))
})

test_that("createTrainingProject() creates as expected when using tufte and xaringan", { # nolint

  tmp <- temp_folder("ttt")

  createTrainingProject(project_name,
    folder = tmp,
    handoutEngine = "tufte", slideEngine = "xaringan",
    packagedeps = "none",
    external_setup = NULL
  )

  expect_true(file.exists(file.path(
    tmp, project_name,
    paste0(project_name, ".Rproj")
  )))
  expect_true(file.exists(file.path(tmp, project_name, "DESCRIPTION")))
  expect_true(file.exists(file.path(tmp, project_name, "R")))
  expect_true(file.exists(file.path(tmp, project_name, "README.Rmd")))
  expect_true(file.exists(file.path(tmp, project_name, ".git")))
  expect_true(file.exists(file.path(tmp, project_name, ".gitignore")))
  expect_true(file.exists(file.path(tmp, project_name, "data")))
  expect_true(file.exists(file.path(tmp, project_name, "handouts")))
  expect_true(file.exists(file.path(
    tmp, project_name, "handouts",
    "tufte_handout.Rmd"
  )))
  expect_true(file.exists(file.path(
    tmp, project_name, "slides",
    "xaringan_slides.Rmd"
  )))
})

test_that("createTrainingProject() cleans if there was an error", {

  tmp <- temp_folder("ttt")

  mockery::stub(where = createTrainingProject,
                what = "createdirs",
                how = stop)
    expect_message(
      createTrainingProject(project_name,
        folder = tmp,
        handoutEngine = "tufte", slideEngine = "xaringan",
        packagedeps = "none",
        external_setup = NULL
      ),
      "Oops"
    )

})