tests/testthat/test-get_param.R

In 2DegreesInvesting/r2dii.utils: General Utility Tools

test_that("get_param(<field>)(<file>) outputs a value from a config <file>", {
  config_file <- glue::glue("
    default:
      a_field: a_value
  ")
  config_path <- tempfile()
  readr::write_lines(config_file, config_path)

  # Avoid warning from default_config()
  default_config <- suppressWarnings(default_config())
  expect_equal(get_param("a_field")(default_config), NULL)
  expect_equal(get_param("a_field")(config_path), "a_value")
})

test_that("get_param returns value if param is not NULL", {
  path_config <- example_config("config-toy.yml")

  get_1 <- get_param("Expect", "param_1", if_null = stop)
  expect_equal(get_1(path_config), 1)
  expect_equal(get_1(path_config), 1)
  expect_is(get_1(path_config), "integer")

  get_a <- get_param("Expect", "param_a")
  expect_equal(get_a(path_config), "a")

  get_true <- get_param("Expect", "param_true")
  expect_true(get_true(path_config))

  get_false <- get_param("Expect", "param_false")
  expect_false(get_false(path_config))
})

test_that("get_param with `if_null = stop` throws an error", {
  path_config <- example_config("config-toy.yml")

  get_null <- get_param("Expect", "param_null", if_null = stop)
  expect_error(
    get_null(path_config),
    "must be not `NULL`"
  )
})

test_that("get_param with `if_null = NULL` returns null", {
  path_config <- example_config("config-toy.yml")

  get_null <- get_param("Expect", "param_null", if_null = NULL)
  expect_null(get_null(path_config))
})

test_that("get_param with `if_null = <value>` returns <value>", {
  path_config <- example_config("config-toy.yml")

  get_null_set_1 <- get_param("Expect", "param_null", if_null = 1)
  expect_equal(
    expect_warning(get_null_set_1(path_config), "param_null.*is undefined"),
    1
  )
})

test_that("FIN.DATA.PATH uses `r2dii_config` option", {
  config <- example_config("config-toy.yml")
  withr::local_options(list(r2dii_config = config))

  fin <- fs::path_file(FIN.DATA.PATH())
  expect_equal(fin, "2018Q3")
})

test_that("FINANCIAL.TIMESTAMP uses `r2dii_config` option", {
  config <- example_config("config-toy.yml")
  withr::local_options(list(r2dii_config = config))

  expect_equal(FINANCIAL.TIMESTAMP(), "2018Q3")
  expect_equal(ALD.TIMESTAMP(), 3333L)
})

test_that("FINANCIAL.TIMESTAMP with defaults outputs 'DONT-DELETE'", {
  default_config <- suppressWarnings(default_config())
  expect_equal(FINANCIAL.TIMESTAMP(file = default_config), "DONT-DELETE")
})

test_that("DATAPREP.TIMESTAMP errors if param is `NULL` (#8 thanks @Clare2D)", {
  config_text <- glue::glue("
   default:
     a_field: a_value
 ")
  config <- tempfile()
  readr::write_lines(config_text, config)

  expect_error(
    DATAPREP.TIMESTAMP(config),
    "must be not `NULL`"
  )
})