Add check for incorrect library.properties architecture case

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -731,6 +731,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Strict},
 		CheckFunction:   checkfunctions.LibraryPropertiesArchitecturesFieldSoloAlias,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "architectures field",
+		ID:              "",
+		Brief:           "miscased architecture",
+		Description:     "",
+		MessageTemplate: "Incorrect case of library.properties architectures field item(s): {{.}}. Architectures are case sensitive. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.Default},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Default},
+		ErrorModes:      []checkmode.Type{checkmode.Strict},
+		CheckFunction:   checkfunctions.LibraryPropertiesArchitecturesFieldValueCase,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",

check/checkfunctions/library.go

@@ -871,6 +871,72 @@ func LibraryPropertiesArchitecturesFieldSoloAlias() (result checkresult.Type, ou
 	return checkresult.Pass, ""
 }
 
+// LibraryPropertiesArchitecturesFieldValueCase checks for incorrect case of common architectures.
+func LibraryPropertiesArchitecturesFieldValueCase() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, "Couldn't load library.properties"
+	}
+
+	architectures, ok := checkdata.LibraryProperties().GetOk("architectures")
+	if !ok {
+		return checkresult.Skip, "Field not present"
+	}
+
+	architecturesList := commaSeparatedToList(architectures)
+
+	var commonArchitecturesList = []string{
+		"apollo3",
+		"arc32",
+		"avr",
+		"esp32",
+		"esp8266",
+		"i586",
+		"i686",
+		"k210",
+		"mbed",
+		"megaavr",
+		"mraa",
+		"nRF5",
+		"nrf52",
+		"pic32",
+		"sam",
+		"samd",
+		"wiced",
+		"win10",
+	}
+
+	correctArchitecturePresent := func(correctArchitectureQuery string) bool {
+		for _, architecture := range architecturesList {
+			if architecture == correctArchitectureQuery {
+				return true
+			}
+		}
+
+		return false
+	}
+
+	miscasedArchitectures := []string{}
+	for _, architecture := range architecturesList {
+		for _, commonArchitecture := range commonArchitecturesList {
+			if architecture == commonArchitecture {
+				break
+			}
+
+			if strings.EqualFold(architecture, commonArchitecture) && !correctArchitecturePresent(commonArchitecture) {
+				// The architecture has incorrect case and the correctly cased name is not present in the architectures field.
+				miscasedArchitectures = append(miscasedArchitectures, architecture)
+				break
+			}
+		}
+	}
+
+	if len(miscasedArchitectures) > 0 {
+		return checkresult.Fail, strings.Join(miscasedArchitectures, ", ")
+	}
+
+	return checkresult.Pass, ""
+}
+
 // LibraryPropertiesDependsFieldDisallowedCharacters checks for disallowed characters in the library.properties "depends" field.
 func LibraryPropertiesDependsFieldDisallowedCharacters() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {

check/checkfunctions/library_test.go

@@ -316,6 +316,18 @@ func TestLibraryPropertiesArchitecturesFieldSoloAlias(t *testing.T) {
 	checkLibraryCheckFunction(LibraryPropertiesArchitecturesFieldSoloAlias, testTables, t)
 }
 
+func TestLibraryPropertiesArchitecturesFieldValueCase(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},
+		{"Not defined", "MissingFields", checkresult.Skip, ""},
+		{"Miscased", "ArchitectureMiscased", checkresult.Fail, ""},
+		{"Miscased w/ correct case", "ArchitectureMiscasedWithCorrect", checkresult.Pass, ""},
+		{"Correct case", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(LibraryPropertiesArchitecturesFieldValueCase, testTables, t)
+}
+
 func TestLibraryPropertiesDependsFieldNotInIndex(t *testing.T) {
 	testTables := []libraryCheckFunctionTestTable{
 		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},

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

@@ -0,0 +1,9 @@
+name=ArchitectureMiscased
+version=1.0.0
+author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>
+maintainer=Cristian Maglie <c.maglie@example.com>
+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, samd, foo

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

@@ -0,0 +1,9 @@
+name=ArchitectureMiscasedWithCorrect
+version=1.0.0
+author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>
+maintainer=Cristian Maglie <c.maglie@example.com>
+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, samd, avr, foo