Merge pull request #64 from arduino/per1234/incorrect-extras-folder-name

Add checks on path base name case

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -101,6 +101,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Default},
 		CheckFunction:   checkfunctions.MisspelledLibraryPropertiesFileName,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "general",
+		ID:              "",
+		Brief:           "incorrect library.properties file name case",
+		Description:     `This causes "1.5" format (AKA "recursive layout") libraries to not be recognized on filename case-sensitive operating systems.`,
+		MessageTemplate: "Incorrect library.properties file name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    nil,
+		ErrorModes:      []checkmode.Type{checkmode.All},
+		CheckFunction:   checkfunctions.IncorrectLibraryPropertiesFileNameCase,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",
@@ -956,6 +971,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Default},
 		CheckFunction:   checkfunctions.MisspelledExamplesFolderName,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "structure",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "incorrect examples folder name case",
+		Description:     "",
+		MessageTemplate: "Incorrect examples folder name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Permissive},
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.IncorrectExamplesFolderNameCase,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "structure",
@@ -971,6 +1001,21 @@ var configurations = []Type{
 		ErrorModes:      nil,
 		CheckFunction:   checkfunctions.MisspelledExtrasFolderName,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "structure",
+		Subcategory:     "",
+		ID:              "",
+		Brief:           "incorrect extras folder name case",
+		Description:     "",
+		MessageTemplate: "Incorrect extras folder name case: {{.}}. See: https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Permissive},
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.IncorrectExtrasFolderNameCase,
+	},
 	{
 		ProjectType:     projecttype.Sketch,
 		Category:        "structure",

check/checkfunctions/checkfunctions.go

@@ -18,6 +18,7 @@ package checkfunctions
 
 import (
 	"regexp"
+	"strings"
 
 	"github.com/arduino/arduino-check/check/checkresult"
 	"github.com/arduino/go-paths-helper"
@@ -47,3 +48,19 @@ func containsMisspelledPathBaseName(pathList paths.PathList, correctBaseName str
 
 	return nil, false
 }
+
+func containsIncorrectPathBaseCase(pathList paths.PathList, correctBaseName string) (*paths.Path, bool) {
+	for _, path := range pathList {
+		if path.Base() == correctBaseName {
+			// There was a case-sensitive match (paths package's Exist() is not always case-sensitive, so can't be used here).
+			return nil, false
+		}
+
+		if strings.EqualFold(path.Base(), correctBaseName) {
+			// There was a case-insensitive match.
+			return path, true
+		}
+	}
+
+	return nil, false
+}

check/checkfunctions/library.go

@@ -68,6 +68,22 @@ func MisspelledLibraryPropertiesFileName() (result checkresult.Type, output stri
 	return checkresult.Pass, ""
 }
 
+// IncorrectLibraryPropertiesFileNameCase checks for incorrect library.properties file name case.
+func IncorrectLibraryPropertiesFileNameCase() (result checkresult.Type, output string) {
+	directoryListing, err := checkdata.ProjectPath().ReadDir()
+	if err != nil {
+		panic(err)
+	}
+	directoryListing.FilterOutDirs()
+
+	path, found := containsIncorrectPathBaseCase(directoryListing, "library.properties")
+	if found {
+		return checkresult.Fail, path.String()
+	}
+
+	return checkresult.Pass, ""
+}
+
 // LibraryPropertiesNameFieldMissing checks for missing library.properties "name" field.
 func LibraryPropertiesNameFieldMissing() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {
@@ -1006,6 +1022,22 @@ func MisspelledExamplesFolderName() (result checkresult.Type, output string) {
 	return checkresult.Pass, ""
 }
 
+// IncorrectExamplesFolderNameCase checks for incorrect `examples` folder name case.
+func IncorrectExamplesFolderNameCase() (result checkresult.Type, output string) {
+	directoryListing, err := checkdata.ProjectPath().ReadDir()
+	if err != nil {
+		panic(err)
+	}
+	directoryListing.FilterDirs()
+
+	path, found := containsIncorrectPathBaseCase(directoryListing, "examples")
+	if found {
+		return checkresult.Fail, path.String()
+	}
+
+	return checkresult.Pass, ""
+}
+
 // MisspelledExtrasFolderName checks for incorrectly spelled `extras` folder name.
 func MisspelledExtrasFolderName() (result checkresult.Type, output string) {
 	directoryListing, err := checkdata.ProjectPath().ReadDir()
@@ -1041,6 +1073,22 @@ func spellCheckLibraryPropertiesFieldValue(fieldName string) (result checkresult
 	return checkresult.Pass, ""
 }
 
+// IncorrectExtrasFolderNameCase checks for incorrect `extras` folder name case.
+func IncorrectExtrasFolderNameCase() (result checkresult.Type, output string) {
+	directoryListing, err := checkdata.ProjectPath().ReadDir()
+	if err != nil {
+		panic(err)
+	}
+	directoryListing.FilterDirs()
+
+	path, found := containsIncorrectPathBaseCase(directoryListing, "extras")
+	if found {
+		return checkresult.Fail, path.String()
+	}
+
+	return checkresult.Pass, ""
+}
+
 // nameInLibraryManagerIndex returns whether there is a library in Library Manager index using the given name.
 func nameInLibraryManagerIndex(name string) bool {
 	libraries := checkdata.LibraryManagerIndex()["libraries"].([]interface{})

check/checkfunctions/library_test.go

@@ -73,6 +73,15 @@ func TestMisspelledLibraryPropertiesFileName(t *testing.T) {
 	checkLibraryCheckFunction(MisspelledLibraryPropertiesFileName, testTables, t)
 }
 
+func TestIncorrectLibraryPropertiesFileNameCase(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Incorrect", "IncorrectLibraryPropertiesCase", checkresult.Fail, ""},
+		{"Correct", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(IncorrectLibraryPropertiesFileNameCase, testTables, t)
+}
+
 func TestLibraryPropertiesMissing(t *testing.T) {
 	testTables := []libraryCheckFunctionTestTable{
 		{"Legacy", "Legacy", checkresult.Fail, ""},
@@ -302,6 +311,16 @@ func TestMisspelledExamplesFolderName(t *testing.T) {
 	checkLibraryCheckFunction(MisspelledExamplesFolderName, testTables, t)
 }
 
+func TestIncorrectExamplesFolderNameCase(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Correct case", "ExamplesFolder", checkresult.Pass, ""},
+		{"Incorrect case", "IncorrectExamplesFolderCase", checkresult.Fail, ""},
+		{"No examples folder", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(IncorrectExamplesFolderNameCase, testTables, t)
+}
+
 func TestMisspelledExtrasFolderName(t *testing.T) {
 	testTables := []libraryCheckFunctionTestTable{
 		{"Correctly spelled", "ExtrasFolder", checkresult.Pass, ""},
@@ -311,3 +330,13 @@ func TestMisspelledExtrasFolderName(t *testing.T) {
 
 	checkLibraryCheckFunction(MisspelledExtrasFolderName, testTables, t)
 }
+
+func TestIncorrectExtrasFolderNameCase(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Correct case", "ExtrasFolder", checkresult.Pass, ""},
+		{"Incorrect case", "IncorrectExtrasFolderCase", checkresult.Fail, ""},
+		{"No extras folder", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(IncorrectExtrasFolderNameCase, testTables, t)
+}

check/checkfunctions/testdata/libraries/IncorrectExamplesFolderCase/Examples/.gitkeep

@@ -0,0 +1,9 @@
+name=IncorrectExamplesFolderCase
+version=1.0.0
+author=Cristian Maglie <[email protected]>, Pippo Pluto <[email protected]>
+maintainer=Cristian Maglie <[email protected]>
+sentence=A library that makes coding a web server a breeze.
+paragraph=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://example.com/
+architectures=avr

check/checkfunctions/testdata/libraries/IncorrectExamplesFolderCase/library.properties

@@ -0,0 +1,9 @@
+name=IncorrectExtrasFolderCase
+version=1.0.0
+author=Cristian Maglie <[email protected]>, Pippo Pluto <[email protected]>
+maintainer=Cristian Maglie <[email protected]>
+sentence=A library that makes coding a web server a breeze.
+paragraph=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://example.com/
+architectures=avr

check/checkfunctions/testdata/libraries/IncorrectExamplesFolderCase/src/IncorrectExamplesFolderCase.h

@@ -0,0 +1,9 @@
+name=IncorrectLibraryPropertiesCase
+version=1.0.0
+author=Cristian Maglie <[email protected]>, Pippo Pluto <[email protected]>
+maintainer=Cristian Maglie <[email protected]>
+sentence=A library that makes coding a web server a breeze.
+paragraph=Supports HTTP1.1 and you can do GET and POST.
+category=Communication
+url=http://example.com/
+architectures=avr