tests/testthat/test-rqualify-orchestration.R

In rqualify: Qualification of R Software Installations

test_that("rqualify() orchestrates helpers in the expected order with correct arguments", {
  calls <- list()
  record <- function(name, args = list()) {
    calls[[length(calls) + 1L]] <<- list(name = name, args = args)
  }

  fake_paths <- list(
    path_save           = "/fake/parent",
    path_rvalidation    = "/fake/parent/R-validation",
    path_iqoqtestoutput = "/fake/parent/R-validation/IQ-OQ-TestOutput"
  )

  local_mocked_bindings(
    setup_validation_dirs = function(path_save) {
      record("setup_validation_dirs", list(path_save = path_save))
      fake_paths
    },
    setup_tinytex_env = function(setup_tinytex, render_latex, verbose) {
      record("setup_tinytex_env",
             list(setup_tinytex = setup_tinytex,
                  render_latex  = render_latex,
                  verbose       = verbose))
      invisible(NULL)
    },
    setup_pandoc_env = function(setup_pandoc, verbose) {
      record("setup_pandoc_env",
             list(setup_pandoc = setup_pandoc, verbose = verbose))
      invisible(NULL)
    },
    render_validation = function(path_rvalidation, engine, render_latex, verbose) {
      record("render_validation",
             list(path_rvalidation = path_rvalidation,
                  engine           = engine,
                  render_latex     = render_latex,
                  verbose          = verbose))
      invisible(NULL)
    },
    check_validation_results = function(path_rvalidation) {
      record("check_validation_results",
             list(path_rvalidation = path_rvalidation))
      invisible("ok")
    }
  )

  result <- rqualify(
    path_save     = "/fake/parent",
    engine        = "latex",
    setup_tinytex = FALSE,
    setup_pandoc  = FALSE,
    render_latex  = TRUE,
    verbose       = FALSE
  )

  # Return value is the R-validation path from setup_validation_dirs()
  expect_identical(result, fake_paths$path_rvalidation)

  # Each helper called exactly once, in the expected order
  expect_identical(
    vapply(calls, `[[`, character(1), "name"),
    c("setup_validation_dirs",
      "setup_tinytex_env",
      "setup_pandoc_env",
      "render_validation",
      "check_validation_results")
  )

  # Arguments propagated correctly
  expect_identical(calls[[1]]$args$path_save, "/fake/parent")

  expect_identical(calls[[2]]$args,
                   list(setup_tinytex = FALSE,
                        render_latex  = TRUE,
                        verbose       = FALSE))

  expect_identical(calls[[3]]$args,
                   list(setup_pandoc = FALSE, verbose = FALSE))

  expect_identical(calls[[4]]$args,
                   list(path_rvalidation = fake_paths$path_rvalidation,
                        engine           = "latex",
                        render_latex     = TRUE,
                        verbose          = FALSE))

  expect_identical(calls[[5]]$args,
                   list(path_rvalidation = fake_paths$path_rvalidation))
})

test_that("rqualify() errors when path_save is missing without calling any helper", {
  calls <- character()
  fail_if_called <- function(...) {
    calls <<- c(calls, "called")
    stop("should not be called")
  }

  local_mocked_bindings(
    setup_validation_dirs    = fail_if_called,
    setup_tinytex_env        = fail_if_called,
    setup_pandoc_env         = fail_if_called,
    render_validation        = fail_if_called,
    check_validation_results = fail_if_called
  )

  expect_error(
    rqualify(setup_tinytex = FALSE, setup_pandoc = FALSE, verbose = FALSE),
    "path_save"
  )
  expect_length(calls, 0)
})

test_that("rqualify() forwards render_latex = FALSE to the relevant helpers", {
  seen <- list()
  fake_paths <- list(
    path_save           = "/fake",
    path_rvalidation    = "/fake/R-validation",
    path_iqoqtestoutput = "/fake/R-validation/IQ-OQ-TestOutput"
  )

  local_mocked_bindings(
    setup_validation_dirs = function(path_save) fake_paths,
    setup_tinytex_env = function(setup_tinytex, render_latex, verbose) {
      seen$tinytex_render_latex <<- render_latex
      invisible(NULL)
    },
    setup_pandoc_env = function(...) invisible(NULL),
    render_validation = function(path_rvalidation, engine, render_latex, verbose) {
      seen$render_render_latex <<- render_latex
      invisible(NULL)
    },
    check_validation_results = function(...) invisible("ok")
  )

  rqualify(path_save     = "/fake",
           engine        = "latex",
           setup_tinytex = FALSE,
           setup_pandoc  = FALSE,
           render_latex  = FALSE,
           verbose       = FALSE)

  expect_false(seen$tinytex_render_latex)
  expect_false(seen$render_render_latex)
})

test_that("rqualify() still returns the R-validation path when check_validation_results() warns", {
  fake_paths <- list(
    path_save           = "/fake",
    path_rvalidation    = "/fake/R-validation",
    path_iqoqtestoutput = "/fake/R-validation/IQ-OQ-TestOutput"
  )

  local_mocked_bindings(
    setup_validation_dirs    = function(path_save) fake_paths,
    setup_tinytex_env        = function(...) invisible(NULL),
    setup_pandoc_env         = function(...) invisible(NULL),
    render_validation        = function(...) invisible(NULL),
    check_validation_results = function(path_rvalidation) {
      warning("R-validation failed. Please check the output files in the 'R-validation' folder.")
      invisible("fail")
    }
  )

  expect_warning(
    result <- rqualify(path_save     = "/fake",
                       setup_tinytex = FALSE,
                       setup_pandoc  = FALSE,
                       verbose       = FALSE),
    "R-validation failed"
  )
  expect_identical(result, fake_paths$path_rvalidation)
})

test_that("rqualify() still returns the R-validation path when summary file is missing", {
  fake_paths <- list(
    path_save           = "/fake",
    path_rvalidation    = "/fake/R-validation",
    path_iqoqtestoutput = "/fake/R-validation/IQ-OQ-TestOutput"
  )

  local_mocked_bindings(
    setup_validation_dirs    = function(path_save) fake_paths,
    setup_tinytex_env        = function(...) invisible(NULL),
    setup_pandoc_env         = function(...) invisible(NULL),
    render_validation        = function(...) invisible(NULL),
    check_validation_results = function(path_rvalidation) {
      warning("Test summary file not found. Please check the output files in the 'R-validation' folder.")
      invisible("missing")
    }
  )

  expect_warning(
    result <- rqualify(path_save     = "/fake",
                       setup_tinytex = FALSE,
                       setup_pandoc  = FALSE,
                       verbose       = FALSE),
    "not found"
  )
  expect_identical(result, fake_paths$path_rvalidation)
})