Package org.opensearch.test.rest.yaml

package org.opensearch.test.rest.yaml

Infrastructure to run suites of tests written in YAML against a running OpenSearch cluster using OpenSearch's low level REST client. The YAML tests are run by all official clients and serve as tests for both OpenSearch and the clients.

Related Packages

Package	Description
org.opensearch.test.rest	Infrastructure for testing REST.
org.opensearch.test.rest.yaml.restspec	Specification of REST endpoints used to convert YAML do sections into actual calls to OpenSearch.
org.opensearch.test.rest.yaml.section	Sections within the YAML tests that are executed to run the tests.

Class	Description
ClientYamlDocsTestClient	Used to execute REST requests according to the docs snippets that need to be tests.
ClientYamlTestCandidate	Wraps ClientYamlTestSections ready to be run.
ClientYamlTestClient	Used by OpenSearchClientYamlSuiteTestCase to execute REST requests according to the tests written in yaml suite files.
ClientYamlTestExecutionContext	Execution context passed across the REST tests.
ClientYamlTestResponse	Response obtained from a REST call, eagerly reads the response body into a string for later optional parsing.
ClientYamlTestResponseException	Exception obtained from a REST call in case the response code indicated an error.
Features	Allows to register additional features supported by the tests runner.
ObjectPath	Holds an object and allows to extract specific values from it given their path
OpenSearchClientYamlSuiteTestCase	Runs a suite of yaml tests shared with all the official OpenSearch clients against an opensearch cluster.
Stash	Allows to cache the last obtained test response and or part of it within variables that can be used as input values in following requests and assertions.