wip

Author: bfabio

parser.go

@@ -94,19 +94,13 @@ func NewDefaultParser() (*Parser, error) {
 
 // ParseStream reads the data and tries to parse it. Returns an error if fails.
 func (p *Parser) ParseStream(in io.Reader) (PublicCode, error) {
-	var ve ValidationResults
-
 	b, err := io.ReadAll(in)
 	if err != nil {
-		ve = append(ve, newValidationError("", fmt.Sprintf("Can't read the stream: %v", err)))
-
-		return nil, ve
+		return nil, ValidationResults{newValidationError("", fmt.Sprintf("Can't read the stream: %v", err))}
 	}
 
 	if !utf8.Valid(b) {
-		ve = append(ve, newValidationError("", "Invalid UTF-8"))
-
-		return nil, ve
+		return nil, ValidationResults{newValidationError("", "Invalid UTF-8")}
 	}
 
 	// First, decode the YAML into yaml.Node so we can access line and column
@@ -121,19 +115,27 @@ func (p *Parser) ParseStream(in io.Reader) (PublicCode, error) {
 		node = *node.Content[0]
 	} else {
 		// YAML is malformed
-		ve = append(ve, toValidationError(err.Error(), nil))
-
-		return nil, ve;
+		return nil, ValidationResults{toValidationError(err.Error(), nil)}
 	}
 
 	_, version := getNodes("publiccodeYmlVersion", &node)
 	if version == nil {
-		ve = append(ve, newValidationError("publiccodeYmlVersion", "required"))
+		return nil, ValidationResults{newValidationError("publiccodeYmlVersion", "required")}
+	}
+	if version.ShortTag() != "!!str" {
+		line, column := getPositionInFile("publiccodeYmlVersion", node)
 
-		return nil, ve
+		return nil, ValidationResults{ValidationError{
+			Key: "publiccodeYmlVersion",
+			Description: "wrong type for this field",
+			Line: line,
+			Column: column,
+		}}
 	}
 
-	if slices.Contains(SupportedVersions, version.Value) && strings.HasPrefix(version.Value, "0.2") {
+	var ve ValidationResults
+
+	if slices.Contains(SupportedVersions, version.Value) && !strings.HasPrefix(version.Value, "0.3") {
 		latestVersion := SupportedVersions[len(SupportedVersions)-1]
 		line, column := getPositionInFile("publiccodeYmlVersion", node)
 

parser_test.go

@@ -33,6 +33,19 @@ func parse(file string) error {
 	return err
 }
 
+func parseNoNetwork(file string) error {
+	var p *Parser
+	var err error
+
+	if p, err = NewParser(ParserConfig{DisableNetwork: true}); err != nil {
+		return err
+	}
+
+	_, err = p.Parse(file)
+
+	return err
+}
+
 // Check all the YAML files matching the glob pattern and fail for each file
 // with parsing or validation errors.
 func checkValidFiles(pattern string, t *testing.T) {
@@ -69,12 +82,39 @@ func TestValidPreviousStandardVersion(t *testing.T) {
 		})
 	})
 }
-func TestInvalidTestcasesV0_3(t *testing.T) {
-	cwd, err := os.Getwd()
-	if err != nil {
-		t.Errorf("Can't get current working directory")
+
+func TestInvalidTestcasesV0_3_NoNetwork(t *testing.T) {
+	expected := map[string]error{
+		// logo
+		"logo_missing_file.yml": ValidationResults{
+			ValidationError{"logo", "no such file: no_such_file.png", 18, 1},
+		},
+		"logo_invalid_png.yml": ValidationResults{
+			ValidationError{"logo", "image: unknown format", 18, 1},
+		},
+
+		// monochromeLogo
+		"monochromeLogo_invalid_png.yml": ValidationResults{
+			ValidationWarning{"monochromeLogo", "This key is DEPRECATED and will be removed in the future", 18, 1},
+			ValidationError{"monochromeLogo", "image: unknown format", 18, 1},
+		},
+
 	}
 
+	testFiles, _ := filepath.Glob("testdata/v0.3/invalid/no-network/*yml")
+	for _, file := range testFiles {
+		baseName := path.Base(file)
+		if expected[baseName] == nil {
+			t.Errorf("No expected data for file %s", baseName)
+		}
+		t.Run(file, func(t *testing.T) {
+			err := parseNoNetwork(file)
+			checkParseErrors(t, err, testType{file, expected[baseName]})
+		})
+	}
+}
+
+func TestInvalidTestcasesV0_3(t *testing.T) {
 	expected := map[string]error{
 		// publiccodeYmlVersion
 		"publiccodeYmlVersion_missing.yml": ValidationResults{ValidationError{"publiccodeYmlVersion", "required", 0, 0}},
@@ -83,7 +123,7 @@ func TestInvalidTestcasesV0_3(t *testing.T) {
 		}},
 		"publiccodeYmlVersion_wrong_type.yml": ValidationResults{
 			ValidationError{"publiccodeYmlVersion", "wrong type for this field", 2, 1},
-			ValidationError{"publiccodeYmlVersion", "required", 2, 1}},
+		},
 
 		// name
 		"name_missing.yml": ValidationResults{ValidationError{"name", "required", 1, 1}},
@@ -152,13 +192,10 @@ func TestInvalidTestcasesV0_3(t *testing.T) {
 			ValidationError{"logo", "wrong type for this field", 18, 1},
 		},
 		"logo_unsupported_extension.yml": ValidationResults{
-			ValidationError{"logo", fmt.Sprintf("invalid file extension for: %s/logo.mpg", cwd), 18, 1},
+			ValidationError{"logo", "invalid file extension for: https://raw.githubusercontent.com/italia/developers.italia.it/main/logo.mpg", 18, 1},
 		},
 		"logo_missing_file.yml": ValidationResults{
-			ValidationError{"logo", fmt.Sprintf("no such file: %s/no_such_file.png", cwd), 18, 1},
-		},
-		"logo_invalid_png.yml": ValidationResults{
-			ValidationError{"logo", "image: unknown format", 18, 1},
+			ValidationError{"logo", "no such file: https://raw.githubusercontent.com/italia/developers.italia.it/main/no_such_file.png", 18, 1},
 		},
 
 		// monochromeLogo
@@ -169,18 +206,14 @@ func TestInvalidTestcasesV0_3(t *testing.T) {
 			ValidationWarning{"monochromeLogo", "This key is DEPRECATED and will be removed in the future", 18, 1},
 			ValidationError{
 				"monochromeLogo",
-				fmt.Sprintf("invalid file extension for: %s/monochromeLogo.mpg", cwd),
+				"invalid file extension for: https://raw.githubusercontent.com/italia/developers.italia.it/main/monochromeLogo.mpg",
 				18,
 				1,
 			},
 		},
 		"monochromeLogo_missing_file.yml": ValidationResults{
 			ValidationWarning{"monochromeLogo", "This key is DEPRECATED and will be removed in the future", 18, 1},
-			ValidationError{"monochromeLogo", fmt.Sprintf("no such file: %s/no_such_file.png", cwd), 18, 1},
-		},
-		"monochromeLogo_invalid_png.yml": ValidationResults{
-			ValidationWarning{"monochromeLogo", "This key is DEPRECATED and will be removed in the future", 18, 1},
-			ValidationError{"monochromeLogo", "image: unknown format", 18, 1},
+			ValidationError{"monochromeLogo", "no such file: https://raw.githubusercontent.com/italia/developers.italia.it/main/no_such_file.png", 18, 1},
 		},
 
 		// inputTypes

testdata/v0.3/invalid/legal_license_missing.yml

@@ -38,7 +38,7 @@ description:
        - Just one feature
 
 legal:
-  authorsFile: testdata/AUTHORS
+  repoOwner: foobar
   # Should NOT validate: license is missing
 
 maintenance:

testdata/v0.3/invalid/logo_invalid_png.yml testdata/v0.3/invalid/no-network/logo_invalid_png.yml

@@ -0,0 +1,54 @@
+publiccodeYmlVersion: "0.3"
+
+name: Medusa
+url: "https://github.com/italia/developers.italia.it.git"
+releaseDate: "2017-04-15"
+
+platforms:
+  - web
+
+categories:
+  - cloud-management
+
+developmentStatus: development
+
+softwareType: "standalone/other"
+
+# Should NOT validate: logo must exist as a file
+logo: "no_such_file.png"
+
+description:
+  eng:
+    localisedName: Medusa
+    shortDescription: >
+          A rather short description which
+          is probably useless
+    longDescription: >
+          Very long description of this software, also split
+          on multiple rows. You should note what the software
+          is and why one should need it. This is 158 characters.
+          Very long description of this software, also split
+          on multiple rows. You should note what the software
+          is and why one should need it. This is 316 characters.
+          Very long description of this software, also split
+          on multiple rows. You should note what the software
+          is and why one should need it. This is 474 characters.
+          Very long description of this software, also split
+          on multiple rows. You should note what the software
+          is and why one should need it. This is 632 characters.
+    features:
+       - Just one feature
+
+legal:
+  license: AGPL-3.0-or-later
+
+maintenance:
+  type: "community"
+
+  contacts:
+    - name: Francesco Rossi
+
+localisation:
+  localisationReady: true
+  availableLanguages:
+    - eng