adds coverage analysis and junit reports to tests

- collect golangci-lint output as junit
- conditionally install required tools

Author: cheesesashimi

Diff for: .gitignore

@@ -1,4 +1,8 @@
 **/*.swp
 .DS_Store
 _output
-.vscode/
+.vscode/
+junit*.xml
+checkstyle*.xml
+mco-unit-test-coverage.out
+mco-unit-test-coverage.html

Diff for: .golangci.yml

@@ -112,3 +112,5 @@ linters-settings:
     confidence: medium
     excludes:
       - G204
+output:
+  format: "checkstyle:checkstyle-golangci-lint.xml,junit-xml:junit-golangci-lint.xml,colored-line-number"

Diff for: Makefile

@@ -22,9 +22,12 @@ export GOLANGCI_LINT_CACHE=$(shell echo $${GOLANGCI_LINT_CACHE:-$$GOPATH/cache})
 
 GOTAGS = "containers_image_openpgp exclude_graphdriver_devicemapper exclude_graphdriver_btrfs containers_image_ostree_stub"
 
+UNITTEST_OPTS = -tags=$(GOTAGS) -count=1 -v ./cmd/... ./pkg/... ./lib/...
+
 all: binaries
 
 .PHONY: clean test test-unit test-e2e verify update install-tools
+
 # Remove build artifaces
 # Example:
 #    make clean
@@ -46,16 +49,27 @@ image:
 test: test-unit test-e2e
 
 # Unit tests only (no active cluster required)
-test-unit:
-	CGO_ENABLED=0 go test -tags=$(GOTAGS) -count=1 -v ./cmd/... ./pkg/... ./lib/...
+test-unit: install-go-junit-report
+ifdef ARTIFACT_DIR
+	CGO_ENABLED=0 go test -coverprofile=mco-unit-test-coverage.out $(UNITTEST_OPTS) | ./hack/test-with-junit.sh $(@)
+	go tool cover -html=mco-unit-test-coverage.out -o mco-unit-test-coverage.html
+	# Move the test coverage report into ARTIFACT_DIR only when it is not the same as our current dir
+	# This enables test coverage analysis to be collected locally by running:
+	# $ ARTIFACT_DIR="$PWD" make test-unit
+	if [[ "${PWD}" != "${ARTIFACT_DIR}" ]]; then \
+		mv mco-unit-test-coverage.out mco-unit-test-coverage.html "${ARTIFACT_DIR}"; \
+	fi
+else
+	CGO_ENABLED=0 go test $(UNITTEST_OPTS)
+endif
 
 # Run the code generation tasks.
 # Example:
 #    make update
 update:
 	hack/update-codegen.sh
 	hack/update-templates.sh
-
+ 
 go-deps:
 	go mod tidy
 	go mod vendor
@@ -64,14 +78,42 @@ go-deps:
 	chmod +x ./vendor/k8s.io/code-generator/generate-groups.sh
 	chmod +x ./vendor/k8s.io/code-generator/generate-internal-groups.sh
 
-install-tools:
+SETUP_ENVTEST := $(shell command -v setup-envtest 2> /dev/null)
+install-setup-envtest:
+ifdef SETUP_ENVTEST
+	@echo "Found setup-envtest"
+else
+	@echo "Installing setup-envtest"
+	go install -mod= sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
+endif
+
+GO_JUNIT_REPORT := $(shell command -v go-junit-report 2> /dev/null)
+install-go-junit-report:
+ifdef GO_JUNIT_REPORT
+	@echo "Found go-junit-report"
+	go-junit-report --version
+else
+	@echo "Installing go-junit-report"
+	go install -mod= github.com/jstemmer/go-junit-report@latest
+endif
+
+GOLANGCI_LINT := $(shell command -v golangci-lint 2> /dev/null)
+install-golangci-lint:
+ifdef GOLANGCI_LINT
+	@echo "Found golangci-lint"
+	golangci-lint --version
+else
+	@echo "Installing golangci-lint"
 	GO111MODULE=on go build -o $(GOPATH)/bin/golangci-lint ./vendor/github.com/golangci/golangci-lint/cmd/golangci-lint
+endif
+
+install-tools: install-golangci-lint install-setup-envtest install-go-junit-report
 
 # Run verification steps
 # Example:
 #    make verify
 verify: install-tools
-	golangci-lint run --build-tags=$(GOTAGS)
+	./hack/golangci-lint.sh $(GOTAGS)
 	hack/verify-codegen.sh
 	hack/verify-templates.sh
 
@@ -101,16 +143,11 @@ Dockerfile.rhel7: Dockerfile Makefile
 	 sed -e s,org/openshift/release,org/ocp/builder, -e s,/openshift/origin-v4.0:base,/ocp/4.0:base, < $<) > $@.tmp && mv $@.tmp $@
 
 # This was copied from https://github.com/openshift/cluster-image-registry-operator
-test-e2e:
-	go test -tags=$(GOTAGS) -failfast -timeout 110m -v$${WHAT:+ -run="$$WHAT"} ./test/e2e/
-
-test-e2e-single-node:
-	go test -tags=$(GOTAGS) -failfast -timeout 110m -v$${WHAT:+ -run="$$WHAT"} ./test/e2e-single-node/
+test-e2e: install-go-junit-report
+	go test -tags=$(GOTAGS) -failfast -timeout 110m -v$${WHAT:+ -run="$$WHAT"} ./test/e2e/ | ./hack/test-with-junit.sh $(@)
 
-bootstrap-e2e:
-	./hack/bootstrap-e2e-test.sh
+test-e2e-single-node: install-go-junit-report
+	go test -tags=$(GOTAGS) -failfast -timeout 110m -v$${WHAT:+ -run="$$WHAT"} ./test/e2e-single-node/ | ./hack/test-with-junit.sh $(@)
 
-bootstrap-e2e-local:
-	# Use GOTAGS to exclude the default CGO implementation of signatures, which is not used by MCO
-	# but dragged in by containers/image/signature
-	CGO_ENABLED=0 go test -tags=$(GOTAGS) -v$${WHAT:+ -run="$$WHAT"} ./test/e2e-bootstrap/
+bootstrap-e2e: install-go-junit-report install-setup-envtest
+	CGO_ENABLED=0 go test -tags=$(GOTAGS) -v$${WHAT:+ -run="$$WHAT"} ./test/e2e-bootstrap/ | ./hack/test-with-junit.sh $(@)

Diff for: hack/bootstrap-e2e-test.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# This script exists so that we can ensure that the report files produced by
+# golangci-lint are still copied to the ARTIFACT_DIR (if it exists) even when
+# golangci-lint exits with a non-zero exit code, such as whenever it finds
+# issues.
+
+REPO_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
+
+GOTAGS="${1:-""}"
+ARTIFACT_DIR="${ARTIFACT_DIR:-""}"
+
+if [ ! -n "$GOTAGS" ]; then
+  echo "No Go tags provided"
+  exit 1
+fi
+
+cd "$REPO_ROOT"
+
+retval=0
+golangci-lint run --build-tags="$GOTAGS" || retval="$?";
+
+if [ -n "$ARTIFACT_DIR" ] && [ -d "$ARTIFACT_DIR" ]; then
+  if [ "$ARTIFACT_DIR" != "$PWD" ]; then
+    mv checkstyle-golangci-lint.xml junit-golangci-lint.xml "$ARTIFACT_DIR"
+  fi
+fi
+
+exit "$retval"

Diff for: hack/fetch-ext-bins.sh

@@ -7,9 +7,13 @@ export MCD_DAEMONSET="daemonset/machine-config-daemon"
 export MCD_CONTAINER_NAME="machine-config-daemon"
 export ROOTFS_MCD_PATH="/rootfs/usr/local/bin/machine-config-daemon"
 
+exists() {
+  builtin type -P "$1" &> /dev/null
+}
+
 can_run() {
   # Check if we have an oc binary in our path
-  if [ ! "$(which oc)" ]; then
+  if ! exists 'oc'; then
     echo "oc not in path"
     exit 1
   fi

Diff for: hack/golangci-lint.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# This script exists to process Go test output into junit-compatible output
+# whenever we are running in CI. Otherwise, it will just output all given input
+# to stdout as-is.
+
+REPO_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
+
+MAKEFILE_TARGET="${1:-""}"
+OPENSHIFT_CI="${OPENSHIFT_CI:-""}"
+ARTIFACT_DIR="${ARTIFACT_DIR:-""}"
+
+if [ ! -n "$MAKEFILE_TARGET" ]; then
+  echo "No Makefile target provided"
+  exit 1
+fi
+
+if [ ! -p /dev/stdin ]; then
+  echo "This script expects Go test output to be piped into it"
+  exit 1
+fi
+
+function generate_junit_report() {
+  echo "CI env detected, run tests with junit report extraction"
+  if [ -n "$ARTIFACT_DIR" ] && [ -d "$ARTIFACT_DIR" ]; then
+    JUNIT_LOCATION="$ARTIFACT_DIR/junit-$MAKEFILE_TARGET.xml"
+    echo "junit report location: $JUNIT_LOCATION"
+    cat | tee >(go-junit-report > "$JUNIT_LOCATION")
+  else
+    echo "\$ARTIFACT_DIR not set or does not exists, no junit will be published"
+    cat
+  fi
+}
+
+cd "$REPO_ROOT"
+
+if [ "$OPENSHIFT_CI" == "true" ]; then # detect ci environment there
+  generate_junit_report
+else
+  cat
+fi