Merge pull request kubernetes#86910 from RaunakShah/golint_vspherestorage

Fix golint errors in test/e2e/storage/vsphere

Author: k8s-ci-robot

hack/.golint_failures

@@ -514,5 +514,4 @@ staging/src/k8s.io/sample-apiserver/pkg/apis/wardle/v1alpha1
 staging/src/k8s.io/sample-apiserver/pkg/registry/wardle/fischer
 staging/src/k8s.io/sample-apiserver/pkg/registry/wardle/flunder
 test/e2e/common
-test/e2e/storage/vsphere
 test/utils

test/e2e/storage/vsphere/bootstrap.go

@@ -49,7 +49,7 @@ func bootstrapOnce() {
 	if err != nil {
 		framework.Failf("Failed to get nodes: %v", err)
 	}
-	TestContext = VSphereContext{NodeMapper: &NodeMapper{}, VSphereInstances: vsphereInstances}
+	TestContext = Context{NodeMapper: &NodeMapper{}, VSphereInstances: vsphereInstances}
 	// 3. Get Node to VSphere mapping
 	err = TestContext.NodeMapper.GenerateNodeMap(vsphereInstances, *nodeList)
 	if err != nil {

test/e2e/storage/vsphere/config.go

@@ -99,7 +99,7 @@ func GetVSphereInstances() (map[string]*VSphere, error) {
 func getConfig() (*ConfigFile, error) {
 	if confFileLocation == "" {
 		if framework.TestContext.CloudConfig.ConfigFile == "" {
-			return nil, fmt.Errorf("Env variable 'VSPHERE_CONF_FILE' is not set, and no config-file specified")
+			return nil, fmt.Errorf("env variable 'VSPHERE_CONF_FILE' is not set, and no config-file specified")
 		}
 		confFileLocation = framework.TestContext.CloudConfig.ConfigFile
 	}

test/e2e/storage/vsphere/context.go

@@ -17,10 +17,10 @@ limitations under the License.
 package vsphere
 
 // Context holds common information for vSphere tests
-type VSphereContext struct {
+type Context struct {
 	NodeMapper       *NodeMapper
 	VSphereInstances map[string]*VSphere
 }
 
 // TestContext should be used by all tests to access common context data. It should be initialized only once, during bootstrapping the tests.
-var TestContext VSphereContext
+var TestContext Context

test/e2e/storage/vsphere/nodemapper.go

@@ -33,9 +33,11 @@ import (
 	neturl "net/url"
 )
 
+// NodeMapper contains information to generate nameToNodeInfo and vcToZoneDatastore maps
 type NodeMapper struct {
 }
 
+// NodeInfo contains information about vcenter nodes
 type NodeInfo struct {
 	Name              string
 	DataCenterRef     types.ManagedObjectReference
@@ -46,9 +48,9 @@ type NodeInfo struct {
 }
 
 const (
-	DatacenterType             = "Datacenter"
-	ClusterComputeResourceType = "ClusterComputeResource"
-	HostSystemType             = "HostSystem"
+	datacenterType             = "Datacenter"
+	clusterComputeResourceType = "ClusterComputeResource"
+	hostSystemType             = "HostSystem"
 )
 
 var (
@@ -58,13 +60,13 @@ var (
 
 // GenerateNodeMap populates node name to node info map
 func (nm *NodeMapper) GenerateNodeMap(vSphereInstances map[string]*VSphere, nodeList v1.NodeList) error {
-	type VmSearch struct {
+	type VMSearch struct {
 		vs         *VSphere
 		datacenter *object.Datacenter
 	}
 
 	var wg sync.WaitGroup
-	var queueChannel []*VmSearch
+	var queueChannel []*VMSearch
 
 	var datacenters []*object.Datacenter
 	var err error
@@ -99,7 +101,7 @@ func (nm *NodeMapper) GenerateNodeMap(vSphereInstances map[string]*VSphere, node
 
 		for _, dc := range datacenters {
 			framework.Logf("Search candidates vc=%s and datacenter=%s", vs.Config.Hostname, dc.Name())
-			queueChannel = append(queueChannel, &VmSearch{vs: vs, datacenter: dc})
+			queueChannel = append(queueChannel, &VMSearch{vs: vs, datacenter: dc})
 		}
 	}
 
@@ -170,7 +172,7 @@ func retrieveZoneInformationForNode(nodeName string, connection *VSphere, hostSy
 		// zone precedence will be received by the HostSystem type.
 		for _, ancestor := range ancestors {
 			moType := ancestor.ExtensibleManagedObject.Self.Type
-			if moType == DatacenterType || moType == ClusterComputeResourceType || moType == HostSystemType {
+			if moType == datacenterType || moType == clusterComputeResourceType || moType == hostSystemType {
 				validAncestors = append(validAncestors, ancestor)
 			}
 		}
@@ -208,7 +210,7 @@ func retrieveZoneInformationForNode(nodeName string, connection *VSphere, hostSy
 	return zones
 }
 
-// Generate zone to datastore mapping for easily verifying volume placement
+// GenerateZoneToDatastoreMap generates a mapping of zone to datastore for easily verifying volume placement
 func (nm *NodeMapper) GenerateZoneToDatastoreMap() error {
 	// 1. Create zone to hosts map for each VC
 	var vcToZoneHostsMap = make(map[string](map[string][]string))
@@ -254,7 +256,7 @@ func (nm *NodeMapper) GenerateZoneToDatastoreMap() error {
 	return nil
 }
 
-// Retrieves the common datastores from the specified hosts
+// retrieveCommonDatastoresAmongHosts retrieves the common datastores from the specified hosts
 func retrieveCommonDatastoresAmongHosts(hosts []string, hostToDatastoresMap map[string][]string) []string {
 	var datastoreCountMap = make(map[string]int)
 	for _, host := range hosts {
@@ -272,12 +274,12 @@ func retrieveCommonDatastoresAmongHosts(hosts []string, hostToDatastoresMap map[
 	return commonDatastores
 }
 
-// Get all the datastores in the specified zone
+// GetDatastoresInZone returns all the datastores in the specified zone
 func (nm *NodeMapper) GetDatastoresInZone(vc string, zone string) []string {
 	return vcToZoneDatastoresMap[vc][zone]
 }
 
-// GetNodeInfo return NodeInfo for given nodeName
+// GetNodeInfo returns NodeInfo for given nodeName
 func (nm *NodeMapper) GetNodeInfo(nodeName string) *NodeInfo {
 	return nameToNodeInfo[nodeName]
 }

test/e2e/storage/vsphere/pvc_label_selector.go

@@ -36,23 +36,23 @@ import (
    ----------
    1. Create VMDK.
    2. Create pv with label volume-type:ssd, volume path set to vmdk created in previous step, and PersistentVolumeReclaimPolicy is set to Delete.
-   3. Create PVC (pvc_vvol) with label selector to match with volume-type:vvol
-   4. Create PVC (pvc_ssd) with label selector to match with volume-type:ssd
-   5. Wait and verify pvc_ssd is bound with PV.
-   6. Verify Status of pvc_vvol is still pending.
-   7. Delete pvc_ssd.
+   3. Create PVC (pvcVvol) with label selector to match with volume-type:vvol
+   4. Create PVC (pvcSsd) with label selector to match with volume-type:ssd
+   5. Wait and verify pvSsd is bound with PV.
+   6. Verify Status of pvcVvol is still pending.
+   7. Delete pvcSsd.
    8. verify associated pv is also deleted.
-   9. delete pvc_vvol
+   9. delete pvcVvol
 
 */
 var _ = utils.SIGDescribe("PersistentVolumes [Feature:LabelSelector]", func() {
 	f := framework.NewDefaultFramework("pvclabelselector")
 	var (
 		c          clientset.Interface
 		ns         string
-		pv_ssd     *v1.PersistentVolume
-		pvc_ssd    *v1.PersistentVolumeClaim
-		pvc_vvol   *v1.PersistentVolumeClaim
+		pvSsd      *v1.PersistentVolume
+		pvcSsd     *v1.PersistentVolumeClaim
+		pvcVvol    *v1.PersistentVolumeClaim
 		volumePath string
 		ssdlabels  map[string]string
 		vvollabels map[string]string
@@ -77,35 +77,35 @@ var _ = utils.SIGDescribe("PersistentVolumes [Feature:LabelSelector]", func() {
 		ginkgo.AfterEach(func() {
 			ginkgo.By("Running clean up actions")
 			if framework.ProviderIs("vsphere") {
-				testCleanupVSpherePVClabelselector(c, ns, nodeInfo, volumePath, pv_ssd, pvc_ssd, pvc_vvol)
+				testCleanupVSpherePVClabelselector(c, ns, nodeInfo, volumePath, pvSsd, pvcSsd, pvcVvol)
 			}
 		})
 		ginkgo.It("should bind volume with claim for given label", func() {
-			volumePath, pv_ssd, pvc_ssd, pvc_vvol, err = testSetupVSpherePVClabelselector(c, nodeInfo, ns, ssdlabels, vvollabels)
+			volumePath, pvSsd, pvcSsd, pvcVvol, err = testSetupVSpherePVClabelselector(c, nodeInfo, ns, ssdlabels, vvollabels)
 			framework.ExpectNoError(err)
 
-			ginkgo.By("wait for the pvc_ssd to bind with pv_ssd")
-			framework.ExpectNoError(e2epv.WaitOnPVandPVC(c, ns, pv_ssd, pvc_ssd))
+			ginkgo.By("wait for the pvcSsd to bind with pvSsd")
+			framework.ExpectNoError(e2epv.WaitOnPVandPVC(c, ns, pvSsd, pvcSsd))
 
-			ginkgo.By("Verify status of pvc_vvol is pending")
-			err = e2epv.WaitForPersistentVolumeClaimPhase(v1.ClaimPending, c, ns, pvc_vvol.Name, 3*time.Second, 300*time.Second)
+			ginkgo.By("Verify status of pvcVvol is pending")
+			err = e2epv.WaitForPersistentVolumeClaimPhase(v1.ClaimPending, c, ns, pvcVvol.Name, 3*time.Second, 300*time.Second)
 			framework.ExpectNoError(err)
 
-			ginkgo.By("delete pvc_ssd")
-			framework.ExpectNoError(e2epv.DeletePersistentVolumeClaim(c, pvc_ssd.Name, ns), "Failed to delete PVC ", pvc_ssd.Name)
+			ginkgo.By("delete pvcSsd")
+			framework.ExpectNoError(e2epv.DeletePersistentVolumeClaim(c, pvcSsd.Name, ns), "Failed to delete PVC ", pvcSsd.Name)
 
-			ginkgo.By("verify pv_ssd is deleted")
-			err = framework.WaitForPersistentVolumeDeleted(c, pv_ssd.Name, 3*time.Second, 300*time.Second)
+			ginkgo.By("verify pvSsd is deleted")
+			err = framework.WaitForPersistentVolumeDeleted(c, pvSsd.Name, 3*time.Second, 300*time.Second)
 			framework.ExpectNoError(err)
 			volumePath = ""
 
-			ginkgo.By("delete pvc_vvol")
-			framework.ExpectNoError(e2epv.DeletePersistentVolumeClaim(c, pvc_vvol.Name, ns), "Failed to delete PVC ", pvc_vvol.Name)
+			ginkgo.By("delete pvcVvol")
+			framework.ExpectNoError(e2epv.DeletePersistentVolumeClaim(c, pvcVvol.Name, ns), "Failed to delete PVC ", pvcVvol.Name)
 		})
 	})
 })
 
-func testSetupVSpherePVClabelselector(c clientset.Interface, nodeInfo *NodeInfo, ns string, ssdlabels map[string]string, vvollabels map[string]string) (volumePath string, pv_ssd *v1.PersistentVolume, pvc_ssd *v1.PersistentVolumeClaim, pvc_vvol *v1.PersistentVolumeClaim, err error) {
+func testSetupVSpherePVClabelselector(c clientset.Interface, nodeInfo *NodeInfo, ns string, ssdlabels map[string]string, vvollabels map[string]string) (volumePath string, pvSsd *v1.PersistentVolume, pvcSsd *v1.PersistentVolumeClaim, pvcVvol *v1.PersistentVolumeClaim, err error) {
 	ginkgo.By("creating vmdk")
 	volumePath = ""
 	volumePath, err = nodeInfo.VSphere.CreateVolume(&VolumeOptions{}, nodeInfo.DataCenterRef)
@@ -114,37 +114,37 @@ func testSetupVSpherePVClabelselector(c clientset.Interface, nodeInfo *NodeInfo,
 	}
 
 	ginkgo.By("creating the pv with label volume-type:ssd")
-	pv_ssd = getVSpherePersistentVolumeSpec(volumePath, v1.PersistentVolumeReclaimDelete, ssdlabels)
-	pv_ssd, err = c.CoreV1().PersistentVolumes().Create(pv_ssd)
+	pvSsd = getVSpherePersistentVolumeSpec(volumePath, v1.PersistentVolumeReclaimDelete, ssdlabels)
+	pvSsd, err = c.CoreV1().PersistentVolumes().Create(pvSsd)
 	if err != nil {
 		return
 	}
 
 	ginkgo.By("creating pvc with label selector to match with volume-type:vvol")
-	pvc_vvol = getVSpherePersistentVolumeClaimSpec(ns, vvollabels)
-	pvc_vvol, err = c.CoreV1().PersistentVolumeClaims(ns).Create(pvc_vvol)
+	pvcVvol = getVSpherePersistentVolumeClaimSpec(ns, vvollabels)
+	pvcVvol, err = c.CoreV1().PersistentVolumeClaims(ns).Create(pvcVvol)
 	if err != nil {
 		return
 	}
 
 	ginkgo.By("creating pvc with label selector to match with volume-type:ssd")
-	pvc_ssd = getVSpherePersistentVolumeClaimSpec(ns, ssdlabels)
-	pvc_ssd, err = c.CoreV1().PersistentVolumeClaims(ns).Create(pvc_ssd)
+	pvcSsd = getVSpherePersistentVolumeClaimSpec(ns, ssdlabels)
+	pvcSsd, err = c.CoreV1().PersistentVolumeClaims(ns).Create(pvcSsd)
 	return
 }
 
-func testCleanupVSpherePVClabelselector(c clientset.Interface, ns string, nodeInfo *NodeInfo, volumePath string, pv_ssd *v1.PersistentVolume, pvc_ssd *v1.PersistentVolumeClaim, pvc_vvol *v1.PersistentVolumeClaim) {
+func testCleanupVSpherePVClabelselector(c clientset.Interface, ns string, nodeInfo *NodeInfo, volumePath string, pvSsd *v1.PersistentVolume, pvcSsd *v1.PersistentVolumeClaim, pvcVvol *v1.PersistentVolumeClaim) {
 	ginkgo.By("running testCleanupVSpherePVClabelselector")
 	if len(volumePath) > 0 {
 		nodeInfo.VSphere.DeleteVolume(volumePath, nodeInfo.DataCenterRef)
 	}
-	if pvc_ssd != nil {
-		framework.ExpectNoError(e2epv.DeletePersistentVolumeClaim(c, pvc_ssd.Name, ns), "Failed to delete PVC ", pvc_ssd.Name)
+	if pvcSsd != nil {
+		framework.ExpectNoError(e2epv.DeletePersistentVolumeClaim(c, pvcSsd.Name, ns), "Failed to delete PVC ", pvcSsd.Name)
 	}
-	if pvc_vvol != nil {
-		framework.ExpectNoError(e2epv.DeletePersistentVolumeClaim(c, pvc_vvol.Name, ns), "Failed to delete PVC ", pvc_vvol.Name)
+	if pvcVvol != nil {
+		framework.ExpectNoError(e2epv.DeletePersistentVolumeClaim(c, pvcVvol.Name, ns), "Failed to delete PVC ", pvcVvol.Name)
 	}
-	if pv_ssd != nil {
-		framework.ExpectNoError(e2epv.DeletePersistentVolume(c, pv_ssd.Name), "Failed to delete PV ", pv_ssd.Name)
+	if pvSsd != nil {
+		framework.ExpectNoError(e2epv.DeletePersistentVolume(c, pvSsd.Name), "Failed to delete PV ", pvSsd.Name)
 	}
 }

test/e2e/storage/vsphere/vsphere.go

@@ -34,14 +34,14 @@ import (
 )
 
 const (
-	VolDir                    = "kubevols"
-	DefaultDiskCapacityKB     = 2097152
-	DefaultDiskFormat         = "thin"
-	DefaultSCSIControllerType = "lsiLogic"
-	VirtualMachineType        = "VirtualMachine"
+	volDir                    = "kubevols"
+	defaultDiskCapacityKB     = 2097152
+	defaultDiskFormat         = "thin"
+	defaultSCSIControllerType = "lsiLogic"
+	virtualMachineType        = "VirtualMachine"
 )
 
-// Represents a vSphere instance where one or more kubernetes nodes are running.
+// VSphere represents a vSphere instance where one or more kubernetes nodes are running.
 type VSphere struct {
 	Config *Config
 	Client *govmomi.Client
@@ -63,7 +63,7 @@ func (vs *VSphere) GetDatacenter(ctx context.Context, datacenterPath string) (*o
 	return finder.Datacenter(ctx, datacenterPath)
 }
 
-// GetDatacenter returns the DataCenter Object for the given datacenterPath
+// GetDatacenterFromObjectReference returns the DataCenter Object for the given datacenter reference
 func (vs *VSphere) GetDatacenterFromObjectReference(ctx context.Context, dc object.Reference) *object.Datacenter {
 	Connect(ctx, vs)
 	return object.NewDatacenter(vs.Client.Client, dc.Reference())
@@ -76,7 +76,7 @@ func (vs *VSphere) GetAllDatacenter(ctx context.Context) ([]*object.Datacenter,
 	return finder.DatacenterList(ctx, "*")
 }
 
-// GetVMByUUID gets the VM object Reference from the given vmUUID
+// GetVMByUUID returns the VM object Reference from the given vmUUID
 func (vs *VSphere) GetVMByUUID(ctx context.Context, vmUUID string, dc object.Reference) (object.Reference, error) {
 	Connect(ctx, vs)
 	datacenter := vs.GetDatacenterFromObjectReference(ctx, dc)
@@ -85,7 +85,7 @@ func (vs *VSphere) GetVMByUUID(ctx context.Context, vmUUID string, dc object.Ref
 	return s.FindByUuid(ctx, datacenter, vmUUID, true, nil)
 }
 
-// Get host object reference of the host on which the specified VM resides
+// GetHostFromVMReference returns host object reference of the host on which the specified VM resides
 func (vs *VSphere) GetHostFromVMReference(ctx context.Context, vm types.ManagedObjectReference) types.ManagedObjectReference {
 	Connect(ctx, vs)
 	var vmMo mo.VirtualMachine
@@ -94,15 +94,15 @@ func (vs *VSphere) GetHostFromVMReference(ctx context.Context, vm types.ManagedO
 	return host
 }
 
-// Get the datastore references of all the datastores mounted on the specified host
+// GetDatastoresMountedOnHost returns the datastore references of all the datastores mounted on the specified host
 func (vs *VSphere) GetDatastoresMountedOnHost(ctx context.Context, host types.ManagedObjectReference) []types.ManagedObjectReference {
 	Connect(ctx, vs)
 	var hostMo mo.HostSystem
 	vs.Client.RetrieveOne(ctx, host, []string{"datastore"}, &hostMo)
 	return hostMo.Datastore
 }
 
-// Get the datastore reference of the specified datastore
+// GetDatastoreRefFromName returns the datastore reference of the specified datastore
 func (vs *VSphere) GetDatastoreRefFromName(ctx context.Context, dc object.Reference, datastoreName string) (types.ManagedObjectReference, error) {
 	Connect(ctx, vs)
 	datacenter := object.NewDatacenter(vs.Client.Client, dc.Reference())
@@ -148,7 +148,7 @@ func (vs *VSphere) CreateVolume(volumeOptions *VolumeOptions, dataCenterRef type
 	if err != nil {
 		return "", fmt.Errorf("Failed while searching for datastore: %s. err: %+v", volumeOptions.Datastore, err)
 	}
-	directoryPath := filepath.Clean(ds.Path(VolDir)) + "/"
+	directoryPath := filepath.Clean(ds.Path(volDir)) + "/"
 	fileManager := object.NewFileManager(ds.Client())
 	err = fileManager.MakeDirectory(ctx, directoryPath, datacenter, false)
 	if err != nil {
@@ -237,7 +237,7 @@ func (vs *VSphere) IsVMPresent(vmName string, dataCenterRef types.ManagedObjectR
 		return
 	}
 	for _, vmFoldersChild := range vmFoldersChildren {
-		if vmFoldersChild.Reference().Type == VirtualMachineType {
+		if vmFoldersChild.Reference().Type == virtualMachineType {
 			if object.NewVirtualMachine(vs.Client.Client, vmFoldersChild.Reference()).Name() == vmName {
 				return true, nil
 			}
@@ -255,15 +255,15 @@ func (vs *VSphere) initVolumeOptions(volumeOptions *VolumeOptions) {
 		volumeOptions.Datastore = vs.Config.DefaultDatastore
 	}
 	if volumeOptions.CapacityKB == 0 {
-		volumeOptions.CapacityKB = DefaultDiskCapacityKB
+		volumeOptions.CapacityKB = defaultDiskCapacityKB
 	}
 	if volumeOptions.Name == "" {
 		volumeOptions.Name = "e2e-vmdk-" + strconv.FormatInt(time.Now().UnixNano(), 10)
 	}
 	if volumeOptions.DiskFormat == "" {
-		volumeOptions.DiskFormat = DefaultDiskFormat
+		volumeOptions.DiskFormat = defaultDiskFormat
 	}
 	if volumeOptions.SCSIControllerType == "" {
-		volumeOptions.SCSIControllerType = DefaultSCSIControllerType
+		volumeOptions.SCSIControllerType = defaultSCSIControllerType
 	}
 }