add mock for azcopy ut

Author: umagnus

hack/boilerplate/boilerplate.generatego.txt

@@ -0,0 +1,15 @@
+/*
+Copyright The Kubernetes Authors.
+
+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.
+*/

hack/boilerplate/boilerplate.gomock.txt

@@ -0,0 +1,15 @@
+// /*
+// Copyright The Kubernetes Authors.
+//
+// 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.
+// */

hack/update-mock.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Copyright 2020 The Kubernetes Authors.
+#
+# 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.
+
+set -euo pipefail
+
+REPO_ROOT=$(realpath $(dirname ${BASH_SOURCE})/..)
+COPYRIGHT_FILE="${REPO_ROOT}/hack/boilerplate/boilerplate.generatego.txt"
+
+if ! type mockgen &> /dev/null; then
+    echo "mockgen not exist, install it"
+    go install github.com/golang/mock/[email protected]
+fi
+
+echo "Updating mocks for util.go"
+mockgen -copyright_file=$COPYRIGHT_FILE -source=pkg/util/util.go -package=util -destination=pkg/util/util_mock.go

pkg/azurefile/azurefile.go

@@ -46,6 +46,7 @@ import (
 
 	csicommon "sigs.k8s.io/azurefile-csi-driver/pkg/csi-common"
 	"sigs.k8s.io/azurefile-csi-driver/pkg/mounter"
+	fileutil "sigs.k8s.io/azurefile-csi-driver/pkg/util"
 	"sigs.k8s.io/cloud-provider-azure/pkg/azureclients/fileclient"
 	azcache "sigs.k8s.io/cloud-provider-azure/pkg/cache"
 	azure "sigs.k8s.io/cloud-provider-azure/pkg/provider"
@@ -269,6 +270,8 @@ type Driver struct {
 	volStatsCache azcache.Resource
 	// sas expiry time for azcopy in volume clone
 	sasTokenExpirationMinutes int
+	// azcopyFunc for provide exec mock for ut
+	azcopyFunc *fileutil.AzcopyFunc
 }
 
 // NewDriver Creates a NewCSIDriver object. Assumes vendor version is equal to driver version &
@@ -300,6 +303,7 @@ func NewDriver(options *DriverOptions) *Driver {
 	driver.volLockMap = newLockMap()
 	driver.subnetLockMap = newLockMap()
 	driver.volumeLocks = newVolumeLocks()
+	driver.azcopyFunc = &fileutil.AzcopyFunc{}
 
 	var err error
 	getter := func(key string) (interface{}, error) { return nil, nil }
@@ -928,21 +932,22 @@ func (d *Driver) copyFileShare(ctx context.Context, req *csi.CreateVolumeRequest
 	srcPath := fmt.Sprintf("https://%s.file.%s/%s%s", accountName, storageEndpointSuffix, srcFileShareName, accountSasToken)
 	dstPath := fmt.Sprintf("https://%s.file.%s/%s%s", accountName, storageEndpointSuffix, dstFileShareName, accountSasToken)
 
-	jobState, percent, err := getAzcopyJob(dstFileShareName)
+	aFunc := d.azcopyFunc
+	jobState, percent, err := aFunc.GetAzcopyJob(dstFileShareName)
 	klog.V(2).Infof("azcopy job status: %s, copy percent: %s%%, error: %v", jobState, percent, err)
-	if jobState == AzcopyJobError || jobState == AzcopyJobCompleted {
+	if jobState == fileutil.AzcopyJobError || jobState == fileutil.AzcopyJobCompleted {
 		return err
 	}
 	klog.V(2).Infof("begin to copy fileshare %s to %s", srcFileShareName, dstFileShareName)
 	for {
 		select {
 		case <-timeTick:
-			jobState, percent, err := getAzcopyJob(dstFileShareName)
+			jobState, percent, err := aFunc.GetAzcopyJob(dstFileShareName)
 			klog.V(2).Infof("azcopy job status: %s, copy percent: %s%%, error: %v", jobState, percent, err)
 			switch jobState {
-			case AzcopyJobError, AzcopyJobCompleted:
+			case fileutil.AzcopyJobError, fileutil.AzcopyJobCompleted:
 				return err
-			case AzcopyJobNotFound:
+			case fileutil.AzcopyJobNotFound:
 				klog.V(2).Infof("copy fileshare %s to %s", srcFileShareName, dstFileShareName)
 				out, copyErr := exec.Command("azcopy", "copy", srcPath, dstPath, "--recursive", "--check-length=false").CombinedOutput()
 				if copyErr != nil {

pkg/azurefile/controllerserver.go

@@ -108,7 +108,8 @@ func (d *Driver) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest)
 	if acquired := d.volumeLocks.TryAcquire(volName); !acquired {
 		// logging the job status if it's volume cloning
 		if req.GetVolumeContentSource() != nil {
-			jobState, percent, err := getAzcopyJob(volName)
+			aFunc := d.azcopyFunc
+			jobState, percent, err := aFunc.GetAzcopyJob(volName)
 			klog.V(2).Infof("azcopy job status: %s, copy percent: %s%%, error: %v", jobState, percent, err)
 		}
 		return nil, status.Errorf(codes.Aborted, volumeOperationAlreadyExistsFmt, volName)

pkg/azurefile/controllerserver_test.go

@@ -23,12 +23,14 @@ import (
 	"net/http"
 	"net/url"
 	"reflect"
-	"sigs.k8s.io/cloud-provider-azure/pkg/azureclients/fileclient"
 	"strings"
 	"sync"
 	"testing"
 	"time"
 
+	"sigs.k8s.io/azurefile-csi-driver/pkg/util"
+	"sigs.k8s.io/cloud-provider-azure/pkg/azureclients/fileclient"
+
 	"github.com/Azure/azure-sdk-for-go/services/network/mgmt/2022-07-01/network"
 	"sigs.k8s.io/cloud-provider-azure/pkg/azureclients/subnetclient/mocksubnetclient"
 	azcache "sigs.k8s.io/cloud-provider-azure/pkg/cache"
@@ -1783,6 +1785,95 @@ func TestCopyVolume(t *testing.T) {
 				}
 			},
 		},
+		{
+			name: "azcopy job is already completed",
+			testFunc: func(t *testing.T) {
+				d := NewFakeDriver()
+				mp := map[string]string{}
+
+				volumeSource := &csi.VolumeContentSource_VolumeSource{
+					VolumeId: "vol_1#f5713de20cde511e8ba4900#fileshare#",
+				}
+				volumeContentSourceVolumeSource := &csi.VolumeContentSource_Volume{
+					Volume: volumeSource,
+				}
+				volumecontensource := csi.VolumeContentSource{
+					Type: volumeContentSourceVolumeSource,
+				}
+
+				req := &csi.CreateVolumeRequest{
+					Name:                "unit-test",
+					VolumeCapabilities:  stdVolCap,
+					Parameters:          mp,
+					VolumeContentSource: &volumecontensource,
+				}
+
+				ctrl := gomock.NewController(t)
+				defer ctrl.Finish()
+
+				m := util.NewMockEXEC(ctrl)
+				listStr := "JobId: ed1c3833-eaff-fe42-71d7-513fb065a9d9\nStart Time: Monday, 07-Aug-23 03:29:54 UTC\nStatus: Completed\nCommand: copy https://{accountName}.file.core.windows.net/{srcFileshare}{SAStoken} https://{accountName}.file.core.windows.net/{dstFileshare}{SAStoken} --recursive --check-length=false"
+				m.EXPECT().RunCommand(gomock.Eq("azcopy jobs list | grep dstFileshare -B 3")).Return(listStr, nil)
+				// if test.enableShow {
+				// 	m.EXPECT().RunCommand(gomock.Not("azcopy jobs list | grep dstContainer -B 3")).Return(test.showStr, test.showErr)
+				// }
+
+				d.azcopyFunc.ExecCmd = m
+
+				ctx := context.Background()
+
+				var expectedErr error
+				err := d.copyVolume(ctx, req, "", &fileclient.ShareOptions{Name: "dstFileshare"}, "core.windows.net")
+				if !reflect.DeepEqual(err, expectedErr) {
+					t.Errorf("Unexpected error: %v", err)
+				}
+			},
+		},
+		{
+			name: "azcopy job is first in progress and then be completed",
+			testFunc: func(t *testing.T) {
+				d := NewFakeDriver()
+				mp := map[string]string{}
+
+				volumeSource := &csi.VolumeContentSource_VolumeSource{
+					VolumeId: "vol_1#f5713de20cde511e8ba4900#fileshare#",
+				}
+				volumeContentSourceVolumeSource := &csi.VolumeContentSource_Volume{
+					Volume: volumeSource,
+				}
+				volumecontensource := csi.VolumeContentSource{
+					Type: volumeContentSourceVolumeSource,
+				}
+
+				req := &csi.CreateVolumeRequest{
+					Name:                "unit-test",
+					VolumeCapabilities:  stdVolCap,
+					Parameters:          mp,
+					VolumeContentSource: &volumecontensource,
+				}
+
+				ctrl := gomock.NewController(t)
+				defer ctrl.Finish()
+
+				m := util.NewMockEXEC(ctrl)
+				listStr1 := "JobId: ed1c3833-eaff-fe42-71d7-513fb065a9d9\nStart Time: Monday, 07-Aug-23 03:29:54 UTC\nStatus: InProgress\nCommand: copy https://{accountName}.file.core.windows.net/{srcFileshare}{SAStoken} https://{accountName}.file.core.windows.net/{dstFileshare}{SAStoken} --recursive --check-length=false"
+				listStr2 := "JobId: ed1c3833-eaff-fe42-71d7-513fb065a9d9\nStart Time: Monday, 07-Aug-23 03:29:54 UTC\nStatus: Completed\nCommand: copy https://{accountName}.file.core.windows.net/{srcFileshare}{SAStoken} https://{accountName}.file.core.windows.net/{dstFileshare}{SAStoken} --recursive --check-length=false"
+				o1 := m.EXPECT().RunCommand(gomock.Eq("azcopy jobs list | grep dstFileshare -B 3")).Return(listStr1, nil).Times(1)
+				m.EXPECT().RunCommand(gomock.Not("azcopy jobs list | grep dstFileshare -B 3")).Return("Percent Complete (approx): 50.0", nil)
+				o2 := m.EXPECT().RunCommand(gomock.Eq("azcopy jobs list | grep dstFileshare -B 3")).Return(listStr2, nil)
+				gomock.InOrder(o1, o2)
+
+				d.azcopyFunc.ExecCmd = m
+
+				ctx := context.Background()
+
+				var expectedErr error
+				err := d.copyVolume(ctx, req, "", &fileclient.ShareOptions{Name: "dstFileshare"}, "core.windows.net")
+				if !reflect.DeepEqual(err, expectedErr) {
+					t.Errorf("Unexpected error: %v", err)
+				}
+			},
+		},
 	}
 
 	for _, tc := range testCases {

pkg/azurefile/utils.go

@@ -19,7 +19,6 @@ package azurefile
 import (
 	"fmt"
 	"os"
-	"os/exec"
 	"strconv"
 	"strings"
 	"sync"
@@ -35,15 +34,6 @@ const (
 	tagKeyValueDelimiter = "="
 )
 
-type AzcopyJobState string
-
-const (
-	AzcopyJobError     AzcopyJobState = "Error"
-	AzcopyJobNotFound  AzcopyJobState = "NotFound"
-	AzcopyJobRunning   AzcopyJobState = "Running"
-	AzcopyJobCompleted AzcopyJobState = "Completed"
-)
-
 // lockMap used to lock on entries
 type lockMap struct {
 	sync.Mutex
@@ -275,87 +265,3 @@ func replaceWithMap(str string, m map[string]string) string {
 	}
 	return str
 }
-
-// getAzcopyJob get the azcopy job status if job existed
-func getAzcopyJob(dstFileshare string) (AzcopyJobState, string, error) {
-	cmdStr := fmt.Sprintf("azcopy jobs list | grep %s -B 3", dstFileshare)
-	// cmd output example:
-	// JobId: ed1c3833-eaff-fe42-71d7-513fb065a9d9
-	// Start Time: Monday, 07-Aug-23 03:29:54 UTC
-	// Status: Completed (or Cancelled, InProgress)
-	// Command: copy https://{accountName}.file.core.windows.net/{srcFileshare}{SAStoken} https://{accountName}.file.core.windows.net/{dstFileshare}{SAStoken} --recursive --check-length=false
-	// --
-	// JobId: b598cce3-9aa9-9640-7793-c2bf3c385a9a
-	// Start Time: Wednesday, 09-Aug-23 09:09:03 UTC
-	// Status: Cancelled
-	// Command: copy https://{accountName}.file.core.windows.net/{srcFileshare}{SAStoken} https://{accountName}.file.core.windows.net/{dstFileshare}{SAStoken} --recursive --check-length=false
-	out, err := exec.Command("sh", "-c", cmdStr).CombinedOutput()
-	// if grep command returns nothing, the exec will return exit status 1 error, so filter this error
-	if err != nil && err.Error() != "exit status 1" {
-		klog.Warningf("failed to get azcopy job with error: %v, jobState: %v", err, AzcopyJobError)
-		return AzcopyJobError, "", fmt.Errorf("couldn't list jobs in azcopy %v", err)
-	}
-	jobid, jobState, err := parseAzcopyJobList(string(out), dstFileshare)
-	if err != nil || jobState == AzcopyJobError {
-		klog.Warningf("failed to get azcopy job with error: %v, jobState: %v", err, jobState)
-		return AzcopyJobError, "", fmt.Errorf("couldn't parse azcopy job list in azcopy %v", err)
-	}
-	if jobState == AzcopyJobCompleted {
-		return jobState, "100.0", err
-	}
-	if jobid == "" {
-		return jobState, "", err
-	}
-	cmdPercentStr := fmt.Sprintf("azcopy jobs show %s | grep Percent", jobid)
-	// cmd out example:
-	// Percent Complete (approx): 100.0
-	summary, err := exec.Command("sh", "-c", cmdPercentStr).CombinedOutput()
-	if err != nil {
-		klog.Warningf("failed to get azcopy job with error: %v, jobState: %v", err, AzcopyJobError)
-		return AzcopyJobError, "", fmt.Errorf("couldn't show jobs summary in azcopy %v", err)
-	}
-	jobState, percent, err := parseAzcopyJobShow(string(summary))
-	if err != nil || jobState == AzcopyJobError {
-		klog.Warningf("failed to get azcopy job with error: %v, jobState: %v", err, jobState)
-		return AzcopyJobError, "", fmt.Errorf("couldn't parse azcopy job show in azcopy %v", err)
-	}
-	return jobState, percent, nil
-}
-
-func parseAzcopyJobList(joblist string, dstFileShareName string) (string, AzcopyJobState, error) {
-	jobid := ""
-	jobSegments := strings.Split(joblist, "JobId: ")
-	if len(jobSegments) < 2 {
-		return jobid, AzcopyJobNotFound, nil
-	}
-	jobSegments = jobSegments[1:]
-	for _, job := range jobSegments {
-		segments := strings.Split(job, "\n")
-		if len(segments) < 4 {
-			return jobid, AzcopyJobError, fmt.Errorf("error parsing jobs list: %s", job)
-		}
-		statusSegments := strings.Split(segments[2], ": ")
-		if len(statusSegments) < 2 {
-			return jobid, AzcopyJobError, fmt.Errorf("error parsing jobs list status: %s", segments[2])
-		}
-		status := statusSegments[1]
-		switch status {
-		case "InProgress":
-			jobid = segments[0]
-		case "Completed":
-			return jobid, AzcopyJobCompleted, nil
-		}
-	}
-	if jobid == "" {
-		return jobid, AzcopyJobNotFound, nil
-	}
-	return jobid, AzcopyJobRunning, nil
-}
-
-func parseAzcopyJobShow(jobshow string) (AzcopyJobState, string, error) {
-	segments := strings.Split(jobshow, ": ")
-	if len(segments) < 2 {
-		return AzcopyJobError, "", fmt.Errorf("error parsing jobs summary: %s in Percent Complete (approx)", jobshow)
-	}
-	return AzcopyJobRunning, strings.ReplaceAll(segments[1], "\n", ""), nil
-}