tests/testthat/test_namespace_hooks.R

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

library(testthat)
library(tryCatchLog)


context("test_namespace_hooks.R")



source("init_unit_test.R")



# These tests do check the namespace hook functions (for details see "?.onLoad")
# These tests do NOT detach and reload the tryCatchLog package but call the hook functions directly.



test_that("internal package state is initialized", {

  # prepare ---------------------------------------------------------------------------------------------------------

  # Preset the options

  # tryCatchLog:::.tryCatchLog.env$last.log <- NULL
  # Error in loadNamespace(name) : there is no package called ‘*tmp*’

  # tryCatchLog:::.tryCatchLog.env$newline <- "afds"
  # Error in loadNamespace(name) : there is no package called ‘*tmp*’



  # tests -----------------------------------------------------------------------------------------------------------

  expected_Newline_value <- "test_result"

  with_mock(
    `tryCatchLog:::determine.platform.NewLine` = function() return(expected_Newline_value),
    `tryCatchLog:::is.package.available` = function(pkg.name) return(FALSE),
    expect_message({
                     tryCatchLog:::.onLoad(".", "tryCatchLog")
                     tryCatchLog:::.onAttach(".", "tryCatchLog")
                   },
                   "Using tryCatchLog for logging",
                   info = "with no installed logging package the package-internal logging functions of tryCatchLog must be used")
  )



  # new line string is initialized
  expect_equal(tryCatchLog::platform.NewLine(), expected_Newline_value)



  # clean-up---------------------------------------------------------------------------------------------------------

  # DIRTY: Reset to correct value to avoid side effects for other unit tests
  # If this line fails many other unit test results may be wrong...
  tryCatchLog:::.onLoad(".", "tryCatchLog")
  # tryCatchLog:::.onAttach(".", "tryCatchLog")  # old call (before fixing issue #41)

  # Check reset: New line string is initialized
  expect_true(tryCatchLog::platform.NewLine() %in% c("\n", "\r\n"))

})



test_that("futile.logger is used if it is installed", {

  skip_if_not_installed("futile.logger")

  with_mock(
    `tryCatchLog:::is.package.available` = function(pkg.name) return(pkg.name == "futile.logger"),
    options(tryCatchLog.preferred.logging.package = NULL),  # to iterate over all supported packages and check which one is available
    tryCatchLog:::.onLoad(".", "tryCatchLog"),
    expect_message(tryCatchLog:::.onAttach(".", "tryCatchLog"), "Using futile.logger for logging")
  )

})

test_that("lgr is used if it is installed", {

  skip_if_not_installed("lgr")

  with_mock(
    `tryCatchLog:::is.package.available` = function(pkg.name) return(pkg.name == "lgr"),
    options(tryCatchLog.preferred.logging.package = NULL),  # to iterate over all supported packages and check which one is available
    tryCatchLog:::.onLoad(".", "tryCatchLog"),
    expect_message(tryCatchLog:::.onAttach(".", "tryCatchLog"), "Using lgr for logging")
    # . env = "tryCatchLog"
  )

})


test_that("internal logging functions are used", {

  with_mock(
    `tryCatchLog:::is.package.available` = function(pkg.name) return(FALSE),
    options(tryCatchLog.preferred.logging.package = NULL),  # to iterate over all supported packages and check which one is available
    tryCatchLog:::.onLoad(".", "tryCatchLog"),
    expect_message(tryCatchLog:::.onAttach(".", "tryCatchLog"), "Using tryCatchLog for logging")
    # . env = "tryCatchLog"
  )

})


test_that("non-existing options are initialized when package is loaded", {

  # prepare ---------------------------------------------------------------------------------------------------------

  # Unset the options
  options("tryCatchLog.write.error.dump.file" = NULL)
  options("tryCatchLog.write.error.dump.folder" = ".")
  options("tryCatchLog.silent.warnings"       = NULL)
  options("tryCatchLog.silent.messages"       = NULL)

  expect_null(getOption("tryCatchLog.write.error.dump.file"))
  expect_equal(getOption("tryCatchLog.write.error.dump.folder"), ".")
  expect_null(getOption("tryCatchLog.silent.warnings"))
  expect_null(getOption("tryCatchLog.silent.messages"))



  # tests -----------------------------------------------------------------------------------------------------------

  # call the hook function
  expect_silent(tryCatchLog:::.onLoad(".", "tryCatchLog"))



  # tryCatchLog initializes all non-existing options to FALSE
  expect_false(getOption("tryCatchLog.write.error.dump.file"))
  expect_equal(getOption("tryCatchLog.write.error.dump.folder"), ".")
  expect_false(getOption("tryCatchLog.silent.warnings"))
  expect_false(getOption("tryCatchLog.silent.messages"))

})



test_that("existing options are left untouched when package is loaded", {

  # prepare ---------------------------------------------------------------------------------------------------------

  # Preset the options
  options("tryCatchLog.write.error.dump.file" = TRUE)
  options("tryCatchLog.write.error.dump.folder" = ".")
  options("tryCatchLog.silent.warnings"       = TRUE)
  options("tryCatchLog.silent.messages"       = TRUE)



  expect_true(getOption("tryCatchLog.write.error.dump.file"))
  expect_equal(getOption("tryCatchLog.write.error.dump.folder"), ".")
  expect_true(getOption("tryCatchLog.silent.warnings"))
  expect_true(getOption("tryCatchLog.silent.messages"))



  # tests -----------------------------------------------------------------------------------------------------------

  # call the hook function
  expect_silent(tryCatchLog:::.onLoad(".", "tryCatchLog"))



  expect_true(getOption("tryCatchLog.write.error.dump.file"))
  expect_equal(getOption("tryCatchLog.write.error.dump.folder"), ".")
  expect_true(getOption("tryCatchLog.silent.warnings"))
  expect_true(getOption("tryCatchLog.silent.messages"))

})