Add samples to nginx package

Author: jsoriano

internal/testrunner/runners/system/runner.go

@@ -720,7 +720,7 @@ func (r *runner) runTest(config *testConfig, ctxt servicedeployer.ServiceContext
 	}
 
 	// Write sample events file from first doc, if requested
-	if err := r.generateTestResult(docs); err != nil {
+	if err := r.generateTestResult(config, docs); err != nil {
 		return result.WithError(err)
 	}
 
@@ -1183,13 +1183,18 @@ func filterAgents(allAgents []kibana.Agent, ctx servicedeployer.ServiceContext)
 	return filtered
 }
 
-func writeSampleEvent(path string, doc common.MapStr) error {
+func writeSampleEvent(path string, doc common.MapStr, name string) error {
 	body, err := json.MarshalIndent(doc, "", "    ")
 	if err != nil {
 		return fmt.Errorf("marshalling sample event failed: %w", err)
 	}
 
-	err = os.WriteFile(filepath.Join(path, "sample_event.json"), body, 0644)
+	sampleName := "sample_event.json"
+	if name != "" {
+		sampleName = "sample_event_" + name + ".json"
+	}
+
+	err = os.WriteFile(filepath.Join(path, sampleName), body, 0644)
 	if err != nil {
 		return fmt.Errorf("writing sample event failed: %w", err)
 	}
@@ -1249,7 +1254,7 @@ func (r *runner) selectVariants(variantsFile *servicedeployer.VariantsFile) []st
 	return variantNames
 }
 
-func (r *runner) generateTestResult(docs []common.MapStr) error {
+func (r *runner) generateTestResult(config *testConfig, docs []common.MapStr) error {
 	if !r.options.GenerateTestResult {
 		return nil
 	}
@@ -1259,8 +1264,27 @@ func (r *runner) generateTestResult(docs []common.MapStr) error {
 		rootPath = filepath.Join(rootPath, "data_stream", ds)
 	}
 
-	if err := writeSampleEvent(rootPath, docs[0]); err != nil {
-		return fmt.Errorf("failed to write sample event file: %w", err)
+	if len(config.Samples) == 0 {
+		if err := writeSampleEvent(rootPath, docs[0], ""); err != nil {
+			return fmt.Errorf("failed to write sample event file: %w", err)
+		}
+		return nil
+	}
+
+	for _, sample := range config.Samples {
+		found := false
+		for _, doc := range docs {
+			if sample.Matches(doc) {
+				if err := writeSampleEvent(rootPath, docs[0], sample.Name); err != nil {
+					return fmt.Errorf("failed to write sample event file: %w", err)
+				}
+				found = true
+				break
+			}
+		}
+		if !found {
+			return fmt.Errorf("could not find sample for %q", sample.Name)
+		}
 	}
 
 	return nil

test/packages/parallel/nginx/data_stream/access/_dev/test/system/test-default-config.yml

@@ -3,3 +3,8 @@ data_stream:
   vars:
     paths:
       - "{{SERVICE_LOGS_DIR}}/access.log*"
+samples:
+  - name: "200"
+    condition:
+      key: "http.response.status_code"
+      value: "200"

test/packages/parallel/nginx/data_stream/access/sample_event.json

@@ -0,0 +1,113 @@
+{
+    "@timestamp": "2023-08-30T21:58:41.000Z",
+    "_tmp": {},
+    "agent": {
+        "ephemeral_id": "539ad62b-52e5-459a-8412-ab7c327cfd3e",
+        "id": "1fa30280-2acf-49e3-834c-cb600d113118",
+        "name": "docker-fleet-agent",
+        "type": "filebeat",
+        "version": "8.8.2"
+    },
+    "data_stream": {
+        "dataset": "nginx.access",
+        "namespace": "ep",
+        "type": "logs"
+    },
+    "ecs": {
+        "version": "1.12.0"
+    },
+    "elastic_agent": {
+        "id": "1fa30280-2acf-49e3-834c-cb600d113118",
+        "snapshot": false,
+        "version": "8.8.2"
+    },
+    "event": {
+        "agent_id_status": "verified",
+        "category": [
+            "web"
+        ],
+        "created": "2023-08-30T21:58:57.127Z",
+        "dataset": "nginx.access",
+        "ingested": "2023-08-30T21:58:58Z",
+        "kind": "event",
+        "outcome": "success",
+        "timezone": "+00:00",
+        "type": [
+            "access"
+        ]
+    },
+    "host": {
+        "architecture": "x86_64",
+        "containerized": false,
+        "hostname": "docker-fleet-agent",
+        "id": "f61391496aaa43bb94736676494450c5",
+        "ip": [
+            "172.19.0.7"
+        ],
+        "mac": [
+            "02-42-AC-13-00-07"
+        ],
+        "name": "docker-fleet-agent",
+        "os": {
+            "codename": "focal",
+            "family": "debian",
+            "kernel": "5.19.0-50-generic",
+            "name": "Ubuntu",
+            "platform": "ubuntu",
+            "type": "linux",
+            "version": "20.04.6 LTS (Focal Fossa)"
+        }
+    },
+    "http": {
+        "request": {
+            "method": "get"
+        },
+        "response": {
+            "body": {
+                "bytes": 97
+            },
+            "status_code": 200
+        },
+        "version": "1.1"
+    },
+    "input": {
+        "type": "log"
+    },
+    "log": {
+        "file": {
+            "path": "/tmp/service_logs/access.log"
+        },
+        "offset": 0
+    },
+    "nginx": {
+        "access": {
+            "remote_ip_list": [
+                "127.0.0.1"
+            ]
+        }
+    },
+    "related": {
+        "ip": [
+            "127.0.0.1"
+        ]
+    },
+    "source": {
+        "address": "127.0.0.1",
+        "ip": "127.0.0.1"
+    },
+    "tags": [
+        "nginx-access"
+    ],
+    "url": {
+        "original": "/server-status",
+        "path": "/server-status"
+    },
+    "user_agent": {
+        "device": {
+            "name": "Other"
+        },
+        "name": "curl",
+        "original": "curl/7.64.0",
+        "version": "7.64.0"
+    }
+}