[chore][Makefile] Add with-cover targets for integration tests (#6144)

* [chore][Makefile] Add with-cover targets for integration tests

* Update Makefile

* Update .github/workflows/integration-test.yml

* Update .github/workflows/integration-test.yml

* Update .github/workflows/integration-test.yml

* Update .github/workflows/integration-test.yml

* Update Makefile

Author: crobert-1

.github/workflows/integration-test.yml

@@ -230,12 +230,12 @@ jobs:
         if: matrix.PROFILE == 'integration'
       - run: redis-cli set tempkey tempvalue
         if: matrix.PROFILE == 'integration'
-      - name: Run Integration Test
+      - name: Run Integration Test With Cover
         run: |
           set -o pipefail
-          target="integration-test"
+          target="integration-test-with-cover"
           if [[ "${{ matrix.PROFILE }}" = "smartagent" ]]; then
-            target="smartagent-integration-test"
+            target="smartagent-integration-test-with-cover"
           fi
           make $target 2>&1 | tee $TEST_OUTPUT
           exit_status=${PIPESTATUS[0]}
@@ -309,12 +309,12 @@ jobs:
         if: matrix.PROFILE == 'integration'
       - run: redis-cli set tempkey tempvalue
         if: matrix.PROFILE == 'integration'
-      - name: Run Integration Test
+      - name: Run Integration Test With Cover
         run: |
           set -o pipefail
-          target="integration-test"
+          target="integration-test-with-cover"
           if [[ "${{ matrix.PROFILE }}" = "smartagent" ]]; then
-            target="smartagent-integration-test"
+            target="smartagent-integration-test-with-cover"
           fi
           make $target 2>&1 | tee $TEST_OUTPUT
           exit_status=${PIPESTATUS[0]}
@@ -385,8 +385,8 @@ jobs:
         - run: docker load -i ./docker-otelcol/${{ matrix.ARCH }}/image.tar
         - run: ln -sf otelcol_linux_${{ matrix.ARCH }} ./bin/otelcol
         - run: chmod a+x ./bin/*
-        - name: Run ${{ matrix.SERVICE }} Discovery Integration Test
-          run: make integration-test-${{ matrix.SERVICE }}-discovery
+        - name: Run ${{ matrix.SERVICE }} Discovery Integration Test With Cover
+          run: make integration-test-${{ matrix.SERVICE }}-discovery-with-cover
           env:
             SPLUNK_OTEL_COLLECTOR_IMAGE: 'otelcol:latest'
 
@@ -447,8 +447,8 @@ jobs:
       - name: Load Docker image in kind
         run: |
           kind load docker-image otelcol:latest --name kind
-      - name: Run ${{ matrix.SERVICE }} Discovery Kubernetes Integration Test
-        run: KUBECONFIG=$HOME/.kube/config SKIP_TEARDOWN=true make integration-test-${{ matrix.SERVICE }}-discovery-k8s
+      - name: Run ${{ matrix.SERVICE }} Discovery Kubernetes Integration Test With Cover
+        run: KUBECONFIG=$HOME/.kube/config SKIP_TEARDOWN=true make integration-test-${{ matrix.SERVICE }}-discovery-k8s-with-cover
       - name: Print logs
         if: failure()
         run: |

Makefile

@@ -31,6 +31,13 @@ BUILD_INFO=-ldflags "${BUILD_X1} ${BUILD_X2}"
 BUILD_INFO_TESTS=-ldflags "-X $(BUILD_INFO_IMPORT_PATH_TESTS).Version=$(VERSION)"
 CGO_ENABLED?=0
 
+# This directory is used in tests hold code coverage results.
+# It's mounted on docker containers which then write code coverage
+# results to it, making coverage profiles available on the host after tests.
+# 777 privileges are important to allow docker container write
+# access to host dir.
+MAKE_TEST_COVER_DIR=mkdir -m 777 -p $(TEST_COVER_DIR)
+
 JMX_METRIC_GATHERER_RELEASE=$(shell cat packaging/jmx-metric-gatherer-release.txt)
 SKIP_COMPILE=false
 ARCH?=amd64
@@ -82,57 +89,118 @@ for-all-target: $(ALL_MODS)
 integration-vet:
 	@set -e; cd tests && go vet -tags integration,testutilsintegration,zeroconfig,testutils ./... && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) -tags testutils,testutilsintegration -v -timeout 5m -count 1 ./...
 
+.PHONY: integration-test-target
+integration-test-target:
+	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=$(TARGET) -v -timeout 5m -count 1 ./...
+
+.PHONY: integration-test-cover-target
+integration-test-cover-target:
+	@set -e; $(MAKE_TEST_COVER_DIR) && cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=$(TARGET) -v -timeout 5m -count 1 ./... $(COVER_TESTING_INTEGRATION_OPTS)
+	$(GOCMD) tool covdata textfmt -i=$(TEST_COVER_DIR) -o ./$(TARGET)-coverage.txt
+
 .PHONY: integration-test
 integration-test:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=integration -v -timeout 5m -count 1 ./...
+	@make integration-test-target TARGET='integration'
+
+.PHONY: integration-test-with-cover
+integration-test-with-cover:
+	@make integration-test-cover-target TARGET='integration'
 
 .PHONY: integration-test-mongodb-discovery
 integration-test-mongodb-discovery:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_mongodb -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_mongodb'
+
+.PHONY: integration-test-mongodb-discovery-with-cover
+integration-test-mongodb-discovery-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_mongodb'
 
 .PHONY: integration-test-mysql-discovery
 integration-test-mysql-discovery:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_mysql -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_mysql'
+
+.PHONY: integration-test-mysql-discovery-with-cover
+integration-test-mysql-discovery-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_mysql'
 
 .PHONY: integration-test-kafkametrics-discovery
 integration-test-kafkametrics-discovery:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_kafkametrics -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_kafkametrics'
+
+.PHONY: integration-test-kafkametrics-discovery-with-cover
+integration-test-kafkametrics-discovery-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_kafkametrics'
 
 .PHONY: integration-test-jmx/cassandra-discovery
 integration-test-jmx/cassandra-discovery:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_jmx -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_jmx'
+
+.PHONY: integration-test-jmx/cassandra-discovery-with-cover
+integration-test-jmx/cassandra-discovery-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_jmx'
 
 .PHONY: integration-test-apache-discovery
 integration-test-apache-discovery:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_apachewebserver -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_apachewebserver'
+
+.PHONY: integration-test-apache-discovery-with-cover
+integration-test-apache-discovery-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_apachewebserver'
 
 .PHONY: integration-test-envoy-discovery
 integration-test-envoy-discovery:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_envoy -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_envoy'
+
+.PHONY: integration-test-envoy-discovery-with-cover
+integration-test-envoy-discovery-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_envoy'
 
 .PHONY: integration-test-nginx-discovery
 integration-test-nginx-discovery:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_nginx -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_nginx'
+
+.PHONY: integration-test-nginx-discovery-with-cover
+integration-test-nginx-discovery-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_nginx'
 
 .PHONY: integration-test-redis-discovery
 integration-test-redis-discovery:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_redis -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_redis'
+
+.PHONY: integration-test-redis-discovery-with-cover
+integration-test-redis-discovery-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_redis'
 
 .PHONY: integration-test-oracledb-discovery
 integration-test-oracledb-discovery:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_oracledb -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_oracledb'
+
+.PHONY: integration-test-oracledb-discovery-with-cover
+integration-test-oracledb-discovery-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_oracledb'
 
 .PHONY: smartagent-integration-test
 smartagent-integration-test:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=smartagent_integration -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='smartagent_integration'
+
+.PHONY: smartagent-integration-test-with-cover
+smartagent-integration-test-with-cover:
+	@make integration-test-cover-target TARGET='smartagent_integration'
 
 .PHONY: integration-test-envoy-discovery-k8s
 integration-test-envoy-discovery-k8s:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_envoy_k8s -v -timeout 5m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_envoy_k8s'
+
+.PHONY: integration-test-envoy-discovery-k8s-with-cover
+integration-test-envoy-discovery-k8s-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_envoy_k8s'
 
 .PHONY: integration-test-istio-discovery-k8s
 integration-test-istio-discovery-k8s:
-	@set -e; cd tests && $(GOTEST_SERIAL) $(BUILD_INFO_TESTS) --tags=discovery_integration_istio_k8s -v -timeout 15m -count 1 ./...
+	@make integration-test TARGET='discovery_integration_istio_k8s'
+
+.PHONY: integration-test-istio-discovery-k8s-with-cover
+integration-test-istio-discovery-k8s-with-cover:
+	@make integration-test-cover-target TARGET='discovery_integration_istio_k8s'
 
 .PHONY: gotest-with-codecov
 gotest-with-codecov:
@@ -181,7 +249,6 @@ else
 	$(LINK_CMD) otelcol_$(GOOS)_$(GOARCH)$(EXTENSION) ./bin/otelcol$(EXTENSION)
 endif
 
-
 .PHONY: migratecheckpoint
 migratecheckpoint:
 	go generate ./...