Merge pull request #101 from doom/allow-local-crds-flag-to-receive-mu…

…ltiple-values

Allow `--local-crds` flag to receive multiple values

pkg/cmd/validate.go

@@ -59,7 +59,7 @@ type commandFlags struct {
 	kubeConfigOverrides clientcmd.ConfigOverrides
 	version             string
 	localSchemasDir     string
-	localCRDsDir        string
+	localCRDsDir        []string
 	schemaPatchesDir    string
 	outputFormat        OutputFormat
 }
@@ -79,7 +79,7 @@ func NewRootCommand() *cobra.Command {
 	}
 	res.Flags().StringVarP(&invoked.version, "version", "", invoked.version, "Kubernetes version to validate native resources against. Required if not connected directly to cluster")
 	res.Flags().StringVarP(&invoked.localSchemasDir, "local-schemas", "", "", "--local-schemas=./path/to/schemas/dir. Path to a directory with format: /apis/<group>/<version>.json for each group-version's schema.")
-	res.Flags().StringVarP(&invoked.localCRDsDir, "local-crds", "", "", "--local-crds=./path/to/crds/dir. Path to a directory containing .yaml or .yml files for CRD definitions.")
+	res.Flags().StringSliceVarP(&invoked.localCRDsDir, "local-crds", "", []string{}, "--local-crds=./path/to/crds/dir. Paths to directories containing .yaml or .yml files for CRD definitions.")
 	res.Flags().StringVarP(&invoked.schemaPatchesDir, "schema-patches", "", "", "Path to a directory with format: /apis/<group>/<version>.json for each group-version's schema you wish to jsonpatch to the groupversion's final schema. Patches only apply if the schema exists")
 	res.Flags().VarP(&invoked.outputFormat, "output", "o", "Output format. Choice of: \"human\" or \"json\"")
 	clientcmd.BindOverrideFlags(&invoked.kubeConfigOverrides, res.Flags(), clientcmd.RecommendedConfigOverrideFlags("kube-"))

pkg/openapiclient/local_crds.go

@@ -33,55 +33,60 @@ var metadataSchemas map[string]*spec.Schema = func() map[string]*spec.Schema {
 
 // client which provides openapi read from files on disk
 type localCRDsClient struct {
-	fs  fs.FS
-	dir string
+	fs   fs.FS
+	dirs []string
 }
 
 // Dir should have openapi files following directory layout:
 // myCRD.yaml (groupversions read from file)
-func NewLocalCRDFiles(fs fs.FS, dirPath string) openapi.Client {
+func NewLocalCRDFiles(fs fs.FS, dirPaths []string) openapi.Client {
 	return &localCRDsClient{
-		fs:  fs,
-		dir: dirPath,
+		fs:   fs,
+		dirs: dirPaths,
 	}
 }
 
 func (k *localCRDsClient) Paths() (map[string]openapi.GroupVersion, error) {
-	if len(k.dir) == 0 {
+	if len(k.dirs) == 0 {
 		return nil, nil
 	}
-	files, err := utils.ReadDir(k.fs, k.dir)
-	if err != nil {
-		return nil, fmt.Errorf("error listing %s: %w", k.dir, err)
-	}
 	var documents []utils.Document
-	for _, f := range files {
-		path := filepath.Join(k.dir, f.Name())
-		if f.IsDir() {
-			continue
+
+	for _, dir := range k.dirs {
+		files, err := utils.ReadDir(k.fs, dir)
+		if err != nil {
+			return nil, fmt.Errorf("error listing %s: %w", dir, err)
 		}
-		if utils.IsJson(f.Name()) {
-			fileBytes, err := utils.ReadFile(k.fs, path)
-			if err != nil {
-				return nil, fmt.Errorf("failed to read %s: %w", path, err)
-			}
-			documents = append(documents, fileBytes)
-		} else if utils.IsYaml(f.Name()) {
-			fileBytes, err := utils.ReadFile(k.fs, path)
-			if err != nil {
-				return nil, fmt.Errorf("failed to read %s: %w", path, err)
-			}
-			yamlDocs, err := utils.SplitYamlDocuments(fileBytes)
-			if err != nil {
-				return nil, fmt.Errorf("failed to read %s: %w", path, err)
+
+		for _, f := range files {
+			path := filepath.Join(dir, f.Name())
+			if f.IsDir() {
+				continue
 			}
-			for _, document := range yamlDocs {
-				if !utils.IsEmptyYamlDocument(document) {
-					documents = append(documents, document)
+			if utils.IsJson(f.Name()) {
+				fileBytes, err := utils.ReadFile(k.fs, path)
+				if err != nil {
+					return nil, fmt.Errorf("failed to read %s: %w", path, err)
+				}
+				documents = append(documents, fileBytes)
+			} else if utils.IsYaml(f.Name()) {
+				fileBytes, err := utils.ReadFile(k.fs, path)
+				if err != nil {
+					return nil, fmt.Errorf("failed to read %s: %w", path, err)
+				}
+				yamlDocs, err := utils.SplitYamlDocuments(fileBytes)
+				if err != nil {
+					return nil, fmt.Errorf("failed to read %s: %w", path, err)
+				}
+				for _, document := range yamlDocs {
+					if !utils.IsEmptyYamlDocument(document) {
+						documents = append(documents, document)
+					}
 				}
 			}
 		}
 	}
+
 	codecs := serializer.NewCodecFactory(apiserver.Scheme).UniversalDecoder()
 	crds := map[schema.GroupVersion]*spec3.OpenAPI{}
 	for _, document := range documents {

pkg/openapiclient/local_crds_test.go

@@ -14,18 +14,24 @@ import (
 
 func TestNewLocalCRDFiles(t *testing.T) {
 	tests := []struct {
-		name    string
-		fs      fs.FS
-		dirPath string
-		want    openapi.Client
+		name     string
+		fs       fs.FS
+		dirPaths []string
+		want     openapi.Client
 	}{{
 		name: "fs nil and dir empty",
 		want: &localCRDsClient{},
 	}, {
-		name:    "only dir",
-		dirPath: "test",
+		name:     "only dir",
+		dirPaths: []string{"test"},
 		want: &localCRDsClient{
-			dir: "test",
+			dirs: []string{"test"},
+		},
+	}, {
+		name:     "multiple dirs",
+		dirPaths: []string{"test", "test2"},
+		want: &localCRDsClient{
+			dirs: []string{"test", "test2"},
 		},
 	}, {
 		name: "only fs",
@@ -34,17 +40,17 @@ func TestNewLocalCRDFiles(t *testing.T) {
 			fs: os.DirFS("."),
 		},
 	}, {
-		name:    "both fs and dir",
-		fs:      os.DirFS("."),
-		dirPath: "test",
+		name:     "both fs and dir",
+		fs:       os.DirFS("."),
+		dirPaths: []string{"test"},
 		want: &localCRDsClient{
-			fs:  os.DirFS("."),
-			dir: "test",
+			fs:   os.DirFS("."),
+			dirs: []string{"test"},
 		},
 	}}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got := NewLocalCRDFiles(tt.fs, tt.dirPath)
+			got := NewLocalCRDFiles(tt.fs, tt.dirPaths)
 			require.Equal(t, tt.want, got, "NewLocalCRDFiles not equal")
 		})
 	}
@@ -54,14 +60,14 @@ func Test_localCRDsClient_Paths(t *testing.T) {
 	tests := []struct {
 		name    string
 		fs      fs.FS
-		dir     string
+		dirs    []string
 		want    map[string]sets.Set[string]
 		wantErr bool
 	}{{
 		name: "fs nil and dir empty",
 	}, {
 		name: "only dir",
-		dir:  "../../testcases/crds",
+		dirs: []string{"../../testcases/crds"},
 		want: map[string]sets.Set[string]{
 			"apis/batch.x-k8s.io/v1alpha1": sets.New(
 				"batch.x-k8s.io/v1alpha1.JobSet",
@@ -80,13 +86,37 @@ func Test_localCRDsClient_Paths(t *testing.T) {
 				"cert-manager.io/v1.Issuer",
 			),
 		},
+	}, {
+		name: "multiple dirs",
+		dirs: []string{"../../testcases/crds", "../../testcases/more-crds"},
+		want: map[string]sets.Set[string]{
+			"apis/batch.x-k8s.io/v1alpha1": sets.New(
+				"batch.x-k8s.io/v1alpha1.JobSet",
+			),
+			"apis/stable.example.com/v1": sets.New(
+				"stable.example.com/v1.CELBasic",
+			),
+			"apis/acme.cert-manager.io/v1": sets.New(
+				"acme.cert-manager.io/v1.Challenge",
+				"acme.cert-manager.io/v1.Order",
+			),
+			"apis/cert-manager.io/v1": sets.New(
+				"cert-manager.io/v1.Certificate",
+				"cert-manager.io/v1.CertificateRequest",
+				"cert-manager.io/v1.ClusterIssuer",
+				"cert-manager.io/v1.Issuer",
+			),
+			"apis/externaldns.k8s.io/v1alpha1": sets.New(
+				"externaldns.k8s.io/v1alpha1.DNSEndpoint",
+			),
+		},
 	}, {
 		name: "only fs",
 		fs:   os.DirFS("../../testcases/crds"),
 	}, {
 		name: "both fs and dir",
 		fs:   os.DirFS("../../testcases"),
-		dir:  "crds",
+		dirs: []string{"crds"},
 		want: map[string]sets.Set[string]{
 			"apis/batch.x-k8s.io/v1alpha1": sets.New(
 				"batch.x-k8s.io/v1alpha1.JobSet",
@@ -107,17 +137,17 @@ func Test_localCRDsClient_Paths(t *testing.T) {
 		},
 	}, {
 		name:    "invalid dir",
-		dir:     "invalid",
+		dirs:    []string{"invalid"},
 		wantErr: true,
 	}, {
 		name:    "invalid fs",
 		fs:      os.DirFS("../../invalid"),
-		dir:     ".",
+		dirs:    []string{"."},
 		wantErr: true,
 	}}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			k := NewLocalCRDFiles(tt.fs, tt.dir)
+			k := NewLocalCRDFiles(tt.fs, tt.dirs)
 			paths, err := k.Paths()
 			if (err != nil) != tt.wantErr {
 				t.Errorf("localCRDsClient.Paths() error = %v, wantErr %v", err, tt.wantErr)

pkg/validator/factory_test.go

@@ -42,7 +42,7 @@ func TestValidatorFactory_TestPatcher(t *testing.T) {
 		{
 			name:   "cronjob_crd",
 			file:   "./testdata/cronjob.yaml",
-			client: openapiclient.NewLocalCRDFiles(nil, "./testdata/crds/"),
+			client: openapiclient.NewLocalCRDFiles(nil, []string{"./testdata/crds/"}),
 			want: &unstructured.Unstructured{
 				Object: map[string]interface{}{
 					"apiVersion": "batch.tutorial.kubebuilder.io/v1",

testcases/more-crds/dnsendpoints.yaml

@@ -0,0 +1,93 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.5.0
+    api-approved.kubernetes.io: "https://github.com/kubernetes-sigs/external-dns/pull/2007"
+  creationTimestamp: null
+  name: dnsendpoints.externaldns.k8s.io
+spec:
+  group: externaldns.k8s.io
+  names:
+    kind: DNSEndpoint
+    listKind: DNSEndpointList
+    plural: dnsendpoints
+    singular: dnsendpoint
+  scope: Namespaced
+  versions:
+    - name: v1alpha1
+      schema:
+        openAPIV3Schema:
+          properties:
+            apiVersion:
+              description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+              type: string
+            kind:
+              description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+              type: string
+            metadata:
+              type: object
+            spec:
+              description: DNSEndpointSpec defines the desired state of DNSEndpoint
+              properties:
+                endpoints:
+                  items:
+                    description: Endpoint is a high-level way of a connection between a service and an IP
+                    properties:
+                      dnsName:
+                        description: The hostname of the DNS record
+                        type: string
+                      labels:
+                        additionalProperties:
+                          type: string
+                        description: Labels stores labels defined for the Endpoint
+                        type: object
+                      providerSpecific:
+                        description: ProviderSpecific stores provider specific config
+                        items:
+                          description: ProviderSpecificProperty holds the name and value of a configuration which is specific to individual DNS providers
+                          properties:
+                            name:
+                              type: string
+                            value:
+                              type: string
+                          type: object
+                        type: array
+                      recordTTL:
+                        description: TTL for the record
+                        format: int64
+                        type: integer
+                      recordType:
+                        description: RecordType type of record, e.g. CNAME, A, SRV, TXT etc
+                        type: string
+                      setIdentifier:
+                        description: Identifier to distinguish multiple records with the same name and type (e.g. Route53 records with routing policies other than 'simple')
+                        type: string
+                      targets:
+                        description: The targets the DNS record points to
+                        items:
+                          type: string
+                        type: array
+                    type: object
+                  type: array
+              type: object
+            status:
+              description: DNSEndpointStatus defines the observed state of DNSEndpoint
+              properties:
+                observedGeneration:
+                  description: The generation observed by the external-dns controller.
+                  format: int64
+                  type: integer
+              type: object
+          type: object
+      served: true
+      storage: true
+      subresources:
+        status: {}
+status:
+  acceptedNames:
+    kind: ""
+    plural: ""
+  conditions: []
+  storedVersions: []