tests/testthat/test-model-summaries.R

In metrumresearchgroup/bbr: R package for bbi

context("Test bbi summary on multiple models")

skip_if_not_ci_or_metworx("test-model-summaries")

# references
NUM_MODS <- 3

# helper to run expectations
#
# `should_fail_at` lists positions in `mod_sums` that are expected to fail.
test_mod_sums <- function(mod_sums, should_fail_at = NULL) {
  expect_equal(length(mod_sums), NUM_MODS)

  ref_sum <- dget(SUMMARY_REF_FILE)

  for (i in seq_along(mod_sums)) {
    .s <- mod_sums[[i]]
    if (i %in% should_fail_at) {
      expect_false(.s$bbi_summary$success)
    } else {
      # replace incidental differences
      ref_sum[[ABS_MOD_PATH]] <- .s$bbi_summary[[ABS_MOD_PATH]]
      ref_sum$run_details$output_files_used <- NULL
      .s$bbi_summary$run_details$output_files_used <- NULL

      expect_equal(ref_sum, .s$bbi_summary)
    }
  }
}

# setup
cleanup()
create_rlg_models()
copy_output_dir(MOD1, NEW_MOD2)
# teardown
withr::defer(cleanup())


withr::with_options(list(bbr.bbi_exe_path = read_bbi_path()), {

  #########################################
  # extracting things from summary object
  #########################################

  test_that("model_summaries.list produces expected output [BBR-SUM-006]", {
    mods <- purrr::map(file.path(MODEL_DIR, seq(3)), read_model)
    expect_equal(length(mods), NUM_MODS)
    for (.m in mods) {
      expect_equal(class(.m), NM_MOD_CLASS_LIST)
    }
    skip_if_old_bbi("3.2.0")
    mod_sums <- model_summaries(mods)
    test_mod_sums(mod_sums, should_fail_at = 3)

  })

  test_that("model_summaries.list fails with bad list [BBR-SUM-007]", {
    bad_mods <- list(read_model(file.path(MODEL_DIR, 1)), list(naw = "dawg"))
    expect_equal(length(bad_mods), 2)
    expect_equal(class(bad_mods[[1]]), NM_MOD_CLASS_LIST)

    expect_error(model_summaries(bad_mods), regexp = "must contain only model objects")
  })

  test_that("model_summaries.bbi_run_log_df produces expected output [BBR-SUM-008]", {
    skip_if_old_bbi("3.2.0")
    mod_sums <- run_log(MODEL_DIR) %>% model_summaries()
    test_mod_sums(mod_sums, should_fail_at = 3)
  })


  test_that("as_summary_list.bbi_summary_log_df works [BBR-SUM-009]", {
    skip_if_old_bbi("3.2.0")
    mod_sums <- summary_log(MODEL_DIR) %>% as_summary_list()
    test_mod_sums(mod_sums, should_fail_at = 3)
  })

}) # closing withr::with_options