tests/testthat/test-client.R

In vimc/orderlyweb: Orderly Support for 'OrderlyWeb'

context("API client")

test_that("Authentication logic", {
  cl <- test_orderlyweb_api_client(FALSE)
  expect_false(cl$is_authorised())
  res <- cl$GET("/")
  expect_true(cl$is_authorised())
  expect_equal(res$name, "OrderlyWeb")
  expect_is(res$endpoints, "character")

  expect_silent(res1 <- cl$GET("/reports/"))
  cl$api_token <- httr::add_headers("Authorization" =
                                      paste("Bearer", "aninvalidtoken"))
  expect_message(
    res2 <- cl$GET("/reports/"),
    "Authorising with server 'localhost:8888'")
  expect_equal(res1, res2)
})


test_that("Authenticate with function", {
  skip_if_no_orderlyweb_server()
  host <- "localhost"
  port <- 8888
  token <- function() {
    message("<<custom token function>>")
    Sys.getenv("ORDERLYWEB_TEST_TOKEN")
  }
  https <- FALSE
  cl <- orderlyweb_api_client(host, port, token, https = FALSE)

  expect_false(cl$is_authorised())
  expect_message(
    res <- cl$GET("/"),
    "<<custom token function>>", fixed = TRUE)
  expect_true(cl$is_authorised())
})


test_that("API client must use absolute paths", {
  cl <- test_orderlyweb_api_client()
  expect_error(cl$GET("reports"),
               "Expected an absolute path")
})


test_that("API client URL can use prefix, stripping slashes", {
  expect_equal(
    orderlyweb_api_client_url("host", 443, TRUE, "prefix", 1),
    list(www = "https://host:443/prefix",
         api = "https://host:443/prefix/api/v1"))
  expect_equal(
    orderlyweb_api_client_url("host", 443, TRUE, "/prefix/", 1),
    list(www = "https://host:443/prefix",
         api = "https://host:443/prefix/api/v1"))
})


test_that("API client URL ignores empty prefix", {
  cmp <- list(www = "https://host:443",
              api = "https://host:443/api/v1")
  expect_equal(
    orderlyweb_api_client_url("host", 443, TRUE, "", 1), cmp)
  expect_equal(
    orderlyweb_api_client_url("host", 443, TRUE, "/", 1), cmp)
  expect_equal(
    orderlyweb_api_client_url("host", 443, TRUE, NULL, 1), cmp)
})


test_that("Handle unexpcted errors", {
  testthat::skip_on_cran()
  testthat::skip_if_offline()
  r <- httr::GET("https://httpbin.org/status/404")
  expect_error(orderlyweb_api_client_response(r, NULL),
               "endpoint or resource not found")
  r <- httr::GET("https://httpbin.org/status/403")
  expect_error(orderlyweb_api_client_response(r, NULL),
               "endpoint or resource not found, or you do not have permission")
  r <- httr::GET("https://httpbin.org/status/500")
  expect_error(orderlyweb_api_client_response(r, NULL),
               "server returned error code 500")
})


test_that("download type switching", {
  expect_equal(orderlyweb_accept("rds"),
               httr::accept("application/octet-stream"))
  expect_equal(orderlyweb_accept("binary"),
               httr::accept("application/octet-stream"))
  expect_equal(orderlyweb_accept("zip"),
               httr::accept("application/zip"))
  expect_equal(orderlyweb_accept("csv"),
               httr::accept("text/csv"))
  expect_error(orderlyweb_accept("xlsx"),
               "unknown type xlsx")
})


test_that("name validation builds a name", {
  expect_equal(
    orderlyweb_api_client_name("given", "host", 443, "prefix"),
    "given")
  expect_equal(
    orderlyweb_api_client_name(NULL, "host", 443, NULL),
    "host:443")
  expect_equal(
    orderlyweb_api_client_name(NULL, "host", 443, "prefix"),
    "host:443/prefix")
})