replace snapshot tests

as they were troublemakers on CRAN. Instead test with local rds files.

NEWS.md

@@ -1,6 +1,6 @@
 # nflfastR 4.5.1
 
-* New implementation of tests to be able to identify breaking changes in reverse dependencies
+* New implementation of tests to be able to identify breaking changes in reverse dependencies (#396, #406)
 * `calculate_standings()` no more freezes when computing standings from schedules where some games are missing results, i.e. upcoming games.
 * Bug fix that caused problems with upcoming dplyr and tidyselect updates that weren't reverse compatible.
 * Significant performance improvements of internal functions. (#402)

tests/testthat/helpers.R

@@ -7,15 +7,18 @@ pbp_cache <- tempfile("pbp_cache", fileext = ".rds")
 
 load_test_pbp <- function(pbp = pbp_cache, dir = test_dir){
   if (file.exists(pbp) && !is.null(dir)){
-    cli::cli_alert_info("Will return pbp from cache")
+    if(interactive()) cli::cli_alert_info("Will return pbp from cache")
     return(readRDS(pbp))
   }
 
   g <- readRDS(file.path(test_dir, paste0("games.rds")))
 
   # model output differs across machines so we round to 4 significant digits
   # to prevent failing tests
-  pbp_data <- build_nflfastR_pbp(game_ids, dir = dir, games = g)
+  pbp_data <- build_nflfastR_pbp(game_ids, dir = dir, games = g) %>%
+    # we gotta round floating point numbers because of different model output
+    # across platforms
+    round_double_to_digits()
   if(!is.null(dir)) saveRDS(pbp_data, pbp)
   pbp_data
 }
@@ -27,3 +30,33 @@ save_test_object <- function(object){
   data.table::fwrite(modify_digits, tmp_file, na = "NA")
   invisible(tmp_file)
 }
+
+load_expectation <- function(type = c("pbp", "sc", "sc_weekly", "ep", "wp"),
+                             dir = test_dir){
+  type <- match.arg(type)
+  file_name <- switch (
+    type,
+    "pbp" = "expected_pbp.rds",
+    "sc" = "expected_sc.rds",
+    "sc_weekly" = "expected_sc_weekly.rds",
+    "ep" = "expected_ep.rds",
+    "wp" = "expected_wp.rds",
+  )
+  strip_nflverse_attributes(readRDS(file.path(dir, file_name))) %>%
+    # we gotta round floating point numbers because of different model output
+    # across platforms
+    round_double_to_digits()
+}
+
+# strip nflverse attributes for tests because timestamp and version cause failures
+# .internal.selfref is a data.table attribute that is not necessary in this case
+strip_nflverse_attributes <- function(df){
+  input_attrs <- names(attributes(df))
+  input_remove <- input_attrs[grepl("nflverse|.internal.selfref|nflfastR", input_attrs)]
+  attributes(df)[input_remove] <- NULL
+  df
+}
+
+round_double_to_digits <- function(df, digits = 4){
+  dplyr::mutate_if(df, is.double, signif, digits = digits)
+}

tests/testthat/test-build_nflfastR_pbp.R

@@ -2,9 +2,10 @@ test_that("build_nflfastR_pbp works (on CRAN)", {
   # this test will run on everywhere, including CRAN. It uses locally available data
   # so it can't break because of failed downloads
   pbp <- load_test_pbp(dir = test_dir)
-
-  expect_snapshot_file(save_test_object(pbp), "pbp.csv", cran = TRUE)
   expect_s3_class(pbp, "nflverse_data")
+  pbp <- strip_nflverse_attributes(pbp)
+  exp <- load_expectation("pbp")
+  expect_equal(pbp, exp)
 })
 
 test_that("build_nflfastR_pbp works (outside CRAN)", {
@@ -13,6 +14,7 @@ test_that("build_nflfastR_pbp works (outside CRAN)", {
   skip_on_cran()
   skip_if_offline("github.com")
   pbp <- load_test_pbp(dir = NULL)
-  expect_snapshot_file(save_test_object(pbp), "pbp.csv", cran = TRUE)
-  expect_s3_class(pbp, "nflverse_data")
+  pbp <- strip_nflverse_attributes(pbp)
+  exp <- load_expectation("pbp")
+  expect_equal(pbp, exp)
 })

tests/testthat/test-calculate_series_conversion_rates.R

@@ -1,12 +1,17 @@
 test_that("calculate_series_conversion_rates works", {
   pbp <- load_test_pbp()
 
-  sc <- calculate_series_conversion_rates(pbp = pbp, weekly = FALSE)
-  sc_weekly <- calculate_series_conversion_rates(pbp = pbp, weekly = TRUE)
+  sc <- calculate_series_conversion_rates(pbp = pbp, weekly = FALSE) %>%
+    round_double_to_digits()
+  sc_weekly <- calculate_series_conversion_rates(pbp = pbp, weekly = TRUE) %>%
+    round_double_to_digits()
 
-  expect_snapshot_file(save_test_object(sc), "sc.csv", cran = TRUE)
-  expect_snapshot_file(save_test_object(sc_weekly), "sc_weekly.csv", cran = TRUE)
+  exp_sc <- load_expectation("sc")
+  exp_sc_weekly <- load_expectation("sc_weekly")
 
   expect_s3_class(sc, "tbl_df")
   expect_s3_class(sc_weekly, "tbl_df")
+
+  expect_equal(sc, exp_sc)
+  expect_equal(sc_weekly, exp_sc_weekly)
 })

tests/testthat/test-ep_wp_calculators.R

@@ -11,8 +11,9 @@ test_that("calculate_expected_points works", {
     "posteam_timeouts_remaining" = 3,
     "defteam_timeouts_remaining" = 3
   )
-  ep <- calculate_expected_points(data)
-  expect_snapshot_file(save_test_object(ep), "ep.csv", cran = TRUE)
+  ep <- calculate_expected_points(data) %>% round_double_to_digits()
+  exp <- load_expectation("ep")
+  expect_equal(ep, exp)
 })
 
 test_that("calculate_expected_points works", {
@@ -30,6 +31,7 @@ test_that("calculate_expected_points works", {
     "posteam_timeouts_remaining" = 3,
     "defteam_timeouts_remaining" = 3
   )
-  wp <- calculate_win_probability(data)
-  expect_snapshot_file(save_test_object(wp), "wp.csv", cran = TRUE)
+  wp <- calculate_win_probability(data) %>% round_double_to_digits()
+  exp <- load_expectation("wp")
+  expect_equal(wp, exp)
 })