tests/testthat/test-nisra_data_portal_request.R

In nisrarr: Download Data from the NISRA Data Portal

vcr::use_cassette("nisra_data_portal_application_error", {
  test_that("nisra_data_portal reports application errors", {
    expect_error(
      resp <- nisra_data_portal("incorrect_method", flush_cache = TRUE),
      "HTTP 400 Bad Request"
    )
  })
})


vcr::use_cassette("nisra_search", {
  test_that("nisra_search finds the right keywords", {
    out <- nisra_search(
      "health",
      datefrom = "2024-10-14",
      flush_cache = TRUE,
      regex = "\\w"
    )

    expect_equal(
      names(out),
      c(
        "dataset_code",
        "dataset_label",
        "frequency",
        "dataset_dimensions",
        "updated"
      )
    )
    labels <- out[["dataset_label"]]
    expect_true(all(grepl("health", labels, ignore.case = TRUE)))
  })
})

vcr::use_cassette("nisra_search_2", {
  test_that("nisra_search checks for dimensions", {
    out <- nisra_search(
      datefrom = "2024-10-14",
      flush_cache = TRUE,
      variables = "age"
    )

    data_dims <- out$dataset_dimensions
    expect_true(
      all(vapply(
        data_dims,
        \(x) {
          any(stringr::str_detect(x, stringr::fixed("age", ignore_case = TRUE)))
        },
        logical(1)
      ))
    )
  })
})

vcr::use_cassette("nisra_read_dataset", {
  test_that("datasets are returned as tibbles", {
    df <- nisra_read_dataset("CCMLGD", flush_cache = TRUE)

    expect_s3_class(df, "tbl_df")
    expect_s3_class(df, "nisra_df")
    expect_identical(
      colnames(df),
      c(
        "Statistic",
        "Month",
        "Local Government District",
        "value"
      )
    )
    expect_equal(
      get_metadata_field(df, "label"),
      "Claimant Count Monthly Data"
    )
  })
})

vcr::use_cassette("nisra_cache", {
  test_that("cache is used", {
    df <- nisra_read_dataset("CCMLGD", flush_cache = TRUE)
    df2 <- nisra_read_dataset("CCMLGD")

    expect_identical(df, df2)

    cache_keys <- nisrarr_cache$info()
    expect_true(length(cache_keys) > 0)
  })
})

vcr::use_cassette("missing_dataset", {
  test_that("message is shown if dataset does not exist", {
    expect_error(
      nisra_read_dataset("notacode", flush_cache = TRUE),
      "HTTP 404 Not Found"
    )
  })
})