tests/testthat/test-cleanup.R

In vimc/orderly: Lightweight Reproducible Reporting

context("cleanup")

test_that("cleanup nothing", {
  path <- test_prepare_orderly_example("minimal")
  out <- capture_logs(orderly_cleanup(root = path))
  expect_null(out$result)
  expect_equal(orderly_list(root = path), c("example", "example2"))
  expect_match(out$messages, "Found 0 draft reports", all = FALSE)
  expect_match(out$messages, "Found 0 csv files", all = FALSE)
  expect_match(out$messages, "Found 0 rds files", all = FALSE)
})

test_that("cleanup draft", {
  skip_on_cran_windows()
  path <- test_prepare_orderly_example("minimal")
  id <- orderly_run("example", root = path, echo = FALSE)
  expect_equal(nrow(orderly_list_drafts(root = path)), 1)
  expect_equal(length(orderly_db("csv", path)$list()), 1)
  out <- capture_logs(orderly_cleanup(root = path))
  expect_equal(nrow(orderly_list_drafts(root = path)), 0)
  expect_equal(length(orderly_db("csv", path)$list()), 0)
  expect_match(out$messages, "Found 1 draft report", all = FALSE)
  expect_match(out$messages, "Found 1 csv file", all = FALSE)
  expect_match(out$messages, "Found 1 rds file", all = FALSE)
})

test_that("cleanup keeps draft data", {
  skip_on_cran_windows()
  path <- test_prepare_orderly_example("minimal")
  id <- orderly_run("example", root = path, echo = FALSE)
  rds <- orderly_db("rds", root = path)
  h <- rds$list()
  out <- capture_logs(orderly_cleanup(root = path, draft = FALSE))
  expect_identical(rds$list(), h)
  expect_match(out$messages, "Found 0 csv files", all = FALSE)
  expect_match(out$messages, "Found 0 rds files", all = FALSE)
})

test_that("cleanup with archive", {
  skip_on_cran_windows()
  path <- test_prepare_orderly_example("minimal")
  id1 <- orderly_run("example", root = path, echo = FALSE)
  id2 <- orderly_run("example", root = path, echo = FALSE)

  expect_equal(nrow(orderly_list_drafts(root = path)), 2)
  expect_equal(length(orderly_db("csv", path)$list()), 1)

  orderly_commit(id2, root = path)

  out <- capture_logs(orderly_cleanup(root = path))
  expect_equal(nrow(orderly_list_drafts(root = path)), 0)
  expect_equal(nrow(orderly_list_archive(root = path)), 1)
  expect_equal(length(orderly_db("csv", path)$list()), 1)
  expect_match(out$messages, "Found 1 draft report", all = FALSE)
  expect_match(out$messages, "Found 0 csv files", all = FALSE)
  expect_match(out$messages, "Found 0 rds files", all = FALSE)
})

test_that("cleanup failed", {
  skip_on_cran_windows()
  path <- test_prepare_orderly_example("minimal")
  id1 <- orderly_run("example", root = path, echo = FALSE)
  id2 <- orderly_run("example", root = path, echo = FALSE)

  append_text(file.path(path, "src", "example", "script.R"),
              "stop('this is an error')")
  id3 <- tryCatch(orderly_run("example", root = path, echo = FALSE),
                  error = function(e) NULL)
  expect_null(id3)
  d <- orderly_list_drafts("example", root = path, include_failed = TRUE)
  expect_equal(nrow(d), 3)

  out <- capture_logs(orderly_cleanup(root = path, failed_only = TRUE))
  d <- orderly_list_drafts("example", root = path, include_failed = TRUE)
  expect_equal(nrow(d), 2)
  expect_true(all(c(id1, id2) %in% d$id))
  expect_match(out$messages, "Found 1 draft report", all = FALSE)
  expect_match(out$messages, "Found 0 csv files", all = FALSE)
  expect_match(out$messages, "Found 0 rds files", all = FALSE)
})

test_that("cleanup by name", {
  skip_on_cran_windows()
  path <- test_prepare_orderly_example("demo")
  id1 <- orderly_run("minimal", root = path, echo = FALSE)
  id2 <- orderly_run("other", list(nmin = 0), root = path, echo = FALSE)
  out <- capture_logs(orderly_cleanup("minimal", path))
  expect_equal(orderly_list_drafts(path),
               data.frame(name = "other", id = id2, stringsAsFactors = FALSE))
  expect_match(out$messages, "Found 1 draft report for report name 'minimal'",
               all = FALSE)
  expect_match(out$messages, "Found 0 csv files", all = FALSE)
  expect_match(out$messages, "Found 0 rds files", all = FALSE)
})

test_that("cleanup by name sanitises report name", {
  skip_on_cran_windows()
  path <- test_prepare_orderly_example("demo")
  id1 <- orderly_run("minimal", root = path, echo = FALSE)
  id2 <- orderly_run("other", list(nmin = 0), root = path, echo = FALSE)
  out <- capture_logs(orderly_cleanup("minimal/", path))
  expect_equal(orderly_list_drafts(path),
               data.frame(name = "other", id = id2, stringsAsFactors = FALSE))
  expect_match(out$messages, "Found 1 draft report for report name 'minimal'",
               all = FALSE)
  expect_match(out$messages, "Found 0 csv files", all = FALSE)
  expect_match(out$messages, "Found 0 rds files", all = FALSE)
})