sarroutbi / tang-operator-tests

Upstream repository for tang-operator

tang-operator test suite

Upstream repository for tang-operator test suite. Based on the previous work developed on common repository: https://github.com/RedHat-SP-Security/tests

This test suite is supposed to be executed and maintained through Test Managament Tool (tmt). The data are structured in flexible metadata format (fmf).

For more information about tmt and fmf, please visit:

• https://github.com/teemtee/tmt
• https://github.com/teemtee/fmf

In order to execute tang-operator test suite, you will need some software installed in your machine:

• A K8S/OpenShift/minikube cluster. By default, Minikube will be considered the platform being used, as it is the recommended platform for upstream tests.
• kubectl/oc
• helm (for DAST test execution)
• podman (for Malware Detection test execution)
• clamav (for Malware Detection test execution)

In case helm, podman or clamav does not exist, tests requiring its installation won't be executed. When Test Managament Tool (tmt) is used, no requirements are needed.

To execute the test suite, next steps must be followed:

Clone Security Special Projects Test repository:

$ git clone https://github.com/RedHat-SP-Security/tang-operator-tests

Execute Test suite (through make command):

$ make

Previous command will install the latest version of the upstream project, that corresponds to version "quay.io/sec-eng-special/tang-operator-bundle:latest". In case a specific version wants to be executed instead, it can be done through next command:

$ IMAGE_VERSION="quay.io/sec-eng-special/tang-operator-bundle:v1.0.4" make

It is also possible to run the Test Suite without installing any tang-operator version, by just keeping the existing installed version. To do so, next command must be executed:

$ DISABLE_BUNDLE_INSTALL_TESTS=1 make

Finally, it is also possible to run the Test Suite installing the latest tang-operator test suite, without uninstalling it at the end of the test execution and keeping the existing installed version. To do so, next command must be executed:

$ DISABLE_BUNDLE_UNINSTALL_TESTS=1 make

In case it is necessary, a more verbose output of the test execution can be indicated, through V=1 option:

$ V=1 make

Execute Test suite (through tmt command):

To execute the test suite, next steps must be followed:

Need to install tmt:

# dnf install -y tmt tmt-all

Clone Security Special Projects Test repository:

$ git clone https://github.com/RedHat-SP-Security/tang-operator-tests

1. Executing tests on minikube cluster ( setup of minikube is provided in test ).

Execute localy through tmt:

# tmt -c distro=fedora-39 run plan --name packit-ci -vvv prepare discover provision -h local execute

Or running in virtual system through tmt:

# tmt -c distro=fedora-39 run plan --name packit-ci -vvv prepare discover provision -h virtual -i Fedora-39 -c system execute report finish

2. Executing test on OpenShift or Openshift-local(CRC).

To execute the test suite, next steps must be followed:

Configure OpenShift cluster to connect and check status through oc status command:

$ oc status
Warning: apps.openshift.io/v1 DeploymentConfig is deprecated in v4.14+, unavailable in v4.10000+
In project default on server https://api.ci-ln-08j16qt-72292.origin-ci-int-gce.dev.rhcloud.com:6443

svc/openshift - kubernetes.default.svc.cluster.local
svc/kubernetes - 172.30.0.1:443 -> 6443

After checking status, execute the test suite locally through tmt:

# tmt -c distro=fedora-39 run plan --name operator-oc -vvv prepare discover provision -h local execute