Skip to content

Commit 06e1ca5

Browse files
heitorlessarubenfonseca
authored andcommitted
docs(maintainers): cleanup structure and parallelization
Signed-off-by: heitorlessa <[email protected]>
1 parent dbf7fa1 commit 06e1ca5

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

MAINTAINERS.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -220,11 +220,7 @@ To run locally, you need [AWS CDK CLI](https://docs.aws.amazon.com/cdk/v2/guide/
220220

221221
#### Structure
222222

223-
Our E2E framework relies on pytest fixtures to coordinate infrastructure and test parallelization (see [Workflow](#workflow)). You'll notice multiple `conftest.py`, `infrastructure.py`, and `handlers`.
224-
225-
- **`infrastructure`**. Uses CDK to define what a Stack for a given feature should look like. It inherits from `BaseInfrastructure` to handle all boilerplate and deployment logic necessary.
226-
- **`conftest.py`**. Imports and deploys a given feature Infrastructure. Hierarchy matters. Top-level `conftest` deploys stacks only once and blocks I/O across all CPUs. Feature-level `conftest` deploys stacks in parallel, and once complete run all tests in parallel.
227-
- **`handlers`**. Lambda function handlers that will be automatically deployed and exported as PascalCase for later use.
223+
Our E2E framework relies on pytest fixtures to coordinate infrastructure and test parallelization (see [Parallelization](#Parallelization)).
228224

229225
**tests/e2e structure**
230226

@@ -262,7 +258,15 @@ Our E2E framework relies on pytest fixtures to coordinate infrastructure and tes
262258
├── infrastructure.py # base infrastructure like deploy logic, etc.
263259
```
264260

265-
#### Workflow
261+
You probably notice we have multiple `conftest.py`, `infrastructure.py`, and `handlers` directory.
262+
263+
- **`infrastructure.py`**. Uses CDK to define the infrastructure a given feature needs.
264+
- **`conftest.py`**. Handles deployment and deletion a given feature Infrastructure. Hierarchy matters
265+
- Top-level `e2e/conftest` deploys stacks only once and blocks I/O across all CPUs.
266+
- Feature-level `e2e/<feature>/conftest` deploys stacks in parallel and make them independent of each other.
267+
- **`handlers/`**. Lambda function handlers that will be automatically deployed and exported as PascalCase for later use.
268+
269+
#### Parallelization
266270

267271
We parallelize our end-to-end tests to benefit from speed and isolate Lambda functions to ease assessing side effects (e.g., traces, logs, etc.). The following diagram demonstrates the process we take every time you use `make e2e`:
268272

0 commit comments

Comments
 (0)