Skip to content

Commit

Permalink
chore: update RHTAP -> Konflux and Go version in guide (#1527)
Browse files Browse the repository at this point in the history
chore: update RHTAP -> Konflux and Go ver in guide

Signed-off-by: Dheeraj<[email protected]>
  • Loading branch information
dheerajodha authored Mar 4, 2025
1 parent 396b772 commit 81c5d7b
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 23 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ It is recommended to install AppStudio in E2E mode, but the E2E suite can be als

## Start running E2E tests

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.
All the instructions about installing Konflux 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.

## Start developing tests

To develop new tests in RHTAP consider first to reading some tips for a better experience:
To develop new tests in Konflux consider first to reading some tips for a better experience:
* Basic tips to write readable tests. [Documentation](docs/Guidelines.md).
* How to auto generate tests. [Documentation](docs/DeveloperGenerateTest.md).

Expand Down
12 changes: 6 additions & 6 deletions docs/Guidelines.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Overview
The purpose of *this* document is to serve as a primer for developers/qe who are looking for best practices or adding new tests to RHTAP E2E framework.
The purpose of *this* document is to serve as a primer for developers/qe who are looking for best practices or adding new tests to Konflux E2E framework.

## General tips

Expand Down Expand Up @@ -77,18 +77,18 @@ Good code that waits for something to happen meets the following criteria:

## E2E directory structure

This is a basic layout for RHTAP E2E framework project. It is a set of common directories for all teams in RHTAP.
This is a basic layout for Konflux E2E framework project. It is a set of common directories for all teams in Konflux.

* `/cmd`: Is the main for all e2e tests. Don't put a lot of code in the application directory. If you think the code can be imported and used in other projects, then it should live in the `/pkg` directory.
* `docs`: Documentation about RHTAP e2e world.
* `docs`: Documentation about Konflux e2e world.
* `/magefiles`: The code definition about installing and running the e2e tests
* `/pipelines`: Tekton pipelines utilities for QE team like IC.
* `/pkg`: All used and imported packages for e2e tests.
* `/pkg/clients`: Definition of different clients connection providers (like Slack, GitHub, and Kubernetes Server) and all API interaction with different RHTAP controllers.
* `/pkg/clients`: Definition of different clients connection providers (like Slack, GitHub, and Kubernetes Server) and all API interaction with different Konflux controllers.
* `/pkg/constants`: Global constants of the e2e tests.
* `/pkg/framework`: In the framework folder are all controllers initialization, tests reports and the interaction with Report Portal.
* `/pkg/logs`: Tests logging utilities.
* `/pkg/sandbox`: Initialize Sandbox controller to make authenticated requests to a Kubernetes server.
* `/pkg/utils`: Util folders with all auxiliary functions used in the different RHTAP controllers. Futhermore, it also contains some tests utils that can be found in `/pkg/utils/util.go`.
* `/pkg/utils`: Util folders with all auxiliary functions used in the different Konflux controllers. Futhermore, it also contains some tests utils that can be found in `/pkg/utils/util.go`.
* `/scripts`: Scripts to perform operations which cannot be do it at magefiles level.
* `/tests`: Folder where all RHTAP tests are defined and documented.
* `/tests`: Folder where all Konflux tests are defined and documented.
20 changes: 8 additions & 12 deletions docs/Installation.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
# RHTAP Installation locally and Openshift CI

The following guide will walk through the necessary instruction about driving an installation of RHTAP locally or in Openshift CI.

## RHTAP in dev mode
# Konflux Local Installation

The following guide will walk through the necessary instruction about driving an installation of Konflux locally

### Requirements

Requirements for installing RHTAP in E2E mode:
Requirements for installing Konflux in E2E mode:

* An OpenShift 4.12 or higher Environment (If you are using CRC/OpenShift Local please also review [optional-codeready-containers-post-bootstrap-configuration](https://github.com/redhat-appstudio/infra-deployments/blob/main/docs/development/deployment.md#optional-openshift-local-post-bootstrap-configuration))
* A machine from which to run the install (usually your laptop) with required tools:
* A properly setup Go workspace using **Go 1.19 is required**
* A properly setup Go workspace using **Go 1.21 is required**
* The OpenShift Command Line Tool (oc) **Use the version corresponding to the Openshift version**
* [yq]((https://github.com/mikefarah/yq))
* jq
Expand All @@ -21,11 +18,11 @@ Requirements for installing RHTAP in E2E mode:
* `repo`
* `delete_repo`
* `workflow`
* Valid quay token where to push RHTAP components images generated by the e2e framework
* Valid quay token where to push Konflux components images generated by the e2e framework

### Installation

1. Before deploying RHTAP in E2E mode you need to login to your OpenShift cluster with OpenShift Command Line Tool as `admin` (by default `kubeadmin`):
1. Before deploying Konflux in E2E mode you need to login to your OpenShift cluster with OpenShift Command Line Tool as `admin` (by default `kubeadmin`):

```bash
oc login -u <user> -p <password> --server=<oc_api_url>
Expand Down Expand Up @@ -120,17 +117,16 @@ Or build and run the tests without scripts:
2. Run the e2e tests:
The `e2e-appstudio` command is the root command that executes all test functionality. To obtain all available flags for the binary please use `--help` flags. All ginkgo flags and go tests are available in `e2e-appstudio` binary.


```bash
`./bin/e2e-appstudio`
```
Note: The binary must be updated by running `make build` every time there are new changes in the tests.
**NOTE**: The binary must be updated by running `make build` every time there are new changes in the tests.

The instructions for every test suite can be found in the [tests folder](tests), e.g. [has Readme.md](tests/konflux-demo/README.md).
You can also specify which tests you want to run using [labels](docs/LabelsNaming.md) or [Ginkgo Focus](docs/DeveloperFocus.md).


## KONFLUX in Openshift CI and branch pairing
# Konflux in Openshift CI and branch pairing

The e2e tests are executed against almost all AppStudio repositories.

Expand Down
4 changes: 2 additions & 2 deletions docs/InvestigatingCIFailures.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ Please include:
- **Failure message**
- **Relevant logs**
- (+ could be helpful to also include Slack thread conversation link in the ticket)
2. Post this issue in **#forum-rhtap-qe**(ping **@ic-appstudio-qe**) channel and relevant component channel.
- You can also raise this issue on **#forum-rhtap-developer** channel and your lead can raise this issue on SoS call(and PM call and architects call, if this is necessary).
2. Post this issue in **#forum-konflux-qe**(ping **@ic-appstudio-qe**) channel and relevant component channel.
- You can also raise this issue on **#forum-konflux-developer** channel and your lead can raise this issue on SoS call(and PM call and architects call, if this is necessary).
2 changes: 1 addition & 1 deletion docs/OpenShiftCI.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You can take a look at the [application-service](https://github.com/openshift/re

### Cluster Pools

All RHTAP components owns a dedicated cluster pool defined running in AWS. To find more information about how to use cluster pool in your rhtap component in CI testing read our [documentation](https://github.com/openshift/release/blob/master/clusters/hive/pools/rhtap/Readme.md).
All Konflux components owns a dedicated cluster pool defined running in AWS. To find more information about how to use cluster pool in your Konflux component in CI testing read our [documentation](https://github.com/openshift/release/blob/master/clusters/hive/pools/rhtap/Readme.md).

### Define your tests

Expand Down

0 comments on commit 81c5d7b

Please sign in to comment.