martinhesko / testsuite

Kuadrant E2E testsuite

This repository contains end-to-end tests for Kuadrant project. It supports running tests either against standalone Authorino and Authorino Operator, or the entire Kuadrant, both Service Protection and MGC. For more information about Kuadrant, please visit https://kuadrant.io/

Requirements

Authorino standalone tests

• OpenShift 4.x cluster
• Authorino Operator installed
• Use authorino make target

Service Protection tests

• OpenShift 4.x cluster
• Kuadrant Operator installed
• Use test make target

Multi-cluster Gateway Controller tests (make mgc)

• OpenShift 4.x cluster(s)
• OCM setup with both hub and spokes (can be a single cluster)
• Existing GatewayClass kuadrant-multi-cluster-gateway-instance-per-cluster
• Existing ManagedZones gcp-mz and aws-mz for Google Cloud and AWS respectively
• Use mgc make target

Configuration

Kuadrant testsuite uses Dynaconf for configuration, which means you can specify the configuration through either settings files in config directory or through environmental variables. All the required and possible configuration options can be found in config/settings.local.yaml.tpl

OpenShift auto-fetching

Some configuration options can be fetched from OpenShift if there are correctly deployed tools. Tools can be deployed by using overlays/kuadrant overlay and deploying RHSSO with the provided script like this:

oc apply -k overlays/kuadrant/ --namespace tools
NAMESPACE=tools ./base/rhsso/deploy-rhsso.sh

Settings files

Settings files are located at config directory and are in yaml format. To use them for local development, you can create settings.local.yaml and put all settings there.

Environmental variables

You can also configure all the settings through environmental variables as well. We use prefix KUADRANT so the variables can look like this:

export KUADRANT_RHSSO__url="https://my-sso.net"

You can find more info on the Dynaconf wiki page

Usage

You can run and manage environment for testsuite with the included Makefile, but the recommended way how to run the testsuite is from Container image

Local development setup

Requirements:

• Python 3.11+
• poetry
• CFSSL
• OpenShift CLI tools (oc)

If you have all of those, you can run make poetry to install virtual environment and all dependencies To run all tests you can then use make test

Running from container

For just running tests, the container image is the easiest option, you can log in to OpenShift and then run it like this

If you omit any options, Testsuite will run only subset of tests that don't require that variable e.g. not providing Auth0 will result in skipping Auth0 tests.

NOTE: For binding kubeconfig file, the "others" need to have permission to read, otherwise it will not work. The results and reports will be saved in /test-run-results in the container.

With tools setup

podman run \
	-v $HOME/.kube/config:/run/kubeconfig:z \
	-e KUADRANT_SERVICE_PROTECTION__PROJECT=authorino \
	-e KUADRANT_SERVICE_PROTECTION__PROJECT2=authorino2 \
	-e KUADRANT_AUTH0__url="AUTH0_URL" \
	-e KUADRANT_AUTH0__client_id="AUTH0_CLIENT_ID" \
	-e KUADRANT_AUTH0__client_secret="AUTH0_CLIENT_SECRET" \	
	quay.io/kuadrant/testsuite:latest

Without tools

podman run \
	-v $HOME/.kube/config:/run/kubeconfig:z \
	-e KUADRANT_SERVICE_PROTECTION__PROJECT=authorino \
	-e KUADRANT_SERVICE_PROTECTION__PROJECT2=authorino2 \
	-e KUADRANT_RHSSO__url="https://my-sso.net" \
	-e KUADRANT_RHSSO__password="ADMIN_PASSWORD" \
	-e KUADRANT_RHSSO__username="ADMIN_USERNAME" \
	-e KUADRANT_AUTH0__url="AUTH0_URL" \
	-e KUADRANT_AUTH0__client_id="AUTH0_CLIENT_ID" \
	-e KUADRANT_AUTH0__client_secret="AUTH0_CLIENT_SECRET" \
	quay.io/kuadrant/testsuite:latest

Developing tests

For developing tests for Authorino you might need to know content of the authorization JSON, you can do that through this AuthConfig, which will return all the context in the response

apiVersion: authorino.kuadrant.io/v1beta1
kind: AuthConfig
metadata:
  name: example
spec:
  response:
  - name: auth-json
    json:
      properties:
      - name: context
        valueFrom: { authJSON: context }
      - name: auth
        valueFrom: { authJSON: auth }

Another thing which might helpful is using playground for developing OPA policies https://play.openpolicyagent.org/.