tests/testthat/test-003-add_dependencies_to_description.R

In benmarwick/rrtools: Creates a Reproducible Research Compendium

context("add_dependencies_to_description()")

#### preparations ####

# create artificial files with some dependencies
testfile_1 <- file.path(package_path, "/R/testfile_1.R")
writeLines(
  c("library(knitr)", "require(glue)", "rmarkdown::draft()", "#'@importFrom magrittr \"%>%\""),
  con = testfile_1
)

if (!dir.exists(file.path(package_path, "/playground"))) {
  dir.create(file.path(package_path, "/playground"))
}
testfile_2 <- file.path(package_path, "/playground/testfile_2.R")
writeLines(
  c("require(git2r)", "usethis::use_template()"),
  con = testfile_2
)

description_path <- paste0(package_path, "/DESCRIPTION")
description_unchanged <- readLines(description_path)

#### run function to change description ####

rrtools::add_dependencies_to_description(
  package_path,
  description_path,
  just_packages = FALSE
)

#### check results ####

description_changed <- readLines(description_path)

test_that("the DESCRIPTION file has changed exactly as expected", {
  expect_equal(
    all.equal(
      description_unchanged, description_changed
    ),
    "Lengths (12, 19) differ (string compare on first 12)"
  )
})

test_that("the DESCRIPTION file now actually contains the package dependencies", {
  expect_equal(
    grep(" git2r | glue | knitr | rmarkdown | usethis | magrittr", description_changed),
    c(14:19)
  )
})

#### check functions ability to provide packages vector ####

test_that("add_dependencies_to_description provides correct packages vector if just_packages = TRUE", {
  expect_equal(
    rrtools::add_dependencies_to_description(
      package_path,
      description_path,
      just_packages = TRUE
    ),
    c("git2r", "glue", "knitr", "magrittr", "rmarkdown", "usethis")
  )
})

#### check that adding more packages later works as expected as well ###

testfile_3 <- file.path(package_path, "/R/testfile_3.R")
writeLines(
  c("library(raster)"),
  con = testfile_3
)

rrtools::add_dependencies_to_description(
  package_path,
  description_path,
  just_packages = FALSE
)

description_changed_once_more <- readLines(description_path)

test_that("the DESCRIPTION file has once more changed exactly as expected", {
  expect_equal(
    all.equal(
      description_changed_once_more, description_changed
    ),
    c("Lengths (20, 19) differ (string compare on first 19)", "1 string mismatch")
  )
})

test_that("the DESCRIPTION file again contains the package dependencies", {
  expect_equal(
    grep(" git2r | glue | knitr | magrittr | rmarkdown | usethis | raster ", description_changed_once_more),
    c(14:19)
  )
})