From 2528d438693628d7da64fa7afbfd21385f6362eb Mon Sep 17 00:00:00 2001 From: Sergio Arroutbi Date: Wed, 17 Apr 2024 09:41:36 +0200 Subject: [PATCH] Fix and groom README.md (#103) Resolves: #102 Signed-off-by: Sergio Arroutbi --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2865ef3..62cb011 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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 via Test Managament Tool (`tmt`). +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: @@ -16,7 +16,7 @@ In order to execute tang-operator test suite, you will need some software instal - 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 is used Test Managament Tool (`tmt`) no requirements are needed. +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: @@ -36,12 +36,12 @@ In case a specific version wants to be executed instead, it can be done through $ 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 must be executed: +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: ```bash $ 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 keep the existing installed version. To do so, next must be executed: +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: ```bash $ DISABLE_BUNDLE_UNINSTALL_TESTS=1 make ``` @@ -67,12 +67,12 @@ $ 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 via tmt: +Execute localy through tmt: ```bash # tmt -c distro=fedora-39 run plan --name packit-ci -vvv prepare discover provision -h local execute ``` -Or running in virtual system via tmt: +Or running in virtual system through tmt: ```bash # tmt -c distro=fedora-39 run plan --name packit-ci -vvv prepare discover provision -h virtual -i Fedora-39 -c system execute report finish @@ -81,9 +81,18 @@ Or running in virtual system via tmt: To execute the test suite, next steps must be followed: -Have OpenShift cluster and be connected via oc cli. +Configure OpenShift cluster to connect and check status through `oc status` command: -Execute localy via tmt: +```bash +$ 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: ```bash # tmt -c distro=fedora-39 run plan --name operator-oc -vvv prepare discover provision -h local execute ```