tests/testthat/test-save_rds_archive.R

In STATWORX/helfRlein: R Helper Functions

testthat::context("check save_rds_archive")

testthat::test_that("'file' must be a non-empty character", {

  testthat::expect_error(save_rds_archive(5, file = ""),
               "'file' must be a non-empty character string")

  testthat::expect_error(save_rds_archive(5, file = 5),
               "'file' must be a non-empty character string")

  con <- url("https://www.statworx.com/de/")

  testthat::expect_error(save_rds_archive(5, file = con),
               "'file' must be a non-empty character string")

  close(con)

})

testthat::test_that("'archive_dir_path' cannot be null", {

  testthat::expect_error(save_rds_archive(5, file = "test.RDS", archive_dir_path = ""),
               "must supply a directory name to 'archive_dir_path' if not NULL")

})



testthat::test_that("'archive' and 'with_time' must be bools", {

  testthat::expect_warning(save_rds_archive(5, file = "temp.RDS", archive = 0),
                 "'archive' is not set to a boolean - will use default")

  testthat::expect_warning(save_rds_archive(5, file = "temp.RDS", with_time = 1),
                 "'with_time' is not set to a boolean - will use default")

})


testthat::test_that(paste0("if file name contains multiple 'RDS',
                 only the last one is replaced with suffix"), {

  temp <- "temp_rds_Rds.rds"

  saveRDS(10, file = temp)
  save_rds_archive(20, file = temp)

  testthat::expect_true(file.exists(paste0(tools::file_path_sans_ext(temp),
                                 "_ARCHIVED_on_",
                                 Sys.Date(),
                                 ".",
                                 tools::file_ext(temp))))

})

testthat::test_that("creation of archive dir works as expected", {

  temp <- "temp.RDS"
  my_path <- "archives/rds_files/dump"

  saveRDS(10, file = temp)

  testthat::expect_message(save_rds_archive(object = 20,
                                  file = temp,
                                  archive_dir_path = my_path),
                 "Created missing archive directory")

  archived_version <- readRDS(paste0(my_path, "/",
                                     tools::file_path_sans_ext(temp),
                                     "_ARCHIVED_on_",
                                     Sys.Date(),
                                     ".",
                                     tools::file_ext(temp)))

  updated_version <- readRDS("temp.RDS")

  testthat::expect_true(archived_version == 10)
  testthat::expect_true(updated_version == 20)

})

testthat::test_that("existing archived copies will be overwritten", {

  temp <- "temp_copy.RDS"

  saveRDS(5, temp)
  save_rds_archive(10, temp)

  testthat::expect_warning(save_rds_archive(object = 20, file = temp),
                 "Archived copy already exists - will overwrite!")

  overwritten_copy <- readRDS(paste0(tools::file_path_sans_ext(temp),
                                     "_ARCHIVED_on_",
                                     Sys.Date(),
                                     ".",
                                     tools::file_ext(temp)))

  current <- readRDS(temp)

  testthat::expect_true(overwritten_copy == 10)
  testthat::expect_true(current == 20)


})

testthat::test_that("everything goes as expected if file does not exist", {

  temp1 <- "temp123.RDS"

  testthat::expect_warning(save_rds_archive(500, temp1, archive = TRUE),
                 NULL)

  temp2 <- "temp234.RDS"
  testthat::expect_warning(save_rds_archive(500, temp2, archive = FALSE),
                 NULL)

})