Merge pull request #71 from docker/coverage

Add coverage target in Makefile for coverage reporting

Author: chris-crone

Dockerfile

@@ -5,8 +5,10 @@ ARG TAG=unknown
 
 FROM golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS build
 RUN apk add --no-cache \
+  bash \
   build-base \
-  git
+  git \
+  util-linux
 WORKDIR /go/src/github.com/docker/lunchbox/
 COPY . .
 

Gopkg.lock

@@ -20,6 +20,7 @@
 #  name = "github.com/x/y"
 #  version = "2.4.0"
 
+required = ["github.com/wadey/gocovmerge"]
 
 [[constraint]]
   name = "github.com/spf13/cobra"
@@ -34,6 +35,11 @@
   branch = "master"
   source = "github.com/mnottale/cli"
 
+[[override]]
+  name = "github.com/spf13/pflag"
+  branch = "master"
+  source = "github.com/shin-/pflag"
+
 [[constraint]]
   name = "github.com/gotestyourself/gotestyourself"
   branch = "master"
@@ -70,6 +76,10 @@
   name = "google.golang.org/grpc"
   revision = "v1.3.0"
 
+[[constraint]]
+  name = "github.com/wadey/gocovmerge"
+  branch = "master"
+
 [prune]
   non-go = true
   unused-packages = true

Gopkg.toml

@@ -34,7 +34,7 @@ pipeline {
                                 archiveArtifacts '*.tar.gz'
                             }
                         } finally {
-                            def clean_images = /docker image ls --format "{{.ID}}\t{{.Tag}}" | grep $(git describe --always --dirty) | awk '{print $1}' | xargs docker image rm/
+                            def clean_images = /docker image ls --format "{{.ID}}\t{{.Tag}}" | grep $(git describe --always --dirty) | awk '{print $1}' | xargs docker image rm -f/
                             sh clean_images
                         }
                     }
@@ -48,6 +48,23 @@ pipeline {
         }
         stage('Test') {
             parallel {
+                stage("Coverage report") {
+                    environment {
+                        CODECOV_TOKEN = credentials('jenkins-codecov-token')
+                    }
+                    agent {
+                        label 'gcp-linux-worker-0'
+                    }
+                    steps {
+                        dir('src/github.com/docker/lunchbox') {
+                            checkout scm
+                            sh 'make ci-coverage'
+                            archiveArtifacts '_build/ci-cov/all.out'
+                            archiveArtifacts '_build/ci-cov/coverage.html'
+                            sh 'curl -s https://codecov.io/bash | bash -s - -f _build/ci-cov/all.out -K'
+                        }
+                    }
+                }
                 stage("Test Linux") {
                     agent {
                         label 'linux'

Jenkinsfile

@@ -81,13 +81,29 @@ unit-test:
 	@echo "Running unit tests..."
 	$(GO_TEST) $(shell go list ./... | grep -vE '/e2e')
 
+coverage-bin:
+	$(GO_TEST) -coverpkg="./..." -c -ldflags=$(LDFLAGS) -tags testrunmain -o _build/$(BIN_NAME).cov ./cmd/docker-app
+	go install ./vendor/github.com/wadey/gocovmerge/
+
+coverage: coverage-bin
+	mkdir -p _build/cov
+	@echo "Running e2e tests (coverage)..."
+	DOCKERAPP_BINARY=../e2e/coverage-bin $(GO_TEST) -v ./e2e
+	@echo "Running unit tests (coverage)..."
+	$(GO_TEST) -cover -test.coverprofile=_build/cov/unit.out $(shell go list ./... | grep -vE '/e2e')
+	gocovmerge _build/cov/*.out > _build/cov/all.out
+	go tool cover -func _build/cov/all.out
+	go tool cover -html _build/cov/all.out -o _build/cov/coverage.html
+
 clean:
 	rm -Rf ./_build docker-app-*.tar.gz
 
 ##########################
 # Continuous Integration #
 ##########################
 
+COV_LABEL := com.docker.lunchbox.cov-run=$(TAG)
+
 ci-lint:
 	@echo "Linting..."
 	docker build -t $(IMAGE_NAME)-lint:$(TAG) $(IMAGE_BUILD_ARGS) -f Dockerfile.lint . --target=lint-image
@@ -97,6 +113,11 @@ ci-test:
 	@echo "Testing..."
 	docker build -t $(IMAGE_NAME)-test:$(TAG) $(IMAGE_BUILD_ARGS) . --target=test
 
+ci-coverage:
+	docker build --target=build -t $(IMAGE_NAME)-cov:$(TAG) $(IMAGE_BUILD_ARGS) .
+	docker run --label $(COV_LABEL) $(IMAGE_NAME)-cov:$(TAG) make COMMIT=$(TAG) TAG=$(COMMIT) coverage
+	mkdir -p ./_build && docker cp $$(docker ps -aql --filter label=$(COV_LABEL)):$(PKG_PATH)/_build/cov/ ./_build/ci-cov
+
 ci-bin-all:
 	docker build -t $(IMAGE_NAME)-bin-all:$(TAG) $(IMAGE_BUILD_ARGS) . --target=bin-build
 	$(foreach OS, $(OS_LIST), docker run --rm $(IMAGE_NAME)-bin-all:$(TAG) tar -cz -C $(PKG_PATH)/_build $(BIN_NAME)-$(OS)$(if $(filter windows, $(OS)),.exe,) > $(BIN_NAME)-$(OS)-$(TAG).tar.gz || exit 1;)
@@ -107,5 +128,5 @@ ci-gradle-test:
 	  -e GRADLE_USER_HOME=/tmp/gradle \
 	  gradle:jdk8 bash -c "cd /gradle && gradle --stacktrace build && cd example && gradle renderIt"
 
-.PHONY: bin bin-all test check lint e2e-test e2e-all unit-test clean ci-lint ci-test ci-bin-all ci-e2e-all ci-gradle-test
+.PHONY: bin bin-all release test check lint test-cov e2e-test e2e-all unit-test coverage coverage-bin clean ci-lint ci-test ci-coverage ci-bin-all ci-e2e-all ci-gradle-test
 .DEFAULT: all

Makefile

@@ -0,0 +1,9 @@
+// +build testrunmain
+
+package main
+
+import "testing"
+
+func TestRunMain(t *testing.T) {
+	main()
+}

cmd/docker-app/main_test.go

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# This script is a proxy that injects the required test flags and strips out test output
+# It allows us to use a coverage-enabled binary for e2e tests
+
+BUILD_DIR=${BASH_SOURCE%/*}/../_build
+
+$BUILD_DIR/docker-app.cov \
+    -test.coverprofile=$BUILD_DIR/cov/$(uuidgen).out \
+    "$@" \
+| grep -vE '^PASS$' \
+| grep -vE '^coverage: [0-9]+\.[0-9]+% of statements in .+$' \
+| grep -v '^=== RUN   TestRunMain$'
+
+exit ${PIPESTATUS[0]}