Merge pull request volcano-sh#234 from nikita15p/e2elintfix

Lint fix for admission and e2e package except dot import lint failures

hack/.golint_failures

@@ -1,2 +1 @@
-volcano.sh/volcano/pkg/admission
 volcano.sh/volcano/test/e2e

pkg/admission/admission_controller.go

@@ -34,13 +34,19 @@ import (
 )
 
 const (
-	AdmitJobPath  = "/jobs"
+	//AdmitJobPath is the pattern for the jobs admission
+	AdmitJobPath = "/jobs"
+	//MutateJobPath is the pattern for the mutating jobs
 	MutateJobPath = "/mutating-jobs"
 )
 
+//The AdmitFunc returns response
 type AdmitFunc func(v1beta1.AdmissionReview) *v1beta1.AdmissionResponse
 
 var scheme = runtime.NewScheme()
+
+//Codecs is for retrieving serializers for the supported wire formats
+//and conversion wrappers to define preferred internal and external versions.
 var Codecs = serializer.NewCodecFactory(scheme)
 
 // policyEventMap defines all policy events and whether to allow external use
@@ -73,6 +79,7 @@ func addToScheme(scheme *runtime.Scheme) {
 	admissionregistrationv1beta1.AddToScheme(scheme)
 }
 
+//ToAdmissionResponse updates the admission response with the input error
 func ToAdmissionResponse(err error) *v1beta1.AdmissionResponse {
 	glog.Error(err)
 	return &v1beta1.AdmissionResponse{
@@ -82,6 +89,7 @@ func ToAdmissionResponse(err error) *v1beta1.AdmissionResponse {
 	}
 }
 
+//DecodeJob decodes the job using deserializer from the raw object
 func DecodeJob(object runtime.RawExtension, resource metav1.GroupVersionResource) (v1alpha1.Job, error) {
 	jobResource := metav1.GroupVersionResource{Group: v1alpha1.SchemeGroupVersion.Group, Version: v1alpha1.SchemeGroupVersion.Version, Resource: "jobs"}
 	raw := object.Raw
@@ -176,7 +184,7 @@ func getValidActions() []v1alpha1.Action {
 	return actions
 }
 
-// validate IO configuration
+// ValidateIO validate IO configuration
 func ValidateIO(volumes []v1alpha1.VolumeSpec) (string, bool) {
 	volumeMap := map[string]bool{}
 	for _, volume := range volumes {

pkg/admission/admit_job.go

@@ -39,7 +39,7 @@ import (
 //KubeBatchClientSet is kube-batch clientset
 var KubeBatchClientSet versioned.Interface
 
-// job admit.
+// AdmitJobs is to admit jobs and return response
 func AdmitJobs(ar v1beta1.AdmissionReview) *v1beta1.AdmissionResponse {
 
 	glog.V(3).Infof("admitting jobs -- %s", ar.Request.Operation)

pkg/admission/admit_job_test.go

@@ -33,7 +33,7 @@ import (
 func TestValidateExecution(t *testing.T) {
 
 	namespace := "test"
-	var invTtl int32 = -1
+	var invTTL int32 = -1
 
 	testCases := []struct {
 		Name           string
@@ -281,7 +281,7 @@ func TestValidateExecution(t *testing.T) {
 							},
 						},
 					},
-					TTLSecondsAfterFinished: &invTtl,
+					TTLSecondsAfterFinished: &invTTL,
 				},
 			},
 			reviewResponse: v1beta1.AdmissionResponse{Allowed: true},

pkg/admission/mutate_job.go

@@ -29,6 +29,7 @@ import (
 )
 
 const (
+	//DefaultQueue constant stores the name of the queue as "default"
 	DefaultQueue = "default"
 )
 
@@ -38,7 +39,7 @@ type patchOperation struct {
 	Value interface{} `json:"value,omitempty"`
 }
 
-// mutate job.
+// MutateJobs mutate jobs
 func MutateJobs(ar v1beta1.AdmissionReview) *v1beta1.AdmissionResponse {
 	glog.V(3).Infof("mutating jobs")
 

test/e2e/cli_util.go

@@ -24,6 +24,7 @@ import (
 	. "github.com/onsi/gomega"
 )
 
+//ResumeJob resumes the job in the given namespace
 func ResumeJob(name string, namespace string) string {
 	command := []string{"job", "resume"}
 	Expect(name).NotTo(Equal(""), "Job name should not be empty in Resume job command")
@@ -34,6 +35,7 @@ func ResumeJob(name string, namespace string) string {
 	return RunCliCommand(command)
 }
 
+//SuspendJob suspends the job in the given namepsace
 func SuspendJob(name string, namespace string) string {
 	command := []string{"job", "suspend"}
 	Expect(name).NotTo(Equal(""), "Job name should not be empty in Suspend job command")
@@ -44,6 +46,7 @@ func SuspendJob(name string, namespace string) string {
 	return RunCliCommand(command)
 }
 
+//ListJobs list all the jobs in the given namespace
 func ListJobs(namespace string) string {
 	command := []string{"job", "list"}
 	if namespace != "" {
@@ -52,6 +55,7 @@ func ListJobs(namespace string) string {
 	return RunCliCommand(command)
 }
 
+//DeleteJob delete the job in the given namespace
 func DeleteJob(name string, namespace string) string {
 	command := []string{"job", "delete"}
 	Expect(name).NotTo(Equal(""), "Job name should not be empty in delete job command")
@@ -62,6 +66,7 @@ func DeleteJob(name string, namespace string) string {
 	return RunCliCommand(command)
 }
 
+//RunCliCommand runs the volcano command
 func RunCliCommand(command []string) string {
 	if masterURL() != "" {
 		command = append(command, "--master", masterURL())

test/e2e/mpi.go

@@ -13,6 +13,7 @@ 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 e2e
 
 import (

test/e2e/util.go

@@ -92,6 +92,7 @@ func kubeconfigPath(home string) string {
 	return filepath.Join(home, ".kube", "config") // default kubeconfig path is $HOME/.kube/config
 }
 
+//VolcanoCliBinary function gets the volcano cli binary
 func VolcanoCliBinary() string {
 	if bin := os.Getenv("VK_BIN"); bin != "" {
 		return filepath.Join(bin, "vkctl")
@@ -974,6 +975,7 @@ func preparePatchBytesforNode(nodeName string, oldNode *v1.Node, newNode *v1.Nod
 	return patchBytes, nil
 }
 
+// IsNodeReady function returns the node ready status
 func IsNodeReady(node *v1.Node) bool {
 	for _, c := range node.Status.Conditions {
 		if c.Type == v1.NodeReady {
@@ -987,9 +989,8 @@ func waitClusterReady(ctx *context) error {
 	return wait.Poll(100*time.Millisecond, oneMinute, func() (bool, error) {
 		if readyNodeAmount(ctx) >= 1 {
 			return true, nil
-		} else {
-			return false, nil
 		}
+		return false, nil
 	})
 }