github.com/redhat-appstudio/e2e-tests@v0.0.0-20240520140907-9709f6f59323/README.md (about)

     1  # Red Hat AppStudio E2E Tests and Testing Framework
     2  
     3  Testing framework and E2E tests are written in [Go](https://go.dev/) using [Ginkgo](https://onsi.github.io/ginkgo/) and [Gomega](https://onsi.github.io/gomega/) frameworks to cover Red Hat AppStudio.
     4  It is recommended to install AppStudio in E2E mode, but the E2E suite can be also usable in [development and preview modes](https://github.com/redhat-appstudio/infra-deployments#preview-mode-for-your-clusters).
     5  
     6  # Features
     7  
     8  * Instrumented tests with Ginkgo 2.0 framework. You can find more information in [Ginkgo documentation](https://onsi.github.io/ginkgo/).
     9  * Ability to run the E2E tests everywhere: locally([CRC/OpenShift local](https://developers.redhat.com/products/openshift-local/overview)), OpenShift Cluster, OSD...
    10  * Writes tests results in JUnit XML/JSON file to a custom directory by using `--ginkgo.junit(or json)-report` flag.
    11  * Ability to run the test suites separately.
    12  
    13  ## Start running E2E tests
    14  
    15  All the instructions about installing RHTAP locally/CI and running tests locally/CI can be found in this [Documentation](docs/Installation.md), which contains also information about how to pair Pull Requests when breaking changes are introduced.
    16  
    17  ## Start developing tests
    18  
    19  To develop new tests in RHTAP consider first to reading some tips for a better experience:
    20  * Basic tips to write readable tests. [Documentation](docs/Guidelines.md).
    21  * How to auto generate tests. [Documentation](docs/DeveloperGenerateTest.md).
    22  
    23  ## Start debugging CI
    24  
    25  To onboard a new component in Openshift CI follow this [Documentation](docs/OpenShiftCI.md).
    26  To debug CI jobs follow this [Documentation](docs/InvestigatingCIFailures.md).
    27  
    28  ***HAPPY TESTING!***