Merge pull request kubernetes#81423 from codenrhoden/mount-testing-pkg

Refactor mount fakes

Author: k8s-ci-robot

pkg/kubelet/cm/container_manager_linux_test.go

@@ -31,8 +31,8 @@ import (
 )
 
 func fakeContainerMgrMountInt() mount.Interface {
-	return &mount.FakeMounter{
-		MountPoints: []mount.MountPoint{
+	return mount.NewFakeMounter(
+		[]mount.MountPoint{
 			{
 				Device: "cgroup",
 				Type:   "cgroup",
@@ -53,8 +53,7 @@ func fakeContainerMgrMountInt() mount.Interface {
 				Type:   "cgroup",
 				Opts:   []string{"rw", "relatime", "memory"},
 			},
-		},
-	}
+		})
 }
 
 func TestCgroupMountValidationSuccess(t *testing.T) {
@@ -64,8 +63,8 @@ func TestCgroupMountValidationSuccess(t *testing.T) {
 }
 
 func TestCgroupMountValidationMemoryMissing(t *testing.T) {
-	mountInt := &mount.FakeMounter{
-		MountPoints: []mount.MountPoint{
+	mountInt := mount.NewFakeMounter(
+		[]mount.MountPoint{
 			{
 				Device: "cgroup",
 				Type:   "cgroup",
@@ -81,15 +80,14 @@ func TestCgroupMountValidationMemoryMissing(t *testing.T) {
 				Type:   "cgroup",
 				Opts:   []string{"rw", "relatime", "cpuacct"},
 			},
-		},
-	}
+		})
 	_, err := validateSystemRequirements(mountInt)
 	assert.Error(t, err)
 }
 
 func TestCgroupMountValidationMultipleSubsystem(t *testing.T) {
-	mountInt := &mount.FakeMounter{
-		MountPoints: []mount.MountPoint{
+	mountInt := mount.NewFakeMounter(
+		[]mount.MountPoint{
 			{
 				Device: "cgroup",
 				Type:   "cgroup",
@@ -105,8 +103,7 @@ func TestCgroupMountValidationMultipleSubsystem(t *testing.T) {
 				Type:   "cgroup",
 				Opts:   []string{"rw", "relatime", "cpuacct"},
 			},
-		},
-	}
+		})
 	_, err := validateSystemRequirements(mountInt)
 	assert.Nil(t, err)
 }
@@ -118,8 +115,8 @@ func TestSoftRequirementsValidationSuccess(t *testing.T) {
 	defer os.RemoveAll(tempDir)
 	req.NoError(ioutil.WriteFile(path.Join(tempDir, "cpu.cfs_period_us"), []byte("0"), os.ModePerm))
 	req.NoError(ioutil.WriteFile(path.Join(tempDir, "cpu.cfs_quota_us"), []byte("0"), os.ModePerm))
-	mountInt := &mount.FakeMounter{
-		MountPoints: []mount.MountPoint{
+	mountInt := mount.NewFakeMounter(
+		[]mount.MountPoint{
 			{
 				Device: "cgroup",
 				Type:   "cgroup",
@@ -136,8 +133,7 @@ func TestSoftRequirementsValidationSuccess(t *testing.T) {
 				Type:   "cgroup",
 				Opts:   []string{"rw", "relatime", "cpuacct", "memory"},
 			},
-		},
-	}
+		})
 	f, err := validateSystemRequirements(mountInt)
 	assert.NoError(t, err)
 	assert.True(t, f.cpuHardcapping, "cpu hardcapping is expected to be enabled")

pkg/kubelet/kubelet_test.go

@@ -161,7 +161,7 @@ func newTestKubeletWithImageList(
 	kubelet.kubeClient = fakeKubeClient
 	kubelet.heartbeatClient = fakeKubeClient
 	kubelet.os = &containertest.FakeOS{}
-	kubelet.mounter = &mount.FakeMounter{}
+	kubelet.mounter = mount.NewFakeMounter(nil)
 	kubelet.hostutil = hostutil.NewFakeHostUtil(nil)
 	kubelet.subpather = &subpath.FakeSubpath{}
 

pkg/kubelet/runonce_test.go

@@ -129,7 +129,7 @@ func TestRunOnce(t *testing.T) {
 
 	kb.evictionManager = evictionManager
 	kb.admitHandlers.AddPodAdmitHandler(evictionAdmitHandler)
-	kb.mounter = &mount.FakeMounter{}
+	kb.mounter = mount.NewFakeMounter(nil)
 	if err := kb.setupDataDirs(); err != nil {
 		t.Errorf("Failed to init data dirs: %v", err)
 	}

pkg/kubelet/volumemanager/reconciler/reconciler_test.go

@@ -84,7 +84,7 @@ func Test_Run_Positive_DoNothing(t *testing.T) {
 		asw,
 		hasAddedPods,
 		oex,
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		volumePluginMgr,
 		kubeletPodsDir)
@@ -128,7 +128,7 @@ func Test_Run_Positive_VolumeAttachAndMount(t *testing.T) {
 		asw,
 		hasAddedPods,
 		oex,
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		volumePluginMgr,
 		kubeletPodsDir)
@@ -206,7 +206,7 @@ func Test_Run_Positive_VolumeMountControllerAttachEnabled(t *testing.T) {
 		asw,
 		hasAddedPods,
 		oex,
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		volumePluginMgr,
 		kubeletPodsDir)
@@ -285,7 +285,7 @@ func Test_Run_Positive_VolumeAttachMountUnmountDetach(t *testing.T) {
 		asw,
 		hasAddedPods,
 		oex,
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		volumePluginMgr,
 		kubeletPodsDir)
@@ -375,7 +375,7 @@ func Test_Run_Positive_VolumeUnmountControllerAttachEnabled(t *testing.T) {
 		asw,
 		hasAddedPods,
 		oex,
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		volumePluginMgr,
 		kubeletPodsDir)
@@ -502,7 +502,7 @@ func Test_Run_Positive_VolumeAttachAndMap(t *testing.T) {
 		asw,
 		hasAddedPods,
 		oex,
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		volumePluginMgr,
 		kubeletPodsDir)
@@ -608,7 +608,7 @@ func Test_Run_Positive_BlockVolumeMapControllerAttachEnabled(t *testing.T) {
 		asw,
 		hasAddedPods,
 		oex,
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		volumePluginMgr,
 		kubeletPodsDir)
@@ -709,7 +709,7 @@ func Test_Run_Positive_BlockVolumeAttachMapUnmapDetach(t *testing.T) {
 		asw,
 		hasAddedPods,
 		oex,
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		volumePluginMgr,
 		kubeletPodsDir)
@@ -823,7 +823,7 @@ func Test_Run_Positive_VolumeUnmapControllerAttachEnabled(t *testing.T) {
 		asw,
 		hasAddedPods,
 		oex,
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		volumePluginMgr,
 		kubeletPodsDir)
@@ -1096,7 +1096,7 @@ func Test_Run_Positive_VolumeFSResizeControllerAttachEnabled(t *testing.T) {
 				asw,
 				hasAddedPods,
 				oex,
-				&mount.FakeMounter{},
+				mount.NewFakeMounter(nil),
 				hostutil.NewFakeHostUtil(nil),
 				volumePluginMgr,
 				kubeletPodsDir)
@@ -1278,7 +1278,7 @@ func Test_Run_Positive_VolumeMountControllerAttachEnabledRace(t *testing.T) {
 		asw,
 		hasAddedPods,
 		oex,
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		volumePluginMgr,
 		kubeletPodsDir)

pkg/kubelet/volumemanager/volume_manager_test.go

@@ -302,7 +302,7 @@ func newTestVolumeManager(tmpDir string, podManager kubepod.Manager, kubeClient
 		kubeClient,
 		plugMgr,
 		&containertest.FakeRuntime{},
-		&mount.FakeMounter{},
+		mount.NewFakeMounter(nil),
 		hostutil.NewFakeHostUtil(nil),
 		"",
 		fakeRecorder,

pkg/util/mount/BUILD

@@ -5,7 +5,8 @@ go_library(
     srcs = [
         "doc.go",
         "exec.go",
-        "fake.go",
+        "fake_exec.go",
+        "fake_mounter.go",
         "mount.go",
         "mount_helper_common.go",
         "mount_helper_unix.go",

pkg/util/mount/exec.go

@@ -19,35 +19,18 @@ package mount
 import "k8s.io/utils/exec"
 
 // NewOSExec returns a new Exec interface implementation based on exec()
-func NewOSExec() Exec {
-	return &osExec{}
+func NewOSExec() *OSExec {
+	return &OSExec{}
 }
 
-// Real implementation of Exec interface that uses simple utils.Exec
-type osExec struct{}
+// OSExec is an implementation of Exec interface that uses simple utils.Exec
+type OSExec struct{}
 
-var _ Exec = &osExec{}
+var _ Exec = &OSExec{}
 
-func (e *osExec) Run(cmd string, args ...string) ([]byte, error) {
+// Run exucutes the given cmd and arges and returns stdout and stderr as a
+// combined byte stream
+func (e *OSExec) Run(cmd string, args ...string) ([]byte, error) {
 	exe := exec.New()
 	return exe.Command(cmd, args...).CombinedOutput()
 }
-
-// NewFakeExec returns a new FakeExec
-func NewFakeExec(run runHook) *FakeExec {
-	return &FakeExec{runHook: run}
-}
-
-// FakeExec for testing.
-type FakeExec struct {
-	runHook runHook
-}
-type runHook func(cmd string, args ...string) ([]byte, error)
-
-// Run executes the command using the optional runhook, if given
-func (f *FakeExec) Run(cmd string, args ...string) ([]byte, error) {
-	if f.runHook != nil {
-		return f.runHook(cmd, args...)
-	}
-	return nil, nil
-}

pkg/util/mount/fake_exec.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2017 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.
+*/
+
+package mount
+
+// NewFakeExec returns a new FakeExec
+func NewFakeExec(run runHook) *FakeExec {
+	return &FakeExec{runHook: run}
+}
+
+// FakeExec for testing.
+type FakeExec struct {
+	runHook runHook
+}
+type runHook func(cmd string, args ...string) ([]byte, error)
+
+// Run executes the command using the optional runhook, if given
+func (f *FakeExec) Run(cmd string, args ...string) ([]byte, error) {
+	if f.runHook != nil {
+		return f.runHook(cmd, args...)
+	}
+	return nil, nil
+}

pkg/util/mount/fake.go renamed to pkg/util/mount/fake_mounter.go

@@ -27,7 +27,7 @@ import (
 // FakeMounter implements mount.Interface for tests.
 type FakeMounter struct {
 	MountPoints []MountPoint
-	Log         []FakeAction
+	log         []FakeAction
 	// Error to return for a path when calling IsLikelyNotMountPoint
 	MountCheckErrors map[string]error
 	// Some tests run things in parallel, make sure the mounter does not produce
@@ -55,12 +55,26 @@ type FakeAction struct {
 	FSType string // applies only to "mount" actions
 }
 
+func NewFakeMounter(mps []MountPoint) *FakeMounter {
+	return &FakeMounter{
+		MountPoints: mps,
+	}
+}
+
 // ResetLog clears all the log entries in FakeMounter
 func (f *FakeMounter) ResetLog() {
 	f.mutex.Lock()
 	defer f.mutex.Unlock()
 
-	f.Log = []FakeAction{}
+	f.log = []FakeAction{}
+}
+
+// GetLog returns the slice of FakeActions taken by the mounter
+func (f *FakeMounter) GetLog() []FakeAction {
+	f.mutex.Lock()
+	defer f.mutex.Unlock()
+
+	return f.log
 }
 
 // Mount records the mount event and updates the in-memory mount points for FakeMounter
@@ -102,7 +116,7 @@ func (f *FakeMounter) Mount(source string, target string, fstype string, options
 	}
 	f.MountPoints = append(f.MountPoints, MountPoint{Device: source, Path: absTarget, Type: fstype, Opts: opts})
 	klog.V(5).Infof("Fake mounter: mounted %s to %s", source, absTarget)
-	f.Log = append(f.Log, FakeAction{Action: FakeActionMount, Target: absTarget, Source: source, FSType: fstype})
+	f.log = append(f.log, FakeAction{Action: FakeActionMount, Target: absTarget, Source: source, FSType: fstype})
 	return nil
 }
 
@@ -133,7 +147,7 @@ func (f *FakeMounter) Unmount(target string) error {
 		newMountpoints = append(newMountpoints, MountPoint{Device: mp.Device, Path: mp.Path, Type: mp.Type})
 	}
 	f.MountPoints = newMountpoints
-	f.Log = append(f.Log, FakeAction{Action: FakeActionUnmount, Target: absTarget})
+	f.log = append(f.log, FakeAction{Action: FakeActionUnmount, Target: absTarget})
 	delete(f.MountCheckErrors, target)
 	return nil
 }

pkg/util/mount/mount_helper_test.go

@@ -93,10 +93,10 @@ func TestDoCleanupMountPoint(t *testing.T) {
 				t.Fatalf("failed to prepare test: %v", err)
 			}
 
-			fake := &FakeMounter{
-				MountPoints:      []MountPoint{mountPoint},
-				MountCheckErrors: map[string]error{mountPoint.Path: mountError},
-			}
+			fake := NewFakeMounter(
+				[]MountPoint{mountPoint},
+			)
+			fake.MountCheckErrors = map[string]error{mountPoint.Path: mountError}
 
 			err = doCleanupMountPoint(mountPoint.Path, fake, true, tt.corruptedMnt)
 			if tt.expectErr {