Make sketch filename matching rule case-sensitive

per1234 · per1234 · commit 9a2f7fe8d72e · 2021-02-17T03:37:06.000-08:00
The primary sketch file name must match the sketch folder exactly. Previously, the rule did not check for file name case
matching on case-insensitive file systems.
diff --git a/internal/rule/rulefunction/sketch.go b/internal/rule/rulefunction/sketch.go
@@ -28,15 +28,20 @@ import (
 
 // SketchNameMismatch checks for mismatch between sketch folder name and primary file name.
 func SketchNameMismatch() (result ruleresult.Type, output string) {
-	for extension := range globals.MainFileValidExtensions {
-		validPrimarySketchFilePath := projectdata.ProjectPath().Join(projectdata.ProjectPath().Base() + extension)
-		exist, err := validPrimarySketchFilePath.ExistCheck()
-		if err != nil {
-			panic(err)
-		}
+	primarySketchFilePrefix := projectdata.ProjectPath().Base()
 
-		if exist {
-			return ruleresult.Pass, ""
+	directoryListing, err := projectdata.ProjectPath().ReadDir()
+	if err != nil {
+		panic(err)
+	}
+	directoryListing.FilterOutDirs()
+
+	for _, filePath := range directoryListing {
+		for extension := range globals.MainFileValidExtensions {
+			if filePath.Base() == primarySketchFilePrefix+extension {
+				// There was a case-sensitive match (paths package's Exist() is not always case-sensitive, so can't be used here).
+				return ruleresult.Pass, ""
+			}
 		}
 	}
 
diff --git a/internal/rule/rulefunction/sketch_test.go b/internal/rule/rulefunction/sketch_test.go
@@ -64,7 +64,8 @@ func checkSketchRuleFunction(ruleFunction Type, testTables []sketchRuleFunctionT
 func TestSketchNameMismatch(t *testing.T) {
 	testTables := []sketchRuleFunctionTestTable{
 		{"Valid", "Valid", ruleresult.Pass, ""},
-		{"Mismatch", "NameMismatch", ruleresult.Fail, ""},
+		{"Name Mismatch", "NameMismatch", ruleresult.Fail, ""},
+		{"Case Mismatch", "CaseMismatch", ruleresult.Fail, ""},
 	}
 
 	checkSketchRuleFunction(SketchNameMismatch, testTables, t)
diff --git a/internal/rule/rulefunction/testdata/sketches/CaseMismatch/caseMismatch.ino b/internal/rule/rulefunction/testdata/sketches/CaseMismatch/caseMismatch.ino
@@ -0,0 +1,2 @@
+void setup() {}
+void loop() {}

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,8 @@ func checkSketchRuleFunction(ruleFunction Type, testTables []sketchRuleFunctionT`
`64`	`64`	`func TestSketchNameMismatch(t *testing.T) {`
`65`	`65`	`testTables := []sketchRuleFunctionTestTable{`
`66`	`66`	`{"Valid", "Valid", ruleresult.Pass, ""},`
`67`		`- {"Mismatch", "NameMismatch", ruleresult.Fail, ""},`
	`67`	`+ {"Name Mismatch", "NameMismatch", ruleresult.Fail, ""},`
	`68`	`+ {"Case Mismatch", "CaseMismatch", ruleresult.Fail, ""},`
`68`	`69`	`}`
`69`	`70`
`70`	`71`	`checkSketchRuleFunction(SketchNameMismatch, testTables, t)`