fix: handle special case in 'checking tests' R CMD check step (#103)

Author: walkowif

.github/workflows/lint.yml

@@ -47,7 +47,7 @@ jobs:
     strategy:
       matrix:
         go-version:
-          - 1.22.0
+          - 1.23.2
     steps:
       - name: Checkout Repo 🛎
         uses: actions/checkout@v4

.github/workflows/release.yml

@@ -34,7 +34,7 @@ jobs:
       - name: Setup Go 🐹
         uses: actions/setup-go@v5
         with:
-          go-version: 1.22.0
+          go-version: 1.23.2
           cache: true
           cache-dependency-path: go.sum
 
@@ -91,7 +91,7 @@ jobs:
     needs: args
     uses: slsa-framework/slsa-github-generator/.github/workflows/builder_go_slsa3.yml@v1.5.0
     with:
-      go-version: "1.22"
+      go-version: "1.23"
       # Optional: only needed if using ldflags.
       evaluated-envs: "COMMIT_DATE:${{needs.args.outputs.commit-date}}, COMMIT:${{needs.args.outputs.commit}}, VERSION:${{needs.args.outputs.version}}, TREE_STATE:${{needs.args.outputs.tree-state}}"
       private-repository: true

.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
     strategy:
       matrix:
         go-version:
-          - 1.22.0
+          - 1.23.2
     defaults:
       run:
         shell: bash
@@ -92,7 +92,7 @@ jobs:
     strategy:
       matrix:
         go-version:
-          - 1.22.0
+          - 1.23.2
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo 🛎

.golangci.yml

@@ -22,11 +22,11 @@ linters-settings:
     # default is false: such cases aren't reported by default.
     check-blank: true
   govet:
-    # report about shadowed variables
-    check-shadowing: true
+    enable:
+      - shadow
   gocyclo:
     # minimal code complexity to report, 30 by default
-    min-complexity: 15
+    min-complexity: 16
   maligned:
     # print struct with more effective memory layout or not, false by default
     suggest-new: true

cmd/check.go

@@ -144,7 +144,15 @@ func parseCheckOutput(stringToParse string, singlePackageCheckInfo *[]ItemCheckI
 				case strings.HasSuffix(trimmedNewLine, "ERROR"):
 					checkItemType = errConst
 					continuationOnNextLine = false
-				case strings.HasSuffix(trimmedNewLine, "OK"):
+				case strings.HasSuffix(trimmedNewLine, "OK") && !strings.HasPrefix(trimmedNewLine, "Comparing"):
+					// The 'Comparing' prefix may occur in situation like the one shown below.
+					// In that case, we ignore the 'OK' at this line, and expect to see another check status
+					// in one of subsequent lines.
+					// * checking tests ...
+					//  Running ‘spelling.R’
+					//  Comparing ‘spelling.Rout’ to ‘spelling.Rout.save’ ... OK
+					//  Running ‘testthat.R’
+					//  ERROR
 					checkItemType = ""
 					continuationOnNextLine = false
 				}

cmd/check_test.go

@@ -67,6 +67,9 @@ func Test_parseCheckOutput(t *testing.T) {
 	assert.Equal(t, allCheckInfo[7].CheckItemType, "ERROR")
 	assert.Equal(t, allCheckInfo[7].CheckItemContent,
 		"* checking tests ...   Running ‘testthat.R’  ERROR Running the tests in ‘tests/testthat.R’ failed. ")
+	assert.Equal(t, allCheckInfo[8].CheckItemType, "ERROR")
+	assert.Equal(t, allCheckInfo[8].CheckItemContent,
+		"* checking tests ...   Running ‘spelling.R’   Comparing ‘spelling.Rout’ to ‘spelling.Rout.save’ ... OK   Running ‘testthat.R’  ERROR Running the tests in ‘tests/testthat.R’ failed. ")
 }
 
 func Test_getCheckedPackages(t *testing.T) {

cmd/install.go

@@ -308,8 +308,8 @@ func getPackagesReadyToInstall(
 }
 
 // mapTrueLength returns the number of elements in the map for which the value is true.
-func mapTrueLength(m map[string]bool) uint {
-	var trueLength uint
+func mapTrueLength(m map[string]bool) int {
+	var trueLength int
 	for _, v := range m {
 		if v {
 			trueLength++

cmd/install_test.go

@@ -103,7 +103,7 @@ func Test_mapTrueLength(t *testing.T) {
 	m["test3"] = true
 	m["test4"] = false
 	m["test5"] = true
-	assert.Equal(t, mapTrueLength(m), uint(3))
+	assert.Equal(t, mapTrueLength(m), 3)
 }
 
 func Test_getPackageToInstall(t *testing.T) {

cmd/root.go

@@ -38,7 +38,7 @@ var checkAllPackages bool
 var maxDownloadRoutines int
 var maxCheckRoutines int
 var outputReportDirectory string
-var numberOfWorkers uint
+var numberOfWorkers int
 var clearCache bool
 var includeSuggests bool
 var failOnError bool
@@ -141,7 +141,7 @@ for a collection of R packages that are defined in an
 			fmt.Println(`failOnError = ` + strconv.FormatBool(failOnError))
 			fmt.Println(`maxDownloadRoutines = ` + strconv.Itoa(maxDownloadRoutines))
 			fmt.Println(`maxCheckRoutines = ` + strconv.Itoa(maxCheckRoutines))
-			fmt.Println(`numberOfWorkers = ` + strconv.Itoa(int(numberOfWorkers)))
+			fmt.Println(`numberOfWorkers = ` + strconv.Itoa(numberOfWorkers))
 
 			if maxDownloadRoutines < 1 {
 				log.Warn("Maximum number of download routines set to less than 1. Setting the number to default value of 40.")
@@ -151,7 +151,7 @@ for a collection of R packages that are defined in an
 				log.Warn("Maximum number of R CMD check routines set to less than 1. Setting the number to default value of 5.")
 				maxCheckRoutines = 5
 			}
-			if int(numberOfWorkers) < 1 {
+			if numberOfWorkers < 1 {
 				log.Warn("Number of simultaneous installation processes should be greater than 0. Setting the default number of workers to 20.")
 				numberOfWorkers = 20
 			}
@@ -268,7 +268,7 @@ for a collection of R packages that are defined in an
 		"Maximum number of concurrently running download goroutines.")
 	rootCmd.PersistentFlags().IntVar(&maxCheckRoutines, "maxCheckRoutines", 5,
 		"Maximum number of concurrently running R CMD check goroutines.")
-	rootCmd.PersistentFlags().UintVar(&numberOfWorkers, "numberOfWorkers", 20,
+	rootCmd.PersistentFlags().IntVar(&numberOfWorkers, "numberOfWorkers", 20,
 		"Number of simultaneous installation processes.")
 	rootCmd.PersistentFlags().BoolVar(&clearCache, "clearCache", false,
 		"Use this flag if you want to clear scribe internal cache directory structure. This will cause "+

cmd/testdata/r_cmd_check.txt

@@ -56,6 +56,17 @@ Some error 6
  ERROR
 Running the tests in ‘tests/testthat.R’ failed.
 * checking PDF version of manual ... OK
+* checking tests ...
+  Running ‘spelling.R’
+  Comparing ‘spelling.Rout’ to ‘spelling.Rout.save’ ... OK
+  Running ‘testthat.R’
+ OK
+* checking tests ...
+  Running ‘spelling.R’
+  Comparing ‘spelling.Rout’ to ‘spelling.Rout.save’ ... OK
+  Running ‘testthat.R’
+ ERROR
+Running the tests in ‘tests/testthat.R’ failed.
 * checking PDF version of
 manual
 ... OK