Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 docs: e2e test structure ADR #2127

Merged
merged 2 commits into from
Dec 2, 2020
Merged

📖 docs: e2e test structure ADR #2127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07601c3
docs: e2e test structure ADR
richardcase Nov 30, 2020
1b21f3e
chore: incorporating review comments
richardcase Dec 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/adr/0003-separate-e2e-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 3. E2E tests organised as packages

* Status: accepted
* Date: 2020-11-09
* Authors: @richardcase
* Deciders: @randomvariable

## Context

The e2e tests for CAPA where initially in a single package and this package contained functional e2e and conformance tests for the unmanaged (i.e. purely EC2 with CABPK) side of the provider.

With the addition of the EKS functionality to CAPA new e2e tests ([#1907](https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues/1907)) are required and we need the ability to maintain and run e2e tests for the different parts of the provider separately.

## Decision

The e2e tests will be split into separate packages that will represent a distinct suite of e2e tests with accompanying targets to enable running each suite. To reduce code duplication there will also be a shared e2e package that will contain functionality that is common to all the test package suites.

## Consequences

The existing e2e tests will be refactored into separate test suites. As this ADR is written retrospectively there is no issue but [#2102](https://github.com/kubernetes-sigs/cluster-api-provider-aws/pull/2102) is the initial consequnce of this and then [#1907](https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues/1907) will be implemented as a new package.