LOG-8007: Make AzureMonitor LogType a required, non-empty field

Author: vparfonov

api/observability/v1/output_types.go

@@ -306,9 +306,11 @@ type AzureMonitor struct {
 	// Can only contain letters, numbers, and underscores (_), and may not exceed 100 characters.
 	// https://learn.microsoft.com/en-us/azure/azure-monitor/logs/data-collector-api?tabs=powershell#request-headers
 	//
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength:=1
 	// +kubebuilder:validation:Pattern:="^[a-zA-Z0-9][a-zA-Z0-9_]{0,99}$"
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Log Type",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
-	LogType string `json:"logType,omitempty"`
+	LogType string `json:"logType"`
 
 	// AzureResourceId the Resource ID of the Azure resource the data should be associated with.
 	// https://learn.microsoft.com/en-us/azure/azure-monitor/logs/data-collector-api?tabs=powershell#request-headers

bundle/manifests/observability.openshift.io_clusterlogforwarders.yaml

@@ -1833,6 +1833,7 @@ spec:
                             LogType the record type of the data that is being submitted.
                             Can only contain letters, numbers, and underscores (_), and may not exceed 100 characters.
                             https://learn.microsoft.com/en-us/azure/azure-monitor/logs/data-collector-api?tabs=powershell#request-headers
+                          minLength: 1
                           pattern: ^[a-zA-Z0-9][a-zA-Z0-9_]{0,99}$
                           type: string
                         tuning:
@@ -1870,6 +1871,7 @@ spec:
                       required:
                       - authentication
                       - customerId
+                      - logType
                       type: object
                     cloudwatch:
                       description: Cloudwatch configures forwarding log events to

config/crd/bases/observability.openshift.io_clusterlogforwarders.yaml

@@ -1833,6 +1833,7 @@ spec:
                             LogType the record type of the data that is being submitted.
                             Can only contain letters, numbers, and underscores (_), and may not exceed 100 characters.
                             https://learn.microsoft.com/en-us/azure/azure-monitor/logs/data-collector-api?tabs=powershell#request-headers
+                          minLength: 1
                           pattern: ^[a-zA-Z0-9][a-zA-Z0-9_]{0,99}$
                           type: string
                         tuning:
@@ -1870,6 +1871,7 @@ spec:
                       required:
                       - authentication
                       - customerId
+                      - logType
                       type: object
                     cloudwatch:
                       description: Cloudwatch configures forwarding log events to

test/e2e/collection/apivalidations/api_validations_test.go

@@ -112,5 +112,13 @@ var _ = Describe("", func() {
 		Entry("should fail for OTLP with non http URL", "otlp_valid_non_http.yaml", func(out string, err error) {
 			Expect(err).To(HaveOccurred())
 		}),
+		Entry("should fail for AzureMonitor with empty LogType", "azure-monitor-empty-logtype.yaml", func(out string, err error) {
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(MatchRegexp("azureMonitor.logType in body should be at least 1 chars long"))
+		}),
+		Entry("should fail for AzureMonitor if no LogType", "azure-monitor-no-logtype.yaml", func(out string, err error) {
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(MatchRegexp("azureMonitor.logType: Required value"))
+		}),
 	)
 })

test/e2e/collection/apivalidations/azure-monitor-empty-logtype.yaml

@@ -0,0 +1,30 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: my-secret
+data:
+  shared_key: Zm9vLWJhci1rZXk=
+---
+apiVersion: "observability.openshift.io/v1"
+kind: ClusterLogForwarder
+metadata:
+  name: clf-validation-test
+spec:
+  serviceAccount:
+    name: mine
+  outputs:
+    - name: app-logs-azure
+      type: azureMonitor
+      azureMonitor:
+        authentication:
+          sharedKey:
+            key: shared_key
+            secretName: my-secret
+        customerId: 1111-111-1111-1111-11111
+        logType: ""
+  pipelines:
+    - name: my-logs
+      inputRefs:
+        - application
+      outputRefs:
+        - app-logs-azure

test/e2e/collection/apivalidations/azure-monitor-no-logtype.yaml

@@ -0,0 +1,29 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: my-secret
+data:
+  shared_key: Zm9vLWJhci1rZXk=
+---
+apiVersion: "observability.openshift.io/v1"
+kind: ClusterLogForwarder
+metadata:
+  name: clf-validation-test
+spec:
+  serviceAccount:
+    name: mine
+  outputs:
+    - name: app-logs-azure
+      type: azureMonitor
+      azureMonitor:
+        authentication:
+          sharedKey:
+            key: shared_key
+            secretName: my-secret
+        customerId: 1111-111-1111-1111-11111
+  pipelines:
+    - name: my-logs
+      inputRefs:
+        - application
+      outputRefs:
+        - app-logs-azure