Add validation of linter configuration

Author: JoelSpeed

pkg/validation/linters_config.go

@@ -32,6 +32,7 @@ func ValidateLintersConfig(lc config.LintersConfig, fldPath *field.Path) field.E
 	fieldErrors = append(fieldErrors, validateConditionsConfig(lc.Conditions, fldPath.Child("conditions"))...)
 	fieldErrors = append(fieldErrors, validateJSONTagsConfig(lc.JSONTags, fldPath.Child("jsonTags"))...)
 	fieldErrors = append(fieldErrors, validateNoMapsConfig(lc.NoMaps, fldPath.Child("nomaps"))...)
+	fieldErrors = append(fieldErrors, validateOptionalFieldsConfig(lc.OptionalFields, fldPath.Child("optionalFields"))...)
 	fieldErrors = append(fieldErrors, validateOptionalOrRequiredConfig(lc.OptionalOrRequired, fldPath.Child("optionalOrRequired"))...)
 	fieldErrors = append(fieldErrors, validateRequiredFieldsConfig(lc.RequiredFields, fldPath.Child("requiredFields"))...)
 
@@ -90,6 +91,48 @@ func validateNoMapsConfig(nmc config.NoMapsConfig, fldPath *field.Path) field.Er
 	return fieldErrors
 }
 
+// validateOptionalFieldsConfig is used to validate the configuration in the config.OptionalFieldsConfig struct.
+func validateOptionalFieldsConfig(ofc config.OptionalFieldsConfig, fldPath *field.Path) field.ErrorList {
+	fieldErrors := field.ErrorList{}
+
+	fieldErrors = append(fieldErrors, validateOptionFieldsPointers(ofc.Pointers, fldPath.Child("pointers"))...)
+	fieldErrors = append(fieldErrors, validateOptionFieldsOmitEmpty(ofc.OmitEmpty, fldPath.Child("omitEmpty"))...)
+
+	return fieldErrors
+}
+
+// validateOptionFieldsPointers is used to validate the configuration in the config.OptionalFieldsPointers struct.
+func validateOptionFieldsPointers(opc config.OptionalFieldsPointers, fldPath *field.Path) field.ErrorList {
+	fieldErrors := field.ErrorList{}
+
+	switch opc.Preference {
+	case "", config.OptionalFieldsPointerPreferenceAlways, config.OptionalFieldsPointerPreferenceWhenRequired:
+	default:
+		fieldErrors = append(fieldErrors, field.Invalid(fldPath.Child("preference"), opc.Preference, fmt.Sprintf("invalid value, must be one of %q, %q or omitted", config.OptionalFieldsPointerPreferenceAlways, config.OptionalFieldsPointerPreferenceWhenRequired)))
+	}
+
+	switch opc.Policy {
+	case "", config.OptionalFieldsPointerPolicySuggestFix, config.OptionalFieldsPointerPolicyWarn:
+	default:
+		fieldErrors = append(fieldErrors, field.Invalid(fldPath.Child("policy"), opc.Policy, fmt.Sprintf("invalid value, must be one of %q, %q or omitted", config.OptionalFieldsPointerPolicySuggestFix, config.OptionalFieldsPointerPolicyWarn)))
+	}
+
+	return fieldErrors
+}
+
+// validateOptionFieldsOmitEmpty is used to validate the configuration in the config.OptionalFieldsOmitEmpty struct.
+func validateOptionFieldsOmitEmpty(oec config.OptionalFieldsOmitEmpty, fldPath *field.Path) field.ErrorList {
+	fieldErrors := field.ErrorList{}
+
+	switch oec.Policy {
+	case "", config.OptionalFieldsOmitEmptyPolicyIgnore, config.OptionalFieldsOmitEmptyPolicySuggestFix:
+	default:
+		fieldErrors = append(fieldErrors, field.Invalid(fldPath.Child("policy"), oec.Policy, fmt.Sprintf("invalid value, must be one of %q, %q or omitted", config.OptionalFieldsOmitEmptyPolicyIgnore, config.OptionalFieldsOmitEmptyPolicySuggestFix)))
+	}
+
+	return fieldErrors
+}
+
 // validateOptionalOrRequiredConfig is used to validate the configuration in the config.OptionalOrRequiredConfig struct.
 func validateOptionalOrRequiredConfig(oorc config.OptionalOrRequiredConfig, fldPath *field.Path) field.ErrorList {
 	fieldErrors := field.ErrorList{}

pkg/validation/linters_config_test.go

@@ -221,6 +221,112 @@ var _ = Describe("LintersConfig", func() {
 			expectedErr: `lintersConfig.nomaps.policy: Invalid value: "invalid": invalid value, must be one of "Enforce", "AllowStringToStringMaps", "Ignore" or omitted`,
 		}),
 
+		// OptionalFieldsConfig validation
+		Entry("With a valid OptionalFieldsConfig", validateLintersConfigTableInput{
+			config: config.LintersConfig{
+				OptionalFields: config.OptionalFieldsConfig{
+					Pointers: config.OptionalFieldsPointers{
+						Preference: "",
+						Policy:     "",
+					},
+					OmitEmpty: config.OptionalFieldsOmitEmpty{
+						Policy: "",
+					},
+				},
+			},
+			expectedErr: "",
+		}),
+		Entry("With a valid OptionalFieldsConfig: Pointer Preference Always", validateLintersConfigTableInput{
+			config: config.LintersConfig{
+				OptionalFields: config.OptionalFieldsConfig{
+					Pointers: config.OptionalFieldsPointers{
+						Preference: config.OptionalFieldsPointerPreferenceAlways,
+					},
+				},
+			},
+			expectedErr: "",
+		}),
+		Entry("With a valid OptionalFieldsConfig: Pointer Preference WhenRequired", validateLintersConfigTableInput{
+			config: config.LintersConfig{
+				OptionalFields: config.OptionalFieldsConfig{
+					Pointers: config.OptionalFieldsPointers{
+						Preference: config.OptionalFieldsPointerPreferenceWhenRequired,
+					},
+				},
+			},
+			expectedErr: "",
+		}),
+		Entry("With an invalid OptionalFieldsConfig: Pointer Preference", validateLintersConfigTableInput{
+			config: config.LintersConfig{
+				OptionalFields: config.OptionalFieldsConfig{
+					Pointers: config.OptionalFieldsPointers{
+						Preference: "invalid",
+					},
+				},
+			},
+			expectedErr: "lintersConfig.optionalFields.pointers.preference: Invalid value: \"invalid\": invalid value, must be one of \"Always\", \"WhenRequired\" or omitted",
+		}),
+		Entry("With a valid OptionalFieldsConfig: Pointer Policy SuggestFix", validateLintersConfigTableInput{
+			config: config.LintersConfig{
+				OptionalFields: config.OptionalFieldsConfig{
+					Pointers: config.OptionalFieldsPointers{
+						Policy: config.OptionalFieldsPointerPolicySuggestFix,
+					},
+				},
+			},
+			expectedErr: "",
+		}),
+		Entry("With a valid OptionalFieldsConfig: Pointer Policy Warn", validateLintersConfigTableInput{
+			config: config.LintersConfig{
+				OptionalFields: config.OptionalFieldsConfig{
+					Pointers: config.OptionalFieldsPointers{
+						Policy: config.OptionalFieldsPointerPolicyWarn,
+					},
+				},
+			},
+			expectedErr: "",
+		}),
+		Entry("With an invalid OptionalFieldsConfig: Pointer Policy", validateLintersConfigTableInput{
+			config: config.LintersConfig{
+				OptionalFields: config.OptionalFieldsConfig{
+					Pointers: config.OptionalFieldsPointers{
+						Policy: "invalid",
+					},
+				},
+			},
+			expectedErr: "lintersConfig.optionalFields.pointers.policy: Invalid value: \"invalid\": invalid value, must be one of \"SuggestFix\", \"Warn\" or omitted",
+		}),
+		Entry("With a valid OptionalFieldsConfig: OmitEmpty Policy Ignore", validateLintersConfigTableInput{
+			config: config.LintersConfig{
+				OptionalFields: config.OptionalFieldsConfig{
+					OmitEmpty: config.OptionalFieldsOmitEmpty{
+						Policy: config.OptionalFieldsOmitEmptyPolicyIgnore,
+					},
+				},
+			},
+			expectedErr: "",
+		}),
+		Entry("With a valid OptionalFieldsConfig: OmitEmpty Policy SuggestFix", validateLintersConfigTableInput{
+			config: config.LintersConfig{
+				OptionalFields: config.OptionalFieldsConfig{
+					OmitEmpty: config.OptionalFieldsOmitEmpty{
+						Policy: config.OptionalFieldsOmitEmptyPolicySuggestFix,
+					},
+				},
+			},
+			expectedErr: "",
+		}),
+		Entry("With an invalid OptionalFieldsConfig: OmitEmpty Policy", validateLintersConfigTableInput{
+			config: config.LintersConfig{
+				OptionalFields: config.OptionalFieldsConfig{
+					OmitEmpty: config.OptionalFieldsOmitEmpty{
+						Policy: "invalid",
+					},
+				},
+			},
+			expectedErr: "lintersConfig.optionalFields.omitEmpty.policy: Invalid value: \"invalid\": invalid value, must be one of \"Ignore\", \"SuggestFix\" or omitted",
+		}),
+
 		// OptionalOrRequiredConfig validation
 		Entry("With a valid OptionalOrRequiredConfig", validateLintersConfigTableInput{
 			config: config.LintersConfig{