tests/testthat/test-github_api.R

In tidytuesdayR: Access the Weekly 'TidyTuesday' Project Dataset

test_that("gh_get_sha_in_folder gets sha for a file in a folder", {
  local_tt_mocked_bindings(
    gh_get = function(path, auth) {
      return(readRDS(test_path("fixtures", "static_contents.rds")))
    }
  )
  expect_equal(
    {
      gh_get_sha_in_folder("static", "tt_data_type.csv")
    },
    "5b7d51181d18d1af90caedd4e008509722612efb"
  )
  expect_equal(
    {
      gh_get_sha_in_folder("static", "tt_logo.png")
    },
    "61ab36921f82e35c621c2c4086c38b177bc89ea1"
  )
})

test_that("gh_get_csv gets and parses csv", {
  local_tt_mocked_bindings(
    gh_get = function(path, auth) {
      return(readRDS(test_path("fixtures", "tt_data_type_response.rds")))
    }
  )
  test_response <- gh_get_csv("static/tt_data_type.csv")
  expect_s3_class(test_response, "data.frame")
  expect_setequal(
    names(test_response),
    c("Week", "Date", "year", "data_files", "data_type", "delim")
  )
  expect_equal(nrow(test_response), 683)
})

test_that("gh_get_readme_html gets readme html", {
  local_tt_mocked_bindings(
    gh_get = function(path, auth, ...) {
      if (path == "data/2020") {
        return(readRDS(test_path("fixtures", "folder2020_response.rds")))
      } else if (path == "data/2020/readme.md") {
        return(readRDS(test_path("fixtures", "readme2020_response.rds")))
      }
    }
  )
  test_result <- gh_get_readme_html("data/2020")
  expected_result <- xml2::read_html(
    readRDS(test_path("fixtures", "readme2020_response.rds"))$message
  )
  expect_equal(test_result, expected_result)
})

test_that("gh_get_readme_html warns when no readme found", {
  local_tt_mocked_bindings(
    gh_get_folder = function(...) {
      list()
    }
  )
  expect_warning(
    {
      expect_null(gh_get_readme_html("data/2018/2018-04-02"))
    },
    "No readme found",
    class = "tt-warning-no_readme"
  )
})

test_that("gh_extract_text errors with empty response", {
  expect_error(
    {
      gh_extract_text(list())
    },
    "No content found",
    class = "tt-error-bad_gh_response"
  )
})

test_that("gh_extract_html errors with empty response", {
  expect_error(
    {
      gh_extract_html(list())
    },
    "No html found",
    class = "tt-error-bad_gh_response"
  )
})

test_that("gh_extract_sha_in_folder errors for missing file", {
  expect_error(
    {
      gh_extract_sha_in_folder(list(), "missing_file_name")
    },
    "Found no",
    class = "tt-error-file_not_found"
  )
  expect_error(
    {
      gh_extract_sha_in_folder(list(list(name = "found_file_name")), "missing_file_name")
    },
    "Found 1 file",
    class = "tt-error-file_not_found"
  )
})