Add race condition check in unit-test CI and add test-coverage cmd in Makefile (vllm-project#1169)

Signed-off-by: Varun Gupta <[email protected]>
Signed-off-by: Modi Tamam <[email protected]>

Author: varungup90

.github/.testcoverage.yml

@@ -11,15 +11,15 @@ profile: cover.out
 threshold:
   # (optional; default 0) 
   # Minimum coverage percentage required for individual files.
-  file: 90
+  file: 0
 
   # (optional; default 0) 
   # Minimum coverage percentage required for each package.
-  package: 90
+  package: 0
 
   # (optional; default 0) 
   # Minimum overall project coverage percentage required.
-  total: 90
+  total: 25
 
 # # Holds regexp rules which will override thresholds for matched files or packages 
 # # using their paths.
@@ -38,9 +38,16 @@ threshold:
 exclude:
   # Exclude files or packages matching their paths
   paths:
-    - \.pb\.go$    # excludes all protobuf generated files
-    - ^pkg/client     # exclude package `pkg/client`
+    - \.pb\.go$        # excludes all protobuf generated files
+    - ^api/            # exclude package `api/`
+    - ^cmd/            # exclude package `cmd/`
+    - ^pkg/cert        # exclude package `pkg/cert`
+    - ^pkg/client      # exclude package `pkg/client`
+    - ^pkg/config      # exclude package `pkg/config`
+    - ^pkg/constants   # exclude package `pkg/constants`
+    - ^pkg/features    # exclude package `pkg/features`
     - ^pkg/webhook     # exclude package `pkg/webhook`
+    - ^test            # exclude package `test/`
 
 # File name of go-test-coverage breakdown file, which can be used to 
 # analyze coverage difference.

.github/workflows/lint-and-tests.yml

@@ -89,6 +89,9 @@ jobs:
           path: cover.out
           if-no-files-found: error
           retention-days: 1
+      
+      - name: Run Race Condition Tests
+        run: make test-race-condition
 
       - name: Run Integration Tests
         run: make test-integration

Makefile

@@ -90,6 +90,10 @@ vet: ## Run go vet against code.
 test: manifests generate fmt vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out
 
+.PHONY: test-code-coverage
+test-code-coverage: test
+	$(GO_TEST_COVERAGE) --config=./.github/.testcoverage.yml
+
 .PHONY: test-race-condition
 test-race-condition: manifests generate fmt vet envtest ## Run tests with race detection enabled.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test -race $$(go list ./... | grep -v /e2e)
@@ -295,12 +299,14 @@ KUSTOMIZE ?= $(LOCALBIN)/kustomize-$(KUSTOMIZE_VERSION)
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen-$(CONTROLLER_TOOLS_VERSION)
 ENVTEST ?= $(LOCALBIN)/setup-envtest-$(ENVTEST_VERSION)
 GOLANGCI_LINT = $(LOCALBIN)/golangci-lint-$(GOLANGCI_LINT_VERSION)
+GO_TEST_COVERAGE = $(LOCALBIN)/go-test-coverage-$(GO_TEST_COVERAGE_VERSION)
 
 ## Tool Versions
 KUSTOMIZE_VERSION ?= v5.3.0
 CONTROLLER_TOOLS_VERSION ?= v0.16.1
 ENVTEST_VERSION ?= release-0.17
 GOLANGCI_LINT_VERSION ?= v1.57.2
+GO_TEST_COVERAGE_VERSION ?= v2.14.3
 
 .PHONY: kustomize
 kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
@@ -322,6 +328,11 @@ golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
 $(GOLANGCI_LINT): $(LOCALBIN)
 	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,${GOLANGCI_LINT_VERSION})
 
+.PHONY: go-test-coverage
+go-test-coverage: $(GO_TEST_COVERAGE) ## Download go-test-coverage locally if necessary.
+$(GO_TEST_COVERAGE): $(LOCALBIN)
+	$(call go-install-tool,$(GO_TEST_COVERAGE),github.com/vladopajic/go-test-coverage/v2,${GO_TEST_COVERAGE_VERSION})
+
 # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
 # $1 - target path with name of binary (ideally with version)
 # $2 - package url which can be installed

pkg/cache/trace_test.go

@@ -1,3 +1,5 @@
+//go:build !race
+
 /*
 Copyright 2024 The Aibrix Team.
 

pkg/types/types_test.go

@@ -1,3 +1,5 @@
+//go:build !race
+
 /*
 Copyright 2024 The Aibrix Team.
 

pkg/utils/prefixcacheindexer/tree_test.go

@@ -1,3 +1,5 @@
+//go:build !race
+
 /*
 Copyright 2024 The Aibrix Team.
 

pkg/utils/utils_test.go

@@ -1,3 +1,5 @@
+//go:build !race
+
 /*
 Copyright 2024 The Aibrix Team.