Add support for system test code coverage

This commit adds possibility to build and deploy kiali which is
producing code coverage report even for system tests which run against
kiali deployed in OpenShift. Note this does not do anything
for code coverage of unit tests.

Makefile

@@ -98,6 +98,11 @@ format:
 			gofmt -w $$gofile; \
 	done
 
+## build-system-test: Building executable for system tests with code coverage enabled
+build-system-test:
+	@echo Building executable for system tests with code coverage enabled
+	go test -c -covermode=count -coverpkg ./...  -o ${GOPATH}/bin/kiali
+
 ## build-test: Run tests and installing test dependencies, excluding third party tests under vendor. Runs `go test -i` internally
 build-test:
 	@echo Building and installing test dependencies to help speed up test runs.

main_test.go

@@ -0,0 +1,20 @@
+package main
+
+// This file is mandatory as otherwise the kiali binary for system tests is not generated correctly.
+import (
+	"flag"
+	"testing"
+)
+
+var systemTest *bool
+
+func init() {
+	systemTest = flag.Bool("systemTest", false, "Set to true when running system tests")
+}
+
+// Test started when the test binary is started. Only calls main.
+func TestSystem(t *testing.T) {
+	if *systemTest {
+		main()
+	}
+}

operator/Makefile

@@ -13,6 +13,7 @@ CREDENTIALS_PASSPHRASE ?= admin
 IMAGE_VERSION ?= dev
 NAMESPACE ?= istio-system
 VERBOSE_MODE ?= 3
+SYSTEM_TEST_CODECOV_ENABLED ?= false
 
 # Find the client executable (either istiooc or oc or kubectl)
 OC ?= $(shell which istiooc 2>/dev/null || which oc 2>/dev/null || which kubectl 2>/dev/null || echo "MISSING-OC/KUBECTL-FROM-PATH")
@@ -71,6 +72,7 @@ CREDENTIALS_USERNAME="${CREDENTIALS_USERNAME}" \
 CREDENTIALS_PASSPHRASE="${CREDENTIALS_PASSPHRASE}" \
 IMAGE_VERSION="${IMAGE_VERSION}" \
 NAMESPACE="${NAMESPACE}" \
+SYSTEM_TEST_CODECOV_ENABLED="${SYSTEM_TEST_CODECOV_ENABLED}" \
 deploy/deploy-kiali-operator.sh
 
 ## operator-delete: Remove the Kiali operator resources from the cluster along with Kiali itself

operator/deploy/deploy-kiali-operator.sh

@@ -143,6 +143,10 @@
 #    already (or will) contain the credentials (i.e. the secret you must create manually).
 #    Default: kiali
 #
+# SYSTEM_TEST_CODECOV_ENABLED
+#    When true, Kiali will start with arguments needed for system tests to generate
+#    code coverage report. This expects the Kiali image to contain Kiali coverage binary.
+#
 ##############################################################################
 
 # Determine what tool to use to download files. This supports environments that have either wget or curl.
@@ -375,6 +379,7 @@ echo ISTIO_NAMESPACE=$ISTIO_NAMESPACE
 echo JAEGER_URL=$JAEGER_URL
 echo NAMESPACE=$NAMESPACE
 echo SECRET_NAME=$SECRET_NAME
+echo SYSTEM_TEST_CODECOV_ENABLED=$SYSTEM_TEST_CODECOV_ENABLED
 echo "=== KIALI SETTINGS ==="
 
 # Create the secret when required
@@ -441,6 +446,7 @@ spec:
     $(build_spec_value image_version IMAGE_VERSION)
     $(build_spec_value namespace NAMESPACE)
     $(build_spec_value secret_name SECRET_NAME)
+    $(build_spec_value system_test_codecov_enabled SYSTEM_TEST_CODECOV_ENABLED)
   external_services:
     grafana:
       $(build_spec_value url GRAFANA_URL true)

operator/deploy/kiali/kiali_cr.yaml

@@ -93,6 +93,11 @@ spec:
 # modify the service mesh.
 #    ---
 #    view_only_mode: false
+#
+# When true, Kiali will start with arguments needed for system tests to generate
+# code coverage report. This expects the Kiali image to contain Kiali coverage binary.
+#    ---
+#    system_test_codecov_enabled: false
 
 ##########
 #  ---

operator/roles/kiali-deploy/defaults/main.yml

@@ -31,6 +31,7 @@ kiali_defaults:
     verbose_mode: "3"
     version_label: ""
     view_only_mode: false
+    system_test_codecov_enabled: false
 
   external_services:
     grafana:

operator/roles/kiali-deploy/templates/openshift/deployment.yaml

@@ -39,6 +39,11 @@ spec:
         - "/kiali-configuration/config.yaml"
         - "-v"
         - "{{ kiali_vars.deployment.verbose_mode }}"
+{% if kiali_vars.deployment.system_test_codecov_enabled %}
+        - "-systemTest"
+        - "-test.coverprofile"
+        - "/opt/kiali/console/coverage.cov"
+{% endif %}
         ports:
           - name: api-port
             containerPort: {{ kiali_vars.server.port }}