From 07601c3cb936bcc6822c64a7cc7fc1b7cf31d3c1 Mon Sep 17 00:00:00 2001 From: Richard Case <198425+richardcase@users.noreply.github.com> Date: Mon, 30 Nov 2020 09:46:20 +0000 Subject: [PATCH 1/2] docs: e2e test structure ADR --- docs/adr/0003-separate-e2e-packages.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/adr/0003-separate-e2e-packages.md diff --git a/docs/adr/0003-separate-e2e-packages.md b/docs/adr/0003-separate-e2e-packages.md new file mode 100644 index 0000000000..efa5bbeda6 --- /dev/null +++ b/docs/adr/0003-separate-e2e-packages.md @@ -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 CAPBK) 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 accompying 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. From 1b21f3ef2a8c5d3cb69d944f301be40b20ef4fa6 Mon Sep 17 00:00:00 2001 From: Richard Case <198425+richardcase@users.noreply.github.com> Date: Tue, 1 Dec 2020 10:52:57 +0000 Subject: [PATCH 2/2] chore: incorporating review comments --- docs/adr/0003-separate-e2e-packages.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/adr/0003-separate-e2e-packages.md b/docs/adr/0003-separate-e2e-packages.md index efa5bbeda6..c74a6d5c62 100644 --- a/docs/adr/0003-separate-e2e-packages.md +++ b/docs/adr/0003-separate-e2e-packages.md @@ -7,13 +7,13 @@ ## 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 CAPBK) side of the provider. +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 accompying 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. +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