(feat): Improved Error Messages for watchNamespace Configuration

Author: camilamacedo86

internal/operator-controller/config/config.go

@@ -267,6 +267,11 @@ func formatSingleError(errUnit jsonschema.OutputUnit) string {
 		// Unknown/additional field
 		fieldName := extractFieldNameFromMessage(errUnit.Error)
 		if fieldName != "" {
+			// Special case: if watchNamespace is rejected as unknown, it means only
+			// AllNamespaces install mode is supported
+			if fieldName == "watchNamespace" {
+				return fmt.Sprintf("field %q not allowed: only AllNamespaces install mode is supported", fieldName)
+			}
 			return fmt.Sprintf("unknown field %q", fieldName)
 		}
 		return "unknown field"

internal/operator-controller/config/config_test.go

@@ -80,22 +80,22 @@ func Test_UnmarshalConfig(t *testing.T) {
 			expectedErrMessage:    `got object, want string`,
 		},
 		{
-			name:                  "rejects with unknown field when install modes {AllNamespaces}",
+			name:                  "rejects with descriptive message when install modes {AllNamespaces}",
 			supportedInstallModes: []v1alpha1.InstallModeType{v1alpha1.InstallModeTypeAllNamespaces},
 			rawConfig:             []byte(`{"watchNamespace": "some-namespace"}`),
-			expectedErrMessage:    `unknown field "watchNamespace"`,
+			expectedErrMessage:    `field "watchNamespace" not allowed: only AllNamespaces install mode is supported`,
 		},
 		{
-			name:                  "rejects with unknown field when install modes {MultiNamespace}",
+			name:                  "rejects with descriptive message when install modes {MultiNamespace}",
 			supportedInstallModes: []v1alpha1.InstallModeType{v1alpha1.InstallModeTypeMultiNamespace},
 			rawConfig:             []byte(`{"watchNamespace": "some-namespace"}`),
-			expectedErrMessage:    `unknown field "watchNamespace"`,
+			expectedErrMessage:    `field "watchNamespace" not allowed: only AllNamespaces install mode is supported`,
 		},
 		{
-			name:                  "reject with unknown field when install modes {AllNamespaces, MultiNamespace}",
+			name:                  "reject with descriptive message when install modes {AllNamespaces, MultiNamespace}",
 			supportedInstallModes: []v1alpha1.InstallModeType{v1alpha1.InstallModeTypeAllNamespaces, v1alpha1.InstallModeTypeMultiNamespace},
 			rawConfig:             []byte(`{"watchNamespace": "some-namespace"}`),
-			expectedErrMessage:    `unknown field "watchNamespace"`,
+			expectedErrMessage:    `field "watchNamespace" not allowed: only AllNamespaces install mode is supported`,
 		},
 		{
 			name:                  "reject with required field when install modes {OwnNamespace} and watchNamespace is null",