Generate an instrumented vDVS plugin binary

client_plugin/Makefile

@@ -39,6 +39,7 @@ SCRIPTS     := ../misc/scripts
 PLUGNAME  := docker-volume-vsphere
 SHARED_PLUGNAME  := vsphere-shared
 GOPATH_PLUGNAME := $(PLUGNAME)/client_plugin
+INSTRUMENTED_PLUGIN_BIN := vdvs-instrumented
 GOPATH_ORG :=vmware
 MAINTAINERS := cna-storage@vmware.com
 REPO_URL    := https://github.com/$(GOPATH_ORG)/$(PLUGNAME)
@@ -72,7 +73,11 @@ PLUGIN_BIN = $(BIN)/$(PLUGNAME)
 SHARED_PLUGIN_BIN = $(BIN)/$(SHARED_PLUGNAME)
 
 # all binaries for VMs - plugin and tests
-VM_BINS = $(PLUGIN_BIN) $(BIN)/$(VMDKOPS_TEST_MODULE).test $(BIN)/$(PLUGNAME).test
+# PLUGIN_BIN - vDVS plugin binary
+# $(BIN)/$(VMDKOPS_TEST_MODULE).test - Running mock esx test
+# $(BIN)/$(PLUGNAME).test - Running sanity test
+# $(BIN)/$(INSTRUMENTED_PLUGIN_BIN) - Instrumented vDVS plugin binary for capturing code coverage
+VM_BINS = $(PLUGIN_BIN) $(BIN)/$(VMDKOPS_TEST_MODULE).test $(BIN)/$(PLUGNAME).test $(BIN)/$(INSTRUMENTED_PLUGIN_BIN)
 SHARED_VM_BINS = $(SHARED_PLUGIN_BIN)
 
 VIBFILE := vmware-esx-vmdkops-$(PKG_VERSION).vib
@@ -84,7 +89,7 @@ PLUGIN := github.com/$(GOPATH_ORG)/$(GOPATH_PLUGNAME)
 # test location, picking up E2E tests
 E2E_Tests := github.com/$(GOPATH_ORG)/$(PLUGNAME)/tests/e2e
 
-GO := GO15VENDOREXPERIMENT=1 go
+GO := go
 FPM := fpm
 
 # make sure we rebuild of vmkdops or Dockerfile change (since we develop them together)
@@ -105,6 +110,8 @@ SHARED_PLUGIN_SRC = shared_plugin/main.go drivers/shared/shared_driver.go driver
 
 TEST_SRC = ../tests/utils/inputparams/testparams.go
 
+VMDK_PLUGIN_TEST_SRC = ./vmdk_plugin/*_test.go
+
 # Canned recipe
 define log_target
 @echo
@@ -152,13 +159,17 @@ $(PLUGIN_BIN): $(COMMON_SRC) $(VMDK_PLUGIN_SRC) $(VMDKOPS_MODULE_SRC)
 $(BIN)/$(VMDKOPS_TEST_MODULE).test: $(VMDKOPS_MODULE_SRC) $(TEST_SRC) $(VMDKOPS_MODULE)/*_test.go
 	$(GO) test -c -o $@ $(PLUGIN)/$(VMDKOPS_MODULE) -cover
 
-$(BIN)/$(PLUGNAME).test: $(COMMON_SRC) $(VMDK_PLUGIN_SRC) $(TEST_SRC) ./vmdk_plugin/*_test.go
-	$(GO) test -c -o $@ $(PLUGIN)/vmdk_plugin -cover
+$(BIN)/$(PLUGNAME).test: $(COMMON_SRC) $(VMDK_PLUGIN_SRC) $(TEST_SRC) $(VMDK_PLUGIN_TEST_SRC)
+	$(GO) test -c -o $@ $(PLUGIN)/vmdk_plugin -cover -tags sanity
 
 $(SHARED_PLUGIN_BIN): $(COMMON_SRC) $(SHARED_PLUGIN_SRC)
 	@-mkdir -p $(BIN) && chmod a+w $(BIN)
 	$(GO) build --ldflags '-extldflags "-static"' -o $(SHARED_PLUGIN_BIN) $(PLUGIN)/shared_plugin
 
+# vDVS binary to capture code coverage
+$(BIN)/$(INSTRUMENTED_PLUGIN_BIN): $(COMMON_SRC) $(VMDKOPS_MODULE_SRC) $(VMDK_PLUGIN_TEST_SRC)
+	$(GO) test -coverprofile=/tmp/cover.out -coverpkg=$(PLUGIN)/... -c -o $@ $(PLUGIN)/vmdk_plugin -tags testmain -covermode count
+
 .PHONY: clean
 clean:
 	$(BUILD) clean-as-root

client_plugin/utils/codecov/covdata.go

@@ -0,0 +1,52 @@
+// Copyright 2016 VMware, Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Util to flush out coverage profile from an instrumented binary.
+
+package coverage
+
+import (
+	"fmt"
+	"os"
+	"testing"
+)
+
+type dummyTestDeps func(pat, str string) (bool, error)
+
+// Capture util dumps the collected data locally.
+func Capture() {
+	fmt.Println("START: Collecting coverage profiling data")
+
+	// saving the state
+	oldstdout := os.Stdout
+	oldstderr := os.Stderr
+
+	os.Stdout, _ = os.Open(os.DevNull)
+	os.Stderr, _ = os.Open(os.DevNull)
+
+	tests := []testing.InternalTest{}
+	benchmarks := []testing.InternalBenchmark{}
+	examples := []testing.InternalExample{}
+	var f dummyTestDeps
+
+	dummyM := testing.MainStart(f, tests, benchmarks, examples)
+	dummyM.Run()
+
+	// back to normal state
+	// restore stdout/err
+	os.Stdout = oldstdout
+	os.Stderr = oldstderr
+
+	fmt.Println("END: Collecting coverage data...")
+}

client_plugin/utils/plugin_server/plugin_server.go

@@ -21,6 +21,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/go-plugins-helpers/volume"
+	"github.com/vmware/docker-volume-vsphere/client_plugin/utils/codecov"
 )
 
 // PluginServer responds to HTTP requests from Docker.
@@ -40,6 +41,7 @@ func StartServer(driverName string, driver *volume.Driver) {
 	go func() {
 		sig := <-sigChannel
 		log.WithFields(log.Fields{"signal": sig}).Warning("Received signal ")
+		coverage.Capture()
 		server.Destroy()
 		os.Exit(0)
 	}()

client_plugin/vmdk_plugin/main_test.go

@@ -0,0 +1,28 @@
+// Copyright 2017 VMware, Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.\
+
+// A sample test to run vDVS in a test mode to collect coverage data from
+// an instrumented binary.
+
+// +build testmain
+
+package main
+
+import (
+	"testing"
+)
+
+func TestRunMain(t *testing.T) {
+	main()
+}

client_plugin/vmdk_plugin/sanity_test.go

@@ -16,6 +16,8 @@
 // VMDK Docker driver sanity tests.
 //
 
+// +build sanity
+
 package main
 
 import (