checking presence of ".template" variable and adding tests for check_guide

Author: douwe

R/guide.R

@@ -59,7 +59,7 @@ validate_unique_names <- function(names_vector, name_type) {
 #' @noRd
 #'
 check_guide <- function(guide) {
-  ## NOTE: Most of the validation of a guide should be performed using the JSON schema
+  ## NOTE: Most of the validation of a guide should be performed using the schema validator before the guide is used
 
   # Ensure translations are optional
   if (!"translations" %in% names(guide)) {
@@ -71,6 +71,17 @@ check_guide <- function(guide) {
     validate_plate_format(guide)
   }
 
+  # validate presence of .template variable in locations
+  if (
+    !any(sapply(guide$locations, function(loc) {
+      isTRUE(loc$varname == ".template")
+    }))
+  ) {
+    rlang::abort(
+      "The spreadsheet guide must contain the '.template' element with at least a version key."
+    )
+  }
+
   # Validate each location in the guide
   lapply(guide$locations, validate_location, guide)
 }

tests/testthat/fixtures/erroneousguides/duplicate_long_translations.yml

@@ -0,0 +1,16 @@
+guide.version: '1.0'
+template.name: test
+template.min.version: '1.0'
+template.max.version: ~
+locations:
+  - sheet: description
+    type: keyvalue
+    varname: .template
+    translate: false
+    ranges:
+      - A1:B1
+translations:
+  - long: Version
+    short: template.version
+  - long: Version
+    short: version.duplicate

tests/testthat/fixtures/erroneousguides/duplicate_short_translations.yml

@@ -0,0 +1,16 @@
+guide.version: '1.0'
+template.name: test
+template.min.version: '1.0'
+template.max.version: ~
+locations:
+  - sheet: description
+    type: keyvalue
+    varname: .template
+    translate: false
+    ranges:
+      - A1:B1
+translations:
+  - long: Version
+    short: template.version
+  - long: Version2
+    short: template.version

tests/testthat/fixtures/erroneousguides/invalid_plate_format.yml

@@ -0,0 +1,18 @@
+guide.version: '1.0'
+template.name: test
+template.min.version: '1.0'
+template.max.version: ~
+plate.format: 192
+locations:
+  - sheet: description
+    type: keyvalue
+    varname: .template
+    translate: false
+    ranges:
+      - A1:B1
+  - sheet: _data
+    type: platedata
+    translate: false
+    varname: plate
+    ranges:
+      - A1:M9

tests/testthat/fixtures/erroneousguides/missing_template_location.yml

@@ -0,0 +1,11 @@
+guide.version: '1.0'
+template.name: test
+template.min.version: '1.0'
+template.max.version: ~
+locations:
+  - sheet: description
+    type: keyvalue
+    varname: metadata
+    translate: false
+    ranges:
+      - A1:B5

tests/testthat/fixtures/erroneousguides/reserved_filepath_translation.yml

@@ -0,0 +1,14 @@
+guide.version: '1.0'
+template.name: test
+template.min.version: '1.0'
+template.max.version: ~
+locations:
+  - sheet: description
+    type: keyvalue
+    varname: .template
+    translate: false
+    ranges:
+      - A1:B1
+translations:
+  - long: File path
+    short: filepath

tests/testthat/fixtures/goodguides/guide_without_platedata.yml

@@ -0,0 +1,17 @@
+guide.version: '1.0'
+template.name: test
+template.min.version: '1.0'
+template.max.version: ~
+locations:
+  - sheet: description
+    type: keyvalue
+    varname: .template
+    translate: false
+    ranges:
+      - A1:B1
+  - sheet: description
+    type: keyvalue
+    varname: metadata
+    translate: false
+    ranges:
+      - A2:B5

tests/testthat/test-guide.R

@@ -1,7 +1,13 @@
-test_that("Reading a spreadsheet map works", {
+test_that("Reading a valid guide with platedata works", {
   expect_no_error(read_guide(test_path("fixtures/guide_competition_1_0.yml")))
 })
 
+test_that("Reading a valid guide without platedata works", {
+  expect_no_error(read_guide(test_path(
+    "fixtures/goodguides/guide_without_platedata.yml"
+  )))
+})
+
 test_that("Function check_dim works", {
   expect_no_error(check_dim("A1:B1", NA, 2))
   expect_no_error(check_dim("A1:C10", 10, 3))
@@ -11,9 +17,61 @@ test_that("Function check_dim works", {
   expect_error(check_dim("A1:C3", NA, NA))
 })
 
-#test_that("check_guide works for correct guides", {
-  # expect_no_error(read_guide(test_path("fixtures/goodguides/guide_competition_9_3.yml")))
-  # expect_no_error(read_guide(test_path("fixtures/goodguides/guide_without_platedata.yml")))
-  # expect_no_error(read_guide(test_path("fixtures/goodguides/guide_with_two_plates.yml")))
-  # expect_no_error(read_guide(test_path("fixtures/goodguides/guide_without_templatemetadata.yml")))
-#})
+test_that("check_guide: missing plate.format when platedata is present yields an error", {
+  expect_error(
+    read_guide(test_path("fixtures/erroneousguides/missing_plate_format.yml")),
+    regexp = "plate.format"
+  )
+})
+
+test_that("check_guide: invalid plate.format value yields an error", {
+  expect_error(
+    read_guide(test_path("fixtures/erroneousguides/invalid_plate_format.yml")),
+    regexp = "plate format"
+  )
+})
+
+test_that("check_guide: wrong platedata range dimensions yield an error", {
+  expect_error(
+    read_guide(test_path(
+      "fixtures/erroneousguides/invalid_platedata_range.yml"
+    )),
+    regexp = "required dimensions"
+  )
+})
+
+test_that("check_guide: guide without a .template location yields an error", {
+  expect_error(
+    read_guide(test_path(
+      "fixtures/erroneousguides/missing_template_location.yml"
+    )),
+    regexp = "\\.template"
+  )
+})
+
+test_that("read_guide: duplicate long names in translations yield an error", {
+  expect_error(
+    read_guide(test_path(
+      "fixtures/erroneousguides/duplicate_long_translations.yml"
+    )),
+    regexp = "Duplicate keys in long"
+  )
+})
+
+test_that("read_guide: duplicate short names in translations yield an error", {
+  expect_error(
+    read_guide(test_path(
+      "fixtures/erroneousguides/duplicate_short_translations.yml"
+    )),
+    regexp = "Duplicate keys in short"
+  )
+})
+
+test_that("read_guide: reserved 'File path' long name mapped to non-.sourcefile short name yields an error", {
+  expect_error(
+    read_guide(test_path(
+      "fixtures/erroneousguides/reserved_filepath_translation.yml"
+    )),
+    regexp = "File path"
+  )
+})