Update exec_cfg_check to use config source path relative to the hub root

R/exec_cfg_check.R

@@ -6,7 +6,9 @@ exec_cfg_check <- function(check_name, validations_cfg, caller_env, caller_call)
     )
   } else if (!is.null(fn_cfg[["source"]])) {
     # TODO Validate source script.
-    source(fn_cfg[["source"]], local = TRUE)
+    hub_path <- rlang::env_get(env = caller_env, nm = "hub_path")
+    src <- fs::path(hub_path, fn_cfg[["source"]])
+    source(src, local = TRUE)
     fn <- get(fn_cfg[["fn"]])
   }
 

tests/testthat/_snaps/execute_custom_checks.md

@@ -32,13 +32,12 @@
 # execute_custom_checks sourcing functions from scripts works
 
     Code
-      test_custom_checks_caller(validations_cfg_path = testthat::test_path("testdata",
-        "config", "validations-src.yml"))
+      print(res)
     Message
 
       -- 2023-05-08-hub-ensemble.parquet ----
 
-      i [src_check_works]: Sourcing custom functions WORKS! Also "Extra arguments passed"!!
+      i [check_1]: Sourcing custom functions WORKS! Also "Extra arguments passed"!!
 
 # execute_custom_checks return early when appropriate
 

tests/testthat/helper-custom-fns.R

@@ -11,3 +11,37 @@ test_custom_checks_caller <- function(
   # nolint end
   execute_custom_checks(validations_cfg_path = validations_cfg_path)
 }
+
+stand_up_custom_check_hub <- function(
+    # nolint start
+    hub_path = system.file("testhubs/flusight", package = "hubValidations"),
+    new_path = NULL,
+    check_path = testthat::test_path("testdata/src/R/src_check_works.R"),
+    args = list("src_check_works" = list(extra_msg = 'Extra arguments passed'))
+    ) {
+  if (is.null(new_path)) {
+    return()
+  }
+  fs::dir_copy(hub_path, new_path)
+  new_path <- fs::path(new_path, fs::path_file(hub_path))
+  script_path <- fs::path(new_path, "src/validations/R/test-check.R")
+  fs::dir_create(fs::path_dir(script_path))
+  fs::file_copy(check_path, script_path, overwrite = TRUE)
+  n <- seq_along(args)
+  fun <- lapply(n, function(fn) {
+      list(
+        fn = names(args)[[fn]],
+        source = fs::path_rel(script_path, start = new_path),
+        args = args[[fn]]
+      )
+  })
+  names(fun) <- paste0("check_", n)
+  yml <- list(
+    "default" = list(
+      "test_custom_checks_caller" = fun
+    )
+  )
+  # nolint end
+  writeLines(yaml::as.yaml(yml), fs::path(new_path, "hub-config", "validations.yml"))
+  return(new_path)
+}

tests/testthat/test-execute_custom_checks.R

@@ -25,54 +25,62 @@ test_that("execute_custom_checks works", {
 })
 
 test_that("execute_custom_checks sourcing functions from scripts works", {
+  tmp <- withr::local_tempdir()
+  hub <- stand_up_custom_check_hub(new_path = tmp)
 
-  expect_snapshot(
-    test_custom_checks_caller(
-      validations_cfg_path = testthat::test_path(
-        "testdata",
-        "config",
-        "validations-src.yml"
-      )
-    )
-  )
+  expect_no_error({
+    withr::with_tempdir({
+      res <- test_custom_checks_caller(hub_path = hub)
+    })
+  })
+
+  expect_snapshot(print(res))
 })
 
+
 test_that("execute_custom_checks return early when appropriate", {
   # When the first custom check returns an check_error class object, custom check
   # execution should return early
-  early_ret_custom <- test_custom_checks_caller(
-    validations_cfg_path = testthat::test_path(
-      "testdata",
-      "config",
-      "validations-early-ret.yml"
+  tmp1 <- withr::local_tempdir()
+  the_check <- testthat::test_path("testdata/src/R/src_simple_example_check.R")
+  hub1 <- stand_up_custom_check_hub(new_path = tmp1,
+    check_path = the_check,
+    args = list(
+      simple_example_check = list(check = FALSE, error = TRUE),
+      simple_example_check = list(check = TRUE, error = FALSE)
     )
   )
+  early_ret_custom <- test_custom_checks_caller(hub_path = hub1)
   expect_snapshot(early_ret_custom)
   expect_length(early_ret_custom, 1L)
   expect_false("check_2" %in% names(early_ret_custom))
 
   # Same when the first custom check returns an exec_error class object
-  early_ret_exec_error <- test_custom_checks_caller(
-    validations_cfg_path = testthat::test_path(
-      "testdata",
-      "config",
-      "validations-exec-error.yml"
+  tmp2 <- withr::local_tempdir()
+  hub2 <- stand_up_custom_check_hub(new_path = tmp2,
+    check_path = the_check,
+    args = list(
+      simple_example_check = list(check = FALSE, error = TRUE, exec_error = TRUE),
+      simple_example_check = list(check = TRUE, error = FALSE)
     )
   )
+  early_ret_exec_error <- test_custom_checks_caller(hub2)
   expect_snapshot(early_ret_exec_error)
   expect_length(early_ret_exec_error, 1L)
-  expect_false("check_2" %in% names(early_ret_exec_error))
+  expect_false("check_2" %in% names(early_ret_custom))
 
 
   # When the first custom check returns an check_failure class object, custom check
   # execution should proceed
-  no_early_ret_custom <- test_custom_checks_caller(
-    validations_cfg_path = testthat::test_path(
-      "testdata",
-      "config",
-      "validations-no-early-ret.yml"
+  tmp3 <- withr::local_tempdir()
+  hub3 <- stand_up_custom_check_hub(new_path = tmp3,
+    check_path = the_check,
+    args = list(
+      simple_example_check = list(check = FALSE, error = FALSE),
+      simple_example_check = list(check = TRUE, error = FALSE)
     )
   )
+  no_early_ret_custom <- test_custom_checks_caller(hub3)
   expect_snapshot(no_early_ret_custom)
   expect_length(no_early_ret_custom, 2L)
   expect_true("check_2" %in% names(no_early_ret_custom))