Add dynamic signal types system test support

docs/howto/system_testing.md

@@ -534,12 +534,14 @@ for system tests.
 | policy_template | string |  | Name of policy template associated with the data stream and input. Required when multiple policy templates include the input being tested. |
 | service | string |  | Name of a specific Docker service to setup for the test. |
 | service_notify_signal | string |  | Signal name to send to 'service' when the test policy has been applied to the Agent. This can be used to trigger the service after the Agent is ready to receive data. |
+| signal_types | []string |  | For otel packages with dynamic_signal_types, this specifies which signal data streams to assert on. Otherwise all detected data streams for the dataset will be asserted against. 
 | skip.link | URL |  | URL linking to an issue about why the test is skipped. |
 | skip.reason | string |  | Reason to skip the test. If specified the test will not execute. |
 | skip_ignored_fields | array string |  | List of fields to be skipped when performing validation of fields ignored during ingestion. |
 | skip_transform_validation | boolean |  | Disable or enable the transforms validation performed in system tests. |
 | vars | dictionary |  | Package level variables to set (i.e. declared in `$package_root/manifest.yml`). If not specified the defaults from the manifest are used. |
 | wait_for_data_timeout | duration |  | Amount of time to wait for data to be present in Elasticsearch. Defaults to 10m. |
+| wait_for_dynamic_streams_stable | duration |  | For packages with dynamic data streams (e.g. `dynamic_signal_types`), minimum time the discovered data stream count must stay unchanged after the first stream appears before discovery completes. Defaults to 10s. |
 
 For example, the `apache/access` data stream's `test-access-log-config.yml` is
 shown below.

internal/docs/readme_test.go

@@ -5,6 +5,7 @@
 package docs
 
 import (
+	"fmt"
 	"os"
 	"path/filepath"
 	"testing"
@@ -16,6 +17,21 @@ import (
 	"github.com/elastic/elastic-package/internal/packages"
 )
 
+const (
+	sampleEventReadmeTemplateRel = "_dev/build/docs/README.md"
+	sampleEventReadmeDocPrefix   = `{{- generatedHeader }}
+# README
+Introduction to the package
+`
+)
+
+func readmeEventTemplateLine(eventTarget string) string {
+	if eventTarget == "" {
+		return "{{ event }}"
+	}
+	return fmt.Sprintf(`{{ event %q }}`, eventTarget)
+}
+
 func TestGenerateReadme(t *testing.T) {
 	cases := []struct {
 		title                  string
@@ -134,59 +150,107 @@ http://www.example.com/bar
 
 func TestRenderReadmeWithSampleEvent(t *testing.T) {
 	cases := []struct {
-		title                   string
-		packageRoot             string
-		templatePath            string
-		dataStreamName          string
-		readmeTemplateContents  string
-		sampleEventJsonContents string
-		expected                string
+		title        string
+		eventTarget  string // data stream folder and {{ event "…" }} argument; empty → package root and {{ event }}
+		plainValue   string // if set, writes sample_event.json with JSON {"v": plainValue}
+		namedSamples []string
+		expected     string
 	}{
 		{
-			title:        "README with sample event",
-			packageRoot:  t.TempDir(),
-			templatePath: "_dev/build/docs/README.md",
-			readmeTemplateContents: `
-{{- generatedHeader }}
+			title:       "README with sample event",
+			eventTarget: "example",
+			plainValue:  "event1",
+			expected: `<!-- NOTICE: Do not edit this file manually.-->
+<!-- This file is automatically generated by Elastic Package -->
 # README
 Introduction to the package
-{{ event "example" }}`,
+An example event for ` + "`example`" + ` looks as following:
+
+` + "```json" + `
+{
+    "v": "event1"
+}
+` + "```" + "\n",
+		},
+		{
+			title:        "named sample_event_*.json only uses first lexicographic basename",
+			eventTarget:  "otel_ds",
+			namedSamples: []string{"metrics", "logs"},
 			expected: `<!-- NOTICE: Do not edit this file manually.-->
 <!-- This file is automatically generated by Elastic Package -->
 # README
 Introduction to the package
-An example event for ` + "`example`" + ` looks as following:
+An example event for ` + "`otel_ds`" + ` looks as following:
+
+` + "```json" + `
+{
+    "v": "logs"
+}
+` + "```" + "\n",
+		},
+		{
+			title:        "sample_event.json is preferred over sample_event_*.json",
+			eventTarget:  "otel_ds",
+			plainValue:   "plain",
+			namedSamples: []string{"logs"},
+			expected: `<!-- NOTICE: Do not edit this file manually.-->
+<!-- This file is automatically generated by Elastic Package -->
+# README
+Introduction to the package
+An example event for ` + "`otel_ds`" + ` looks as following:
+
+` + "```json" + `
+{
+    "v": "plain"
+}
+` + "```" + "\n",
+		},
+		{
+			title:        "package root: named sample_event_*.json files only uses first lexicographic basename",
+			eventTarget:  "",
+			namedSamples: []string{"metrics", "logs"},
+			expected: `<!-- NOTICE: Do not edit this file manually.-->
+<!-- This file is automatically generated by Elastic Package -->
+# README
+Introduction to the package
+An example event looks as following:
 
 ` + "```json" + `
 {
-    "id": "event1"
+    "v": "logs"
 }
-` + "```",
-			dataStreamName:          "example",
-			sampleEventJsonContents: `{"id": "event1"}`,
+` + "```" + "\n",
 		},
 	}
 
 	linksMap := newEmptyLinkMap()
 	urls := fields.SchemaURLs{}
 	for _, c := range cases {
 		t.Run(c.title, func(t *testing.T) {
-			filename := filepath.Base(c.templatePath)
-			templatePath := filepath.Join(c.packageRoot, c.templatePath)
+			packageRoot := t.TempDir()
+			filename := filepath.Base(sampleEventReadmeTemplateRel)
+			templatePath := filepath.Join(packageRoot, sampleEventReadmeTemplateRel)
 
-			createReadmeTemplateFile(t, c.packageRoot, c.readmeTemplateContents)
-			createSampleEventFile(t, c.packageRoot, c.dataStreamName, c.sampleEventJsonContents)
-			createManifestFile(t, c.packageRoot)
+			readmeContents := sampleEventReadmeDocPrefix + readmeEventTemplateLine(c.eventTarget) + "\n"
+			createReadmeTemplateFile(t, packageRoot, readmeContents)
 
-			root, err := os.OpenRoot(c.packageRoot)
+			ds := c.eventTarget
+			if c.plainValue != "" {
+				createSampleEventFile(t, packageRoot, ds, fmt.Sprintf(`{"v": %q}`, c.plainValue))
+			}
+			for _, name := range c.namedSamples {
+				createNamedSampleEventFile(t, packageRoot, ds, name, fmt.Sprintf(`{"v": %q}`, name))
+			}
+			createManifestFile(t, packageRoot)
+
+			root, err := os.OpenRoot(packageRoot)
 			require.NoError(t, err)
 			t.Cleanup(func() { root.Close() })
 
-			rendered, err := renderReadme(root, filename, c.packageRoot, templatePath, linksMap, urls)
+			rendered, err := renderReadme(root, filename, packageRoot, templatePath, linksMap, urls)
 			require.NoError(t, err)
 
-			renderedString := string(rendered)
-			assert.Equal(t, c.expected, renderedString)
+			assert.Equal(t, c.expected, string(rendered))
 		})
 	}
 }
@@ -500,10 +564,26 @@ func createDocsFolder(t *testing.T, packageRoot string) string {
 
 func createSampleEventFile(t *testing.T, packageRoot, dataStreamName, contents string) {
 	t.Helper()
-	dataStreamFolder := createDataStreamFolder(t, packageRoot, dataStreamName)
+	writeSampleEventAt(t, packageRoot, dataStreamName, sampleEventFile, contents)
+}
+
+// createNamedSampleEventFile writes sample_event_<name>.json.
+func createNamedSampleEventFile(t *testing.T, packageRoot, dataStreamName, name, contents string) {
+	t.Helper()
+	require.NotEmpty(t, name, "sample event name is required")
+	writeSampleEventAt(t, packageRoot, dataStreamName, fmt.Sprintf("sample_event_%s.json", name), contents)
+}
 
-	sampleEventFile := filepath.Join(dataStreamFolder, sampleEventFile)
-	err := os.WriteFile(sampleEventFile, []byte(contents), 0644)
+func writeSampleEventAt(t *testing.T, packageRoot, dataStreamName, fileName, contents string) {
+	t.Helper()
+	var dir string
+	if dataStreamName == "" {
+		dir = packageRoot
+	} else {
+		dir = createDataStreamFolder(t, packageRoot, dataStreamName)
+	}
+	path := filepath.Join(dir, fileName)
+	err := os.WriteFile(path, []byte(contents), 0644)
 	require.NoError(t, err)
 }
 

internal/docs/sample_event.go

@@ -9,6 +9,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"sort"
 	"strings"
 
 	"github.com/Masterminds/semver/v3"
@@ -20,11 +21,15 @@ import (
 const sampleEventFile = "sample_event.json"
 
 func renderSampleEvent(packageRoot, dataStreamName string) (string, error) {
-	var eventPath string
+	var dir string
 	if dataStreamName == "" {
-		eventPath = filepath.Join(packageRoot, sampleEventFile)
+		dir = packageRoot
 	} else {
-		eventPath = filepath.Join(packageRoot, "data_stream", dataStreamName, sampleEventFile)
+		dir = filepath.Join(packageRoot, "data_stream", dataStreamName)
+	}
+	eventPath, err := resolveSampleEventPath(dir)
+	if err != nil {
+		return "", err
 	}
 
 	body, err := os.ReadFile(eventPath)
@@ -60,6 +65,27 @@ func renderSampleEvent(packageRoot, dataStreamName string) (string, error) {
 	return builder.String(), nil
 }
 
+func resolveSampleEventPath(dir string) (string, error) {
+	plain := filepath.Join(dir, sampleEventFile)
+	if info, err := os.Stat(plain); err == nil && !info.IsDir() {
+		return plain, nil
+	}
+
+	matches, err := filepath.Glob(filepath.Join(dir, "sample_event_*.json"))
+	if err != nil {
+		return "", fmt.Errorf("glob sample_event_*.json failed (dir: %s): %w", dir, err)
+	}
+	if len(matches) == 0 {
+		return "", fmt.Errorf("sample event file not found (looked for %s and sample_event_*.json under %s): %w",
+			sampleEventFile, dir, os.ErrNotExist)
+	}
+
+	sort.Slice(matches, func(i, j int) bool {
+		return filepath.Base(matches[i]) < filepath.Base(matches[j])
+	})
+	return matches[0], nil
+}
+
 func stripDataStreamFolderSuffix(dataStreamName string) string {
 	dataStreamName = strings.ReplaceAll(dataStreamName, "_metrics", "")
 	dataStreamName = strings.ReplaceAll(dataStreamName, "_logs", "")

internal/packages/packages.go

@@ -221,10 +221,11 @@ type PolicyTemplate struct {
 	Inputs      []Input  `config:"inputs,omitempty" json:"inputs,omitempty" yaml:"inputs,omitempty"`
 
 	// For purposes of "input packages"
-	Input        string     `config:"input,omitempty" json:"input,omitempty" yaml:"input,omitempty"`
-	Type         string     `config:"type,omitempty" json:"type,omitempty" yaml:"type,omitempty"`
-	TemplatePath string     `config:"template_path,omitempty" json:"template_path,omitempty" yaml:"template_path,omitempty"`
-	Vars         []Variable `config:"vars,omitempty" json:"vars,omitempty" yaml:"vars,omitempty"`
+	Input              string     `config:"input,omitempty" json:"input,omitempty" yaml:"input,omitempty"`
+	Type               string     `config:"type,omitempty" json:"type,omitempty" yaml:"type,omitempty"`
+	DynamicSignalTypes bool       `config:"dynamic_signal_types,omitempty" json:"dynamic_signal_types,omitempty" yaml:"dynamic_signal_types,omitempty"`
+	TemplatePath       string     `config:"template_path,omitempty" json:"template_path,omitempty" yaml:"template_path,omitempty"`
+	Vars               []Variable `config:"vars,omitempty" json:"vars,omitempty" yaml:"vars,omitempty"`
 }
 
 // Owner defines package owners, either a single person or a team.

internal/testrunner/runners/static/runner.go

@@ -20,6 +20,7 @@ const (
 	TestType testrunner.TestType = "static"
 
 	sampleEventJSON = "sample_event.json"
+	sampleEventGlob = "sample_event*.json"
 )
 
 type runner struct {