E2E tests are executed on GitHub CI using the E2E Tests Reusable Workflow or dedicated workflows.
These workflows are designed to run automatically at crucial stages of the software development process, such as on every commit in a PR, nightly or before release.
Run on every commit in a PR to ensure changes do not introduce regressions.
Conducted nightly to catch issues that may develop over time or with accumulated changes.
This section contains automatic workflows triggering E2E tests at release.
Triggered manually by QA for specific testing needs.
Examples:
E2E tests utilize TOML files to define their parameters. Each test is equipped with a default TOML config, which can be overridden by specifying an alternative TOML config. This allows for running tests with varied parameters, such as on a non-default blockchain network. For tests executed on GitHub CI, both the default configs and any override configs must reside within the git repository. The test_config_override_path workflow input is used to provide a path to an override config.
Config overrides should be stored in testconfig/*/overrides/*.toml. Placing files here will not trigger a rebuild of the test runner image.
Important Note: The use of base64Config input is deprecated in favor of test_config_override_path. For more details, refer to the decision log.
To learn more about test configs see CTF Test Config.
For security reasons, test secrets and sensitive information are not stored directly within the test config TOML files. Instead, these secrets are securely injected into tests using environment variables. For a detailed explanation on managing test secrets, refer to our Test Secrets documentation.
If you need to run a GitHub workflow using custom secrets, please refer to the guide on running GitHub workflows with your test secrets.
For information on the E2E Test Reusable Workflow, visit the documentation in the smartcontractkit/.github repository.