tests/testthat/test_gen_find.R

In CorrelAid/restatis: R Wrapper to Access a Wide Range of Germany's Federal Statistical System Databases Based on the GENESIS Web Service RESTful API of the German Federal Statistical Office (Statistisches Bundesamt/Destatis)

#-------------------------------------------------------------------------------
# Test for expected output & API calls ----
#-------------------------------------------------------------------------------

with_mock_dir("find1", {
  test_that("gen_find returns list", {

    skip_on_cran()
    skip_on_ci()

    result <- gen_find(term = "forst",
                       detailed = TRUE,
                       ordering = TRUE,
                       error.ignore = FALSE,
                       database = "genesis")

    expect_type(result, type = "list")

    attrs <- attributes(result)

    expect_true("Term" %in% names(attrs))
    expect_true("Language" %in% names(attrs))
    expect_true("Pagelength" %in% names(attrs))
    expect_true("Copyright" %in% names(attrs))

  })

})

#-------------------------------------------------------------------------------

with_mock_dir("find2_fake", {

  test_that("gen_find errors if there is an error code (fake response)", {

    # Here, the mockfile needs to be altered:
    # The Status$Code needs, e.g., 999
    # The Status$Content needs to be "test error message"

    skip_on_cran()
    skip_on_ci()

    expect_error(object = gen_find(term = "bus", error.ignore = TRUE, database = "genesis"),
                 regexp = "test error message")

  })

})

#-------------------------------------------------------------------------------

with_mock_dir("find3", {

  test_that("gen_find messages for 'detailed = TRUE'", {

    skip_on_cran()
    skip_on_ci()

    expect_message(object = gen_find(term = "zensus", error.ignore = TRUE, database = "genesis"),
                   regexp = "Use 'detailed = TRUE' to obtain the complete output.")

  })

})

#-------------------------------------------------------------------------------
# Test for errors, warnings, messages of parameters ----
#-------------------------------------------------------------------------------

test_that("gen_find function errors on numeric term param", {

  skip_on_cran()
  skip_on_ci()

  expect_error(object = gen_find(term = 12345, detailed = TRUE, category = "tables", database = "genesis"),
               regexp = "Parameter 'term' has to be of type 'character'.")

})

test_that("gen_find function errors on wrong category", {

  skip_on_cran()
  skip_on_ci()

  expect_error(object = gen_find(term = "bus", detailed = TRUE, category = "table", database = "genesis"),
               regexp = "Available categories for parameter 'category' for 'genesis' database are 'all', 'tables', 'statistics', 'variables', and 'cubes'.")

})

test_that("gen_find function errors on wrong detailed param", {

  skip_on_cran()
  skip_on_ci()

  expect_error(object = gen_find(term = "bus", detailed = 1, category = "tables", database = "genesis"),
               regexp = "Parameter 'detailed' has to be of type 'logical' and of length 1.")

})

test_that("gen_find function errors on wrong ordering param", {

  skip_on_cran()
  skip_on_ci()

  expect_error(object = gen_find(term = "bus", ordering = 1, category = "tables", database = "genesis"),
               regexp = "Parameter 'ordering' has to be of type 'logical' and of length 1.")

})

test_that("gen_find function errors on wrong error.ignore param", {

  skip_on_cran()
  skip_on_ci()

  expect_error(object = gen_find(term = "bus", error.ignore = 1, category = "tables", database = "genesis"),
               regexp = "Parameter 'error.ignore' has to be of type 'logical' and of length 1.")

})