[chore] Avoid go list ./... on GL compile step (#6878)

* [chore] Avoid `go list ./...` on GL compile step

* Remove extra white-space

* Better formatting

* Remove unmatched `(`

* Add missing space

* Specify COVER_TESTING=true on build-and-test

* Specify COVER_TESTING=true on reusable-unit-test

* Remove identation from conditionals

* Add COVER_TESTING=true to integration-test workflow

* Add COVER_TESTING=true to integration-test-discovery-k8s

Author: pjanotti

.github/workflows/build-and-test.yml

@@ -112,7 +112,7 @@ jobs:
       - uses: ./.github/actions/setup-environment
 
       - name: Run Unit Tests With Coverage
-        run: make gotest-with-codecov
+        run: COVER_TESTING=true make gotest-with-codecov
 
       - name: Upload coverage report
         uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # 5.5.1

.github/workflows/integration-test.yml

@@ -147,6 +147,7 @@ jobs:
         PROFILE: [ "integration", "smartagent" ]
       fail-fast: false
     env:
+      COVER_TESTING: true
       TEST_OUTPUT: ${{ github.job }}-${{ matrix.PROFILE }}-${{ matrix.ARCH }}.out
     steps:
       # Multiarch images require more disk space
@@ -232,6 +233,7 @@ jobs:
         PROFILE: [ "integration", "smartagent" ]
       fail-fast: false
     env:
+      COVER_TESTING: true
       TEST_OUTPUT: ${{ github.job }}-${{ matrix.PROFILE }}-${{ matrix.RUNNER }}.out
     steps:
       # Multiarch images require more disk space
@@ -336,6 +338,8 @@ jobs:
       strategy:
         matrix: ${{ fromJSON(needs.integration-test-discovery-matrix.outputs.matrix) }}
         fail-fast: false
+      env:
+        COVER_TESTING: true
       steps:
         - name: Free up disk space for next step
           uses: jlumbroso/[email protected]
@@ -442,6 +446,7 @@ jobs:
           KUBECONFIG=$HOME/.kube/config SKIP_TEARDOWN=true make integration-test-${{ matrix.SERVICE }}-discovery-k8s-with-cover
         env:
           CONTAINER_COVER_DEST: '/etc/otel/collector/coverage'
+          COVER_TESTING: true
       - name: Print logs
         if: failure()
         run: |

.github/workflows/reusable-unit-test.yml

@@ -37,7 +37,7 @@ jobs:
           trap "go-junit-report  -set-exit-code < unit-test-results-${{ inputs.OS }}/go-unit-tests.out > unit-test-results-${{ inputs.OS }}/junit/results.xml" EXIT
 
           if ${{ inputs.COVERAGE }}; then
-            make gotest-cover-without-race | tee unit-test-results-${{ inputs.OS }}/go-unit-tests.out
+            COVER_TESTING=true make gotest-cover-without-race | tee unit-test-results-${{ inputs.OS }}/go-unit-tests.out
           else
             make test-all | tee unit-test-results/go-unit-tests.out
           fi

Makefile

@@ -40,8 +40,6 @@ SKIP_COMPILE=false
 ARCH?=amd64
 BUNDLE_SUPPORTED_ARCHS := amd64 arm64
 SKIP_BUNDLE=false
-# Used for building the collector to collect coverage information
-COVER_TESTING=false
 
 # For integration testing against local changes you can run
 # SPLUNK_OTEL_COLLECTOR_IMAGE='otelcol:latest' make -e docker-otelcol integration-test
@@ -201,6 +199,9 @@ integration-test-istio-discovery-k8s:
 integration-test-istio-discovery-k8s-with-cover:
 	@make integration-test-cover-target TARGET='discovery_integration_istio_k8s'
 
+ifeq ($(COVER_TESTING),true)
+# These targets are expensive to build, so only build if explicitly requested
+
 .PHONY: gotest-with-codecov
 gotest-with-codecov:
 	@$(MAKE) for-all-target TARGET="test-with-codecov"
@@ -211,6 +212,8 @@ gotest-cover-without-race:
 	@$(MAKE) for-all-target TARGET="test-cover-without-race"
 	$(GOCMD) tool covdata textfmt -i=./coverage  -o ./coverage.txt
 
+endif
+
 .PHONY: tidy-all
 tidy-all:
 	$(MAKE) for-all-target TARGET="tidy"

Makefile.Common

@@ -1,6 +1,9 @@
 # Explicitly define the shell we will use for commands.
 SHELL?=/bin/bash
 
+# Used for building the collector to collect coverage information
+COVER_TESTING?=false
+
 # Add support to use Makefile on Windows
 SHELL_CASE_EXP = case "$$(uname -s)" in CYGWIN*|MINGW*|MSYS*) echo "true";; esac;
 UNIX_SHELL_ON_WINDOWS := $(shell $(SHELL_CASE_EXP))
@@ -45,14 +48,6 @@ BUILD_TYPE?=release
 # COVER_PKGS is the list of packages to include in the test coverage
 EXCLUDE_MODS=-not -path "./examples/*" -not -path "./packaging/technical-addon/*"
 FIND_MOD_ARGS=-type f -name "go.mod"
-COVER_PKGS := $(shell find . $(EXCLUDE_MODS) $(FIND_MOD_ARGS) -execdir $(GOCMD) list ./... \; | tr "\n" "," )
-
-COVER_DIR?=coverage
-COVER_DIR_ABS?=$(SRC_ROOT)/$(COVER_DIR)
-TEST_COVER_DIR?=$(SRC_ROOT)/tests/$(COVER_DIR)
-COVER_OPTS?=-cover -covermode=atomic -coverpkg $(COVER_PKGS)
-COVER_TESTING_OPTS?=$(COVER_OPTS) -args -test.gocoverdir="$(COVER_DIR_ABS)"
-COVER_TESTING_INTEGRATION_OPTS?=$(COVER_OPTS) -args -test.gocoverdir="$(TEST_COVER_DIR)"
 
 ALL_PKG_DIRS := $(shell $(GOCMD) list -f '{{ .Dir }}' ./... | $(NORMALIZE_DIRS))
 
@@ -89,6 +84,17 @@ common: checklicense lint misspell
 test:
 	$(GOTEST) $(GOTEST_OPT) $(ALL_PKG_DIRS)
 
+ifeq ($(COVER_TESTING),true)
+# These variables and targets are expensive to build, so only build if explicitly requested
+
+COVER_PKGS := $(shell find . $(EXCLUDE_MODS) $(FIND_MOD_ARGS) -execdir $(GOCMD) list ./... \; | tr "\n" "," )
+COVER_DIR?=coverage
+COVER_DIR_ABS?=$(SRC_ROOT)/$(COVER_DIR)
+TEST_COVER_DIR?=$(SRC_ROOT)/tests/$(COVER_DIR)
+COVER_OPTS?=-cover -covermode=atomic -coverpkg $(COVER_PKGS)
+COVER_TESTING_OPTS?=$(COVER_OPTS) -args -test.gocoverdir="$(COVER_DIR_ABS)"
+COVER_TESTING_INTEGRATION_OPTS?=$(COVER_OPTS) -args -test.gocoverdir="$(TEST_COVER_DIR)"
+
 .PHONY: test-with-codecov
 test-with-codecov:
 	mkdir -p $(COVER_DIR)
@@ -102,6 +108,8 @@ test-cover-without-race:
 	mkdir -p $(COVER_DIR_ABS)
 	$(GOTEST) $(GOTEST_OPT_WITHOUT_RACE) ./... $(COVER_TESTING_OPTS)
 
+endif
+
 .PHONY: addlicense
 addlicense:
 	@ADDLICENCESEOUT=`$(ADDLICENCESE) -y "" -c 'Splunk, Inc.' $(ALL_SRC) 2>&1`; \