E2Engine Documentation
E2Engine is a declarative end-to-end testing engine for distributed systems.
Describe the test environment, define behavior and expectations, execute the test, and inspect what happened across service boundaries.
Getting started
Section titled “Getting started”InstallationInstall E2Engine and prepare the CLI.
Your first testDefine an environment and execute your first E2Engine test.
Concepts
Section titled “Concepts”EnvironmentsDefine the services and dependencies that participate in a test.
TestsDescribe behavior to execute and the interactions you expect.
Test suitesGroup related tests and execute them together against an environment.
ExecutionsUnderstand persisted test and test suite execution records and their results.
Running tests
Section titled “Running tests”Running a testExecute a test against an environment and work with its execution record.
Running a test suiteExecute a test suite and track the resulting suite execution.
Inspecting resultsInspect execution status, results, and observed interactions.
Using E2Engine
Section titled “Using E2Engine”CLICreate, inspect, run, and manage E2Engine resources from the command line.
DockerRun E2Engine as a container and integrate it with containerized systems.
Architecture
Section titled “Architecture”Architecture overviewUnderstand E2Engine's layers, boundaries, execution path, and repository structure.
Design principlesExplore the principles that guide E2Engine's model and implementation.
Extending E2EngineSee where repositories, schedulers, runners, runtime services, and protocols can be extended.
Guides
Section titled “Guides”Running E2Engine with DockerFollow a complete workflow for running E2Engine with Docker and test services.
CI/CD pipelinesIntegrate E2Engine execution and result checking into a CI/CD pipeline.