Remove "Pass" check level

There is no valid reason for a check to be defined, only for the results to be ignored. This was used as a default behavior when no level was configured for the check, but that indicates a configuration error and should not be ignored. So I now error exit when this situation occurs.

Author: per1234

check/check.go

@@ -3,6 +3,7 @@ package check
 import (
 	"bytes"
 	"fmt"
+	"os"
 	"text/template"
 
 	"github.com/arduino/arduino-check/check/checkconfigurations"
@@ -12,6 +13,8 @@ import (
 	"github.com/arduino/arduino-check/configuration"
 	"github.com/arduino/arduino-check/configuration/checkmode"
 	"github.com/arduino/arduino-check/project"
+	"github.com/arduino/arduino-cli/cli/errorcodes"
+	"github.com/arduino/arduino-cli/cli/feedback"
 )
 
 func shouldRun(checkConfiguration checkconfigurations.Type, currentProject project.Type) bool {
@@ -79,7 +82,12 @@ func RunChecks(project project.Type) {
 			// TODO: make the check functions output an explanation for why they didn't run
 			fmt.Printf("%s: %s\n", checklevel.Notice, output)
 		} else if result != checkresult.Pass {
-			fmt.Printf("%s: %s\n", checklevel.CheckLevel(checkConfiguration).String(), message(checkConfiguration.MessageTemplate, output))
+			checkLevel, err := checklevel.CheckLevel(checkConfiguration)
+			if err != nil {
+				feedback.Errorf("Error while determining check level: %v", err)
+				os.Exit(errorcodes.ErrGeneric)
+			}
+			fmt.Printf("%s: %s\n", checkLevel.String(), message(checkConfiguration.MessageTemplate, output))
 		}
 	}
 }

check/checkconfigurations/checkconfigurations.go

@@ -24,7 +24,6 @@ type Type struct {
 	// Check is only enabled when tool is in one of these modes
 	EnableModes []checkmode.Type
 	// The following fields define the check level in each configuration mode
-	PassModes    []checkmode.Type
 	InfoModes    []checkmode.Type
 	WarningModes []checkmode.Type
 	ErrorModes   []checkmode.Type
@@ -44,7 +43,6 @@ var Configurations = []Type{
 		MessageTemplate: "library.properties has an invalid format: {{.}}",
 		DisableModes:    nil,
 		EnableModes:     []checkmode.Type{checkmode.All},
-		PassModes:       nil,
 		InfoModes:       nil,
 		WarningModes:    nil,
 		ErrorModes:      []checkmode.Type{checkmode.All},
@@ -60,7 +58,6 @@ var Configurations = []Type{
 		MessageTemplate: "missing name field in library.properties",
 		DisableModes:    nil,
 		EnableModes:     []checkmode.Type{checkmode.All},
-		PassModes:       nil,
 		InfoModes:       nil,
 		WarningModes:    nil,
 		ErrorModes:      []checkmode.Type{checkmode.All},
@@ -76,7 +73,6 @@ var Configurations = []Type{
 		MessageTemplate: "disallowed characters in library.properties name field. See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
 		DisableModes:    nil,
 		EnableModes:     []checkmode.Type{checkmode.All},
-		PassModes:       nil,
 		InfoModes:       nil,
 		WarningModes:    nil,
 		ErrorModes:      []checkmode.Type{checkmode.All},
@@ -92,7 +88,6 @@ var Configurations = []Type{
 		MessageTemplate: "missing version field in library.properties",
 		DisableModes:    nil,
 		EnableModes:     []checkmode.Type{checkmode.All},
-		PassModes:       nil,
 		InfoModes:       nil,
 		WarningModes:    nil,
 		ErrorModes:      []checkmode.Type{checkmode.All},
@@ -108,7 +103,6 @@ var Configurations = []Type{
 		MessageTemplate: "{{.}} uses deprecated .pde file extension. Use .ino for Arduino sketches",
 		DisableModes:    nil,
 		EnableModes:     []checkmode.Type{checkmode.All},
-		PassModes:       nil,
 		InfoModes:       nil,
 		WarningModes:    []checkmode.Type{checkmode.Permissive},
 		ErrorModes:      []checkmode.Type{checkmode.Default},

check/checklevel/checklevel.go

@@ -1,6 +1,8 @@
 package checklevel
 
 import (
+	"fmt"
+
 	"github.com/arduino/arduino-check/check/checkconfigurations"
 	"github.com/arduino/arduino-check/configuration"
 	"github.com/arduino/arduino-check/configuration/checkmode"
@@ -11,64 +13,50 @@ type Type int
 
 // Line comments set the string for each level
 const (
-	Pass    Type = iota // pass
-	Info                // info
+	Info    Type = iota // info
 	Warning             // warning
 	Error               // error
 	Notice              // notice
 )
 
-func CheckLevel(checkConfiguration checkconfigurations.Type) Type {
+func CheckLevel(checkConfiguration checkconfigurations.Type) (Type, error) {
 	configurationCheckModes := configuration.CheckModes(checkConfiguration.ProjectType)
 	for _, errorMode := range checkConfiguration.ErrorModes {
 		if configurationCheckModes[errorMode] == true {
-			return Error
+			return Error, nil
 		}
 	}
 
 	for _, warningMode := range checkConfiguration.WarningModes {
 		if configurationCheckModes[warningMode] == true {
-			return Warning
+			return Warning, nil
 		}
 	}
 
 	for _, infoMode := range checkConfiguration.InfoModes {
 		if configurationCheckModes[infoMode] == true {
-			return Info
-		}
-	}
-
-	for _, passMode := range checkConfiguration.PassModes {
-		if configurationCheckModes[passMode] == true {
-			return Pass
+			return Info, nil
 		}
 	}
 
 	// Use default level
 	for _, errorMode := range checkConfiguration.ErrorModes {
 		if errorMode == checkmode.Default {
-			return Error
+			return Error, nil
 		}
 	}
 
 	for _, warningMode := range checkConfiguration.WarningModes {
 		if warningMode == checkmode.Default {
-			return Warning
+			return Warning, nil
 		}
 	}
 
 	for _, infoMode := range checkConfiguration.InfoModes {
 		if infoMode == checkmode.Default {
-			return Info
-		}
-	}
-
-	for _, passMode := range checkConfiguration.PassModes {
-		if passMode == checkmode.Default {
-			return Pass
+			return Info, nil
 		}
 	}
 
-	// TODO: this should return an error
-	return Pass
+	return Notice, fmt.Errorf("Check %s is incorrectly configured", checkConfiguration.ID)
 }