Environment Object

The environment object describes the execution environment, system configuration, and build context for the test run. It captures metadata about where and how tests were executed, enabling correlation with CI/CD pipelines and infrastructure.

Properties

Name	Type	Required	Description
reportName	String	Optional	A human-readable name for this report.
appName	String	Optional	The name of the application under test.
appVersion	String	Optional	The version of the application under test.
buildId	String	Optional	A unique identifier for the CI/CD build.
buildName	String	Optional	The name of the CI/CD build or pipeline.
buildNumber	Integer	Optional	A sequential build number.
buildUrl	String	Optional	URL to the CI/CD build for easy navigation.
repositoryName	String	Optional	The name of the source code repository.
repositoryUrl	String	Optional	URL of the source code repository.
commit	String	Optional	Git commit SHA or VCS revision identifier.
branchName	String	Optional	Git branch or VCS branch name.
osPlatform	String	Optional	Operating system platform (e.g., linux, darwin, win32).
osRelease	String	Optional	Operating system release version.
osVersion	String	Optional	Operating system version string.
testEnvironment	String	Optional	Logical test environment (e.g., staging, production, local).
shardId	String	Optional	Identifies the shard or partition that produced this document. Values should be unique among documents sharing the same runId.
healthy	Boolean	Optional	Indicates if the run is considered healthy based on defined criteria.
extra	Object	Optional	Extension point for arbitrary environment-related metadata.

Example

"environment": {
  "reportName": "Nightly Regression Suite",
  "appName": "my-web-app",
  "appVersion": "2.1.0",
  "buildName": "main-pipeline",
  "buildNumber": 1542,
  "buildUrl": "https://ci.example.com/builds/1542",
  "repositoryName": "my-web-app",
  "repositoryUrl": "https://github.com/example/my-web-app",
  "commit": "a1b2c3d4e5f6",
  "branchName": "main",
  "shardId": "shard-1-of-4",
  "osPlatform": "linux",
  "testEnvironment": "staging"
}