test-utils.R
In scrutiny: Error Detection in Science

test_that("The `globalVariables()` call returns these variables as strings", {
  utils::globalVariables(c(
    ".", "where", "desc", "all_of", "contains", "everything", "x", "items",
    "frac"
  )) %>% expect_type("character")
})


test_that("`wrong_spec_string()` returns a string", {
  wrong_spec_string(4) %>% expect_type("character")
})


sd_rec_scalar <- reconstruct_sd_scalar("mean_n", "0.3", 30, 12, 15)

test_that("`reconstruct_sd_scalar()` returns correct values", {
  sd_rec_scalar %>% expect_type("double")
  sd_rec_scalar %>% expect_equal(0.4660916)
})


sd_rec <- reconstruct_sd("mean_n", "0.3", 30, 12, 15)

test_that("`reconstruct_sd()` returns correct values", {
  sd_rec %>% expect_type("double")
  sd_rec %>% expect_equal(0.4660916)
})


test_that("`integer_places()` returns correct values", {
  integer_places(1.2)     %>% expect_equal(1)
  integer_places(11.2)    %>% expect_equal(2)
  integer_places(111.2)   %>% expect_equal(3)
  integer_places(1111.2)  %>% expect_equal(4)
  integer_places(11111.2) %>% expect_equal(5)

  integer_places(1.22222) %>% expect_equal(1)
  integer_places(11.2222) %>% expect_equal(2)
  integer_places(111.222) %>% expect_equal(3)
  integer_places(1111.22) %>% expect_equal(4)
  integer_places(11111.2) %>% expect_equal(5)
})


test_that("`straighten_out()` returns correct values", {
  straighten_out(1, 2, 3)           %>% expect_equal(list(1, 2, 3))
  straighten_out("a", "b", "c")     %>% expect_equal(list("a", "b", "c"))
  straighten_out(TRUE, FALSE, TRUE) %>% expect_equal(list(TRUE, FALSE, TRUE))
})



test_that("`an_a()` returns correct values", {
  an_a("start") %>% expect_equal("a")
  an_a("end")   %>% expect_equal("an")
})



test_that("`an_a_type()` returns correct values", {
  an_a_type("bla") %>% expect_equal("a string")
  an_a_type(4)     %>% expect_equal("a double (numeric value)")
})


test_that("`is_whole_number()` returns correct values", {
  is_whole_number(1)   %>% expect_true()
  is_whole_number(985) %>% expect_true()
  is_whole_number(37)  %>% expect_true()

  is_whole_number(0.2)    %>% expect_false()
  is_whole_number(25.05)  %>% expect_false()
  is_whole_number(75.489) %>% expect_false()
})



parcel_letters_expected <- c(
  "a", "c", "e", "g", "i", "k", "m", "o", "q", "s", "u", "w", "y"
)

test_that("`parcel_nth_elements()` returns correct values", {
  parcel_nth_elements(letters, 2) %>% expect_equal(parcel_letters_expected)
  parcel_nth_elements(1:10, 2) %>% expect_equal(c(1, 3, 5, 7, 9))
  parcel_nth_elements(1:10, 5) %>% expect_equal(c(1, 6))
})



df_test <- tibble::tibble(
  a = c(1, 2, 3, 1, 2, 3),
)


df_test_2 <- tibble::tibble(
  a = 1,
  b = 2,
  c = 3
) %>%
  reverse_column_order()

df_expected_2 <- tibble::tibble(
  c = 3,
  b = 2,
  a = 1
)

test_that("`reverse_column_order()` returns correct values", {
  df_test_2 %>% expect_equal(df_expected_2)
})



vec_test_1 <- 1:50 %>%
  as.double() %>%
  censor(25, 40)

vec_expected_1 <- rep(25, 25) %>%
  append(26:39) %>%
  append(rep(40, 11))

test_that("`censor()` returns correct values", {
  vec_test_1 %>% expect_equal(vec_expected_1)
})




vec_test_2 <- 1:7
vec_test_2 <- add_class(vec_test_2, "silly test")

df_test_3 <- add_class(df_test, "dummy class")
df_test_4 <- add_class(df_test, c("dummy class 1", "dummy class 2"))

test_that("`add_class()` really does add one or more classes", {
  vec_test_2 %>% expect_s3_class("silly test")
  df_test_3  %>% expect_s3_class("dummy class")
  df_test_4  %>% expect_s3_class("dummy class 1")
  df_test_4  %>% expect_s3_class("dummy class 2")
})



# Vectors with lengths 5, 3, 2, and 3 (they are all > 1):
numbers  <- 1:5
nephews  <- c("Huey", "Dewey", "Louie")
norberts <- c("Lammert", "Röttgen")
nikes    <- c("Air Max", "Zoom Freak", "Phantom")

n_list <- list(numbers, nephews, norberts, nikes)

test_that("`check_lengths_congruent()` throws an error when it should", {
  check_lengths_congruent(list(numbers, nephews, norberts, nikes)) %>% expect_error()
  check_lengths_congruent(list(numbers, nephews, norberts)) %>% expect_error()
  check_lengths_congruent(list(numbers, nephews, nikes)) %>% expect_error()
  check_lengths_congruent(list(numbers, norberts, nikes)) %>% expect_error()
  check_lengths_congruent(list(nephews, norberts, nikes)) %>% expect_error()
})

test_that("`check_lengths_congruent()` throws a warning when it should", {
  check_lengths_congruent(list(nephews, nikes), warn = TRUE) %>% expect_warning()
  check_lengths_congruent(list(numbers, numbers), warn = TRUE) %>% expect_warning()
  check_lengths_congruent(list(nephews, nephews), warn = TRUE) %>% expect_warning()
  check_lengths_congruent(list(norberts, norberts), warn = TRUE) %>% expect_warning()
  check_lengths_congruent(list(nikes, nikes), warn = TRUE) %>% expect_warning()
})


test_that("`check_lengths_congruent()` remains silent when it should", {
  check_lengths_congruent(list(nephews, nikes), warn = FALSE) %>% expect_silent()
  check_lengths_congruent(list(numbers, numbers), warn = FALSE) %>% expect_silent()
  check_lengths_congruent(list(nephews, nephews), warn = FALSE) %>% expect_silent()
  check_lengths_congruent(list(norberts, norberts), warn = FALSE) %>% expect_silent()
  check_lengths_congruent(list(nikes, nikes), warn = FALSE) %>% expect_silent()
})


test_that("`check_lengths_congruent()` remains silent when it should", {
  check_lengths_congruent(list(nephews, nikes), warn = FALSE) %>% expect_silent()
  check_lengths_congruent(list("a", "b", c("c", "d", "e"))) %>% expect_silent()
  check_lengths_congruent(list("a", "b")) %>% expect_silent()
  check_lengths_congruent(list(1, 2, 3, 4, 5)) %>% expect_silent()
  check_lengths_congruent(list("a", "b", "c", "d", "e")) %>% expect_silent()
  check_lengths_congruent(list(1, c(1, 2), 3, 4, 5)) %>% expect_silent()
  check_lengths_congruent(list("a", c("a", "b"), "c", "d", "e")) %>% expect_silent()
})



test_that("`check_length()` throws an error when it should", {
  check_length(numbers, 1) %>% expect_error()
  check_length(nephews, 1) %>% expect_error()
})

test_that("`check_length()` remains silent when it should", {
  check_length(numbers, 5) %>% expect_silent()
  check_length(nephews, 3) %>% expect_silent()
})



test_that("`check_type()` remains silent when the type is correct", {
  numbers  %>% check_type("integer")   %>% expect_silent()
  nephews  %>% check_type("character") %>% expect_silent()
  norberts %>% check_type("character") %>% expect_silent()
  nikes    %>% check_type("character") %>% expect_silent()
})


test_that("`check_type()` remains silent when the correct type is
          contained in a string vector of length > 1, along with
          wrong types", {
  numbers  %>% check_type(c("integer",   "THESE")) %>% expect_silent()
  nephews  %>% check_type(c("character", "TYPES")) %>% expect_silent()
  norberts %>% check_type(c("character", "ARE"  )) %>% expect_silent()
  nikes    %>% check_type(c("character", "WRONG")) %>% expect_silent()
})



test_that("`check_type()` throws an error if the type is wrong", {
  numbers  %>% check_type("character") %>% expect_error()
  nephews  %>% check_type("double")    %>% expect_error()
  norberts %>% check_type("integer")   %>% expect_error()
  nikes    %>% check_type("logical")   %>% expect_error()
})