tests/testthat/test-api_key.R

In openrouteservice: An 'openrouteservice' API Client

context("Key management")

on_cran <- function() {
  !interactive() && !isTRUE(as.logical(Sys.getenv("NOT_CRAN", "false")))
}

## record current state before starting any tests
env <- Sys.getenv("ORS_API_KEY", NA);
key <- tryCatch(if (on_cran()) NA else keyring::key_get("openrouteservice"), error = function(e) NA)

## restore initial state
on.exit({
  if ( !is.na(env) ) Sys.setenv(ORS_API_KEY = env)
  if ( !is.na(key) ) keyring::key_set_with_value("openrouteservice", NULL, key)
}, add = TRUE)

Sys.unsetenv("ORS_API_KEY")
api_key_val <- "key_stored_in_keyring"

test_that("Set key in keyring", {
  skip_on_cran()
  skip_on_os("linux")
  expect_silent(ors_api_key(api_key_val))
})

test_that("Get key from keyring", {
  skip_on_cran()
  skip_on_os("linux")
  expect_identical(ors_api_key(), api_key_val)
})

test_that("Environment variable takes precedance over keyring", {
  api_key_val <- "key_stored_in_env_var"
  Sys.setenv(ORS_API_KEY = api_key_val)
  expect_identical(ors_api_key(), api_key_val)
})

test_that("Use non-default environment variable for api key", {
  options(openrouteservice.api_key_env = "MY_API_KEY")
  api_key_val <- "my_api_key_value"
  Sys.setenv(MY_API_KEY = api_key_val)
  expect_identical(ors_api_key(), api_key_val)
  Sys.unsetenv("MY_API_KEY")
})