Tests for color utilities and global settings (#285)

* Tests for color utilities

* tests for global settings

* Use functions for error messages

R/messages.R

@@ -48,6 +48,10 @@ messages$valueShouldNotBeNegative <- function(parameterName, value) {
   paste0(parameterName, " must be a positive numerical value, but the value is ", value)
 }
 
+messages$nrOfColorsShouldBePositive <- function(nrOfColors) {
+  paste0("nrOfColors must be positive, value ", nrOfColors, " is not valid!")
+}
+
 
 messages$noPKDataToWrite <- function() {
   "`pkDataFilePath` argument is specified, but there is no PK parameters data to write to spreadsheets."

R/utilities-figures.R

@@ -37,7 +37,7 @@ esqLABS_colors <- function(nrOfColors) {
   deltaV_r_g <- max(esqRed_hsv[3], esqGreen_hsv[3]) - min(esqRed_hsv[3], esqGreen_hsv[3])
 
   if (nrOfColors < 0) {
-    stop("nrOfColors must be positive, value ", nrOfColors, " is not valid!")
+    stop(messages$nrOfColorsShouldBePositive(nrOfColors))
   }
   if (nrOfColors == 0) {
     return(c())

R/zzz.R

@@ -1,4 +1,6 @@
+# nocov start
 .onLoad <- function(...) {
   options(warnPartialMatchDollar = TRUE)
   Sys.setenv("_R_CHECK_LENGTH_1_CONDITION_" = "true")
 }
+# nocov end

tests/testthat/_snaps/esqlabsr-settings.md

@@ -0,0 +1,18 @@
+# Names for settings are as expected
+
+    Code
+      esqlabsRSettingNames
+    Output
+      $packageVersion
+      [1] "packageVersion"
+      
+      $packageName
+      [1] "packageName"
+      
+      $widthPerPlotMapping
+      [1] "widthPerPlotMapping"
+      
+      $heightPerPlotMapping
+      [1] "heightPerPlotMapping"
+      
+

tests/testthat/test-esqlabsr-settings.R

@@ -0,0 +1,12 @@
+test_that("Names for settings are as expected", {
+  expect_snapshot(esqlabsRSettingNames)
+})
+
+test_that("Check that values for package environment bindings are correct", {
+  expect_error(
+    getEsqlabsRSetting("xyz"),
+    messages$errorPackageSettingNotFound("xyz", esqlabsEnv)
+  )
+
+  expect_equal(getEsqlabsRSetting("packageName"), "esqlabsR")
+})

tests/testthat/test-utilities-figures.R

@@ -1,12 +1,51 @@
 ## context("esqLABS_colors")
+
+test_that("esqLABS_colors input validation works as expected", {
+  expect_error(esqLABS_colors(-1), messages$nrOfColorsShouldBePositive(-1))
+})
+
+test_that("esqLABS_colors wprks with empty argument vector", {
+  expect_equal(length(esqLABS_colors(0)), 0)
+})
+
 test_that("esqLABS_colors returns two colors", {
   expect_equal(length(esqLABS_colors(2)), 2)
 })
 
+test_that("esqLABS_colors returns three colors", {
+  expect_equal(length(esqLABS_colors(3)), 3)
+})
+
 test_that("esqLABS_colors returns ten colors", {
   expect_equal(length(esqLABS_colors(10)), 10)
 })
 
+test_that("esqLABS_colors returns ten colors", {
+  expect_equal(length(esqLABS_colors(10)), 10)
+})
+
+## context("col2hsv")
+
+test_that("col2hsv returns expected HSV values for a given R color name", {
+  expect_equal(
+    col2hsv("yellow"),
+    structure(c(0.166666666666667, 1, 1),
+      .Dim = c(3L, 1L),
+      .Dimnames = list(c("h", "s", "v"), NULL)
+    )
+  )
+
+  expect_equal(
+    col2hsv("white"),
+    structure(c(0, 0, 1),
+      .Dim = c(3L, 1L),
+      .Dimnames = list(c("h", "s", "v"), NULL)
+    )
+  )
+})
+
+
+
 ## context("createEsqlabsPlotConfiguration")
 
 test_that("createEsqlabsPlotConfiguration() creates object with chosen defaults", {