chore: add validation to error out early for accessLog

envoyproxy · Aug 31, 2023 · 87c955b · 87c955b
1 parent 51d3b99
commit 87c955b
Show file tree

Hide file tree

Showing 2 changed files with 109 additions and 0 deletions.
diff --git a/api/config/v1alpha1/validation/validate.go b/api/config/v1alpha1/validation/validate.go
@@ -56,6 +56,12 @@ func validateEnvoyProxySpec(spec *egcfgv1a1.EnvoyProxySpec) error {
 			errs = append(errs, err)
 		}
 	}
+
+	validateProxyTelemetryErrs := validateProxyTelemetry(spec)
+	if len(validateProxyTelemetryErrs) != 0 {
+		errs = append(errs, validateProxyTelemetryErrs...)
+	}
+
 	return utilerrors.NewAggregate(errs)
 }
 
@@ -156,3 +162,54 @@ func validateBootstrap(boostrapConfig *egcfgv1a1.ProxyBootstrap) error {
 
 	return nil
 }
+
+func validateProxyTelemetry(spec *egcfgv1a1.EnvoyProxySpec) []error {
+	var errs []error
+
+	if spec != nil && spec.Telemetry.AccessLog != nil {
+		accessLogErrs := validateProxyAccessLog(spec.Telemetry.AccessLog)
+		if len(accessLogErrs) > 0 {
+			errs = append(errs, accessLogErrs...)
+		}
+	}
+
+	return errs
+}
+
+func validateProxyAccessLog(accessLog *egcfgv1a1.ProxyAccessLog) []error {
+	if accessLog.Disable {
+		return nil
+	}
+
+	var errs []error
+
+	for _, setting := range accessLog.Settings {
+		switch setting.Format.Type {
+		case egcfgv1a1.ProxyAccessLogFormatTypeText:
+			if setting.Format.Text == nil {
+				err := fmt.Errorf("unable to configure access log when using Text format but \"text\" field being empty")
+				errs = append(errs, err)
+			}
+		case egcfgv1a1.ProxyAccessLogFormatTypeJSON:
+			if setting.Format.JSON == nil {
+				err := fmt.Errorf("unable to configure access log when using JSON format but \"json\" field being empty")
+				errs = append(errs, err)
+			}
+		}
+
+		for _, sink := range setting.Sinks {
+			switch sink.Type {
+			case egcfgv1a1.ProxyAccessLogSinkTypeFile:
+				if sink.File == nil {
+					err := fmt.Errorf("unable to configure access log when using File sink type but \"file\" field being empty")
+					errs = append(errs, err)
+				}
+			case egcfgv1a1.ProxyAccessLogSinkTypeOpenTelemetry:
+				err := fmt.Errorf("unable to configure access log when using OpenTelemetry sink type but \"openTelemetry\" field being empty")
+				errs = append(errs, err)
+			}
+		}
+	}
+
+	return errs
+}
diff --git a/api/config/v1alpha1/validation/validate_test.go b/api/config/v1alpha1/validation/validate_test.go
@@ -246,6 +246,58 @@ func TestValidateEnvoyProxy(t *testing.T) {
 			},
 			expected: false,
 		},
+		{
+			name: "should invalid when accesslog enabled using Text format, but `text` field being empty",
+			proxy: &egcfgv1a1.EnvoyProxy{
+				ObjectMeta: metav1.ObjectMeta{
+					Namespace: "test",
+					Name:      "test",
+				},
+				Spec: egcfgv1a1.EnvoyProxySpec{
+					Telemetry: egcfgv1a1.ProxyTelemetry{
+						AccessLog: &egcfgv1a1.ProxyAccessLog{
+							Settings: []egcfgv1a1.ProxyAccessLogSetting{
+								{
+									Format: egcfgv1a1.ProxyAccessLogFormat{
+										Type: egcfgv1a1.ProxyAccessLogFormatTypeText,
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+			expected: false,
+		},
+		{
+			name: "should invalid when accesslog enabled using File sink, but `file` field being empty",
+			proxy: &egcfgv1a1.EnvoyProxy{
+				ObjectMeta: metav1.ObjectMeta{
+					Namespace: "test",
+					Name:      "test",
+				},
+				Spec: egcfgv1a1.EnvoyProxySpec{
+					Telemetry: egcfgv1a1.ProxyTelemetry{
+						AccessLog: &egcfgv1a1.ProxyAccessLog{
+							Settings: []egcfgv1a1.ProxyAccessLogSetting{
+								{
+									Format: egcfgv1a1.ProxyAccessLogFormat{
+										Type: egcfgv1a1.ProxyAccessLogFormatTypeText,
+										Text: pointer.String("[%START_TIME%]"),
+									},
+									Sinks: []egcfgv1a1.ProxyAccessLogSink{
+										{
+											Type: egcfgv1a1.ProxyAccessLogSinkTypeFile,
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+			expected: false,
+		},
 	}
 
 	for i := range testCases {