add tests for read_smips functions

.gitignore

@@ -5,3 +5,4 @@
 .DS_Store
 .quarto
 docs
+.Renviron

DESCRIPTION

@@ -6,7 +6,9 @@ Authors@R: c(
            comment = c(ORCID = "0000-0002-0061-8359")),
     person("Russell", "Edson", , "russell.edson@adelaide.edu.au", role = "aut",
            comment = c(ORCID = "0000-0002-4607-5396")),
-    person("Max", "Moldovan", , "max.moldovan@adelaide.edu.au", role = "ctb")
+    person("Max", "Moldovan", , "max.moldovan@adelaide.edu.au", role = "ctb"),
+    person("Wasin", "Pipattungsakul", , "wasin.pipattungsakul@adelaide.edu.au", 
+           role = "aut")
   )
 Description: Provides access to Australia's TERN (Terrestrial Ecosystem
     Research Network) data through the API, <https://tern.org.au>.

R/read_smips.R

@@ -64,6 +64,7 @@ read_smips <- function(collection = "totalbucket",
 
   while (attempt <= max_tries && !success)
     tryCatch({
+      # TODO: move the url concatenation out
       r <- (terra::rast(
         paste0(
           "/vsicurl/https://",
@@ -192,7 +193,7 @@ read_smips <- function(collection = "totalbucket",
                             "bucket1",
                             "bucket2",
                             "deepD",
-                            "runnoff")
+                            "runoff")
   collection <- rlang::arg_match(.collection, approved_collections)
 
   .check_collection_agreement(.collection = .collection, .day = .day)
@@ -211,4 +212,6 @@ read_smips <- function(collection = "totalbucket",
     collection == "runoff",
     paste0("smips_runoff_mm_", url_date, ".tif")
   )
+
+  return(collection_url)
 }

tests/testthat/test-.check_collection_agreement.R

@@ -0,0 +1,19 @@
+test_that("A valid collection combination passes", {
+  expect_null(.check_collection_agreement("totalbucket", as.Date("2007-01-01")))
+  expect_null(.check_collection_agreement("some_collection", as.Date("2007-01-01")))
+  expect_null(.check_collection_agreement("some_collection", lubridate::today() - 7))
+})
+
+test_that("An invalid collection combination throws an error", {
+  last_week <- lubridate::today() - 7
+
+  error_msg <- paste0("The data are not available before 2005 and roughly much past ", last_week)
+  expect_error(
+    .check_collection_agreement("some_collection", lubridate::today()),
+    error_msg
+  )
+  expect_error(
+    .check_collection_agreement("totalbucket", as.Date("2004-01-01")),
+    error_msg
+  )
+})

tests/testthat/test-.check_not_example_api_key.R

@@ -1,9 +1,4 @@
 test_that("An error is raised when the API key is the example string", {
   # multiple dates
-  expect_error(
-    .check_not_example_api_key("your_api_key"),
-    "You have copied the example code and not provided a proper API key.
-    An API key may be requested from TERN to access this resource. Please
-    see the help file for {.fn get_key} for more information."
-  )
+  expect_error(.check_not_example_api_key("your_api_key"))
 })

tests/testthat/test-.make_smips_url.R

@@ -0,0 +1,30 @@
+test_that("A valid url part is created", {
+  date_ <- as.Date("2020-01-01")
+
+  # different collections
+  expect_equal(.make_smips_url("totalbucket", date_), "smips_totalbucket_mm_20200101.tif")
+  expect_equal(.make_smips_url("SMindex", date_), "smips_smi_perc_20200101.tif")
+  expect_equal(.make_smips_url("bucket1", date_), "smips_bucket1_mm_20200101.tif")
+  expect_equal(.make_smips_url("bucket2", date_), "smips_bucket2_mm_20200101.tif")
+  expect_equal(.make_smips_url("deepD", date_), "smips_deepD_mm_20200101.tif")
+
+  # different date
+  expect_equal(.make_smips_url("runoff", as.Date("2020-01-02")), "smips_runoff_mm_20200102.tif")
+})
+
+test_that("An invalid collection throws an error", {
+  valid_collections <- c(
+    "totalbucket",
+    "SMindex",
+    "bucket1",
+    "bucket2",
+    "deepD",
+    "runoff"
+  )
+  valid_collections_str <- paste(valid_collections[seq_along(valid_collections) - 1], collapse = '", "')
+  valid_collections_str <- paste0('"', valid_collections_str, '", "', tail(valid_collections, 1), '"')
+
+  # TODO: check error message
+  error_msg <- paste0("`.collection` must be one of ", valid_collections_str, ', not "asdf".')
+  expect_error(.make_smips_url("asdf", as.Date("2020-01-01")))
+})