Merge pull request #46 from arduino/per1234/architectures-schema-checks

Add schema provided checks for library.properties architectures field

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -596,6 +596,36 @@ var configurations = []Type{
 		ErrorModes:      nil,
 		CheckFunction:   checkfunctions.LibraryPropertiesUrlFieldDeadLink,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "architectures field",
+		ID:              "",
+		Brief:           "missing architectures field",
+		Description:     "Defaults to *, but it's better to explicitly define architectures.",
+		MessageTemplate: "missing architectures field in library.properties. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.All},
+		ErrorModes:      nil,
+		CheckFunction:   checkfunctions.LibraryPropertiesArchitecturesFieldMissing,
+	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "architectures field",
+		ID:              "",
+		Brief:           "architectures blank",
+		Description:     "Causes library to be considered incompatible with all architectures.",
+		MessageTemplate: "Empty library.properties architectures field. Please define specific architectures or set to * if compatible with all. See https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Permissive},
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.LibraryPropertiesArchitecturesFieldLTMinLength,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",

check/checkfunctions/library.go

@@ -593,6 +593,35 @@ func LibraryPropertiesUrlFieldDeadLink() (result checkresult.Type, output string
 	return checkresult.Fail, httpResponse.Status
 }
 
+// LibraryPropertiesArchitecturesFieldMissing checks for missing library.properties "architectures" field.
+func LibraryPropertiesArchitecturesFieldMissing() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	if schema.RequiredPropertyMissing("architectures", checkdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Specification], configuration.SchemasPath()) {
+		return checkresult.Fail, ""
+	}
+	return checkresult.Pass, ""
+}
+
+// LibraryPropertiesNameFieldLTMinLength checks if the library.properties "architectures" value is less than the minimum length.
+func LibraryPropertiesArchitecturesFieldLTMinLength() (result checkresult.Type, output string) {
+	if checkdata.LibraryPropertiesLoadError() != nil {
+		return checkresult.NotRun, ""
+	}
+
+	if !checkdata.LibraryProperties().ContainsKey("architectures") {
+		return checkresult.NotRun, ""
+	}
+
+	if schema.PropertyLessThanMinLength("architectures", checkdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Specification], configuration.SchemasPath()) {
+		return checkresult.Fail, ""
+	}
+
+	return checkresult.Pass, ""
+}
+
 // LibraryPropertiesDependsFieldNotInIndex checks whether the libraries listed in the library.properties `depends` field are in the Library Manager index.
 func LibraryPropertiesDependsFieldNotInIndex() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {