tests/testthat/test_use_DRAC.R

In Luminescence: Comprehensive Luminescence Dating Data Analysis

template_v1.2 <- test_path("_data/DRAC_Input_Template_v1.2.csv")
template_v1.3 <- test_path("_data/DRAC_Input_Template_v1.3.csv")

test_that("input validation", {
  testthat::skip_on_cran()

  ## wrong file name
  expect_error(use_DRAC("error"),
               "File '.*error' does not exist") # windows CI needs the regexp
  expect_error(use_DRAC(NA),
               "'file' should be of class 'character', 'DRAC.list' or")
  expect_error(use_DRAC(character(0)),
               "'file' cannot be an empty character")
  expect_error(use_DRAC(letters),
               "'file' should have length 1")

  ## XLS input
  file.create(fake.xls <- tempfile(fileext = ".xls"))
  expect_error(use_DRAC(fake.xls),
               "File extension 'xls' is not supported, only 'csv' is valid")

  ## CSV file with the wrong header
  fake <- data.table::fread(template_v1.2)
  fake[1, 1] <- "error"
  fake.csv <- tempfile(fileext = ".csv")
  data.table::fwrite(fake, file = fake.csv)
  expect_error(use_DRAC(fake.csv),
               "you are not using the original DRAC v1.2 or v1.3 CSV template")

  expect_error(use_DRAC(template_v1.2, NA),
               "'name' should be of class 'character' or NULL")

  ## exceed allowed limit
  SW({
  expect_warning(input <- template_DRAC(preset = "DRAC-example_quartz",
                                        nrow = 5001),
                 "More than 5000 datasets might not be supported")
  })
  expect_error(use_DRAC(input), "The limit of allowed datasets is 5000")

  ## citation style
  expect_error(use_DRAC(template_DRAC(preset = "DRAC-example_quartz",
                                      notification = FALSE),
                        citation_style = "error"),
               "[use_DRAC()] 'citation_style' should be one of",
               fixed = TRUE)
})

test_that("check functionality", {
  testthat::skip_on_cran()

 ##use manual example
 ##create template
 SW({
 input <- template_DRAC(preset = "DRAC-example_quartz")
 })

 ##test
 expect_s3_class(input, "DRAC.list")

 ##fill (which also tests the methods)
 input$`Project ID` <- "DRAC-Example"
 input$`Sample ID` <- "Quartz"
 input$`Conversion factors` <- "AdamiecAitken1998"
 input$`External U (ppm)` <- 3.4
 input$`errExternal U (ppm)` <- 0.51
 input$`External Th (ppm)` <- 14.47
 input$`errExternal Th (ppm)` <- 1.69
 input$`External K (%)` <- 1.2
 input$`errExternal K (%)` <- 0.14
 input$`Calculate external Rb from K conc?` <- "Y"
 input$`Calculate internal Rb from K conc?` <- "Y"
 input$`Scale gammadoserate at shallow depths?` <- "Y"
 input$`Grain size min (microns)` <- 90L
 input$`Grain size max (microns)` <- 125L
 input$`Water content ((wet weight - dry weight)/dry weight) %` <- 5
 input$`errWater content %` <- 2
 input$`Depth (m)` <- 2.2
 input$`errDepth (m)` <- 0.22
 input$`Overburden density (g cm-3)` <- 1.8
 input$`errOverburden density (g cm-3)` <- 0.1
 input$`Latitude (decimal degrees)` <- 30.0000
 input$`Longitude (decimal degrees)` <- 70.0000
 input$`Altitude (m)` <- 150
 input$`De (Gy)` <- 20
 input$`errDe (Gy)` <- 0.2

 ##run DRAC
 SW({
 output <- expect_s4_class(use_DRAC(input), "RLum.Results")
 })

 ## print method for DRAC.highlights
 expect_output(print(output$DRAC$highlights), regexp = "TO:GP = errAge")

 ## DRAC.data.frame
 input.df <- as.data.frame(input)
 class(input.df) <- c("data.frame", "DRAC.data.frame")
 expect_s4_class(use_DRAC(input.df, verbose = FALSE),
                 "RLum.Results")

  SW({
  ## CSV input
  expect_message(expect_s4_class(
      use_DRAC(template_v1.2,
               verbose = TRUE),
      "RLum.Results"),
      "Reference for")

  ## communicate with insufficient input
  t <- template_DRAC(notification = FALSE)
  local_mocked_bindings(readline = function(prompt) "Y")
  expect_output(expect_error(
      use_DRAC(t),
      "The response from the server did not contain DRAC output"),
      "ERROR: Some fields were invalid")

  ## communicate with fake url
  expect_error(expect_warning(
      use_DRAC(t, url = "iamnotvali8793270942hd.valid"),
      "URL is missing '\\?show=calculator', please check validity!"),
      "Transmission failed with error: Could not resolve host: iamnotvali8793270942hd.valid")

  ## mock error status code
  local_mocked_bindings(POST = function(...) list(status_code = 313),
                        .package = "httr")
  expect_error(use_DRAC(t),
               "Transmission failed with HTTP status code: 313")
 })
})

test_that("snapshot tests", {
  testthat::skip_on_cran()

  set.seed(1)

  SW({
  expect_snapshot_output(use_DRAC(template_v1.3))
  })

  ## test print.DRAC.highlight()
  t <- template_DRAC(preset = "DRAC-example_quartz", notification = FALSE)
  res <- use_DRAC(t, verbose = FALSE)
  expect_snapshot_output(print(res$DRAC$highlights))

  ## communicate with insufficient input
  t[52] <- 0.0
  local_mocked_bindings(readline = function(prompt) "Y")
  set.seed(1)
  SW({
  expect_snapshot_output(expect_error(
      use_DRAC(t),
      "The response from the server did not contain DRAC output"))
  })
})