Skip to content

Commit

Permalink
docs: adjust testing strategy to github actions and add new workflows (
Browse files Browse the repository at this point in the history
…#3525)

* docs: adjust testing strategy to github actions and add new workflows

* Update docs/contributor/testing-strategy.md

Co-authored-by: Grzegorz Karaluch <grzegorz.karaluch@sap.com>

* Update docs/contributor/testing-strategy.md

Co-authored-by: Grzegorz Karaluch <grzegorz.karaluch@sap.com>

---------

Co-authored-by: Grzegorz Karaluch <grzegorz.karaluch@sap.com>
  • Loading branch information
mrCherry97 and grego952 authored Dec 11, 2024
1 parent 2e63290 commit 38a1415
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions docs/contributor/testing-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,27 @@

Each pull request (PR) to the repository triggers CI/CD jobs that verify the Busola configuration, build and run integration tests.

- `pre-busola-web-deployment-check` - Checks if the Busola web image in deployment is bumped correctly.
- `pre-busola-backend-deployment-check` - Checks if the Busola backend image in deployment is bumped correctly. The check runs only when PR changes affect the backend.
- `pull-busola-web-build` - Unit tests of Busola checking the ESLint code quality, and building the web Docker image.
- `pull-busola-local-build` - Unit tests of Busola checking the ESLint code quality and building the web and backend Docker image.
- `pull-busola-backend-build` - Builds the backend Docker image. The job runs only when changes affect the backend.
- `pull-busola-integration-cluster-k3d` - Performs integration testing for Busola related to cluster-level functionalities using a k3d cluster.
- `pull-busola-integration-namespace-k3d` - Performs integration testing for Busola related to namespace-level functionalities using a k3d cluster.
- `pull-busola-lighthouse` - Performs performance testing for Busola - threshold for accessibility: 80, best-practices: 100.
- `Busola Web Build / build-web-image / Build image` - Checks the ESLint code quality and builds the web Docker image.
- `Busola Build / build-busola-image / Build image` - Checks the ESLint code quality and builds the web and backend Docker image.
- `Busola Backend Build / build-backend-image / Build image` - Builds the backend Docker image. The job runs only when changes affect the backend.
- `PR Integration Cluster Tests / run-cluster-test` - Performs integration testing for Busola related to cluster-level functionalities using a k3d cluster.
- `PR Integration Namespace Tests / run-namespace-test` - Performs integration testing for Busola related to namespace-level functionalities using a k3d cluster.
- `PR Kyma Dashboard Integration Tests Dev / run-integration-test` - Performs integration testing for Busola with DEV environement and configuration related to the Kyma functionalities using a k3d cluster with installed Kyma.
- `PR Kyma Dashboard Smoke Tests Stage / run-smoke-test-stage` - Performs smoke testing for Busola with STAGE environement and configuration related to the Kyma functionalities using a k3d cluster with installed Kyma.
- `PR Kyma Dashboard Smoke Tests Prod / run-smoke-test-prod` - Performs smoke testing for Busola with PROD environement and configuration related to the Kyma functionalities using a k3d cluster with installed Kyma.
- `PR Lighthouse Test / run-lighthouse-test` - Performs performance testing for Busola - threshold for accessibility: 80, best-practices: 100.
- `PR Lint Check / run-lint-check` - Performing ESlint and Prettier code quality.
- `PR Unit Tests / run-unit-test` - Performs unit tests of the Busola.
- `Lint Markdown Links PR / markdown-link-check` - Checks links in documentation.
- `CodeQL / Analyze (javascript)` - Code quality static code check.

After the pull request is merged, the following CI/CD jobs are executed:

- `post-busola-web-build` - Performs Busola unit tests and builds the web Docker image.
- `post-busola-local-build` - Performs Busola unit tests and builds the web and backend Docker image.
- `post-busola-backend-build` - Builds the backend Docker image.
- `Busola Web Build / build-web-image / Build image` - Performs Busola unit tests and builds the web Docker image.
- `Busola Build / build-busola-image / Build image` - Performs Busola unit tests and builds the web and backend Docker image.
- `Busola Backend Build / build-backend-image / Build image` - Builds the backend Docker image.
- `CodeQL / Analyze (javascript)` - Code quality static code check.

Following CI/CD jobs are executed once a week:

- `Accessibility Tests - run-accessibility-tests` - Performs accessibility tests of the Busola using k3d cluster with Kyma installed.

0 comments on commit 38a1415

Please sign in to comment.