Add coverage evidence to the project

Configure CI to collect coverage and integrate with coveralls.io
service.

Move plugin packages out of `pkg` package, as they aren't
exportable as library and their presence conflicts with
`-coverpkg=./...` cover parameter.

Add Makefile rules for merging coverage profiles from multiple
sources, as tests are usually run by `make test-pkg` and
`make test-controllers`.

Add Makefile's rules to download gocovmerge and gcov2lcov.

Signed-off-by: Andrea Panattoni <[email protected]>

.github/workflows/go.yml

@@ -60,3 +60,31 @@ jobs:
       with:
         # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
         version: v1.46
+
+  test-coverage:
+    name: test-coverage
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Set up Go 1.17
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.17.8
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v2
+
+    - name: test pkg
+      run: make test-pkg
+
+    - name: test controllers on opensfhit
+      run: CLUSTER_TYPE=openshift make test-controllers
+
+    - name: merge test coverage
+      run: make merge-test-coverage
+
+    - name: Coveralls
+      uses: coverallsapp/[email protected]
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        path-to-lcov: lcov.out

Makefile

@@ -222,13 +222,23 @@ test-bindata-scripts: fakechroot
 test-%: generate vet manifests
 	mkdir -p ${ENVTEST_ASSETS_DIR}
 	test -f ${ENVTEST_ASSETS_DIR}/setup-envtest.sh || curl -sSLo ${ENVTEST_ASSETS_DIR}/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/v0.8.3/hack/setup-envtest.sh
-	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR); setup_envtest_env $(ENVTEST_ASSETS_DIR); go test ./$*/... -coverprofile cover.out -v
+	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR); setup_envtest_env $(ENVTEST_ASSETS_DIR); go test ./$*/... -coverprofile cover-$*.out -coverpkg ./... -v
 
 # deploy-setup-k8s: export NAMESPACE=sriov-network-operator
 # deploy-setup-k8s: export ENABLE_ADMISSION_CONTROLLER=false
 # deploy-setup-k8s: export CNI_BIN_PATH=/opt/cni/bin
 # test-e2e-k8s: test-e2e
 
+gocovmerge: ## Download gocovmerge locally if necessary.
+	go install -mod=readonly github.com/shabbyrobe/gocovmerge/cmd/gocovmerge@latest
+
+gcov2lcov:
+	go install -mod=readonly github.com/jandelgado/[email protected]
+
+merge-test-coverage: gocovmerge gcov2lcov
+	gocovmerge cover-*.out > cover.out
+	gcov2lcov -infile cover.out -outfile lcov.out
+
 deploy-wait:
 	hack/deploy-wait.sh
 

hack/build-plugins.sh

@@ -35,5 +35,5 @@ mkdir -p ${BIN_PATH}
 CGO_ENABLED=1
 
 echo "Building ${REPO}/pkg/plugins (${VERSION_OVERRIDE})"
-CGO_ENABLED=${CGO_ENABLED} GOOS=${GOOS} GOARCH=${GOARCH} go build -buildmode=plugin -ldflags "${GLDFLAGS} -s -w" ${GOFLAGS} -o ${BIN_PATH}/plugins/$1_plugin.so ${REPO}/pkg/plugins/$1
+CGO_ENABLED=${CGO_ENABLED} GOOS=${GOOS} GOARCH=${GOARCH} go build -buildmode=plugin -ldflags "${GLDFLAGS} -s -w" ${GOFLAGS} -o ${BIN_PATH}/plugins/$1_plugin.so ${REPO}/plugins/$1
 #CGO_ENABLED=${CGO_ENABLED} GOOS=${GOOS} GOARCH=${GOARCH} go build -buildmode=plugin -gcflags='all=-N -l' -ldflags "${GLDFLAGS} -s -w" ${GOFLAGS} -o ${BIN_PATH}/plugins/$1_plugin.so ${REPO}/pkg/plugins/$1