tests/testthat/test_dump_files.R

In aryoda/tryCatchLog: Advanced 'tryCatch()' and 'try()' Functions

# Basic tests of tryCatchLog

# Tests are run within the folder "tryCatchLog/tests/testthat".
# Clean it up at the beginning of a test!

library(testthat)
library(tryCatchLog)



# Test preparation ------------------------------------------------------------------------------------------------

context("test_dump_files.R")



source("init_unit_test.R")




# helper function to delete all existing dump files in the working directory
# (used for test set-up)
clean.up.dump.files <- function(path = ".") {
  existing.dump.files <- list.files(path = path, pattern = "dump_.*\\.rda", full.names = T)

  if (length(existing.dump.files) > 0)
    file.remove(existing.dump.files)

  invisible(TRUE)
}



# helper function to count the number of existing dump files
number.of.dump.files <- function(path = ".") {
  dump.files <- list.files(path = path, pattern = "dump_.*\\.rda")
  return(length(dump.files))
}



clean.up.dump.files()
clean.up.dump.files("temp_subfolder")



# suppress logging of errors and warnings to avoid overly output
source("disable_logging_output.R")



# unit tests ------------------------------------------------------------------------------------------------------

test_that("no dump file is created without an error", {
  tryCatchLog(TRUE, write.error.dump.file = TRUE)
  expect_equal(number.of.dump.files(), 0)
  clean.up.dump.files()
})



test_that("no dump file is created for a warning", {
  expect_warning(tryCatchLog(log(-1), write.error.dump.file = TRUE))
  expect_equal(number.of.dump.files(), 0)
  clean.up.dump.files()
})



test_that("no dump file is created with an error but disabled write.error.dump.file parameter", {
  tryCatchLog(
    log("a"),
    error = function(e) {
    },
    write.error.dump.file = FALSE
  )
  expect_equal(number.of.dump.files(), 0)

  clean.up.dump.files()

  log <- last.tryCatchLog.result()
  expect_equal(log$dump.file.name, "", info = "no dump file contained in log")
})



test_that("dump file is created with an error and write.error.dump.file parameter enabled", {
  tryCatchLog(
    log("a"),
    error = function(e) {
    },
    write.error.dump.file = TRUE
  )

  expect_equal(number.of.dump.files(), 1)

  log <- last.tryCatchLog.result()

  # Check for correct logging of dump file name
  expect_true(!is.na(log$dump.file.name))
  expect_gt(nchar(log$dump.file.name), 0)
  expect_true(file.exists(log$dump.file.name), info = "correct dump file contained in log")
  # print(log$dump.file.name)

  clean.up.dump.files()
})



options("tryCatchLog.write.error.dump.file" = FALSE)    # global default setting for all tryCatchLog call params "write.error.dump.file"



test_that("no dump file is created (no error)", {
  tryCatchLog(TRUE)
  expect_equal(number.of.dump.files(), 0)
  clean.up.dump.files()
})



test_that("no dump file is created (warning)", {
  expect_warning(tryCatchLog(
    log(-1),
    error = function(e) {
    }
  ))
  expect_equal(number.of.dump.files(), 0)
  clean.up.dump.files()
})



test_that("no dump file is created (error)", {
  tryCatchLog(
    log("a"),
    error = function(e) {
    }
  )
  expect_equal(number.of.dump.files(), 0)
  clean.up.dump.files()
})



options("tryCatchLog.write.error.dump.file" = TRUE)    # global default setting for all tryCatchLog call params "write.error.dump.file"



test_that("no dump file is created (no error but dump default enabled)", {
  tryCatchLog(TRUE)
  expect_equal(number.of.dump.files(), 0)
  clean.up.dump.files()
})



test_that("no dump file is created (warning but dump default enabled)", {
  expect_warning(tryCatchLog(
    log(-1),
    error = function(e) {
    }
  ))
  expect_equal(number.of.dump.files(), 0)
  clean.up.dump.files()
})



test_that("dump file is created (error and dump default enabled)", {
  tryCatchLog(
    log("a"),
    error = function(e) {
    }
  )
  expect_equal(number.of.dump.files(), 1)
  clean.up.dump.files()
})



options("tryCatchLog.write.error.dump.folder" = "temp_subfolder")



test_that("dump file is created in a specifc folder (error and dump default enabled)", {
  tryCatchLog(
    log("a"),
    error = function(e) {
    }
  )
  expect_equal(number.of.dump.files("temp_subfolder"), 1)
  clean.up.dump.files("temp_subfolder")
})



# Test case for issue #39 (errors in multi-threaded/multi-process code overwrite dump files)
# See https://github.com/aryoda/tryCatchLog/issues/39
test_that("dump files are not overwritten due to duplicated file names (non-deterministic test case!))", {
  # may produce non-deterministic errors (the dump file name is time-dependent)!
  num.trials <- 10
  for (i in 1:num.trials) {
    tryCatchLog(
      log("a"),
      error = function(e) {
      }
    )
  }
  expect_equal(number.of.dump.files("temp_subfolder"), num.trials)
  clean.up.dump.files("temp_subfolder")
})



options("tryCatchLog.write.error.dump.folder" = NULL)
# getOption("tryCatchLog.write.error.dump.folder", ".")

test_that("exactly one dump file is created in stacked tryCatchLog calls with handlers", {

  # inner and outer error handler
  tryCatchLog(
    tryCatchLog(
      log("a"),
      error = function(e) {
      },
      write.error.dump.file = TRUE),
    error = function(e) {
    },
    write.error.dump.file = TRUE
  )

  expect_equal(number.of.dump.files(), 1)

  log <- last.tryCatchLog.result()

  # Check for correct logging of dump file name
  expect_true(!is.na(log$dump.file.name))
  expect_gt(nchar(log$dump.file.name), 0)
  expect_true(file.exists(log$dump.file.name), info = "correct dump file contained in log")
  # print(log$dump.file.name)

  clean.up.dump.files()
})



test_that("exactly one dump file is created in stacked tryCatchLog calls without handlers", {

  # inner and outer error handler
  expect_error(tryCatchLog(
    tryCatchLog(
      log("a"),
      write.error.dump.file = TRUE),
    write.error.dump.file = TRUE
  ))

  expect_equal(number.of.dump.files(), 1)

  log <- last.tryCatchLog.result()

  # Check for correct logging of dump file name
  expect_true(!is.na(log$dump.file.name))
  expect_gt(nchar(log$dump.file.name), 0)
  expect_true(file.exists(log$dump.file.name), info = "correct dump file contained in log")
  # print(log$dump.file.name)

  clean.up.dump.files()
})



# Cleanup ----------------------------------------------------------------------------

clean.up.dump.files()
clean.up.dump.files("temp_subfolder")
unlink("temp_subfolder", recursive = TRUE)  # with the default value "FALSE" the folder is NOT deleted (see help)

options("tryCatchLog.write.error.dump.file" = NULL)   #  ".")  # just to be sure :-)