Merge pull request #710 from surajnarwade/sanity_check_fix

Updated code with go lint result

pkg/transformer/kubernetes/k8sutils.go

@@ -562,7 +562,7 @@ func (k *Kubernetes) VolumesFrom(objects *[]runtime.Object, komposeObject kobjec
 	return nil
 }
 
-//Ensure the kubernetes objects are in a consistent order
+// SortedKeys Ensure the kubernetes objects are in a consistent order
 func SortedKeys(komposeObject kobject.KomposeObject) []string {
 	var sortedKeys []string
 	for name := range komposeObject.ServiceConfigs {
@@ -572,7 +572,7 @@ func SortedKeys(komposeObject kobject.KomposeObject) []string {
 	return sortedKeys
 }
 
-//converts duration string to *int64 in seconds
+// DurationStrToSecondsInt converts duration string to *int64 in seconds
 func DurationStrToSecondsInt(s string) (*int64, error) {
 	if s == "" {
 		return nil, nil

pkg/transformer/kubernetes/kubernetes.go

@@ -61,7 +61,7 @@ type Kubernetes struct {
 // used when undeploying resources from kubernetes
 const TIMEOUT = 300
 
-//default size of Persistent Volume Claim
+// PVCRequestSize (Persistent Volume Claim) has default size
 const PVCRequestSize = "100Mi"
 
 // CheckUnsupportedKey checks if given komposeObject contains

pkg/transformer/utils.go

@@ -33,6 +33,7 @@ import (
 	"k8s.io/kubernetes/pkg/api"
 )
 
+// Selector used as labels and selector
 const Selector = "io.kompose.service"
 
 // CreateOutFile creates the file to write to if --out is specified
@@ -155,7 +156,7 @@ func formatProviderName(provider string) string {
 	return provider
 }
 
-// Sort struct
+// EnvSort struct
 type EnvSort []api.EnvVar
 
 // returns the number of elements in the collection.
@@ -189,6 +190,7 @@ func GetComposeFileDir(inputFiles []string) (string, error) {
 	return filepath.Dir(inputFile), nil
 }
 
+//BuildDockerImage builds docker image
 func BuildDockerImage(service kobject.ServiceConfig, name string, relativePath string) error {
 
 	// First, let's figure out the relative path of the Dockerfile!
@@ -223,6 +225,7 @@ func BuildDockerImage(service kobject.ServiceConfig, name string, relativePath s
 	return nil
 }
 
+// PushDockerImage pushes docker image
 func PushDockerImage(service kobject.ServiceConfig, serviceName string) error {
 
 	log.Debugf("Pushing Docker image '%s'", service.Image)

pkg/utils/docker/build.go

@@ -28,12 +28,13 @@ import (
 	"strings"
 )
 
+// Build will provide methods for interaction with API regarding building images
 type Build struct {
 	Client dockerlib.Client
 }
 
 /*
-Build a Docker image via the Docker API. Takes the source directory
+BuildImage builds a Docker image via the Docker API. Takes the source directory
 and image name and then builds the appropriate image. Tarball is utilized
 in order to make building easier.
 */

pkg/utils/docker/client.go

@@ -20,6 +20,7 @@ import (
 	"github.com/fsouza/go-dockerclient"
 )
 
+// DockerClient connects to Docker client on host
 func DockerClient() (*docker.Client, error) {
 
 	// Default end-point, HTTP + TLS support to be added in the future

pkg/utils/docker/push.go

@@ -24,12 +24,13 @@ import (
 	"github.com/pkg/errors"
 )
 
+// Push will provide methods for interaction with API regarding pushing images
 type Push struct {
 	Client dockerlib.Client
 }
 
 /*
-Push a Docker image via the Docker API. Takes the image name,
+PushImage push a Docker image via the Docker API. Takes the image name,
 parses the URL details and then push based on environment authentication
 credentials.
 */
@@ -80,5 +81,5 @@ func (c *Push) PushImage(fullImageName string) error {
 		}
 	}
 
-	return errors.New("Unable to push docker image(s). Check that `docker login` works successfully on the command line.")
+	return errors.New("unable to push docker image(s). Check that `docker login` works successfully on the command line")
 }