refactor: validate mime types via the validation library (italia#172)

Author: bfabio

fields.go

@@ -74,26 +74,10 @@ func validateFieldsV0(publiccode PublicCode, parser Parser, network bool) error
 		vr = append(vr, ValidationWarning{"inputTypes", "This key is DEPRECATED and will be removed in the future", 0, 0})
 	}
 
-	for i, mimeType := range publiccodev0.InputTypes {
-		if !isMIME(mimeType) {
-			vr = append(vr, newValidationError(
-				fmt.Sprintf("inputTypes[%d]", i), "'%s' is not a MIME type", mimeType,
-			))
-		}
-	}
-
 	if len(publiccodev0.OutputTypes) > 0 {
 		vr = append(vr, ValidationWarning{"outputTypes", "This key is DEPRECATED and will be removed in the future", 0, 0})
 	}
 
-	for i, mimeType := range publiccodev0.OutputTypes {
-		if !isMIME(mimeType) {
-			vr = append(vr, newValidationError(
-				fmt.Sprintf("outputTypes[%d]", i), "'%s' is not a MIME type", mimeType,
-			))
-		}
-	}
-
 	for lang, desc := range publiccodev0.Description {
 		if publiccodev0.Description == nil {
 			publiccodev0.Description = make(map[string]DescV0)

parser_test.go

@@ -256,17 +256,17 @@ func TestInvalidTestcasesV0(t *testing.T) {
 
 		// inputTypes
 		"inputTypes_invalid.yml": ValidationResults{
+			ValidationError{"inputTypes[1]", "inputTypes[1] is not a valid MIME type", 1, 1},
 			ValidationWarning{"inputTypes", "This key is DEPRECATED and will be removed in the future", 14, 1},
-			ValidationError{"inputTypes[1]", "'foobar' is not a MIME type", 1, 1},
 		},
 		"inputTypes_wrong_type.yml": ValidationResults{
 			ValidationError{"inputTypes.foobar", "wrong type for this field", 15, 1},
 		},
 
 		// outputTypes
 		"outputTypes_invalid.yml": ValidationResults{
+			ValidationError{"outputTypes[1]", "outputTypes[1] is not a valid MIME type", 1, 1},
 			ValidationWarning{"outputTypes", "This key is DEPRECATED and will be removed in the future", 14, 1},
-			ValidationError{"outputTypes[1]", "'foobar' is not a MIME type", 1, 1},
 		},
 		"outputTypes_wrong_type.yml": ValidationResults{
 			ValidationError{"outputTypes.foobar", "wrong type for this field", 15, 1},
@@ -594,6 +594,10 @@ func TestValidWithWarningsTestcasesV0(t *testing.T) {
 		"valid.minimal.v0.3.yml": ValidationResults{
 			ValidationWarning{"publiccodeYmlVersion", "v0.3 is not the latest version, use '0.4.0'. Parsing this file as v0.4.0.", 1, 1},
 		},
+		"valid.mime_types.yml": ValidationResults{
+			ValidationWarning{"inputTypes", "This key is DEPRECATED and will be removed in the future", 48, 1},
+			ValidationWarning{"outputTypes", "This key is DEPRECATED and will be removed in the future", 50, 1},
+		},
 	}
 
 	testFiles, _ := filepath.Glob("testdata/v0/valid_with_warnings/*yml")

testdata/v0/valid_with_warnings/valid.mime_types.yml

@@ -0,0 +1,59 @@
+publiccodeYmlVersion: "0.4"
+
+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"
+
+description:
+  en:
+    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
+
+inputTypes:
+  - application/json
+outputTypes:
+  - image/svg+xml
+  - audio/ogg
+  - application/x-yaml
+  - image/jpeg
+
+localisation:
+  localisationReady: true
+  availableLanguages:
+    - en

v0.go

@@ -20,8 +20,8 @@ type PublicCodeV0 struct {
 	Logo            string        `yaml:"logo,omitempty"`
 	MonochromeLogo  string        `yaml:"monochromeLogo,omitempty"`
 
-	InputTypes  []string `yaml:"inputTypes,omitempty"`
-	OutputTypes []string `yaml:"outputTypes,omitempty"`
+	InputTypes  []string `validate:"omitempty,dive,is_mime_type" yaml:"inputTypes,omitempty"`
+	OutputTypes []string `validate:"omitempty,dive,is_mime_type" yaml:"outputTypes,omitempty"`
 
 	Platforms []string `validate:"gt=0" yaml:"platforms"`
 

validations.go

@@ -11,7 +11,6 @@ import (
 	"os"
 	"path"
 	"path/filepath"
-	"regexp"
 	"runtime"
 	"slices"
 	"strings"
@@ -216,15 +215,6 @@ func (p *Parser) validLogo(u url.URL, network bool) (bool, error) {
 	return true, nil
 }
 
-// isMIME checks whether the string in input is a well formed MIME or not.
-func isMIME(value string) bool {
-	// Regex for MIME.
-	// Reference: https://github.com/jshttp/media-typer/
-	re := regexp.MustCompile("^ *([A-Za-z0-9][A-Za-z0-9!#$&^_-]{0,126})/([A-Za-z0-9][A-Za-z0-9!#$&^_.+-]{0,126}) *$")
-
-	return re.MatchString(value)
-}
-
 // isOembedURL returns whether the link is from a valid oEmbed provider.
 // Reference: https://oembed.com/providers.json
 func (p *Parser) isOEmbedURL(url *url.URL) (bool, error) {

validators/common.go

@@ -3,6 +3,7 @@ package validators
 import (
 	"fmt"
 	"reflect"
+	"regexp"
 	"strconv"
 	"strings"
 	"time"
@@ -96,3 +97,11 @@ func isSPDXExpression(fl validator.FieldLevel) bool {
 
 	return valid
 }
+
+// isMIMEType checks whether the string in input is a well formed MIME type or not.
+func isMIMEType(fl validator.FieldLevel) bool {
+	// Reference: https://github.com/jshttp/media-typer/
+	re := regexp.MustCompile("^ *([A-Za-z0-9][A-Za-z0-9!#$&^_-]{0,126})/([A-Za-z0-9][A-Za-z0-9!#$&^_.+-]{0,126}) *$")
+
+	return re.MatchString(fl.Field().String())
+}

validators/validator.go

@@ -13,6 +13,7 @@ import (
 func New() *validator.Validate {
 	validate := validator.New(validator.WithRequiredStructEnabled())
 	_ = validate.RegisterValidation("date", isDate)
+	_ = validate.RegisterValidation("is_mime_type", isMIMEType)
 	_ = validate.RegisterValidation("iso3166_1_alpha2_lowercase", isIso3166Alpha2Lowercase)
 	_ = validate.RegisterValidation("umax", uMax)
 	_ = validate.RegisterValidation("umin", uMin)
@@ -97,6 +98,10 @@ func RegisterLocalErrorMessages(v *validator.Validate, trans ut.Translator) erro
 			},
 			override: true,
 		},
+		{
+			tag:         "is_mime_type",
+			translation: "{0} is not a valid MIME type",
+		},
 		{
 			tag: "umax",
 			customRegisFunc: func(ut ut.Translator) error {