test suite reorganization

.travis.yml

@@ -3,10 +3,7 @@ matrix:
   include:
   - go: 1.10.3
 script:
-- go fmt $(go list ./... | grep -v vendor) | wc -l | grep 0
-- go vet $(go list ./... | grep -v vendor)
-- go test $(go list ./... | grep -v vendor | grep -v "cmd/csi-sanity")
-- ./hack/e2e.sh
+- make test
 after_success:
   - if [ "${TRAVIS_BRANCH}" == "master" ] && [ "${TRAVIS_PULL_REQUEST}" == "false" ]; then
       docker login -u "${DOCKER_USERNAME}" -p "${DOCKER_PASSWORD}" quay.io;

Makefile

@@ -38,5 +38,15 @@ container: $(APP)
 push: container
 	docker push $(IMAGE_NAME):$(IMAGE_VERSION)
 
-.PHONY: all clean container push
-
+test:
+	files=$$(find ./ -name '*.go' | grep -v '^./vendor' ); \
+        if [ $$(gofmt -d $$files | wc -l) -ne 0 ]; then \
+                echo "formatting errors:"; \
+                gofmt -d $$files; \
+                false; \
+        fi
+	go vet $$(go list ./... | grep -v vendor)
+	go test $$(go list ./... | grep -v vendor | grep -v "cmd/csi-sanity")
+	./hack/e2e.sh
+
+.PHONY: all clean container push test

driver/driver.go

@@ -19,15 +19,15 @@ limitations under the License.
 package driver
 
 import (
-	context "context"
+	"context"
 	"errors"
 	"net"
 	"sync"
 
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 
-	csi "github.com/container-storage-interface/spec/lib/go/csi/v0"
+	"github.com/container-storage-interface/spec/lib/go/csi/v0"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/reflection"
 )

hack/e2e.sh

@@ -11,10 +11,10 @@ CSI_MOCK_VERSION="master"
 #      See https://github.com/grpc/grpc/blob/master/doc/naming.md
 runTest()
 {
-	CSI_ENDPOINT=$1 mock &
+	CSI_ENDPOINT=$1 ./bin/mock &
 	local pid=$!
 
-	csi-sanity $TESTARGS --csi.endpoint=$2; ret=$?
+	./cmd/csi-sanity/csi-sanity $TESTARGS --csi.endpoint=$2; ret=$?
 	kill -9 $pid
 
 	if [ $ret -ne 0 ] ; then
@@ -24,18 +24,18 @@ runTest()
 
 runTestWithCreds()
 {
-	CSI_ENDPOINT=$1 CSI_ENABLE_CREDS=true mock &
+	CSI_ENDPOINT=$1 CSI_ENABLE_CREDS=true ./bin/mock &
 	local pid=$!
 
-	csi-sanity $TESTARGS --csi.endpoint=$2 --csi.secrets=mock/mocksecret.yaml; ret=$?
+	./cmd/csi-sanity/csi-sanity $TESTARGS --csi.endpoint=$2 --csi.secrets=mock/mocksecret.yaml; ret=$?
 	kill -9 $pid
 
 	if [ $ret -ne 0 ] ; then
 		exit $ret
 	fi
 }
 
-go install ./mock || exit 1
+go build -o bin/mock ./mock || exit 1
 
 cd cmd/csi-sanity
   make clean install || exit 1

pkg/sanity/cleanup.go

@@ -0,0 +1,134 @@
+/*
+Copyright 2018 Intel Corporation
+
+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.
+*/
+
+package sanity
+
+import (
+	"context"
+	"log"
+
+	"github.com/container-storage-interface/spec/lib/go/csi/v0"
+
+	. "github.com/onsi/ginkgo"
+)
+
+// VolumeInfo keeps track of the information needed to delete a volume.
+type VolumeInfo struct {
+	// Node on which the volume was published, empty if none
+	// or publishing is not supported.
+	NodeID string
+
+	// Volume ID assigned by CreateVolume.
+	VolumeID string
+}
+
+// Cleanup keeps track of resources, in particular volumes, which need
+// to be freed when testing is done.
+type Cleanup struct {
+	Context                    *SanityContext
+	ControllerClient           csi.ControllerClient
+	NodeClient                 csi.NodeClient
+	ControllerPublishSupported bool
+	NodeStageSupported         bool
+
+	// Maps from volume name to the node ID for which the volume
+	// is published and the volume ID.
+	volumes map[string]VolumeInfo
+}
+
+// RegisterVolume adds or updates an entry for the volume with the
+// given name.
+func (cl *Cleanup) RegisterVolume(name string, info VolumeInfo) {
+	if cl.volumes == nil {
+		cl.volumes = make(map[string]VolumeInfo)
+	}
+	cl.volumes[name] = info
+}
+
+// MaybeRegisterVolume adds or updates an entry for the volume with
+// the given name if CreateVolume was successful.
+func (cl *Cleanup) MaybeRegisterVolume(name string, vol *csi.CreateVolumeResponse, err error) {
+	if err == nil && vol.GetVolume().GetId() != "" {
+		cl.RegisterVolume(name, VolumeInfo{VolumeID: vol.GetVolume().GetId()})
+	}
+}
+
+// UnregisterVolume removes the entry for the volume with the
+// given name, thus preventing all cleanup operations for it.
+func (cl *Cleanup) UnregisterVolume(name string) {
+	if cl.volumes != nil {
+		delete(cl.volumes, name)
+	}
+}
+
+// DeleteVolumes stops using the registered volumes and tries to delete all of them.
+func (cl *Cleanup) DeleteVolumes() {
+	if cl.volumes == nil {
+		return
+	}
+	logger := log.New(GinkgoWriter, "cleanup: ", 0)
+	ctx := context.Background()
+
+	for name, info := range cl.volumes {
+		logger.Printf("deleting %s = %s", name, info.VolumeID)
+		if _, err := cl.NodeClient.NodeUnpublishVolume(
+			ctx,
+			&csi.NodeUnpublishVolumeRequest{
+				VolumeId:   info.VolumeID,
+				TargetPath: cl.Context.Config.TargetPath,
+			},
+		); err != nil {
+			logger.Printf("warning: NodeUnpublishVolume: %s", err)
+		}
+
+		if cl.NodeStageSupported {
+			if _, err := cl.NodeClient.NodeUnstageVolume(
+				ctx,
+				&csi.NodeUnstageVolumeRequest{
+					VolumeId:          info.VolumeID,
+					StagingTargetPath: cl.Context.Config.StagingPath,
+				},
+			); err != nil {
+				logger.Printf("warning: NodeUnstageVolume: %s", err)
+			}
+		}
+
+		if cl.ControllerPublishSupported && info.NodeID != "" {
+			if _, err := cl.ControllerClient.ControllerUnpublishVolume(
+				ctx,
+				&csi.ControllerUnpublishVolumeRequest{
+					VolumeId: info.VolumeID,
+					NodeId:   info.NodeID,
+					ControllerUnpublishSecrets: cl.Context.Secrets.ControllerUnpublishVolumeSecret,
+				},
+			); err != nil {
+				logger.Printf("warning: ControllerUnpublishVolume: %s", err)
+			}
+		}
+
+		if _, err := cl.ControllerClient.DeleteVolume(
+			ctx,
+			&csi.DeleteVolumeRequest{
+				VolumeId:                info.VolumeID,
+				ControllerDeleteSecrets: cl.Context.Secrets.DeleteVolumeSecret,
+			},
+		); err != nil {
+			logger.Printf("error: DeleteVolume: %s", err)
+		}
+
+		cl.UnregisterVolume(name)
+	}
+}