Skip to content

Enable validation based on mappings by default #2410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 17, 2025
Merged

Enable validation based on mappings by default #2410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cd24f7f
Set by default validation based on mappings
mrodm Feb 14, 2025
2ff0a93
Remove technical preview
mrodm Feb 14, 2025
1d00e53
Update docs env. var
mrodm Feb 14, 2025
c7a5ee7
Update system testing docs
mrodm Feb 14, 2025
8e7fc3b
Re-generate README
mrodm Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions .buildkite/pipeline.trigger.integration.tests.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,22 +110,6 @@ echo " artifact_paths:"
echo " - build/test-results/*.xml"
echo " - build/test-coverage/coverage-*.xml" # these files should not be used to compute the final coverage of elastic-package

# Add steps to test validation method mappings
while IFS= read -r -d '' package ; do
package_name=$(basename "${package}")
echo " - label: \":go: Integration test: ${package_name} (validate mappings)\""
echo " key: \"integration-parallel-${package_name}-agent-validate-mappings\""
echo " command: ./.buildkite/scripts/integration_tests.sh -t test-check-packages-parallel -p ${package_name}"
echo " env:"
echo " UPLOAD_SAFE_LOGS: 1"
echo " ELASTIC_PACKAGE_FIELD_VALIDATION_TEST_METHOD: mappings"
echo " agents:"
echo " provider: \"gcp\""
echo " image: \"${UBUNTU_X86_64_AGENT_IMAGE}\""
echo " artifact_paths:"
echo " - build/test-results/*.xml"
echo " - build/test-coverage/coverage-*.xml" # these files should not be used to compute the final coverage of elastic-package
done < <(find . -maxdepth 1 -mindepth 1 -type d -print0)
popd > /dev/null

# TODO: Missing docker & docker-compose in MACOS ARM agent image, skip installation of packages in the meantime.
Expand Down
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,10 +689,11 @@ There are available some environment variables that could be used to change some
- `ELASTIC_PACKAGE_TEST_ENABLE_INDEPENDENT_AGENT`. If the variable is set to false, all system tests defined in the package will use
the Elastic Agent started along with the stack. If set to true, a new Elastic Agent will be started and enrolled for each test defined in the
package (and unenrolled at the end of each test). Default: `true`.
- `ELASTIC_PACKAGE_FIELD_VALIDATION_TEST_METHOD`. This variable can take one of these values: `all`, `mappings` or `fields`. If this
variable is set to `fields`, then validation of fields will be based on the documents ingested into Elasticsearch. If this is set to
`mappings`, then validation of fields will be based on the mappings generated when the documents are ingested into Elasticsearch. If
set to `all`, then validation will be based on both methods mentioned previously. Default option: `fields`.
- `ELASTIC_PACKAGE_FIELD_VALIDATION_TEST_METHOD`. This variable can take one of these values: `mappings` or `fields`. If this
variable is set to `fields`, then validation of fields will be based on the contents of the documents ingested into Elasticsearch. If this is set to
`mappings`, then validation of fields will be based on their mappings generated when the documents are ingested into Elasticsearch as well as
the contents of the documents ingested into Elasticsearch.
Default option: `mappings`.

- To configure the Elastic stack to be used by `elastic-package`:
- `ELASTIC_PACKAGE_ELASTICSEARCH_HOST`: Host of the elasticsearch (e.g. https://127.0.0.1:9200)
Expand Down
2 changes: 2 additions & 0 deletions docs/howto/system_testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Conceptually, running a system test involves the following steps:
1. Validate mappings are defined for the fields contained in the indexed documents.
1. Validate that the JSON data types contained `_source` are compatible with
mappings declared for the field.
1. Validate mappings generated after ingesting documents are valid according to the definitions installed by the package.
- Requires `ELASTIC_PACKAGE_FIELD_VALIDATION_TEST_METHOD` to be unset or set to `mappings`.
1. If the Elastic Agent from the stack is not used, unenroll and remove the Elastic Agent as well as the test policies created.
1. Delete test artifacts and tear down the instance of the package's integration service.
1. Once the data stream have been system tested, unenroll and remove the Elastic Agent
Expand Down
6 changes: 3 additions & 3 deletions internal/testrunner/runners/system/tester.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,8 +288,8 @@ func NewSystemTester(options SystemTesterOptions) (*tester, error) {
r.runIndependentElasticAgent = strings.ToLower(v) == "true"
}

// default method using just fields
r.fieldValidationMethod = fieldsMethod
// default method to validate using mappings (along with fields)
r.fieldValidationMethod = mappingsMethod
v, ok = os.LookupEnv(fieldValidationTestMethodEnv)
if ok {
method, ok := validationMethods[v]
Expand Down Expand Up @@ -1646,7 +1646,7 @@ func (r *tester) validateTestScenario(ctx context.Context, result *testrunner.Re
}

if r.fieldValidationMethod == mappingsMethod {
logger.Warn("Validation based on mappings enabled (technical preview)")
logger.Debug("Performing validation based on mappings")
Copy link
Contributor Author

@mrodm mrodm Feb 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Took the advantage of removing the technical preview status, since it is going to be enabled by default.

I thought that maybe this message could help to identify if the validation based on mappings has been executed or not. WDYT ?

exceptionFields := listExceptionFields(scenario.docs, fieldsValidator)

mappingsValidator, err := fields.CreateValidatorForMappings(r.esClient,
Expand Down
9 changes: 5 additions & 4 deletions tools/readme/readme.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,10 +243,11 @@ There are available some environment variables that could be used to change some
- `ELASTIC_PACKAGE_TEST_ENABLE_INDEPENDENT_AGENT`. If the variable is set to false, all system tests defined in the package will use
the Elastic Agent started along with the stack. If set to true, a new Elastic Agent will be started and enrolled for each test defined in the
package (and unenrolled at the end of each test). Default: `true`.
- `ELASTIC_PACKAGE_FIELD_VALIDATION_TEST_METHOD`. This variable can take one of these values: `all`, `mappings` or `fields`. If this
variable is set to `fields`, then validation of fields will be based on the documents ingested into Elasticsearch. If this is set to
`mappings`, then validation of fields will be based on the mappings generated when the documents are ingested into Elasticsearch. If
set to `all`, then validation will be based on both methods mentioned previously. Default option: `fields`.
- `ELASTIC_PACKAGE_FIELD_VALIDATION_TEST_METHOD`. This variable can take one of these values: `mappings` or `fields`. If this
variable is set to `fields`, then validation of fields will be based on the contents of the documents ingested into Elasticsearch. If this is set to
`mappings`, then validation of fields will be based on their mappings generated when the documents are ingested into Elasticsearch as well as
the contents of the documents ingested into Elasticsearch.
Default option: `mappings`.

- To configure the Elastic stack to be used by `elastic-package`:
- `ELASTIC_PACKAGE_ELASTICSEARCH_HOST`: Host of the elasticsearch (e.g. https://127.0.0.1:9200)
Expand Down