Adding e2e and ut combined coverage checking scripts

Author: Tony Zhang

.github/workflows/unit-test.yml

@@ -26,13 +26,10 @@ jobs:
       - name: Install Go dependencies
         run: go mod download
 
-      - name: Build and Test
+      - name: Build and Testga.
+        working-directory: ${{ github.workspace }}
         run: |
           scripts/build.sh
           scripts/unit_test.sh
         env:
           CGO_CFLAGS: "-O -D__BLST_PORTABLE__" # Set the CGO flags to use the portable version of BLST
-
-      - name: Check Code Coverage
-        run: |
-          scripts/check_coverage_unit_test.sh

scripts/build.sh

@@ -32,7 +32,9 @@ then
 fi
 if [ "${COVERAGE_MODE:-}" == true ]
 then
-	extra_build_args+=" -cover -race"
+	# coverage mode has to be 'set' to merge with ut coverage which is 'set'
+	# i.e. -race cannot be added here.
+	extra_build_args+=" -cover"
 fi
 
 go build -v -ldflags="-X 'github.com/ava-labs/avalanche-cli/cmd.Version=$VERSION' -X github.com/ava-labs/avalanche-cli/pkg/metrics.telemetryToken=$AVALANCHE_CLI_METRICS_TOKEN" $extra_build_args -o $BIN

scripts/check_coverage_unit_test.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+coverage_dir=$(PWD)/coverage
+combined_coverage_file=$coverage_dir/combined.txt
+COVERAGE_THRESHOLD=15.0 # percentage threshold of code coverage required
+
+echo "Generating coverage report in text format..."
+go tool covdata merge -i=$coverage_dir/e2e,$coverage_dir/ut -o=$coverage_dir
+go tool covdata textfmt -i=./coverage -o $combined_coverage_file
+go tool cover -func $combined_coverage_file
+
+echo "Checking total coverage..."
+
+# print current test coverage from report
+current_test_coverage=$(go tool cover -func=$combined_coverage_file  | grep -e "total" | awk '{print $3}')
+echo "Current test coverage is $current_test_coverage"
+
+go tool cover -func=$combined_coverage_file  | grep -e "total" | \
+awk -v coverageThreshold=$COVERAGE_THRESHOLD '{if (($3 - 0.0) < coverageThreshold) \
+  {print "Coverage is less than", coverageThreshold, "%. Checking Failed"; exit 1} \
+  else \
+  {print "Coverage is greater than or equal to", coverageThreshold, "%. Checking Passed."; exit 0}}'

scripts/check_total_coverage.sh

@@ -60,7 +60,7 @@ ACK_GINKGO_RC=true ~/go/bin/ginkgo build $extra_build_args ./tests/e2e
 
 if [ "${COVERAGE_MODE:-}" == true ]
 then
-    export GOCOVERDIR=coverage/e2e
+    export GOCOVERDIR=$(PWD)/coverage/e2e
 	echo 'Coverage mode enabled - re-creating coverage dir $GOCOVERDIR'
 	echo 'It requires the CLI binary to be built by build.sh with COVERAGE_MODE=true too'
 	rm -rf ${GOCOVERDIR}
@@ -76,11 +76,4 @@ if [[ ${EXIT_CODE} -gt 0 ]]; then
   exit ${EXIT_CODE}
 else
   echo "ALL SUCCESS!"
-
-  if [ "${COVERAGE_MODE:-}" == true ]
-  then
-    echo "Generating coverage report: ${GOCOVERDIR}/profile.txt"
-    go tool covdata textfmt -i=${GOCOVERDIR} -o ${GOCOVERDIR}/profile.txt
-    # go tool cover -func ${GOCOVERDIR}/profile.txt
-  fi
 fi

scripts/run.e2e.sh

@@ -1,4 +1,12 @@
 #!/usr/bin/env bash
 
-go test -v -coverprofile=coverage.out $(go list ./... | grep -v /tests/ | grep -v '/sdk/')
-#go tool cover -func=coverage.out
+set -ex
+
+coverage_dir=$PWD/coverage/ut # should be under the same parent folder as e2e coverage dir
+
+echo "Re-creating unit test coverage directory: $coverage_dir"
+rm -rf $coverage_dir
+mkdir -p $coverage_dir
+
+go test -cover -v  $(go list ./... | grep -v /tests/ | grep -v '/sdk/') -args -test.gocoverdir=$coverage_dir
+