Merge pull request #66 from arduino/per1234/redundant-library_properties-check

Add check for redundant library.properties

Author: per1234

check/checkconfigurations/checkconfigurations.go

@@ -116,6 +116,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.All},
 		CheckFunction:   checkfunctions.IncorrectLibraryPropertiesFileNameCase,
 	},
+	{
+		ProjectType:     projecttype.Library,
+		Category:        "library.properties",
+		Subcategory:     "general",
+		ID:              "",
+		Brief:           "redundant",
+		Description:     "",
+		MessageTemplate: "Redundant library.properties file found at {{.}}. Only the file in the root of the library is used. See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.All},
+		InfoModes:       nil,
+		WarningModes:    []checkmode.Type{checkmode.Permissive},
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.RedundantLibraryProperties,
+	},
 	{
 		ProjectType:     projecttype.Library,
 		Category:        "library.properties",

check/checkfunctions/library.go

@@ -84,6 +84,16 @@ func IncorrectLibraryPropertiesFileNameCase() (result checkresult.Type, output s
 	return checkresult.Pass, ""
 }
 
+// RedundantLibraryProperties checks for redundant copies of the library.properties file.
+func RedundantLibraryProperties() (result checkresult.Type, output string) {
+	redundantLibraryPropertiesPath := checkdata.ProjectPath().Join("src", "library.properties")
+	if redundantLibraryPropertiesPath.Exist() {
+		return checkresult.Fail, redundantLibraryPropertiesPath.String()
+	}
+
+	return checkresult.Pass, ""
+}
+
 // LibraryPropertiesNameFieldMissing checks for missing library.properties "name" field.
 func LibraryPropertiesNameFieldMissing() (result checkresult.Type, output string) {
 	if checkdata.LibraryPropertiesLoadError() != nil {

check/checkfunctions/library_test.go

@@ -92,6 +92,15 @@ func TestLibraryPropertiesMissing(t *testing.T) {
 	checkLibraryCheckFunction(LibraryPropertiesMissing, testTables, t)
 }
 
+func TestRedundantLibraryProperties(t *testing.T) {
+	testTables := []libraryCheckFunctionTestTable{
+		{"Redundant", "RedundantLibraryProperties", checkresult.Fail, ""},
+		{"No redundant", "Recursive", checkresult.Pass, ""},
+	}
+
+	checkLibraryCheckFunction(RedundantLibraryProperties, testTables, t)
+}
+
 func TestLibraryPropertiesNameFieldMissingOfficialPrefix(t *testing.T) {
 	testTables := []libraryCheckFunctionTestTable{
 		{"Unable to load", "InvalidLibraryProperties", checkresult.NotRun, ""},

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

@@ -0,0 +1,9 @@
+name=RedundantLibraryProperties
+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/RedundantLibraryProperties/src/RedundantLibraryProperties.h

@@ -0,0 +1,9 @@
+name=RedundantLibraryProperties
+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