Merge pull request #1579 from orichters/develop

use newest gms in github action; fail on codeCheck warning; test that no line starts with ****

.github/workflows/test-code.yaml

@@ -25,17 +25,22 @@ jobs:
 
       - uses: r-lib/actions/setup-r@v2
         with:
+          use-public-rspm: true
           extra-repositories: https://rse.pik-potsdam.de/r/packages/
 
       - name: Install R dependencies
         uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          packages: gms
-
+          extra-packages: |
+            any::gms
+          # piam packages also available on CRAN (madrat, magclass, citation,
+          # gms, goxygen, GDPuc) will usually have an outdated binary version
+          # available; by using extra-packages we get the newest version
+
       - name: codeCheck
         run: null <- gms::codeCheck(strict=TRUE)
         shell: Rscript {0}
-        
+
       - name: fileSizeCheck
         run: source(".github/workflows/size-check")
         shell: Rscript {0}

tests/testthat/test_99-codeCheck.R

@@ -8,7 +8,24 @@ test_that("GAMS code follows the coding etiquette", {
   # have to run this via localSystem2 so that it uses the renv, where gms
   # is actually installed.
   skipIfPreviousFailed()
-  output <- localSystem2("Rscript", c("-e", "'invisible(gms::codeCheck(strict=TRUE))'"))
+  codecheckcode <- "'invisible(gms::codeCheck(strict=TRUE)); if (! is.null(warnings())) stop(warnings())'"
+  output <- localSystem2("Rscript", c("-e", codecheckcode))
   printIfFailed(output)
   expectSuccessStatus(output)
 })
+
+test_that("No four asterisks in code", {
+  notavailable <- Sys.which("grep") == ""
+  if (notavailable) {
+    skip("'grep' not available, please check yourself whether code starts with four asterisks.")
+  } else {
+    files <- paste0("../../", c("*.gms", "core/*.gms", "modules/*.gms", "modules/*/*.gms", "modules/*/*/*.gms"))
+    grepcode <- paste("grep", "'^\\*\\*\\*\\*'", paste(files, collapse = " "))
+    starlines <- suppressWarnings(system(grepcode, intern = TRUE))
+    if (length(starlines) > 0) {
+      warning("The following lines start with four asterisks, reserved for GAMS error messages.\n",
+              paste(starlines, collapse = "\n"))
+    }
+    expect_true(length(starlines) == 0)
+  }
+})