Add rule for constraint syntax in library.properties depends field

Arduino CLI and the Library Manager system have support for specifying version constraints in the library.properties
`depends` field.

This was previously validated as part of the general `depends` field data format check in LP047.

The constraint system has recently been made much more capable through the addition of support for more syntax.

The previous approach for validating the version constraint was a complex and lengthy regular expression in the
library.properties JSON schema. Extending this to comprehensively validate the full range of constraint forms possible
with the new syntax will not be feasible or maintainable.

The new approach is to validate it using the same `go.bug.st/relaxed-semver` module used by Arduino CLI and
`arduino/libraries-repository-engine` to handle the version constraints in this field.

Author: per1234

internal/rule/ruleconfiguration/ruleconfiguration.go

@@ -1113,6 +1113,23 @@ var configurations = []Type{
 		ErrorModes:       nil,
 		RuleFunction:     rulefunction.LibraryPropertiesDependsFieldNotInIndex,
 	},
+	{
+		ProjectType:      projecttype.Library,
+		SuperprojectType: projecttype.All,
+		Category:         "library.properties",
+		Subcategory:      "depends field",
+		ID:               "LP058",
+		Brief:            "invalid depends constraint syntax",
+		Description:      "The `depends` field in the library's `library.properties` metadata file uses invalid version constraint syntax.",
+		MessageTemplate:  "library.properties depends field item(s) {{.}} have invalid constraint syntax.",
+		Reference:        "https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
+		DisableModes:     nil,
+		EnableModes:      []rulemode.Type{rulemode.Default},
+		InfoModes:        nil,
+		WarningModes:     nil,
+		ErrorModes:       []rulemode.Type{rulemode.Default},
+		RuleFunction:     rulefunction.LibraryPropertiesDependsFieldConstraintInvalid,
+	},
 	{
 		ProjectType:      projecttype.Library,
 		SuperprojectType: projecttype.All,

internal/rule/rulefunction/library.go

@@ -1239,6 +1239,34 @@ func LibraryPropertiesDependsFieldNotInIndex() (result ruleresult.Type, output s
 	return ruleresult.Pass, ""
 }
 
+// LibraryPropertiesDependsFieldConstraintInvalid checks whether the syntax of the version constraints in the
+// library.properties `depends` field is valid.
+func LibraryPropertiesDependsFieldConstraintInvalid() (result ruleresult.Type, output string) {
+	if projectdata.LibraryPropertiesLoadError() != nil {
+		return ruleresult.NotRun, "Couldn't load library.properties"
+	}
+
+	depends, hasDepends := projectdata.LibraryProperties().GetOk("depends")
+	if !hasDepends {
+		return ruleresult.Skip, "Field not present"
+	}
+
+	dependencies := libDependencies(depends)
+
+	nonCompliant := []string{}
+	for _, dependency := range dependencies {
+		if dependency.parseConstraintErr != nil {
+			nonCompliant = append(nonCompliant, dependency.depend)
+		}
+	}
+
+	if len(nonCompliant) > 0 {
+		return ruleresult.Fail, strings.Join(nonCompliant, ", ")
+	}
+
+	return ruleresult.Pass, ""
+}
+
 // LibraryPropertiesDotALinkageFieldInvalid checks for invalid value in the library.properties "dot_a_linkage" field.
 func LibraryPropertiesDotALinkageFieldInvalid() (result ruleresult.Type, output string) {
 	if projectdata.LibraryPropertiesLoadError() != nil {

internal/rule/rulefunction/library_test.go

@@ -846,6 +846,20 @@ func TestLibraryPropertiesDependsFieldNotInIndex(t *testing.T) {
 	checkLibraryRuleFunction(LibraryPropertiesDependsFieldNotInIndex, testTables, t)
 }
 
+func TestLibraryPropertiesDependsFieldConstraintInvalid(t *testing.T) {
+	testTables := []libraryRuleFunctionTestTable{
+		{"Unable to load", "InvalidLibraryProperties", ruleresult.NotRun, ""},
+		{"Legacy", "Legacy", ruleresult.Skip, ""},
+		{"No depends field", "NoDepends", ruleresult.Skip, ""},
+		{"Depends field empty", "DependsEmpty", ruleresult.Pass, ""},
+		{"Invalid depends field format", "DependsHasBadChars", ruleresult.Pass, ""},
+		{"Invalid constraint syntax", "DependsConstraintInvalid", ruleresult.Fail, "^BarLib \\(nope\\), QuxLib \\(huh\\)$"},
+		{"Valid constraint syntax", "DependsConstraintValid", ruleresult.Pass, ""},
+	}
+
+	checkLibraryRuleFunction(LibraryPropertiesDependsFieldConstraintInvalid, testTables, t)
+}
+
 func TestLibraryPropertiesDotALinkageFieldInvalid(t *testing.T) {
 	testTables := []libraryRuleFunctionTestTable{
 		{"Invalid", "InvalidLibraryProperties", ruleresult.NotRun, ""},

internal/rule/rulefunction/testdata/libraries/DependsConstraintInvalid/library.properties

@@ -0,0 +1,11 @@
+name=DependsConstraintInvalid
+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
+depends=FooLib (=0.0.1),BarLib (nope),BazLib (=1.2.3),QuxLib (huh)
+includes=DependsConstraintInvalid.h

internal/rule/rulefunction/testdata/libraries/DependsConstraintInvalid/src/DependsConstraintInvalid.h

@@ -0,0 +1,11 @@
+name=DependsConstraintValid
+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
+depends=LibA (=0.0.1),LibB (>1.0.0),LibC (>=1.0.0),LibD (<2.0.0),LibE (<=2.0.0),LibF (!=1.0.0),LibG (<1.0.0 || >2.0.0),LibH ((>0.1.0 && <2.0.0) || >2.1.0),LibI (),LibJ
+includes=DependsConstraintValid.h