tests/testthat/test-gather.R

In hexFinder: Find Hex Logos for CRAN Packages

# Tests for get_cran_info
test_that("get_cran_info", {
  # package does not exist
  expect_error(get_cran_info("notAPackage"))

  # package exists and returns a named list of settings
  expect_named(get_cran_info("rlang"))
})

# Tests for get_metacran_info
test_that("get_metacran_info", {
  # package does not exist
  expect_null(get_metacran_info("notAPackage"))

  # package exists and returns a named list of settings
  expect_named(get_metacran_info("rlang"))
})

# Tests for get_endpoint_content
with_mock_api({
  test_that("get_endpoint_content", {
    # missing arguments
    expect_error(get_endpoint_content())
    # Error return for existing repo with invalid token
    get_endpoint_content(
      "https://api.github.com/repos/pedrocoutinhosilva/imola", token = "fake") |> #nolint
      expect_null()

    # Error return for existing repo with invalid branch
    get_endpoint_content(
      "https://api.github.com/repos/pedrocoutinhosilva/hexFinder", branch = "fake") |> #nolint
      expect_null()
  })
})


# Tests for get_possible_paths
with_mock_api({
  test_that("get_possible_paths", {

    mock_ok_content <- list(
      list(path = "path/logo", type = "blob"),
      list(path = "path/package", type = "blob"),
      list(path = "path/ignore", type = "blob")
    )

    # missing arguments
    expect_error(get_possible_paths())
    expect_null(get_possible_paths(mock_ok_content))
    expect_null(get_possible_paths(mock_ok_content, c("ignore")))
    expect_null(get_possible_paths(mock_ok_content, c("ignore"), c("logo")))

    # Mininal example
    expect_type(get_possible_paths(mock_ok_content, c("ignore"), c("logo"), "package"), "list") #nolint

    # Empty content
    expect_null(get_possible_paths(list(), c("ignore"), c("logo"), "package")) #nolint
    expect_type(get_possible_paths(list(list()), c("ignore"), c("logo"), "package"), "list") #nolint

    # wrong format of content entry
    expect_type(get_possible_paths(list(list(notpath = "")), c("ignore"), c("logo"), "package"), "list") #nolint

    # Entry is ignored because its not a blob type
    expect_type(get_possible_paths(list(list(path = "", type  = "notblob")), c("ignore"), c("logo"), "package"), "list") #nolint
  })
})

# Tests for get_best_image
with_mock_api({
  test_that("get_best_image ", {
    # missing arguments
    expect_error(get_best_image())
    expect_error(get_best_image(list(), "https://raw.githubusercontent.com/repos/pedrocoutinhosilva/hexFinder", "main")) #nolint

    # Minimal examples
    expect_type(get_best_image(
      list(list(path = "man/figures/logo.svg")),
      "https://raw.githubusercontent.com/pedrocoutinhosilva/hexFinder",
      "main"
    ), "character")
  })
})

# Tests for keep_good_ratio_images
with_mock_api({
  test_that("keep_good_ratio_images", {
    # missing arguments
    expect_error(keep_good_ratio_images())

    # Minimal examples
    expect_type(keep_good_ratio_images(
      list(),
      "https://raw.githubusercontent.com/pedrocoutinhosilva/hexFinder",
      "main"
    ), "list")

    expect_type(keep_good_ratio_images(
      list(list(path = "man/figures/logo.svg")),
      "https://raw.githubusercontent.com/pedrocoutinhosilva/hexFinder",
      "main"
    ), "list")
  })
})

# Tests for search_repo_logo
with_mock_api({
  test_that("search_repo_logo", {
    # missing arguments
    expect_error(search_repo_logo() |> quietly())
    expect_null(search_repo_logo("hexFinder", ""))
  })
})