tests/testthat/test-opts_list.R

In options: Simple, Consistent Package Options

test_that("opts_list produces an option of namespaced option names", {
  e <- new.env(parent = baseenv())

  expect_silent(with(e, options::define_options(
    "option quiet",
    quiet = TRUE
  )))

  l <- expect_silent(with(e, options::opts_list(quiet = FALSE)))

  expect_match(names(l), ".+\\.quiet")
  expect_type(l, "list")
  expect_equal(l[[1]], FALSE)
})

test_that("opts_list returns raw name if not part of namespaced option spec", {
  e <- new.env(parent = baseenv())
  expect_silent(with(e, options::define_options(
    "option quiet",
    quiet = TRUE
  )))

  l <- expect_silent(with(e, options::opts_list(quiet = FALSE, max.print = 10)))

  expect_match(names(l)[[1]], ".+\\.quiet")
  expect_true("max.print" %in% names(l))
})

test_that("opts_list emit warnings when names missing with check_names warn", {
  e <- new.env(parent = baseenv())
  expect_silent(with(e, options::define_options(
    "option quiet",
    quiet = TRUE
  )))

  expect_warning(with(e, {
    options::opts_list(quiet = FALSE, max.print = 10, check_names = "warn")
  }))
})

test_that("opts_list emit error when names missing with check_names stop", {
  e <- new.env(parent = baseenv())
  expect_silent(with(e, options::define_options(
    "option quiet",
    quiet = TRUE
  )))

  expect_error(with(e, {
    options::opts_list(quiet = FALSE, max.print = 10, check_names = "stop")
  }))
})