Compass Runtime Agent tests - readme (#15566)

* Readme for Compass-Runtime-Agent tests

* Values.yaml specification

* Add info for debugging

* Add reference from main README file

* Fix link

* Minor fix

* Update tests/components/application-connector/docs/compass-runtime-agent-tests.md

Co-authored-by: Maja Szostok <[email protected]>

* Update tests/components/application-connector/docs/compass-runtime-agent-tests.md

Co-authored-by: Maja Szostok <[email protected]>

* Update tests/components/application-connector/docs/compass-runtime-agent-tests.md

Co-authored-by: Maja Szostok <[email protected]>

* Apply suggestions from code review

Co-authored-by: Grzegorz Karaluch <[email protected]>
Co-authored-by: Maja Szostok <[email protected]>

* Ignore external link in Compass Runtime Agent tests

Co-authored-by: Arkadiusz Galwas <[email protected]>
Co-authored-by: Maja Szostok <[email protected]>
Co-authored-by: Grzegorz Karaluch <[email protected]>

milv.config.yaml

@@ -56,3 +56,6 @@ files:
   - path: "./kyma/tests/components/application-connector/README.md"
     config:
       internal-links-to-ignore: [ "./resources/charts/gateway-test/templates/service-account.yml#L2" ]
+  - path: "./kyma/tests/components/application-connector/docs/compass-runtime-agent-tests.md"
+    config:
+      external-links-to-ignore: [ "https://compass-gateway-auth-oauth.{COMPASS_HOST}/director/graphql"]

tests/components/application-connector/README.md

@@ -3,3 +3,4 @@
 There are the following component tests for Application Connector:
 - [Application Gateway](docs/application-gateway-tests.md)
 - [Application Connectivity Validator](docs/application-connectivity-validator-tests.md)
+- [Compass Runtime Agent](docs/compass-runtime-agent-tests.md)

tests/components/application-connector/docs/compass-runtime-agent-tests.md

@@ -0,0 +1,136 @@
+# Compass Runtime Agent
+
+**Table of Contents**
+
+- [Design and architecture](#design-and-architecture)
+- [Building](#building)
+- [Running](#running)
+  - [Deploy a Kyma cluster locally](#deploy-a-kyma-cluster-locally)
+  - [Test setup](#test-setup---compass-runtime-agent-configuration)
+  - [Run the tests](#run-the-tests)
+- [Debugging](#debugging)
+  - [Running without cleanup](#running-without-cleanup)
+
+## Design and architecture
+
+The tests consist of:
+- [Test resources](../resources/charts/compass-runtime-agent-test/) used to perform the test
+- [Test runner](../test/application-connectivity-validator/) with all the test cases
+
+The tests are executed as a Kubernetes Job on a Kyma cluster where the tested Compass Runtime Agent is installed. The test Job is deployed in the `test` Namespace.
+
+![Compass Runtime Agent tests architecture](assets/compass-runtime-agent-tests-architecture.svg)
+
+The interactions between components are the following:
+
+1. Compass Runtime Agent periodically fetches certificates from Compass Connector.
+2. Compass Runtime Agent periodically fetches applications from Compass Director.
+3. Compass Runtime Agent Test sends GraphQL mutations to Compass Director to create, modify, or delete Applications.
+4. Compass Runtime Agent Test verifies whether corresponding Application CRs were created, modified, or deleted.
+5. Compass Runtime Agent Test verifies whether the Secret with certificates used for communication with Director was created.
+6. Compass Runtime Agent Test verifies whether the Secret with the CA root certificate used by Istio Gateway was created.
+7. Compass Runtime Agent Test verifies the content of the CompassConnection CR.
+
+## Building
+
+Pipelines build the Compass Runtime Agent test using the **release** target from the `Makefile`.
+
+To build **and push** the Docker images of the tests, run:
+
+```bash
+./scripts/local-build.sh {DOCKER_TAG} {DOCKER_PUSH_REPOSITORY}
+```
+
+This builds the following images:
+- `{DOCKER_PUSH_REPOSITORY}/compass-runtime-agent-test:{DOCKER_TAG}`
+
+## Running
+
+Tests can be run on any Kyma cluster with Compass Runtime Agent.
+
+Pipelines run the tests using the **test-compass-runtime-agent** target from the `Makefile`.
+
+### Deploy a Kyma cluster locally
+
+1. Provision a local Kubernetes cluster with k3d:
+   ```bash
+   kyma provision k3d
+   ```
+
+2. Install the minimal set of components required to run Compass Runtime Agent **for Kyma SKR (Compass mode)**:
+
+    ```bash
+    kyma deploy --components-file ./resources/installation-config/mini-kyma-skr.yaml --value global.disableLegacyConnectivity=true
+    ```
+
+   >**TIP:** Read more about [Kyma installation](https://kyma-project.io/docs/kyma/latest/02-get-started/01-quick-install/#install-kyma).
+
+### Test setup - Compass Runtime Agent configuration
+
+The [`values.yaml`](../resources/charts/compass-runtime-agent-test/values.yaml) file contains environment variables that are used in the Compass Runtime Agent tests. These values can be modified as needed.
+
+- **APP_DIRECTOR_URL** - Compass Director URL
+- **APP_TESTING_TENANT** - Tenant used in GraphQL calls
+- **APP_SKIP_DIRECTOR_CERT_VERIFICATION** - Skip certificate verification on the Director side
+- **APP_OAUTH_CREDENTIALS_SECRET_NAME** - Secret name for Compass OAuth credentials
+- **APP_OAUTH_CREDENTIALS_NAMESPACE** - Namespace for Compass OAuth credentials
+
+### Run the tests
+
+1. Before running the test export the following environment variables
+   - **COMPASS_HOST** - host running Compass 
+   - **COMPASS_CLIENT_ID** - client ID used for fetching authorization tokens
+   - **COMPASS_CLIENT_SECRET** - client Secret used for fetching authorization tokens 
+
+2. To start the tests, run:
+
+   ```bash
+   make test-compass-runtime-agent
+   ```
+
+By default, the tests clean up after themselves, removing all the previously created resources and the `test` Namespace.
+
+> **CAUTION:** If the names of your existing resources are the same as the names used in the tests, running this command overrides or removes the existing resources.
+
+## Debugging
+
+### Running without cleanup
+
+To run the tests without removing all the created resources afterwards, run them in the debugging mode.
+
+1. To start the tests in the debugging mode, run:
+
+   ```bash
+   make test-compass-runtime-agent-debug
+   ```
+
+2. Once you've finished debugging, run:
+
+   ```bash
+   make clean-test-compass-runtime-agent-test
+   ```
+
+### Debugging in the IDE
+
+To run the test in your IDE, perform the following steps.
+
+1. To prepare the cluster for debugging, run the test without cleanup:
+
+   ```bash
+   make test-compass-runtime-agent-debug
+   ```
+
+2. Before starting debugger in your IDE export the following environment variables:
+   - `KUBECONFIG={Your cluster kubeconfig}`
+   - `APP_DIRECTOR_URL=https://compass-gateway-auth-oauth.{COMPASS_HOST}/director/graphql`
+   - `APP_TESTING_TENANT=3e64ebae-38b5-46a0-b1ed-9ccee153a0ae`
+   - `APP_OAUTH_CREDENTIALS_SECRET_NAME=oauth-compass-credentials`
+   - `APP_OAUTH_CREDENTIALS_NAMESPACE=test`
+
+3. Start the debugging session.
+
+4. Once you've finished debugging, run:
+
+   ```bash
+   make clean-test-compass-runtime-agent-test
+   ```