Move linters config validation into intialization

Author: JoelSpeed

pkg/analysis/registry.go

@@ -57,10 +57,6 @@ type Registry interface {
 	// InitializeLinters returns a set of newly initialized linters based on the
 	// provided configuration.
 	InitializeLinters(config.Linters, config.LintersConfig) ([]*analysis.Analyzer, error)
-
-	// ValidateLintersConfig validates the provided linters config
-	// against the set or registered linters.
-	ValidateLintersConfig(config.Linters, config.LintersConfig, *field.Path) field.ErrorList
 }
 
 type registry struct {
@@ -120,6 +116,10 @@ func (r *registry) AllLinters() sets.Set[string] {
 
 // InitializeLinters returns a list of initialized linters based on the provided config.
 func (r *registry) InitializeLinters(cfg config.Linters, lintersCfg config.LintersConfig) ([]*analysis.Analyzer, error) {
+	if errs := r.validateLintersConfig(cfg, lintersCfg, field.NewPath("lintersConfig")); len(errs) > 0 {
+		return nil, fmt.Errorf("error validating linters config: %w", errs.ToAggregate())
+	}
+
 	analyzers := []*analysis.Analyzer{}
 	errs := []error{}
 
@@ -147,9 +147,9 @@ func (r *registry) InitializeLinters(cfg config.Linters, lintersCfg config.Linte
 	return analyzers, kerrors.NewAggregate(errs)
 }
 
-// ValidateLintersConfig validates the provided linters config
+// validateLintersConfig validates the provided linters config
 // against the set or registered linters.
-func (r *registry) ValidateLintersConfig(cfg config.Linters, lintersCfg config.LintersConfig, fieldPath *field.Path) field.ErrorList {
+func (r *registry) validateLintersConfig(cfg config.Linters, lintersCfg config.LintersConfig, fieldPath *field.Path) field.ErrorList {
 	fieldErrors := field.ErrorList{}
 	validatedLinters := sets.New[string]()
 

pkg/analysis/registry_test.go

@@ -22,7 +22,6 @@ import (
 
 	goanalysis "golang.org/x/tools/go/analysis"
 	"k8s.io/apimachinery/pkg/util/sets"
-	"k8s.io/apimachinery/pkg/util/validation/field"
 
 	"sigs.k8s.io/kube-api-linter/pkg/analysis"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/jsontags"
@@ -142,20 +141,20 @@ var _ = Describe("Registry", func() {
 		)
 	})
 
-	Context("ValidateLintersConfig", func() {
+	Context("Config validation", func() {
 		type validateLintersConfigTableInput struct {
 			linters     config.Linters
 			config      config.LintersConfig
 			expectedErr string
 		}
 
-		DescribeTable("Validate Linters Configuration", func(in validateLintersConfigTableInput) {
+		DescribeTable("Validate Linters Configuration through Initialization", func(in validateLintersConfigTableInput) {
 			r := analysis.NewRegistry()
-			errs := r.ValidateLintersConfig(in.linters, in.config, field.NewPath("lintersConfig"))
+			_, err := r.InitializeLinters(in.linters, in.config)
 			if len(in.expectedErr) > 0 {
-				Expect(errs.ToAggregate()).To(MatchError(in.expectedErr))
+				Expect(err).To(MatchError(in.expectedErr))
 			} else {
-				Expect(errs).To(HaveLen(0), "No errors were expected")
+				Expect(err).To(Not(HaveOccurred()), "No errors were expected")
 			}
 		},
 			Entry("Empty config", validateLintersConfigTableInput{
@@ -178,7 +177,7 @@ var _ = Describe("Registry", func() {
 						JSONTagRegex: "^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*",
 					}),
 				},
-				expectedErr: "lintersConfig.jsontags.jsonTagRegex: Invalid value: \"^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*\": invalid regex: error parsing regexp: missing closing ): `^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*`",
+				expectedErr: "error validating linters config: lintersConfig.jsontags.jsonTagRegex: Invalid value: \"^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*\": invalid regex: error parsing regexp: missing closing ): `^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*`",
 			}),
 			Entry("With a valid JSONTagsConfig JSONTagRegex (legacy field name)", validateLintersConfigTableInput{
 				linters: config.Linters{},
@@ -194,9 +193,43 @@ var _ = Describe("Registry", func() {
 						JSONTagRegex: "^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*",
 					}),
 				},
-				expectedErr: "lintersConfig.jsontags.jsonTagRegex: Invalid value: \"^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*\": invalid regex: error parsing regexp: missing closing ): `^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*`",
+				expectedErr: "error validating linters config: lintersConfig.jsontags.jsonTagRegex: Invalid value: \"^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*\": invalid regex: error parsing regexp: missing closing ): `^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*`",
 			}),
 
+			Entry("With a valid OptionalOrRequiredConfig (legacy field name)", validateLintersConfigTableInput{
+				config: config.LintersConfig{
+					"optionalorrequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+						PreferredOptionalMarker: markers.OptionalMarker,
+						PreferredRequiredMarker: markers.RequiredMarker,
+					}),
+				},
+				expectedErr: "",
+			}),
+			Entry("With kubebuilder preferred markers (legacy field name)", validateLintersConfigTableInput{
+				config: config.LintersConfig{
+					"optionalorrequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+						PreferredOptionalMarker: markers.KubebuilderOptionalMarker,
+						PreferredRequiredMarker: markers.KubebuilderRequiredMarker,
+					}),
+				},
+				expectedErr: "",
+			}),
+			Entry("With invalid preferred optional marker (legacy field name)", validateLintersConfigTableInput{
+				config: config.LintersConfig{
+					"optionalorrequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+						PreferredOptionalMarker: "invalid",
+					}),
+				},
+				expectedErr: "error validating linters config: lintersConfig.optionalorrequired.preferredOptionalMarker: Invalid value: \"invalid\": invalid value, must be one of \"optional\", \"kubebuilder:validation:Optional\" or omitted",
+			}),
+			Entry("With invalid preferred required marker (legacy field name)", validateLintersConfigTableInput{
+				config: config.LintersConfig{
+					"optionalorrequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+						PreferredRequiredMarker: "invalid",
+					}),
+				},
+				expectedErr: "error validating linters config: lintersConfig.optionalorrequired.preferredRequiredMarker: Invalid value: \"invalid\": invalid value, must be one of \"required\", \"kubebuilder:validation:Required\" or omitted",
+			}),
 			Entry("With a valid OptionalOrRequiredConfig (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
 					"optionalOrRequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
@@ -221,15 +254,15 @@ var _ = Describe("Registry", func() {
 						PreferredOptionalMarker: "invalid",
 					}),
 				},
-				expectedErr: "lintersConfig.optionalorrequired.preferredOptionalMarker: Invalid value: \"invalid\": invalid value, must be one of \"optional\", \"kubebuilder:validation:Optional\" or omitted",
+				expectedErr: "error validating linters config: lintersConfig.optionalorrequired.preferredOptionalMarker: Invalid value: \"invalid\": invalid value, must be one of \"optional\", \"kubebuilder:validation:Optional\" or omitted",
 			}),
 			Entry("With invalid preferred required marker (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
 					"optionalOrRequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
 						PreferredRequiredMarker: "invalid",
 					}),
 				},
-				expectedErr: "lintersConfig.optionalorrequired.preferredRequiredMarker: Invalid value: \"invalid\": invalid value, must be one of \"required\", \"kubebuilder:validation:Required\" or omitted",
+				expectedErr: "error validating linters config: lintersConfig.optionalorrequired.preferredRequiredMarker: Invalid value: \"invalid\": invalid value, must be one of \"required\", \"kubebuilder:validation:Required\" or omitted",
 			}),
 		)
 	})

pkg/validation/config.go

@@ -17,7 +17,6 @@ package validation
 
 import (
 	"k8s.io/apimachinery/pkg/util/validation/field"
-	"sigs.k8s.io/kube-api-linter/pkg/analysis"
 	"sigs.k8s.io/kube-api-linter/pkg/config"
 )
 
@@ -31,7 +30,6 @@ func ValidateGolangCIConfig(g config.GolangCIConfig, fldPath *field.Path) error
 	var fieldErrors field.ErrorList
 
 	fieldErrors = append(fieldErrors, ValidateLinters(g.Linters, fldPath.Child("linters"))...)
-	fieldErrors = append(fieldErrors, analysis.NewRegistry().ValidateLintersConfig(g.Linters, g.LintersConfig, fldPath.Child("lintersConfig"))...)
 
 	return fieldErrors.ToAggregate()
 }