feat: ignore errors in matchers and add format byte

Signed-off-by: Gergely Brautigam <[email protected]>

Author: Skarlso

crd-testing-README.md

@@ -23,6 +23,8 @@ tests:
       - matchSnapshot:
           # this will generate one snapshot / CRD version and match all of them to the right version of the CRD
           path: sample-tests/__snapshots__
+          ignoreErrors:
+            - "ignore this match"
       - matchSnapshot:
           path: sample-tests/__snapshots__
           # generates a yaml file

pkg/generate.go

@@ -1,6 +1,7 @@
 package pkg
 
 import (
+	"encoding/base64"
 	"fmt"
 	"io"
 	"os"
@@ -240,6 +241,10 @@ func outputValueType(v v1beta1.JSONSchemaProps, skipRandom bool) string {
 			return "2024-10-11T12:48:44Z"
 		}
 
+		if v.Format == "byte" {
+			return base64.StdEncoding.EncodeToString([]byte("string"))
+		}
+
 		return st
 	case "integer":
 		if v.Minimum != nil {

pkg/matches/matchsnapshot/matcher.go

@@ -17,9 +17,11 @@ import (
 const MatcherName = "matchSnapshot"
 
 type Config struct {
-	Path    string `yaml:"path"`
-	Minimal bool   `yaml:"minimal"`
+	Path         string   `yaml:"path"`
+	IgnoreErrors []string `yaml:"ignoreErrors,omitempty"`
+	Minimal      bool     `yaml:"minimal"`
 }
+
 type Matcher struct {
 	Updater Updater
 }
@@ -92,7 +94,7 @@ func (m *Matcher) Match(ctx context.Context, crdLocation string, payload []byte)
 			return fmt.Errorf("failed to read snapshot template: %w", err)
 		}
 
-		if err := matches.Validate(content, snapshotContent); err != nil {
+		if err := matches.Validate(content, snapshotContent, c.IgnoreErrors); err != nil {
 			validationErrors = errors.Join(validationErrors, err)
 		}
 	}

pkg/matches/matchsnapshot/update.go

@@ -50,7 +50,7 @@ func (u *Update) Update(sourceTemplateLocation string, targetSnapshotLocation st
 			return fmt.Errorf("failed to open file %s: %w", filepath.Join(targetSnapshotLocation, name), err)
 		}
 
-		parser := pkg.NewParser(schemaType.Group, schemaType.Kind, false, minimal, false)
+		parser := pkg.NewParser(schemaType.Group, schemaType.Kind, false, minimal, true)
 		if err := parser.ParseProperties(version.Name, file, version.Schema.Properties, pkg.RootRequiredFields); err != nil {
 			_ = file.Close()
 

pkg/matches/matchstring/matcher.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 	"os"
 
-	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/util/yaml"
 
 	"github.com/Skarlso/crd-to-sample-yaml/pkg/matches"
@@ -14,8 +13,12 @@ import (
 
 type Matcher struct{}
 
+type Config struct {
+	IgnoreErrors []string `yaml:"ignoreErrors,omitempty"`
+}
+
 func (m *Matcher) Match(_ context.Context, crdLocation string, payload []byte) error {
-	c := &apiextensionsv1.JSON{}
+	c := &Config{}
 	if err := yaml.Unmarshal(payload, &c); err != nil {
 		return err
 	}
@@ -25,7 +28,7 @@ func (m *Matcher) Match(_ context.Context, crdLocation string, payload []byte) e
 		return fmt.Errorf("error reading file %s: %w", crdLocation, err)
 	}
 
-	return matches.Validate(crdContent, payload)
+	return matches.Validate(crdContent, payload, c.IgnoreErrors)
 }
 
 func init() {

pkg/matches/validate.go

@@ -15,7 +15,7 @@ import (
 const maxBufferSize = 2048
 
 // Validate takes a source CRD and a sample file and validates its contents against the CRD definition.
-func Validate(sourceCRD []byte, sampleFile []byte) error {
+func Validate(sourceCRD []byte, sampleFile []byte, ignoreErrors []string) error {
 	reader := yaml.NewYAMLOrJSONDecoder(bytes.NewReader(sampleFile), maxBufferSize)
 	obj := &unstructured.Unstructured{}
 	err := reader.Decode(obj)
@@ -29,7 +29,7 @@ func Validate(sourceCRD []byte, sampleFile []byte) error {
 	}
 
 	if crd.Spec.Validation != nil && len(crd.Spec.Versions) == 0 {
-		return ValidateCRDValidation(crd, sampleFile)
+		return ValidateCRDValidation(crd, sampleFile, ignoreErrors)
 	}
 
 	availableVersions := make([]string, 0, len(crd.Spec.Versions))
@@ -41,7 +41,7 @@ func Validate(sourceCRD []byte, sampleFile []byte) error {
 		// Make sure we are only testing versions that equal to the CRD's version.
 		// This is important in case there are multiple versions in the CRD.
 		if obj.GroupVersionKind().Version == v.Name {
-			if err := validate(v.Schema.OpenAPIV3Schema, obj, crd.Spec.Names.Kind, v.Name); err != nil {
+			if err := validate(v.Schema.OpenAPIV3Schema, obj, crd.Spec.Names.Kind, v.Name, ignoreErrors); err != nil {
 				return fmt.Errorf("failed to validate kind %s and version %s: %w", crd.Spec.Names.Kind, v.Name, err)
 			}
 
@@ -56,26 +56,33 @@ func Validate(sourceCRD []byte, sampleFile []byte) error {
 	)
 }
 
-func ValidateCRDValidation(crd *apiextensions.CustomResourceDefinition, sampleFile []byte) error {
+func ValidateCRDValidation(crd *apiextensions.CustomResourceDefinition, sampleFile []byte, ignoreErrors []string) error {
 	reader := yaml.NewYAMLOrJSONDecoder(bytes.NewReader(sampleFile), maxBufferSize)
 	obj := &unstructured.Unstructured{}
 	err := reader.Decode(obj)
 	if err != nil {
 		return fmt.Errorf("failed to decode sample file: %w", err)
 	}
 
-	return validate(crd.Spec.Validation.OpenAPIV3Schema, obj, crd.Spec.Names.Kind, crd.Name)
+	return validate(crd.Spec.Validation.OpenAPIV3Schema, obj, crd.Spec.Names.Kind, crd.Name, ignoreErrors)
 }
 
-func validate(props *apiextensions.JSONSchemaProps, obj *unstructured.Unstructured, kind, name string) error {
+func validate(props *apiextensions.JSONSchemaProps, obj *unstructured.Unstructured, kind, name string, ignoreErrors []string) error {
 	eval, _, err := validation.NewSchemaValidator(props)
 	if err != nil {
 		return fmt.Errorf("invalid schema: %w", err)
 	}
 
 	var resultErrors error
 	result := eval.Validate(obj)
+loop:
 	for _, e := range result.Errors {
+		for _, ignore := range ignoreErrors {
+			if strings.Contains(e.Error(), ignore) {
+				continue loop
+			}
+		}
+
 		resultErrors = errors.Join(resultErrors, e)
 	}
 

sample-tests/__snapshots__/bootstrap_crd-v1alpha1.yaml

@@ -48,9 +48,9 @@ status:
   - lastTransitionTime: 2024-10-11T12:48:44Z
     message: string
     observedGeneration: 0
-    reason: w # ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
-    status: "True"
-    type: 2.ik2p.6.i/Q # ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
+    reason: string
+    status: "True" # "True", "False", "Unknown"
+    type: string
   lastAppliedCRDNames: {}
   lastAppliedRevision: string
   lastAttemptedRevision: string

sample-tests/__snapshots__/infrastructure.cluster.x-k8s.io_awsclusters-v1beta1.yaml

@@ -16,11 +16,11 @@ spec:
     additionalSecurityGroups: [] # minItems 0 of type string
     crossZoneLoadBalancing: true
     healthCheckProtocol: string
-    name: OyI7Q3Hn4r # ^[A-Za-z0-9]([A-Za-z0-9]{0,31}|[-A-Za-z0-9]{0,30}[A-Za-z0-9])$
+    name: string
     scheme: "internet-facing"
     subnets: [] # minItems 0 of type string
   identityRef:
-    kind: "AWSClusterControllerIdentity"
+    kind: "AWSClusterControllerIdentity" # "AWSClusterControllerIdentity", "AWSClusterRoleIdentity", "AWSClusterStaticIdentity"
     name: string
   imageLookupBaseOS: string
   imageLookupFormat: string
@@ -57,7 +57,7 @@ spec:
   region: string
   s3Bucket:
     controlPlaneIAMInstanceProfile: string
-    name: pls.vm9y # ^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$
+    name: string
     nodesIAMInstanceProfiles: [] # minItems 0 of type string
   sshKeyName: string
 status:

sample-tests/__snapshots__/infrastructure.cluster.x-k8s.io_awsclusters-v1beta2.yaml

@@ -16,11 +16,11 @@ spec:
     additionalSecurityGroups: [] # minItems 0 of type string
     crossZoneLoadBalancing: true
     healthCheckProtocol: string
-    name: IxmzTD4eEFJ # ^[A-Za-z0-9]([A-Za-z0-9]{0,31}|[-A-Za-z0-9]{0,30}[A-Za-z0-9])$
+    name: string
     scheme: "internet-facing"
     subnets: [] # minItems 0 of type string
   identityRef:
-    kind: "AWSClusterControllerIdentity"
+    kind: "AWSClusterControllerIdentity" # "AWSClusterControllerIdentity", "AWSClusterRoleIdentity", "AWSClusterStaticIdentity"
     name: string
   imageLookupBaseOS: string
   imageLookupFormat: string
@@ -57,7 +57,7 @@ spec:
   region: string
   s3Bucket:
     controlPlaneIAMInstanceProfile: string
-    name: x7-n6fza # ^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$
+    name: string
     nodesIAMInstanceProfiles: [] # minItems 0 of type string
   sshKeyName: string
 status: