From 2a5ed798c084f05e799992fe70f717837d139547 Mon Sep 17 00:00:00 2001 From: Rafaela Soares <119665479+rsoaresd@users.noreply.github.com> Date: Wed, 25 Oct 2023 08:25:15 +0100 Subject: [PATCH] docs: RHTAPBUGS-873 update doc about E2E tests (#816) * RHTAPBUGS-873 * fix --- README.md | 6 +++--- cmd/e2e_test.go | 2 +- docs/DeveloperGenerateTest.md | 2 +- docs/InvestigatingCIFailures.md | 2 +- pipelines/interrupt_catcher/README.md | 2 +- tests/README.md | 13 ++++++++----- tests/release/pipelines/README.md | 4 ++-- .../{remotesecret => remote-secret}/environments.go | 0 .../kubeconfig-auth.go | 0 .../service-account-auth.go | 0 .../target-current-namespace.go | 0 tests/rhtap-demo/README.md | 2 +- 12 files changed, 18 insertions(+), 15 deletions(-) rename tests/{remotesecret => remote-secret}/environments.go (100%) rename tests/{remotesecret => remote-secret}/kubeconfig-auth.go (100%) rename tests/{remotesecret => remote-secret}/service-account-auth.go (100%) rename tests/{remotesecret => remote-secret}/target-current-namespace.go (100%) diff --git a/README.md b/README.md index b59e7f657..84ac8c987 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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). @@ -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. \ No newline at end of file + 2. Tide check passed. diff --git a/cmd/e2e_test.go b/cmd/e2e_test.go index 95c8b2225..ffb10ba1b 100644 --- a/cmd/e2e_test.go +++ b/cmd/e2e_test.go @@ -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" diff --git a/docs/DeveloperGenerateTest.md b/docs/DeveloperGenerateTest.md index 35c15e14a..6dea7fb1e 100644 --- a/docs/DeveloperGenerateTest.md +++ b/docs/DeveloperGenerateTest.md @@ -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 diff --git a/docs/InvestigatingCIFailures.md b/docs/InvestigatingCIFailures.md index c6c50cb55..fd92a2bc3 100644 --- a/docs/InvestigatingCIFailures.md +++ b/docs/InvestigatingCIFailures.md @@ -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 diff --git a/pipelines/interrupt_catcher/README.md b/pipelines/interrupt_catcher/README.md index 08f77f14b..4b4ab6388 100644 --- a/pipelines/interrupt_catcher/README.md +++ b/pipelines/interrupt_catcher/README.md @@ -20,7 +20,7 @@ oc create secret generic slack-token --from-literal="token=" ``` oc create secret generic slack-token --from-literal="token=" ``` -* Deploy rest of the resoureces: +* Deploy rest of the resources: ``` cd pipelines/interrupt_catcher kubectl apply -f . diff --git a/tests/README.md b/tests/README.md index 921d2eaab..f0fe85262 100644 --- a/tests/README.md +++ b/tests/README.md @@ -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) | | diff --git a/tests/release/pipelines/README.md b/tests/release/pipelines/README.md index 2bfdb1b1a..10e0b89c1 100644 --- a/tests/release/pipelines/README.md +++ b/tests/release/pipelines/README.md @@ -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" @@ -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" diff --git a/tests/remotesecret/environments.go b/tests/remote-secret/environments.go similarity index 100% rename from tests/remotesecret/environments.go rename to tests/remote-secret/environments.go diff --git a/tests/remotesecret/kubeconfig-auth.go b/tests/remote-secret/kubeconfig-auth.go similarity index 100% rename from tests/remotesecret/kubeconfig-auth.go rename to tests/remote-secret/kubeconfig-auth.go diff --git a/tests/remotesecret/service-account-auth.go b/tests/remote-secret/service-account-auth.go similarity index 100% rename from tests/remotesecret/service-account-auth.go rename to tests/remote-secret/service-account-auth.go diff --git a/tests/remotesecret/target-current-namespace.go b/tests/remote-secret/target-current-namespace.go similarity index 100% rename from tests/remotesecret/target-current-namespace.go rename to tests/remote-secret/target-current-namespace.go diff --git a/tests/rhtap-demo/README.md b/tests/rhtap-demo/README.md index 651b19aa8..924f2fcd2 100644 --- a/tests/rhtap-demo/README.md +++ b/tests/rhtap-demo/README.md @@ -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)