Create libraryproperties package and add validation helper functions

per1234 · per1234 · commit c39f587d4aa8 · 2020-10-29T20:42:46.000-07:00
diff --git a/check/checkdata/checkdata.go b/check/checkdata/checkdata.go
@@ -2,7 +2,7 @@ package checkdata
 
 import (
 	"github.com/arduino/arduino-check/project"
-	"github.com/arduino/arduino-check/project/library"
+	"github.com/arduino/arduino-check/project/library/libraryproperties"
 	"github.com/arduino/arduino-check/project/projecttype"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
@@ -45,12 +45,12 @@ func Initialize(project project.Type) {
 	switch project.ProjectType {
 	case projecttype.Sketch:
 	case projecttype.Library:
-		libraryProperties, libraryPropertiesLoadError = library.Properties(project.Path)
+		libraryProperties, libraryPropertiesLoadError = libraryproperties.Properties(project.Path)
 		if libraryPropertiesLoadError != nil {
-			libraryPropertiesSchemaValidationResult = library.ValidateProperties(libraryProperties)
-		} else {
 			// TODO: can I even do this?
 			libraryPropertiesSchemaValidationResult = nil
+		} else {
+			libraryPropertiesSchemaValidationResult = libraryproperties.Validate(libraryProperties)
 		}
 	case projecttype.Platform:
 	case projecttype.PackageIndex:
diff --git a/project/library/libraryproperties.go b/project/library/libraryproperties.go
diff --git a/project/library/libraryproperties/libraryproperties.go b/project/library/libraryproperties/libraryproperties.go
@@ -0,0 +1,65 @@
+package libraryproperties
+
+import (
+	"net/url"
+	"os"
+	"path/filepath"
+
+	"github.com/arduino/go-paths-helper"
+	"github.com/arduino/go-properties-orderedmap"
+	"github.com/xeipuuv/gojsonschema"
+)
+
+func Properties(libraryPath *paths.Path) (*properties.Map, error) {
+	libraryProperties, err := properties.Load(libraryPath.Join("library.properties").String())
+	if err != nil {
+		return nil, err
+	}
+	return libraryProperties, nil
+}
+
+func Validate(libraryProperties *properties.Map) *gojsonschema.Result {
+	workingPath, _ := os.Getwd()
+	schemaPath := paths.New(workingPath).Join("arduino-library-properties-schema.json")
+	uriFriendlySchemaPath := filepath.ToSlash(schemaPath.String())
+	schemaPathURI := url.URL{
+		Scheme: "file",
+		Path:   uriFriendlySchemaPath,
+	}
+	schemaLoader := gojsonschema.NewReferenceLoader(schemaPathURI.String())
+
+	documentLoader := gojsonschema.NewGoLoader(libraryProperties)
+
+	result, err := gojsonschema.Validate(schemaLoader, documentLoader)
+	if err != nil {
+		panic(err.Error())
+	}
+
+	return result
+}
+
+func FieldMissing(fieldName string, validationResult *gojsonschema.Result) bool {
+	return ValidationErrorMatch("required", "(root)", fieldName+" is required", validationResult)
+}
+
+func FieldPatternMismatch(fieldName string, validationResult *gojsonschema.Result) bool {
+	return ValidationErrorMatch("pattern", fieldName, "", validationResult)
+}
+
+func ValidationErrorMatch(typeQuery string, fieldQuery string, descriptionQuery string, validationResult *gojsonschema.Result) bool {
+	if validationResult.Valid() {
+		// No error, so nothing to match
+		return false
+	}
+	for _, validationError := range validationResult.Errors() {
+		if typeQuery == "" || typeQuery == validationError.Type() {
+			if fieldQuery == "" || fieldQuery == validationError.Field() {
+				if descriptionQuery == "" || descriptionQuery == validationError.Description() {
+					return true
+				}
+			}
+		}
+	}
+
+	return false
+}
