Merge pull request #176 from per1234/url-min-length-rule

per1234 · web-flow · commit 182dbbace10b · 2021-05-27T00:41:44.000-07:00
Add min length rule for library.properties url field
diff --git a/etc/schemas/arduino-library-properties-definitions-schema.json b/etc/schemas/arduino-library-properties-definitions-schema.json
@@ -413,6 +413,9 @@
             "allOf": [
               {
                 "type": "string"
+              },
+              {
+                "minLength": 1
               }
             ]
           }
diff --git a/internal/rule/ruleconfiguration/ruleconfiguration.go b/internal/rule/ruleconfiguration/ruleconfiguration.go
@@ -889,6 +889,22 @@ var configurations = []Type{
 		ErrorModes:       []rulemode.Type{rulemode.Default},
 		RuleFunction:     rulefunction.LibraryPropertiesUrlFieldMissing,
 	},
+	{
+		ProjectType:      projecttype.Library,
+		SuperprojectType: projecttype.All,
+		Category:         "library.properties",
+		Subcategory:      "url field",
+		ID:               "LP056",
+		Brief:            "url < min length",
+		Description:      "",
+		MessageTemplate:  "library.properties url value is less than minimum length.",
+		DisableModes:     nil,
+		EnableModes:      []rulemode.Type{rulemode.Default},
+		InfoModes:        nil,
+		WarningModes:     nil,
+		ErrorModes:       []rulemode.Type{rulemode.Default},
+		RuleFunction:     rulefunction.LibraryPropertiesUrlFieldLTMinLength,
+	},
 	{
 		ProjectType:      projecttype.Library,
 		SuperprojectType: projecttype.All,
diff --git a/internal/rule/rulefunction/library.go b/internal/rule/rulefunction/library.go
@@ -944,6 +944,23 @@ func LibraryPropertiesUrlFieldMissing() (result ruleresult.Type, output string)
 	return ruleresult.Pass, ""
 }
 
+// LibraryPropertiesUrlFieldLTMinLength checks if the library.properties "url" value is less than the minimum length.
+func LibraryPropertiesUrlFieldLTMinLength() (result ruleresult.Type, output string) {
+	if projectdata.LibraryPropertiesLoadError() != nil {
+		return ruleresult.NotRun, "Couldn't load library.properties"
+	}
+
+	if !projectdata.LibraryProperties().ContainsKey("url") {
+		return ruleresult.NotRun, "Field not present"
+	}
+
+	if schema.PropertyLessThanMinLength("url", projectdata.LibraryPropertiesSchemaValidationResult()[compliancelevel.Permissive]) {
+		return ruleresult.Fail, ""
+	}
+
+	return ruleresult.Pass, ""
+}
+
 // LibraryPropertiesUrlFieldInvalid checks whether the library.properties "url" value has a valid URL format.
 func LibraryPropertiesUrlFieldInvalid() (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
@@ -714,6 +714,17 @@ func TestLibraryPropertiesUrlFieldMissing(t *testing.T) {
 	checkLibraryRuleFunction(LibraryPropertiesUrlFieldMissing, testTables, t)
 }
 
+func TestLibraryPropertiesUrlFieldLTMinLength(t *testing.T) {
+	testTables := []libraryRuleFunctionTestTable{
+		{"Invalid", "InvalidLibraryProperties", ruleresult.NotRun, ""},
+		{"Legacy", "Legacy", ruleresult.NotRun, ""},
+		{"url field too short", "UrlLTMinLength", ruleresult.Fail, ""},
+		{"Valid", "Recursive", ruleresult.Pass, ""},
+	}
+
+	checkLibraryRuleFunction(LibraryPropertiesUrlFieldLTMinLength, testTables, t)
+}
+
 func TestLibraryPropertiesUrlFieldInvalid(t *testing.T) {
 	testTables := []libraryRuleFunctionTestTable{
 		{"Invalid", "InvalidLibraryProperties", ruleresult.NotRun, ""},
diff --git a/internal/rule/rulefunction/testdata/libraries/UrlLTMinLength/library.properties b/internal/rule/rulefunction/testdata/libraries/UrlLTMinLength/library.properties
@@ -0,0 +1,10 @@
+name=UrlLTMinLength
+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=
+architectures=avr
+includes=UrlLTMinLength.h
diff --git a/internal/rule/rulefunction/testdata/libraries/UrlLTMinLength/src/UrlLTMinLength.h b/internal/rule/rulefunction/testdata/libraries/UrlLTMinLength/src/UrlLTMinLength.h
diff --git a/internal/rule/schema/schemadata/bindata.go b/internal/rule/schema/schemadata/bindata.go
@@ -1832,6 +1832,9 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
             "allOf": [
               {
                 "type": "string"
+              },
+              {
+                "minLength": 1
               }
             ]
           }

Original file line number	Diff line number	Diff line change
`@@ -413,6 +413,9 @@`
`413`	`413`	`"allOf": [`
`414`	`414`	`{`
`415`	`415`	`"type": "string"`
	`416`	`+ },`
	`417`	`+ {`
	`418`	`+ "minLength": 1`
`416`	`419`	`}`
`417`	`420`	`]`
`418`	`421`	`}`
Original file line number	Diff line number	Diff line change
@@ -1832,6 +1832,9 @@ var _arduinoLibraryPropertiesDefinitionsSchemaJson = []byte(`{
`1832`	`1832`	`"allOf": [`
`1833`	`1833`	`{`
`1834`	`1834`	`"type": "string"`
	`1835`	`+ },`
	`1836`	`+ {`
	`1837`	`+ "minLength": 1`
`1835`	`1838`	`}`
`1836`	`1839`	`]`
`1837`	`1840`	`}`