tests/testthat/test-zzz-plumb_api.R

In plumber: An API Generator for R

context("plumb() package APIs")


expect_apis <- function(apis) {
  expect_s3_class(apis, "plumber_available_apis")
  expect_s3_class(apis, "data.frame")
  expect_true(all(c("package", "name") %in% names(apis)))
}
test_that("available_apis() works with no package", {
  skip_on_cran()

  apis <- available_apis()
  expect_apis(apis)
})
test_that("available_apis() works with a package", {
  apis <- available_apis("plumber")
  expect_apis(apis)
})
test_that("available_apis() print method works", {
  apis_output <- capture.output({
    available_apis("plumber")
  })

  expected_apis_output <- c(
    "Available Plumber APIs:",
    "* plumber",
    paste0("  - ", dir(system.file("plumber", package = "plumber")))
  )

  expect_equal(
    apis_output,
    expected_apis_output
  )
})
test_that("available_apis() print method works with two packages", {
  top <- available_apis("plumber")
  bottom <- top
  top$package <- "top"
  bottom$package <- "bottom"

  apis_output <- capture.output({
    rbind(top, bottom)
  })

  plumber_apis <- paste0("  - ", dir(system.file("plumber", package = "plumber")))

  # printed in alpha order
  expected_apis_output <- c(
    "Available Plumber APIs:",
    "* bottom",
    plumber_apis,
    "* top",
    plumber_apis
  )

  expect_equal(
    apis_output,
    expected_apis_output
  )
})

test_that("missing args are handled", {
  expect_equal(plumb_api("plumber", NULL), available_apis("plumber"))

  skip_on_cran()
  all_apis <- available_apis()
  expect_equal(plumb_api(NULL, "01-append"), all_apis)
  expect_equal(plumb_api(NULL, NULL), all_apis)
})

test_that("errors are thrown", {


  expect_error(plumb_api(c("plumber", "plumber"), "01-append"))
  expect_error(plumb_api("plumber", c("01-append", "01-append")))

  expect_error(plumb_api(TRUE, "01-append"))
  expect_error(plumb_api("plumber", TRUE))

  expect_error(plumb_api("plumber", "not an api"))

  expect_error(available_apis("not a package"), "No package found with name")
  expect_error(available_apis("crayon"), "No Plumber APIs found for package")
})

test_that("edit opens correct file", {
  # Redefine editor so that file.edit doesn't try to open a file
  with_options(
    list(
      editor = function(name, file, title) {
        cat(file, " test file attempted to open\n", sep = "")
      }
    ),
    {
      apis <- available_apis()

      selected_api <- apis$package == "plumber" & apis$name == "01-append"

      expect_warning(
        expect_output(
          plumb_api("plumber", "01-append", edit = TRUE),
          "plumber.R test file attempted to open",
          fixed = TRUE
        ),
        "plumber.R has been opened in the editor"
      )

      selected_api <- apis$package == "plumber" & apis$name == "12-entrypoint"

      expect_warning(
        expect_output(
          plumb_api("plumber", "12-entrypoint", edit = TRUE),
          "entrypoint.R test file attempted to open",
          fixed = TRUE
        ),
        "entrypoint.R has been opened in the editor"
      )
    }
  )
})

test_that("edit throws a warning", {
  with_options(
    list(editor = function(name, file, title) NULL),
    expect_warning(plumb_api("plumber", "01-append", edit = TRUE))
  )
})

context("plumb() plumber APIs")
test_that("all example plumber apis plumb", {
  # plumb each api and validate they return a plumber object
  for_each_plumber_api(identity)
})