tests/testthat/test_start_logging.R

In jennguyen1/scriptR: Scripting in R

context("Configure Logging")

library(futile.logger)
library(readr)

reset_log <- function() logging.loggers <- NULL

test_that("make_formatter handles missing and invalid data", {
  expect_error(make_formatter())
  expect_error(make_formatter("hi"))
  
  check_error <- function(func, ...){
    blank <- list(...)
    expect_error(make_formatter(blank))
  }
  
  check_error(f = "{message}", s = "{")
  check_error(format = "{message}")
  check_error(format = 1, style = "{")
  check_error(format = "{message}", style = "%")
})

test_that("make_handler handles missing and invalid data", {
  expect_error(make_handler())
  expect_error(make_handler("hi"))
  expect_error(make_handler(log_config$handlers$console))
  expect_error(make_handler(log_config$handlers$console, "", log_config$formatters))
  expect_error(make_handler(log_config$handlers$console, "a"))
  expect_error(make_handler(log_config$handlers$console, "a", NULL))
  
  check_error <- function(file_in_name = FALSE, ...){
    blank <- list(...)
    name <- if(file_in_name) "a_file" else "a"
    expect_error(make_handler(blank, name, log_config$formatters))
  }
  
  check_error(file_in_name = FALSE, c = "", f = "", l = "")
  check_error(file_in_name = FALSE, class = "", f = "", l = "")
  check_error(file_in_name = FALSE, class = "", formatter = "", l = "")
  check_error(file_in_name = FALSE, class = "", formatter = 1, level = "")

  check_error(file_in_name = FALSE, class = "logging.StreamHandler", formatter = "error", stream = "ext://sys.stdout", level = "NOTSET")
  check_error(file_in_name = FALSE, class = "logging.StreamHandler", formatter = "brief", stream = "ext://sys.stdout", level = "not a thing")

  check_error(file_in_name = TRUE, class = "logging.FileHandler", formatter = "brief", level = "INFO", mode = "w")
  check_error(file_in_name = TRUE, class = "logging.FileHandler", formatter = "brief", level = "INFO", filename = "~/file.log")
  check_error(file_in_name = TRUE, class = "logging.FileHandler", formatter = "brief", level = "INFO", filename = "~/file.log", mode = "i")
  check_error(file_in_name = FALSE, class = "logging.FileHandler", formatter = "brief", level = "INFO", filename = "~/file.log", mode = "w")

  check_error(file_in_name = FALSE, class = "not a thing", formatter = "brief", level = "NOTSET")
})

test_that("dictConfig handles missing and invalid data", {
  reset_log()
  expect_error(dictConfig())
  expect_error(dictConfig(list(r = "", h = "", f = "")))
  expect_error(dictConfig(list(root = "", h = "", f = "")))
  expect_error(dictConfig(list(root = "", handlers = "", f = "")))
  
  reset_log()
  expect_error(dictConfig(list(root = "", handlers = "", formatters = "")))
  expect_error(dictConfig(list(root = "", handlers = list(a = 1), formatters = "")))
  expect_error(dictConfig(list(root = "", handlers = list(a = 1), formatters = list(a = 1))))
  
  reset_log()
  check_error <- function(...){
    blank <- log_config
    blank$root <- list(...)
    expect_error(dictConfig(blank))
  }
  check_error(l = "", h = "")
  check_error(level = "", h = "")
  check_error(level = "not a thing", handlers = "")
  check_error(level = "NOTSET", handlers = c("console", "not a thing"))
  reset_log()
})

test_that("start_logging correctly intiates default logging", {
  reset_log()
  expect_null(logging.info("hi"))
  start_logging()
  expect_output(logging.info("hi"))
  base_handlers <- logging.loggers
  expect_equal(base_handlers, "console")
  expect_equal(names(flog.logger("console")$threshold), "TRACE")
  reset_log()
})

test_that("start_logging correctly intiates customized logging", {
  # setup
  blank <- log_config
  names(blank$handlers) <- c("console", "file1", "file2", "file3")
  blank$handlers$file1$filename <- "file1.log"
  blank$handlers$file2$filename <- "file2.log"
  blank$handlers$file1$mode <- "w"
  blank$handlers$file2$mode <- "a"
  blank$handlers$file2$level <- "DEBUG"
  blank$root$handlers <- c("console", "file1", "file2")
  write(rjson::toJSON(blank), file = "file.json")
  write("hello world", file = "test.json")

  # logging file specs
  reset_log()
  expect_error(start_logging("not a thing"))
  reset_log()
  expect_error(start_logging("test.json"))
  
  # logging init
  reset_log()
  start_logging("file.json")
  base_handlers <- logging.loggers
  expect_equal(base_handlers, c("console", "file1", "file2"))
  expect_equal(names(flog.logger("console")$threshold), "TRACE")
  expect_equal(names(flog.logger("file1")$threshold), "INFO")
  expect_equal(names(flog.logger("file2")$threshold), "DEBUG")
  expect_equal(get("file", envir = environment(flog.logger("file1")$appender)), "file1.log")
  expect_equal(get("file", envir = environment(flog.logger("file2")$appender)), "file2.log")
  
  # check file existence
  logging.warning("hi")
  expect_true(file.exists("file1.log"))
  expect_true(file.exists("file2.log"))
  
  # shutdown
  file.remove("file.json")
  file.remove("test.json")
  file.remove("file1.log")
  file.remove("file2.log")
})