Refactored system unit tests

-Added unit test for mount target ocid specified
-Rebased from master and refactored provisioner deployment

Author: MadalinaPatrichi

.gitignore

@@ -5,4 +5,6 @@ env.sh
 *.log
 test/system/venv/
 test/system/run-test-image.yaml*
-examples/*.yaml
+test/system/templates/*.yaml
+*.pyc
+.vscode/launch.json

Gopkg.toml

@@ -48,7 +48,7 @@ ignored = ["k8s.io/client-go/pkg/api/v1"]
 
 [[override]]
 name = "github.com/docker/distribution"
-revision = "f0cc927784781fa395c06317c58dea2841ece3a9" # Lock in to version 2.6.3 when it is released 
+revision = "f0cc927784781fa395c06317c58dea2841ece3a9" # Lock in to version 2.6.3 when it is released
 
 [[override]]
  name = "k8s.io/api"

cmd/main.go

@@ -26,25 +26,21 @@ import (
 	"github.com/oracle/oci-volume-provisioner/pkg/provisioner/core"
 	"github.com/oracle/oci-volume-provisioner/pkg/signals"
 
+	"k8s.io/apimachinery/pkg/api/resource"
 	"k8s.io/client-go/informers"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/tools/clientcmd"
-
-	"k8s.io/apimachinery/pkg/api/resource"
 )
 
 const (
 	resyncPeriod              = 15 * time.Second
 	minResyncPeriod           = 12 * time.Hour
-	provisionerNameBlock      = "oracle.com/oci"
-	provisionerNameFss        = "oracle.com/oci-fss"
 	exponentialBackOffOnError = false
 	failedRetryThreshold      = 5
 	leasePeriod               = controller.DefaultLeaseDuration
 	retryPeriod               = controller.DefaultRetryPeriod
 	renewDeadline             = controller.DefaultRenewDeadline
 	termLimit                 = controller.DefaultTermLimit
-	provisionerTypeArg        = "provisionerType"
 )
 
 // informerResyncPeriod computes the time interval a shared informer waits
@@ -58,7 +54,7 @@ func informerResyncPeriod(minResyncPeriod time.Duration) func() time.Duration {
 
 func main() {
 	syscall.Umask(0)
-
+	rand.Seed(time.Now().Unix())
 	kubeconfig := flag.String("kubeconfig", "", "Path to Kubeconfig file with authorization and master location information.")
 	volumeRoundingEnabled := flag.Bool("rounding-enabled", true, "When enabled volumes will be rounded up if less than 'minVolumeSizeMB'")
 	minVolumeSize := flag.String("min-volume-size", "50Gi", "The minimum size for a block volume. By default OCI only supports block volumes > 50GB")
@@ -97,7 +93,7 @@ func main() {
 	// Decides what type of provider to deploy, either block or fss
 	provisionerType := os.Getenv("PROVISIONER_TYPE")
 	if provisionerType == "" {
-		provisionerType = provisionerNameBlock
+		provisionerType = core.ProvisionerNameBlock
 	}
 
 	glog.Infof("Starting volume provisioner in %s mode", provisionerType)
@@ -111,8 +107,10 @@ func main() {
 
 	// Create the provisioner: it implements the Provisioner interface expected by
 	// the controller
-	ociProvisioner := core.NewOCIProvisioner(clientset, sharedInformerFactory.Core().V1().Nodes(), nodeName, *volumeRoundingEnabled, volumeSizeLowerBound)
-
+	ociProvisioner, err := core.NewOCIProvisioner(clientset, sharedInformerFactory.Core().V1().Nodes(), provisionerType, nodeName, *volumeRoundingEnabled, volumeSizeLowerBound)
+	if err != nil {
+		glog.Fatalf("Cannot create volume provisioner %v", err)
+	}
 	// Start the provision controller which will dynamically provision oci
 	// PVs
 	pc := controller.NewProvisionController(

examples/example-claim-fss.yaml

@@ -3,12 +3,12 @@ apiVersion: v1
 metadata:
   name: demooci
 spec:
-  storageClassName: "fss"
+  storageClassName: "oci-fss"
   selector:
     matchLabels:
-      oci-availability-domain: "PHX-AD-1"
+      failure-domain.beta.kubernetes.io/zone: "PHX-AD-1"
   accessModes:
     - ReadWriteOnce
   resources:
     requests:
-      storage: 50Gi
+      storage: 50Gi

hack/check-golint.sh

@@ -22,7 +22,7 @@ set -o pipefail
 
 TARGETS=$(for d in "$@"; do echo ./$d/...; done)
 echo -n "Checking golint: "
-ERRS=$(golint ${TARGETS} | grep -v mock_interfaces.go 2>&1 || true)
+ERRS=$(golint ${TARGETS} 2>&1 | grep -v mock_interfaces.go || true)
 if [ -n "${ERRS}" ]; then
     echo "FAIL"
     echo "${ERRS}"

pkg/oci/client/client.go

@@ -28,13 +28,13 @@ import (
 	"time"
 
 	"github.com/golang/glog"
-	"github.com/pkg/errors"
-
 	"github.com/oracle/oci-go-sdk/common"
 	"github.com/oracle/oci-go-sdk/common/auth"
 	"github.com/oracle/oci-go-sdk/core"
 	"github.com/oracle/oci-go-sdk/filestorage"
 	"github.com/oracle/oci-go-sdk/identity"
+	"github.com/pkg/errors"
+
 	"github.com/oracle/oci-volume-provisioner/pkg/oci/instancemeta"
 )
 
@@ -62,8 +62,8 @@ type Identity interface {
 	ListAvailabilityDomains(ctx context.Context, request identity.ListAvailabilityDomainsRequest) (response identity.ListAvailabilityDomainsResponse, err error)
 }
 
-// FileStorage specifies the subset of the OCI core API utilised by the provisioner.
-type FileStorage interface {
+// FSS specifies the subset of the OCI core API utilised by the provisioner.
+type FSS interface {
 	CreateFileSystem(ctx context.Context, request filestorage.CreateFileSystemRequest) (response filestorage.CreateFileSystemResponse, err error)
 	DeleteFileSystem(ctx context.Context, request filestorage.DeleteFileSystemRequest) (response filestorage.DeleteFileSystemResponse, err error)
 	CreateMountTarget(ctx context.Context, request filestorage.CreateMountTargetRequest) (response filestorage.CreateMountTargetResponse, err error)
@@ -73,17 +73,17 @@ type FileStorage interface {
 	ListMountTargets(ctx context.Context, request filestorage.ListMountTargetsRequest) (response filestorage.ListMountTargetsResponse, err error)
 }
 
-//VirtualNetwork specifies the subset of the OCI core API utilised by the provisioner.
-type VirtualNetwork interface {
+//VCN specifies the subset of the OCI core API utilised by the provisioner.
+type VCN interface {
 	GetPrivateIp(ctx context.Context, request core.GetPrivateIpRequest) (response core.GetPrivateIpResponse, err error)
 }
 
 // ProvisionerClient is passed to all sub clients to provision a volume
 type ProvisionerClient interface {
 	BlockStorage() BlockStorage
 	Identity() Identity
-	FileStorage() FileStorage
-	VirtualNetwork() VirtualNetwork
+	FSS() FSS
+	VCN() VCN
 	Context() context.Context
 	Timeout() time.Duration
 	CompartmentOCID() string
@@ -98,11 +98,11 @@ func (p *provisionerClient) Identity() Identity {
 	return p.identity
 }
 
-func (p *provisionerClient) FileStorage() FileStorage {
+func (p *provisionerClient) FSS() FSS {
 	return p.fileStorage
 }
 
-func (p *provisionerClient) VirtualNetwork() VirtualNetwork {
+func (p *provisionerClient) VCN() VCN {
 	return p.virtualNetwork
 }
 

pkg/provisioner/block/block_test.go

@@ -15,19 +15,18 @@
 package block
 
 import (
-	"context"
 	"fmt"
 	"testing"
 	"time"
 
-	"github.com/oracle/oci-volume-provisioner/pkg/helpers"
-	"github.com/oracle/oci-volume-provisioner/pkg/oci/client"
 	"github.com/oracle/oci-volume-provisioner/pkg/oci/instancemeta"
+	"github.com/oracle/oci-volume-provisioner/pkg/provisioner"
 
 	"github.com/kubernetes-incubator/external-storage/lib/controller"
 	"github.com/oracle/oci-go-sdk/common"
 	"github.com/oracle/oci-go-sdk/core"
 	"github.com/oracle/oci-go-sdk/identity"
+
 	"k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -37,6 +36,9 @@ var (
 	volumeBackupID = "dummyVolumeBackupId"
 	defaultAD      = identity.AvailabilityDomain{Name: common.String("PHX-AD-1"), CompartmentId: common.String("ocid1.compartment.oc1")}
 	fileSystemID   = "dummyFileSystemId"
+	exportID       = "dummyExportID"
+	serverIPs      = []string{"dummyServerIP"}
+	privateIP      = "127.0.0.1"
 )
 
 func TestResolveFSTypeWhenNotConfigured(t *testing.T) {
@@ -57,73 +59,14 @@ func TestResolveFSTypeWhenConfigured(t *testing.T) {
 	}
 }
 
-type mockBlockStorageClient struct {
-	volumeState core.VolumeLifecycleStateEnum
-}
-
-func (c *mockBlockStorageClient) CreateVolume(ctx context.Context, request core.CreateVolumeRequest) (response core.CreateVolumeResponse, err error) {
-	return core.CreateVolumeResponse{Volume: core.Volume{Id: common.String(volumeBackupID)}}, nil
-}
-
-func (c *mockBlockStorageClient) DeleteVolume(ctx context.Context, request core.DeleteVolumeRequest) (response core.DeleteVolumeResponse, err error) {
-	return core.DeleteVolumeResponse{}, nil
-}
-
-func (c *mockBlockStorageClient) GetVolume(ctx context.Context, request core.GetVolumeRequest) (response core.GetVolumeResponse, err error) {
-	return core.GetVolumeResponse{Volume: core.Volume{LifecycleState: c.volumeState}}, nil
-}
-
-type mockIdentityClient struct {
-	common.BaseClient
-}
-
-func (client mockIdentityClient) ListAvailabilityDomains(ctx context.Context, request identity.ListAvailabilityDomainsRequest) (response identity.ListAvailabilityDomainsResponse, err error) {
-	return
-}
-
-type mockProvisionerClient struct {
-	storage *mockBlockStorageClient
-}
-
-func (p *mockProvisionerClient) BlockStorage() client.BlockStorage {
-	return p.storage
-}
-
-func (p *mockProvisionerClient) Identity() client.Identity {
-	return &mockIdentityClient{}
-}
-
-func (p *mockProvisionerClient) Context() context.Context {
-	return context.Background()
-}
-
-func (p *mockProvisionerClient) Timeout() time.Duration {
-	return 30 * time.Second
-}
-
-func (p *mockProvisionerClient) CompartmentOCID() (compartmentOCID string) {
-	return ""
-}
-
-func (p *mockProvisionerClient) TenancyOCID() string {
-	return "ocid1.tenancy.oc1..aaaaaaaatyn7scrtwtqedvgrxgr2xunzeo6uanvyhzxqblctwkrpisvke4kq"
-}
-
-// NewClientProvisioner creates an OCI client from the given configuration.
-func NewClientProvisioner(pcData client.ProvisionerClient,
-	storage *mockBlockStorageClient,
-) client.ProvisionerClient {
-	return &mockProvisionerClient{storage: storage}
-}
-
 func TestCreateVolumeFromBackup(t *testing.T) {
 	// test creating a volume from an existing backup
 	options := controller.VolumeOptions{
 		PVName: "dummyVolumeOptions",
 		PVC: &v1.PersistentVolumeClaim{
 			ObjectMeta: metav1.ObjectMeta{
 				Annotations: map[string]string{
-					ociVolumeBackupID: helpers.VolumeBackupID,
+					ociVolumeBackupID: volumeBackupID,
 				},
 			},
 			Spec: v1.PersistentVolumeClaimSpec{
@@ -137,7 +80,7 @@ func TestCreateVolumeFromBackup(t *testing.T) {
 		}}
 
 	block := NewBlockProvisioner(
-		NewClientProvisioner(nil, &mockBlockStorageClient{volumeState: core.VolumeLifecycleStateAvailable}),
+		provisioner.NewClientProvisioner(nil, &provisioner.MockBlockStorageClient{VolumeState: core.VolumeLifecycleStateAvailable}),
 		instancemeta.NewMock(&instancemeta.InstanceMetadata{
 			CompartmentOCID: "",
 			Region:          "phx",
@@ -150,8 +93,8 @@ func TestCreateVolumeFromBackup(t *testing.T) {
 	if err != nil {
 		t.Fatalf("Failed to provision volume from block storage: %v", err)
 	}
-	if provisionedVolume.Annotations[ociVolumeID] != helpers.VolumeBackupID {
-		t.Fatalf("Failed to assign the id of the blockID: %s, assigned %s instead", helpers.VolumeBackupID,
+	if provisionedVolume.Annotations[ociVolumeID] != volumeBackupID {
+		t.Fatalf("Failed to assign the id of the blockID: %s, assigned %s instead", volumeBackupID,
 			provisionedVolume.Annotations[ociVolumeID])
 	}
 }
@@ -183,7 +126,7 @@ func TestCreateVolumeFailure(t *testing.T) {
 					},
 				}}
 
-			block := NewBlockProvisioner(NewClientProvisioner(nil, &mockBlockStorageClient{volumeState: tt.state}),
+			block := NewBlockProvisioner(provisioner.NewClientProvisioner(nil, &provisioner.MockBlockStorageClient{VolumeState: tt.state}),
 				instancemeta.NewMock(&instancemeta.InstanceMetadata{
 					CompartmentOCID: "",
 					Region:          "phx",
@@ -223,7 +166,7 @@ func TestVolumeRoundingLogic(t *testing.T) {
 				CompartmentOCID: "",
 				Region:          "phx",
 			})
-			block := NewBlockProvisioner(NewClientProvisioner(nil, &mockBlockStorageClient{volumeState: core.VolumeLifecycleStateAvailable}),
+			block := NewBlockProvisioner(provisioner.NewClientProvisioner(nil, &provisioner.MockBlockStorageClient{VolumeState: core.VolumeLifecycleStateAvailable}),
 				metadata,
 				tt.enabled,
 				tt.minVolumeSize,

pkg/provisioner/core/provisioner.go

@@ -15,14 +15,14 @@
 package core
 
 import (
-	"errors"
 	"os"
 	"strings"
 	"time"
 
 	"github.com/golang/glog"
-
 	"github.com/kubernetes-incubator/external-storage/lib/controller"
+	"github.com/pkg/errors"
+
 	"k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	informersv1 "k8s.io/client-go/informers/core/v1"
@@ -34,10 +34,17 @@ import (
 	"github.com/oracle/oci-volume-provisioner/pkg/oci/client"
 	"github.com/oracle/oci-volume-provisioner/pkg/oci/instancemeta"
 	"github.com/oracle/oci-volume-provisioner/pkg/provisioner/block"
+	"github.com/oracle/oci-volume-provisioner/pkg/provisioner/fss"
 	"github.com/oracle/oci-volume-provisioner/pkg/provisioner/plugin"
 )
 
 const (
+	// ProvisionerNameDefault is the name of the default OCI volume provisioner (block)
+	ProvisionerNameDefault = "oracle.com/oci"
+	// ProvisionerNameBlock is the name of the OCI block volume provisioner
+	ProvisionerNameBlock = "oracle.com/oci-block"
+	// ProvisionerNameFss is the name of the OCI FSS dedicated storage provisioner
+	ProvisionerNameFss     = "oracle.com/oci-fss"
 	ociProvisionerIdentity = "ociProvisionerIdentity"
 	ociAvailabilityDomain  = "ociAvailabilityDomain"
 	ociCompartment         = "ociCompartment"
@@ -56,7 +63,7 @@ type OCIProvisioner struct {
 }
 
 // NewOCIProvisioner creates a new OCI provisioner.
-func NewOCIProvisioner(kubeClient kubernetes.Interface, nodeInformer informersv1.NodeInformer, nodeName string, volumeRoundingEnabled bool, minVolumeSize resource.Quantity) *OCIProvisioner {
+func NewOCIProvisioner(kubeClient kubernetes.Interface, nodeInformer informersv1.NodeInformer, provisionerType string, nodeName string, volumeRoundingEnabled bool, minVolumeSize resource.Quantity) (*OCIProvisioner, error) {
 	configPath, ok := os.LookupEnv("CONFIG_YAML_FILENAME")
 	if !ok {
 		configPath = configFilePath
@@ -77,19 +84,24 @@ func NewOCIProvisioner(kubeClient kubernetes.Interface, nodeInformer informersv1
 	if err != nil {
 		glog.Fatalf("Unable to create volume provisioner client: %v", err)
 	}
-
-	blockProvisioner := block.NewBlockProvisioner(client, instancemeta.New(),
-		volumeRoundingEnabled,
-		minVolumeSize,
-		time.Minute*3)
-
+	var provisioner plugin.ProvisionerPlugin
+	switch provisionerType {
+	case ProvisionerNameDefault:
+		provisioner = block.NewBlockProvisioner(client, instancemeta.New(), volumeRoundingEnabled, minVolumeSize, time.Minute*3)
+	case ProvisionerNameBlock:
+		provisioner = block.NewBlockProvisioner(client, instancemeta.New(), volumeRoundingEnabled, minVolumeSize, time.Minute*3)
+	case ProvisionerNameFss:
+		provisioner = fss.NewFilesystemProvisioner(client)
+	default:
+		return nil, errors.Errorf("invalid provisioner type %q", provisionerType)
+	}
 	return &OCIProvisioner{
 		client:           client,
 		kubeClient:       kubeClient,
 		nodeLister:       nodeInformer.Lister(),
 		nodeListerSynced: nodeInformer.Informer().HasSynced,
-		provisioner:      blockProvisioner,
-	}
+		provisioner:      provisioner,
+	}, nil
 }
 
 var _ controller.Provisioner = &OCIProvisioner{}