Skip to content

Add documentation for E2E testing #1504

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

Merged
merged 1 commit into from
Nov 21, 2023
Merged

Add documentation for E2E testing #1504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/book/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
- [Release Process](./developer/release.md)
- [How to build the machine boot images](./developer/build-images.md)
- [Modules and tools dependencies](./developer/dependencies.md)
- [E2E testing](./developer/e2e.md)
- [Troubleshooting](./user/troubleshooting.md)
- [Reference](./reference/reference.md)
- [API References](./reference/api-references.md)
Expand Down
31 changes: 31 additions & 0 deletions docs/book/src/developer/e2e.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# E2E Testing

### Introduction

* The end-to-end tests for `VPC` and `PowerVS` run on an internal prow cluster on IBM Cloud.
* Resource management is handled via [boskos](https://github.com/kubernetes-sigs/boskos) which is an efficient way to lease infra and clean up after every run.
* The E2E tests use the Cluster API test framework. For more information on developing E2E tests, refer [here](https://cluster-api.sigs.k8s.io/developer/e2e).

### Jobs

The following periodic jobs are being run on main branch once every day.

1. [periodic-capi-provider-ibmcloud-e2e-powervs](https://prow.ppc64le-cloud.cis.ibm.net/job-history/gs/ppc64le-kubernetes/logs/periodic-capi-provider-ibmcloud-e2e-powervs)
2. [periodic-capi-provider-ibmcloud-e2e-vpc](https://prow.ppc64le-cloud.cis.ibm.net/job-history/gs/ppc64le-kubernetes/logs/periodic-capi-provider-ibmcloud-e2e-vpc)

We also test the last two releases, `release-0.5` and `release-0.6` once every week.

### Running the end-to-end tests locally

For development and debugging the E2E tests, they can be executed locally.

1. Set the flavor you want to test. By default it is set to `powervs-md-remeditaion`.

```
export E2E_FLAVOR=<e2e-flavor>
```
2. Set the infra environment variables accrodingly based on the flavor being tested. Check the required variables for [VPC](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/main/scripts/ci-e2e.sh#L132-L145) and [PowerVS](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/main/scripts/ci-e2e.sh#L123-L130) being set in [ci-e2e.sh](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/main/scripts/ci-e2e.sh).
3. Run the e2e test
```
./scripts/ci-e2e.sh
```