Add checks for incorrect Arduino.h filename case in #include directives

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -1121,6 +1121,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Default},
 		CheckFunction:   checkfunctions.RecursiveLibraryWithUtilityFolder,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "code",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "incorrect Arduino.h case",
+		Description:     "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
+		MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.Default},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Default},
+		ErrorModes:      []checkmode.Type{checkmode.Strict},
+		CheckFunction:   checkfunctions.IncorrectArduinoDotHFileNameCase,
+	},
 	{
 		ProjectType:     projecttype.Sketch,
 		Category:        "structure",
@@ -1196,6 +1211,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Strict},
 		CheckFunction:   checkfunctions.MissingLicenseFile,
 	},
+	{
+		ProjectType:     projecttype.Sketch,
+		Category:        "code",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "incorrect Arduino.h case",
+		Description:     "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
+		MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.Default},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Default},
+		ErrorModes:      []checkmode.Type{checkmode.Strict},
+		CheckFunction:   checkfunctions.IncorrectArduinoDotHFileNameCase,
+	},
 	{
 		ProjectType:     projecttype.Platform,
 		Category:        "configuration files",
@@ -1256,6 +1286,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Strict},
 		CheckFunction:   checkfunctions.MissingLicenseFile,
 	},
+	{
+		ProjectType:     projecttype.Platform,
+		Category:        "code",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "incorrect Arduino.h case",
+		Description:     "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
+		MessageTemplate: "Incorrect of Arduino.h filename case detected in #include directive: {{.}}",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.Default},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Default},
+		ErrorModes:      []checkmode.Type{checkmode.Strict},
+		CheckFunction:   checkfunctions.IncorrectArduinoDotHFileNameCase,
+	},
 	{
 		ProjectType:     projecttype.PackageIndex,
 		Category:        "data",

check/checkfunctions/checkfunctions.go

@@ -18,11 +18,13 @@ package checkfunctions
 
 import (
 	"encoding/json"
+	"fmt"
 	"regexp"
 	"strings"
 
 	"github.com/arduino/arduino-check/check/checkdata"
 	"github.com/arduino/arduino-check/check/checkresult"
+	"github.com/arduino/arduino-check/project/sketch"
 	"github.com/arduino/go-paths-helper"
 )
 
@@ -106,6 +108,36 @@ func MissingLicenseFile() (result checkresult.Type, output string) {
 	return checkresult.Fail, ""
 }
 
+// IncorrectArduinoDotHFileNameCase checks for incorrect file name case of Arduino.h in #include directives.
+func IncorrectArduinoDotHFileNameCase() (result checkresult.Type, output string) {
+	incorrectCaseRegexp := regexp.MustCompile(`^\s*#\s*include\s*["<](a((?i)rduino)|(ARDUINO))\.[hH][">]`)
+
+	directoryListing, err := checkdata.ProjectPath().ReadDirRecursive()
+	if err != nil {
+		panic(err)
+	}
+	directoryListing.FilterOutDirs()
+
+	for _, file := range directoryListing {
+		if !sketch.HasSupportedExtension(file) { // Won't catch all possible files, but good enough.
+			continue
+		}
+
+		lines, err := file.ReadFileAsLines()
+		if err != nil {
+			panic(err)
+		}
+
+		for lineNumber, line := range lines {
+			if incorrectCaseRegexp.MatchString(line) {
+				return checkresult.Fail, fmt.Sprintf("%s:%v: %s", file, lineNumber+1, line)
+			}
+		}
+	}
+
+	return checkresult.Pass, ""
+}
+
 // pathContainsRegexpMatch checks if the provided path contains a file name matching the given regular expression.
 func pathContainsRegexpMatch(path *paths.Path, pathRegexp *regexp.Regexp) bool {
 	listing, err := path.ReadDir()

check/checkfunctions/checkfunctions_test.go

@@ -82,3 +82,13 @@ func TestMissingLicenseFile(t *testing.T) {
 
 	checkCheckFunction(MissingLicenseFile, testTables, t)
 }
+
+func TestIncorrectArduinoDotHFileNameCase(t *testing.T) {
+	testTables := []checkFunctionTestTable{
+		{"Incorrect, angle brackets", "arduino.h-angle", projecttype.Sketch, projecttype.Sketch, checkresult.Fail, ""},
+		{"Incorrect, quotes", "arduino.h-quote", projecttype.Sketch, projecttype.Sketch, checkresult.Fail, ""},
+		{"Correct case", "Arduino.h", projecttype.Sketch, projecttype.Sketch, checkresult.Pass, ""},
+	}
+
+	checkCheckFunction(IncorrectArduinoDotHFileNameCase, testTables, t)
+}

check/checkfunctions/testdata/general/Arduino.h/foo.h

@@ -0,0 +1 @@
+#include <Arduino.h>

check/checkfunctions/testdata/general/arduino.h-angle/foo.h

@@ -0,0 +1 @@
+#include <arduino.h>

check/checkfunctions/testdata/general/arduino.h-quote/foo.h

@@ -0,0 +1 @@
+#include <arduino.h>