Fix golint errors in pkg/scheduler based on golint check

kubernetes · Feb 8, 2018 · 3fdacfe · 3fdacfe
1 parent a4e49d1
commit 3fdacfe
Show file tree

Hide file tree

Showing 51 changed files with 512 additions and 304 deletions.
diff --git a/pkg/scheduler/algorithm/doc.go b/pkg/scheduler/algorithm/doc.go
@@ -14,6 +14,6 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package scheduler contains a generic Scheduler interface and several
+// Package algorithm contains a generic Scheduler interface and several
 // implementations.
 package algorithm // import "k8s.io/kubernetes/pkg/scheduler/algorithm"
diff --git a/pkg/scheduler/algorithm/predicates/error.go b/pkg/scheduler/algorithm/predicates/error.go
@@ -30,28 +30,51 @@ var (
 	// be made to pass by removing pods, or you change an existing predicate so that
 	// it can never be made to pass by removing pods, you need to add the predicate
 	// failure error in nodesWherePreemptionMightHelp() in scheduler/core/generic_scheduler.go
-	ErrDiskConflict                          = newPredicateFailureError("NoDiskConflict", "node(s) had no available disk")
-	ErrVolumeZoneConflict                    = newPredicateFailureError("NoVolumeZoneConflict", "node(s) had no available volume zone")
-	ErrNodeSelectorNotMatch                  = newPredicateFailureError("MatchNodeSelector", "node(s) didn't match node selector")
-	ErrPodAffinityNotMatch                   = newPredicateFailureError("MatchInterPodAffinity", "node(s) didn't match pod affinity/anti-affinity")
-	ErrPodAffinityRulesNotMatch              = newPredicateFailureError("PodAffinityRulesNotMatch", "node(s) didn't match pod affinity rules")
-	ErrPodAntiAffinityRulesNotMatch          = newPredicateFailureError("PodAntiAffinityRulesNotMatch", "node(s) didn't match pod anti-affinity rules")
+
+	// ErrDiskConflict is used for NoDiskConflict predicate error.
+	ErrDiskConflict = newPredicateFailureError("NoDiskConflict", "node(s) had no available disk")
+	// ErrVolumeZoneConflict is used for NoVolumeZoneConflict predicate error.
+	ErrVolumeZoneConflict = newPredicateFailureError("NoVolumeZoneConflict", "node(s) had no available volume zone")
+	// ErrNodeSelectorNotMatch is used for MatchNodeSelector predicate error.
+	ErrNodeSelectorNotMatch = newPredicateFailureError("MatchNodeSelector", "node(s) didn't match node selector")
+	// ErrPodAffinityNotMatch is used for MatchInterPodAffinity predicate error.
+	ErrPodAffinityNotMatch = newPredicateFailureError("MatchInterPodAffinity", "node(s) didn't match pod affinity/anti-affinity")
+	// ErrPodAffinityRulesNotMatch is used for PodAffinityRulesNotMatch predicate error.
+	ErrPodAffinityRulesNotMatch = newPredicateFailureError("PodAffinityRulesNotMatch", "node(s) didn't match pod affinity rules")
+	// ErrPodAntiAffinityRulesNotMatch is used for PodAntiAffinityRulesNotMatch predicate error.
+	ErrPodAntiAffinityRulesNotMatch = newPredicateFailureError("PodAntiAffinityRulesNotMatch", "node(s) didn't match pod anti-affinity rules")
+	// ErrExistingPodsAntiAffinityRulesNotMatch is used for ExistingPodsAntiAffinityRulesNotMatch predicate error.
 	ErrExistingPodsAntiAffinityRulesNotMatch = newPredicateFailureError("ExistingPodsAntiAffinityRulesNotMatch", "node(s) didn't satisfy existing pods anti-affinity rules")
-	ErrTaintsTolerationsNotMatch             = newPredicateFailureError("PodToleratesNodeTaints", "node(s) had taints that the pod didn't tolerate")
-	ErrPodNotMatchHostName                   = newPredicateFailureError("HostName", "node(s) didn't match the requested hostname")
-	ErrPodNotFitsHostPorts                   = newPredicateFailureError("PodFitsHostPorts", "node(s) didn't have free ports for the requested pod ports")
-	ErrNodeLabelPresenceViolated             = newPredicateFailureError("CheckNodeLabelPresence", "node(s) didn't have the requested labels")
-	ErrServiceAffinityViolated               = newPredicateFailureError("CheckServiceAffinity", "node(s) didn't match service affinity")
-	ErrMaxVolumeCountExceeded                = newPredicateFailureError("MaxVolumeCount", "node(s) exceed max volume count")
-	ErrNodeUnderMemoryPressure               = newPredicateFailureError("NodeUnderMemoryPressure", "node(s) had memory pressure")
-	ErrNodeUnderDiskPressure                 = newPredicateFailureError("NodeUnderDiskPressure", "node(s) had disk pressure")
-	ErrNodeOutOfDisk                         = newPredicateFailureError("NodeOutOfDisk", "node(s) were out of disk space")
-	ErrNodeNotReady                          = newPredicateFailureError("NodeNotReady", "node(s) were not ready")
-	ErrNodeNetworkUnavailable                = newPredicateFailureError("NodeNetworkUnavailable", "node(s) had unavailable network")
-	ErrNodeUnschedulable                     = newPredicateFailureError("NodeUnschedulable", "node(s) were unschedulable")
-	ErrNodeUnknownCondition                  = newPredicateFailureError("NodeUnknownCondition", "node(s) had unknown conditions")
-	ErrVolumeNodeConflict                    = newPredicateFailureError("VolumeNodeAffinityConflict", "node(s) had volume node affinity conflict")
-	ErrVolumeBindConflict                    = newPredicateFailureError("VolumeBindingNoMatch", "node(s) didn't find available persistent volumes to bind")
+	// ErrTaintsTolerationsNotMatch is used for PodToleratesNodeTaints predicate error.
+	ErrTaintsTolerationsNotMatch = newPredicateFailureError("PodToleratesNodeTaints", "node(s) had taints that the pod didn't tolerate")
+	// ErrPodNotMatchHostName is used for HostName predicate error.
+	ErrPodNotMatchHostName = newPredicateFailureError("HostName", "node(s) didn't match the requested hostname")
+	// ErrPodNotFitsHostPorts is used for PodFitsHostPorts predicate error.
+	ErrPodNotFitsHostPorts = newPredicateFailureError("PodFitsHostPorts", "node(s) didn't have free ports for the requested pod ports")
+	// ErrNodeLabelPresenceViolated is used for CheckNodeLabelPresence predicate error.
+	ErrNodeLabelPresenceViolated = newPredicateFailureError("CheckNodeLabelPresence", "node(s) didn't have the requested labels")
+	// ErrServiceAffinityViolated is used for CheckServiceAffinity predicate error.
+	ErrServiceAffinityViolated = newPredicateFailureError("CheckServiceAffinity", "node(s) didn't match service affinity")
+	// ErrMaxVolumeCountExceeded is used for MaxVolumeCount predicate error.
+	ErrMaxVolumeCountExceeded = newPredicateFailureError("MaxVolumeCount", "node(s) exceed max volume count")
+	// ErrNodeUnderMemoryPressure is used for NodeUnderMemoryPressure predicate error.
+	ErrNodeUnderMemoryPressure = newPredicateFailureError("NodeUnderMemoryPressure", "node(s) had memory pressure")
+	// ErrNodeUnderDiskPressure is used for NodeUnderDiskPressure predicate error.
+	ErrNodeUnderDiskPressure = newPredicateFailureError("NodeUnderDiskPressure", "node(s) had disk pressure")
+	// ErrNodeOutOfDisk is used for NodeOutOfDisk predicate error.
+	ErrNodeOutOfDisk = newPredicateFailureError("NodeOutOfDisk", "node(s) were out of disk space")
+	// ErrNodeNotReady is used for NodeNotReady predicate error.
+	ErrNodeNotReady = newPredicateFailureError("NodeNotReady", "node(s) were not ready")
+	// ErrNodeNetworkUnavailable is used for NodeNetworkUnavailable predicate error.
+	ErrNodeNetworkUnavailable = newPredicateFailureError("NodeNetworkUnavailable", "node(s) had unavailable network")
+	// ErrNodeUnschedulable is used for NodeUnschedulable predicate error.
+	ErrNodeUnschedulable = newPredicateFailureError("NodeUnschedulable", "node(s) were unschedulable")
+	// ErrNodeUnknownCondition is used for NodeUnknownCondition predicate error.
+	ErrNodeUnknownCondition = newPredicateFailureError("NodeUnknownCondition", "node(s) had unknown conditions")
+	// ErrVolumeNodeConflict is used for VolumeNodeAffinityConflict predicate error.
+	ErrVolumeNodeConflict = newPredicateFailureError("VolumeNodeAffinityConflict", "node(s) had volume node affinity conflict")
+	// ErrVolumeBindConflict is used for VolumeBindingNoMatch predicate error.
+	ErrVolumeBindConflict = newPredicateFailureError("VolumeBindingNoMatch", "node(s) didn't find available persistent volumes to bind")
 	// ErrFakePredicate is used for test only. The fake predicates returning false also returns error
 	// as ErrFakePredicate.
 	ErrFakePredicate = newPredicateFailureError("FakePredicateError", "Nodes failed the fake predicate")
@@ -67,6 +90,7 @@ type InsufficientResourceError struct {
 	capacity     int64
 }
 
+// NewInsufficientResourceError returns an InsufficientResourceError.
 func NewInsufficientResourceError(resourceName v1.ResourceName, requested, used, capacity int64) *InsufficientResourceError {
 	return &InsufficientResourceError{
 		ResourceName: resourceName,
@@ -81,14 +105,17 @@ func (e *InsufficientResourceError) Error() string {
 		e.ResourceName, e.requested, e.used, e.capacity)
 }
 
+// GetReason returns the reason of the InsufficientResourceError.
 func (e *InsufficientResourceError) GetReason() string {
 	return fmt.Sprintf("Insufficient %v", e.ResourceName)
 }
 
+// GetInsufficientAmount returns the amount of the insufficient resource of the error.
 func (e *InsufficientResourceError) GetInsufficientAmount() int64 {
 	return e.requested - (e.capacity - e.used)
 }
 
+// PredicateFailureError describes a failure error of predicate.
 type PredicateFailureError struct {
 	PredicateName string
 	PredicateDesc string
@@ -102,18 +129,22 @@ func (e *PredicateFailureError) Error() string {
 	return fmt.Sprintf("Predicate %s failed", e.PredicateName)
 }
 
+// GetReason returns the reason of the PredicateFailureError.
 func (e *PredicateFailureError) GetReason() string {
 	return e.PredicateDesc
 }
 
+// FailureReason describes a failure reason.
 type FailureReason struct {
 	reason string
 }
 
+// NewFailureReason creates a FailureReason with message.
 func NewFailureReason(msg string) *FailureReason {
 	return &FailureReason{reason: msg}
 }
 
+// GetReason returns the reason of the FailureReason.
 func (e *FailureReason) GetReason() string {
 	return e.reason
 }
diff --git a/pkg/scheduler/algorithm/predicates/metadata.go b/pkg/scheduler/algorithm/predicates/metadata.go
@@ -29,6 +29,7 @@ import (
 	"github.com/golang/glog"
 )
 
+// PredicateMetadataFactory defines a factory of predicate metadata.
 type PredicateMetadataFactory struct {
 	podLister algorithm.PodLister
 }
@@ -57,18 +58,20 @@ type predicateMetadata struct {
 // Ensure that predicateMetadata implements algorithm.PredicateMetadata.
 var _ algorithm.PredicateMetadata = &predicateMetadata{}
 
-// PredicateMetadataProducer: Helper types/variables...
+// PredicateMetadataProducer function produces predicate metadata.
 type PredicateMetadataProducer func(pm *predicateMetadata)
 
 var predicateMetaProducerRegisterLock sync.Mutex
-var predicateMetadataProducers map[string]PredicateMetadataProducer = make(map[string]PredicateMetadataProducer)
+var predicateMetadataProducers = make(map[string]PredicateMetadataProducer)
 
+// RegisterPredicateMetadataProducer registers a PredicateMetadataProducer.
 func RegisterPredicateMetadataProducer(predicateName string, precomp PredicateMetadataProducer) {
 	predicateMetaProducerRegisterLock.Lock()
 	defer predicateMetaProducerRegisterLock.Unlock()
 	predicateMetadataProducers[predicateName] = precomp
 }
 
+// NewPredicateMetadataFactory creates a PredicateMetadataFactory.
 func NewPredicateMetadataFactory(podLister algorithm.PodLister) algorithm.PredicateMetadataProducer {
 	factory := &PredicateMetadataFactory{
 		podLister,
@@ -105,7 +108,7 @@ func (pfactory *PredicateMetadataFactory) GetMetadata(pod *v1.Pod, nodeNameToInf
 func (meta *predicateMetadata) RemovePod(deletedPod *v1.Pod) error {
 	deletedPodFullName := schedutil.GetPodFullName(deletedPod)
 	if deletedPodFullName == schedutil.GetPodFullName(meta.pod) {
-		return fmt.Errorf("deletedPod and meta.pod must not be the same.")
+		return fmt.Errorf("deletedPod and meta.pod must not be the same")
 	}
 	// Delete any anti-affinity rule from the deletedPod.
 	delete(meta.matchingAntiAffinityTerms, deletedPodFullName)
@@ -132,10 +135,10 @@ func (meta *predicateMetadata) RemovePod(deletedPod *v1.Pod) error {
 func (meta *predicateMetadata) AddPod(addedPod *v1.Pod, nodeInfo *schedulercache.NodeInfo) error {
 	addedPodFullName := schedutil.GetPodFullName(addedPod)
 	if addedPodFullName == schedutil.GetPodFullName(meta.pod) {
-		return fmt.Errorf("addedPod and meta.pod must not be the same.")
+		return fmt.Errorf("addedPod and meta.pod must not be the same")
 	}
 	if nodeInfo.Node() == nil {
-		return fmt.Errorf("Invalid node in nodeInfo.")
+		return fmt.Errorf("invalid node in nodeInfo")
 	}
 	// Add matching anti-affinity terms of the addedPod to the map.
 	podMatchingTerms, err := getMatchingAntiAffinityTermsOfExistingPod(meta.pod, addedPod, nodeInfo.Node())

diff --git a/pkg/scheduler/algorithm/predicates/metadata_test.go b/pkg/scheduler/algorithm/predicates/metadata_test.go
@@ -92,40 +92,40 @@ var _ = sort.Interface(&sortableServices{})
 // Note: this function does not compare podRequest.
 func predicateMetadataEquivalent(meta1, meta2 *predicateMetadata) error {
 	if !reflect.DeepEqual(meta1.pod, meta2.pod) {
-		return fmt.Errorf("pods are not the same.")
+		return fmt.Errorf("pods are not the same")
 	}
 	if meta1.podBestEffort != meta2.podBestEffort {
-		return fmt.Errorf("podBestEfforts are not equal.")
+		return fmt.Errorf("podBestEfforts are not equal")
 	}
 	if meta1.serviceAffinityInUse != meta1.serviceAffinityInUse {
-		return fmt.Errorf("serviceAffinityInUses are not equal.")
+		return fmt.Errorf("serviceAffinityInUses are not equal")
 	}
 	if len(meta1.podPorts) != len(meta2.podPorts) {
-		return fmt.Errorf("podPorts are not equal.")
+		return fmt.Errorf("podPorts are not equal")
 	}
 	for !reflect.DeepEqual(meta1.podPorts, meta2.podPorts) {
-		return fmt.Errorf("podPorts are not equal.")
+		return fmt.Errorf("podPorts are not equal")
 	}
 	sortAntiAffinityTerms(meta1.matchingAntiAffinityTerms)
 	sortAntiAffinityTerms(meta2.matchingAntiAffinityTerms)
 	if !reflect.DeepEqual(meta1.matchingAntiAffinityTerms, meta2.matchingAntiAffinityTerms) {
-		return fmt.Errorf("matchingAntiAffinityTerms are not euqal.")
+		return fmt.Errorf("matchingAntiAffinityTerms are not euqal")
 	}
 	if meta1.serviceAffinityInUse {
 		sortablePods1 := sortablePods(meta1.serviceAffinityMatchingPodList)
 		sort.Sort(sortablePods1)
 		sortablePods2 := sortablePods(meta2.serviceAffinityMatchingPodList)
 		sort.Sort(sortablePods2)
 		if !reflect.DeepEqual(sortablePods1, sortablePods2) {
-			return fmt.Errorf("serviceAffinityMatchingPodLists are not euqal.")
+			return fmt.Errorf("serviceAffinityMatchingPodLists are not euqal")
 		}
 
 		sortableServices1 := sortableServices(meta1.serviceAffinityMatchingPodServices)
 		sort.Sort(sortableServices1)
 		sortableServices2 := sortableServices(meta2.serviceAffinityMatchingPodServices)
 		sort.Sort(sortableServices2)
 		if !reflect.DeepEqual(sortableServices1, sortableServices2) {
-			return fmt.Errorf("serviceAffinityMatchingPodServices are not euqal.")
+			return fmt.Errorf("serviceAffinityMatchingPodServices are not euqal")
 		}
 	}
 	return nil