Skip to content

Commit

Permalink
docs: RHTAPBUGS-873 update doc about E2E tests (konflux-ci#816)
Browse files Browse the repository at this point in the history
* RHTAPBUGS-873

* fix
  • Loading branch information
rsoaresd authored Oct 25, 2023
1 parent 6caff9a commit 2a5ed79
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 15 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ For more information refer to [Generate Tests](docs/DeveloperGenerateTest.md).
* When running via mage you can filter the suites run by specifying the
`E2E_TEST_SUITE_LABEL` environment variable. For example:
`E2E_TEST_SUITE_LABEL=ec ./mage runE2ETests`
* `klog` level can be controled via `KLOG_VERBOSITY` environment variable. For
* `klog` level can be controlled via `KLOG_VERBOSITY` environment variable. For
example: `KLOG_VERBOSITY=9 ./mage runE2ETests` would output `curl` commands
issued via Kubernetes client from sigs.k8s.io/controller-runtime

Expand Down Expand Up @@ -191,7 +191,7 @@ Our automated tests running in CI create lot of repositories in our redhat-appst

There is a mage target that can cleanup those repositories - `mage local:cleanupGithubOrg`.

For more infor & usage, please run `mage -h local:cleanupGithubOrg`.
For more info & usage, please run `mage -h local:cleanupGithubOrg`.

# PR review process in e2e-tests
* Since RHTAP is leveraging OpenShift CI, [OWNERS](https://github.com/redhat-appstudio/e2e-tests/blob/main/OWNERS) file (in a directory or its parent directory) takes effect in e2e-tests PR review process. Reviewers are selected by [Blunderbuss plugin](https://github.com/kubernetes/test-infra/tree/master/prow/plugins/blunderbuss).
Expand All @@ -200,4 +200,4 @@ For more infor & usage, please run `mage -h local:cleanupGithubOrg`.

* To get a PR merged, the following is needed:
1. approved label added by selected [approver](https://github.com/kubernetes/community/blob/master/community-membership.md#approver) in relevant OWNERS file through [Blunderbuss plugin](https://github.com/kubernetes/test-infra/tree/master/prow/plugins/blunderbuss).
2. Tide check passed.
2. Tide check passed.
2 changes: 1 addition & 1 deletion cmd/e2e_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import (
_ "github.com/redhat-appstudio/e2e-tests/tests/integration-service"
_ "github.com/redhat-appstudio/e2e-tests/tests/release"
_ "github.com/redhat-appstudio/e2e-tests/tests/release/pipelines"
_ "github.com/redhat-appstudio/e2e-tests/tests/remotesecret"
_ "github.com/redhat-appstudio/e2e-tests/tests/remote-secret"
_ "github.com/redhat-appstudio/e2e-tests/tests/rhtap-demo"
_ "github.com/redhat-appstudio/e2e-tests/tests/spi"
_ "github.com/redhat-appstudio/e2e-tests/tests/upgrade"
Expand Down
2 changes: 1 addition & 1 deletion docs/DeveloperGenerateTest.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ BuildSuiteDescribe: Build service E2E tests @build, @HACBS
## How it works

We leverage existing Ginkgo's tool set to be able to do this translation back and forth.
* `ginkgo outline` we use to be able to generate the intial spec outline for our internal model based on what is in the file Ginkgo Test File. This command depends on the GoLang AST to generates the output.
* `ginkgo outline` we use to be able to generate the initial spec outline for our internal model based on what is in the file Ginkgo Test File. This command depends on the GoLang AST to generates the output.
* `ginkgo generate` we use to pass a customize template and data so that it can render a spec file using Ginkgo's extensive use of closures to allow us to build a descriptive spec hierarchy.

## Schema
Expand Down
2 changes: 1 addition & 1 deletion docs/InvestigatingCIFailures.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
- This artifacts are present only with hypershift installer.
- **redhat-appstudio_e2e-tests/gather-extra/**
- Stores all cluster pods logs, events, configmaps etc.
- This artifacts are present only when we dont use hypershift.
- This artifacts are present only when we don't use hypershift.
- More details on all artifacts can be found in [OpenShift CI documentation](https://docs.ci.openshift.org/docs/how-tos/artifacts/ )

## Reporting and escalating CI Issue
Expand Down
2 changes: 1 addition & 1 deletion pipelines/interrupt_catcher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ oc create secret generic slack-token --from-literal="token=<TOKEN>"
```
oc create secret generic slack-token --from-literal="token=<TOKEN>"
```
* Deploy rest of the resoureces:
* Deploy rest of the resources:
```
cd pipelines/interrupt_catcher
kubectl apply -f .
Expand Down
13 changes: 8 additions & 5 deletions tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@ Tests folder contains E2E related to several components divided in folders:
| Folder | Component repository | README | Note |
|---|---|---|---|
| `build` | [build-service](https://github.com/redhat-appstudio/build-service), [jvm-build-service](https://github.com/redhat-appstudio/jvm-build-service) | [README.md](/tests/build/README.md) | |
| `e2e-demos` | N/A | [README.md](/tests/e2e-demos/README.md) | |
| `has` | https://github.com/redhat-appstudio/application-service | [README.md](/tests/has/README.md) | |
| `integration-service` | https://github.com/redhat-appstudio/integration-service | [README.md](/tests/integration-service/README.md) | |
| `byoc` | [application-service](https://github.com/redhat-appstudio/application-service) | [README.md](/tests/byoc/README.md) | |
| `enterprise-contract` | N/A | [README.md](/tests/enterprise-contract/README.md) | |
| `integration-service` | [integration-service](https://github.com/redhat-appstudio/integration-service) | [README.md](/tests/integration-service/README.md) | |
| `load-tests` | N/A | [LoadTests.md](/docs/LoadTests.md) | |
| `release` | https://github.com/redhat-appstudio/release-service | [README.md](/tests/release/README.md) | |
| `spi` | https://github.com/redhat-appstudio/service-provider-integration-operator | [README.md](/tests/spi/README.md) | |
| `release` | [release-service](https://github.com/redhat-appstudio/release-service) | [README.md](/tests/release/README.md) | |
| `remote-secret` | [remote-secret](https://github.com/redhat-appstudio/remote-secret) | [README.md](/tests/remote-secret/README.md) | |
| `rhtap-demo` | N/A | [README.md](/tests/rhtap-demo/README.md) | |
| `spi` | [service-provider-integration-operator](https://github.com/redhat-appstudio/service-provider-integration-operator) | [README.md](/tests/spi/README.md) | |
| `upgrade` | N/A | [README.md](/tests/upgrade/README.md) | |
4 changes: 2 additions & 2 deletions tests/release/pipelines/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This suite contains e2e-tests for testing release pipelines from repository [rel
## How to Run tests:

### 1. To run all e2e-tests in suite ensure your changes of the suite tests are saved.
- navigate to `e2e-tests` directoy
- navigate to `e2e-tests` directory
```bash
make build
./bin/e2e-appstudio --ginkgo.junit-report=report.xml --ginkgo.focus="pipelines"
Expand All @@ -31,7 +31,7 @@ This suite contains e2e-tests for testing release pipelines from repository [rel
For example:
If a test has the label `label-test` to a test in suite `pipelines` then the test should run using the following arguments:

- navigate to `e2e-tests` directoy
- navigate to `e2e-tests` directory
```bash
make build
./bin/e2e-appstudio --ginkgo.junit-report=report.xml --ginkgo.focus="pipelines" --ginkgo.label-filter="label-test"
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion tests/rhtap-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Steps to run 'rhtap-demos':

## Test Generator

The test specs in e2e-demo-suite are generated dynamically using ginkgo specs.
The test specs in rhtap-demo-suite are generated dynamically using ginkgo specs.

If you want to test your own Component (repository), all you need to do is to update the `TestScenarios` variable in [scenarios.go](./config/scenarios.go)

Expand Down

0 comments on commit 2a5ed79

Please sign in to comment.