Merge pull request #180 from per1234/maintainer-contains-arduino

per1234 · web-flow · commit 53c1162f5365 · 2021-06-04T01:59:19.000-07:00
Add rule for 3rd party library.properties maintainer using "Arduino"
diff --git a/etc/schemas/arduino-library-properties-definitions-schema.json b/etc/schemas/arduino-library-properties-definitions-schema.json
@@ -10,6 +10,11 @@
           "not": {
             "pattern": "^[aA][rR][dD][uU][iI][nN][oO].*$"
           }
+        },
+        "notContainsArduino": {
+          "not": {
+            "pattern": "^.+[aA][rR][dD][uU][iI][nN][oO].*$"
+          }
         }
       }
     },
@@ -77,11 +82,6 @@
                   "pattern": "^.* .*$"
                 }
               },
-              "notContainsArduino": {
-                "not": {
-                  "pattern": "^.+[aA][rR][dD][uU][iI][nN][oO].*$"
-                }
-              },
               "notContainsSuperfluousTerms": {
                 "not": {
                   "pattern": "^.*[lL][iI][bB][rR][aA][rR][yY].*$"
@@ -101,7 +101,7 @@
                 "$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSpaces"
               },
               {
-                "$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsArduino"
+                "$ref": "#/definitions/general/patternObjects/notContainsArduino"
               },
               {
                 "$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSuperfluousTerms"
@@ -238,6 +238,9 @@
             "allOf": [
               {
                 "$ref": "#/definitions/propertiesObjects/maintainer/specification/object"
+              },
+              {
+                "$ref": "#/definitions/general/patternObjects/notContainsArduino"
               }
             ]
           }
diff --git a/internal/project/library/libraryproperties/librarypropertiesschemas_test.go b/internal/project/library/libraryproperties/librarypropertiesschemas_test.go
@@ -291,8 +291,11 @@ func TestPropertiesVersionPattern(t *testing.T) {
 func TestPropertiesMaintainerPattern(t *testing.T) {
 	testTables := []propertyValueTestTable{
 		{"Starts with arduino", "arduinofoo", compliancelevel.Permissive, assert.False},
+		{"Contains arduino", "fooarduinobar", compliancelevel.Permissive, assert.False},
 		{"Starts with arduino", "arduinofoo", compliancelevel.Specification, assert.True},
+		{"Contains arduino", "fooarduinobar", compliancelevel.Specification, assert.False},
 		{"Starts with arduino", "arduinofoo", compliancelevel.Strict, assert.True},
+		{"Contains arduino", "fooarduinobar", compliancelevel.Strict, assert.True},
 	}
 
 	checkPropertyPatternMismatch("maintainer", testTables, t)
diff --git a/internal/rule/ruleconfiguration/ruleconfiguration.go b/internal/rule/ruleconfiguration/ruleconfiguration.go
@@ -681,6 +681,22 @@ var configurations = []Type{
 		ErrorModes:       []rulemode.Type{rulemode.Strict},
 		RuleFunction:     rulefunction.LibraryPropertiesMaintainerFieldStartsWithArduino,
 	},
+	{
+		ProjectType:      projecttype.Library,
+		SuperprojectType: projecttype.All,
+		Category:         "library.properties",
+		Subcategory:      "maintainer field",
+		ID:               "LP057",
+		Brief:            `maintainer contains "Arduino"`,
+		Description:      "Case insensitive.",
+		MessageTemplate:  `library.properties maintainer value {{.}} contains "Arduino". 3rd party libraries are not maintained by Arduino.`,
+		DisableModes:     []rulemode.Type{rulemode.Official},
+		EnableModes:      []rulemode.Type{rulemode.Default},
+		InfoModes:        nil,
+		WarningModes:     []rulemode.Type{rulemode.Default},
+		ErrorModes:       []rulemode.Type{rulemode.Strict},
+		RuleFunction:     rulefunction.LibraryPropertiesMaintainerFieldContainsArduino,
+	},
 	{
 		ProjectType:      projecttype.Library,
 		SuperprojectType: projecttype.All,
diff --git a/internal/rule/rulefunction/library.go b/internal/rule/rulefunction/library.go
@@ -744,6 +744,24 @@ func LibraryPropertiesMaintainerFieldStartsWithArduino() (result ruleresult.Type
 	return ruleresult.Pass, ""
 }
 
+// LibraryPropertiesMaintainerFieldContainsArduino checks if the library.properties "maintainer" value contains "Arduino".
+func LibraryPropertiesMaintainerFieldContainsArduino() (result ruleresult.Type, output string) {
+	if projectdata.LibraryPropertiesLoadError() != nil {
+		return ruleresult.NotRun, "Couldn't load library.properties"
+	}
+
+	maintainer, ok := projectdata.LibraryProperties().GetOk("maintainer")
+	if !ok {
+		return ruleresult.NotRun, "Field not present"
+	}
+
+	if schema.ValidationErrorMatch("^#/maintainer$", "/patternObjects/notContainsArduino", "", "", projectdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Strict]) {
+		return ruleresult.Fail, maintainer
+	}
+
+	return ruleresult.Pass, ""
+}
+
 // LibraryPropertiesEmailFieldAsMaintainerAlias checks whether the library.properties "email" field is being used as an alias for the "maintainer" field.
 func LibraryPropertiesEmailFieldAsMaintainerAlias() (result ruleresult.Type, output string) {
 	if projectdata.LibraryPropertiesLoadError() != nil {
diff --git a/internal/rule/rulefunction/library_test.go b/internal/rule/rulefunction/library_test.go
@@ -568,6 +568,17 @@ func TestLibraryPropertiesMaintainerFieldStartsWithArduino(t *testing.T) {
 	checkLibraryRuleFunction(LibraryPropertiesMaintainerFieldStartsWithArduino, testTables, t)
 }
 
+func TestLibraryPropertiesMaintainerFieldContainsArduino(t *testing.T) {
+	testTables := []libraryRuleFunctionTestTable{
+		{"Invalid", "InvalidLibraryProperties", ruleresult.NotRun, ""},
+		{"Legacy", "Legacy", ruleresult.NotRun, ""},
+		{"Maintainer field contains Arduino", "MaintainerContainsArduino", ruleresult.Fail, ""},
+		{"Valid", "Recursive", ruleresult.Pass, ""},
+	}
+
+	checkLibraryRuleFunction(LibraryPropertiesMaintainerFieldContainsArduino, testTables, t)
+}
+
 func TestLibraryPropertiesEmailFieldAsMaintainerAlias(t *testing.T) {
 	testTables := []libraryRuleFunctionTestTable{
 		{"Unable to load", "InvalidLibraryProperties", ruleresult.NotRun, ""},
diff --git a/internal/rule/rulefunction/testdata/libraries/MaintainerContainsArduino/library.properties b/internal/rule/rulefunction/testdata/libraries/MaintainerContainsArduino/library.properties
@@ -0,0 +1,10 @@
+name=MaintainerContainsArduino
+version=1.0.0
+author=Cristian Maglie <c.maglie@example.com>, Pippo Pluto <pippo@example.com>
+maintainer=Cristian "Arduino Wizard" 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
+includes=Recursive.h
diff --git a/internal/rule/rulefunction/testdata/libraries/MaintainerContainsArduino/src/MaintainerContainsArduino.h b/internal/rule/rulefunction/testdata/libraries/MaintainerContainsArduino/src/MaintainerContainsArduino.h
diff --git a/internal/rule/schema/schemadata/bindata.go b/internal/rule/schema/schemadata/bindata.go
@@ -1429,6 +1429,11 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
           "not": {
             "pattern": "^[aA][rR][dD][uU][iI][nN][oO].*$"
           }
+        },
+        "notContainsArduino": {
+          "not": {
+            "pattern": "^.+[aA][rR][dD][uU][iI][nN][oO].*$"
+          }
         }
       }
     },
@@ -1496,11 +1501,6 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
                   "pattern": "^.* .*$"
                 }
               },
-              "notContainsArduino": {
-                "not": {
-                  "pattern": "^.+[aA][rR][dD][uU][iI][nN][oO].*$"
-                }
-              },
               "notContainsSuperfluousTerms": {
                 "not": {
                   "pattern": "^.*[lL][iI][bB][rR][aA][rR][yY].*$"
@@ -1520,7 +1520,7 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
                 "$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSpaces"
               },
               {
-                "$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsArduino"
+                "$ref": "#/definitions/general/patternObjects/notContainsArduino"
               },
               {
                 "$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSuperfluousTerms"
@@ -1657,6 +1657,9 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
             "allOf": [
               {
                 "$ref": "#/definitions/propertiesObjects/maintainer/specification/object"
+              },
+              {
+                "$ref": "#/definitions/general/patternObjects/notContainsArduino"
               }
             ]
           }

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,11 @@`
`10`	`10`	`"not": {`
`11`	`11`	`"pattern": "^[aA][rR][dD][uU][iI][nN][oO].*$"`
`12`	`12`	`}`
	`13`	`+ },`
	`14`	`+ "notContainsArduino": {`
	`15`	`+ "not": {`
	`16`	`+ "pattern": "^.+[aA][rR][dD][uU][iI][nN][oO].*$"`
	`17`	`+ }`
`13`	`18`	`}`
`14`	`19`	`}`
`15`	`20`	`},`
`@@ -77,11 +82,6 @@`
`77`	`82`	`"pattern": "^.* .*$"`
`78`	`83`	`}`
`79`	`84`	`},`
`80`		`- "notContainsArduino": {`
`81`		`- "not": {`
`82`		`- "pattern": "^.+[aA][rR][dD][uU][iI][nN][oO].*$"`
`83`		`- }`
`84`		`- },`
`85`	`85`	`"notContainsSuperfluousTerms": {`
`86`	`86`	`"not": {`
`87`	`87`	`"pattern": "^.[lL][iI][bB][rR][aA][rR][yY].$"`
`@@ -101,7 +101,7 @@`
`101`	`101`	`"$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSpaces"`
`102`	`102`	`},`
`103`	`103`	`{`
`104`		`- "$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsArduino"`
	`104`	`+ "$ref": "#/definitions/general/patternObjects/notContainsArduino"`
`105`	`105`	`},`
`106`	`106`	`{`
`107`	`107`	`"$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSuperfluousTerms"`
`@@ -238,6 +238,9 @@`
`238`	`238`	`"allOf": [`
`239`	`239`	`{`
`240`	`240`	`"$ref": "#/definitions/propertiesObjects/maintainer/specification/object"`
	`241`	`+ },`
	`242`	`+ {`
	`243`	`+ "$ref": "#/definitions/general/patternObjects/notContainsArduino"`
`241`	`244`	`}`
`242`	`245`	`]`
`243`	`246`	`}`
Original file line number	Diff line number	Diff line change
@@ -1429,6 +1429,11 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
`1429`	`1429`	`"not": {`
`1430`	`1430`	`"pattern": "^[aA][rR][dD][uU][iI][nN][oO].*$"`
`1431`	`1431`	`}`
	`1432`	`+ },`
	`1433`	`+ "notContainsArduino": {`
	`1434`	`+ "not": {`
	`1435`	`+ "pattern": "^.+[aA][rR][dD][uU][iI][nN][oO].*$"`
	`1436`	`+ }`
`1432`	`1437`	`}`
`1433`	`1438`	`}`
`1434`	`1439`	`},`
@@ -1496,11 +1501,6 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
`1496`	`1501`	`"pattern": "^.* .*$"`
`1497`	`1502`	`}`
`1498`	`1503`	`},`
`1499`		`- "notContainsArduino": {`
`1500`		`- "not": {`
`1501`		`- "pattern": "^.+[aA][rR][dD][uU][iI][nN][oO].*$"`
`1502`		`- }`
`1503`		`- },`
`1504`	`1504`	`"notContainsSuperfluousTerms": {`
`1505`	`1505`	`"not": {`
`1506`	`1506`	`"pattern": "^.[lL][iI][bB][rR][aA][rR][yY].$"`
@@ -1520,7 +1520,7 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
`1520`	`1520`	`"$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSpaces"`
`1521`	`1521`	`},`
`1522`	`1522`	`{`
`1523`		`- "$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsArduino"`
	`1523`	`+ "$ref": "#/definitions/general/patternObjects/notContainsArduino"`
`1524`	`1524`	`},`
`1525`	`1525`	`{`
`1526`	`1526`	`"$ref": "#/definitions/propertiesObjects/name/strict/definitions/patternObjects/notContainsSuperfluousTerms"`
@@ -1657,6 +1657,9 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
`1657`	`1657`	`"allOf": [`
`1658`	`1658`	`{`
`1659`	`1659`	`"$ref": "#/definitions/propertiesObjects/maintainer/specification/object"`
	`1660`	`+ },`
	`1661`	`+ {`
	`1662`	`+ "$ref": "#/definitions/general/patternObjects/notContainsArduino"`
`1660`	`1663`	`}`
`1661`	`1664`	`]`
`1662`	`1665`	`}`