clean code

pkg/loader/bundle/bundle.go

@@ -30,7 +30,7 @@ import (
 type Bundle struct {
 }
 
-// load Image from bundles file
+// load image from dab file
 func loadImage(service bundlefile.Service) (string, string) {
 	character := "@"
 	if strings.Contains(service.Image, character) {
@@ -39,8 +39,8 @@ func loadImage(service bundlefile.Service) (string, string) {
 	return "", "Invalid image format"
 }
 
-// load Environment Variable from bundles file
-func loadEnvVarsfromBundle(service bundlefile.Service) ([]kobject.EnvVar, string) {
+// load environment variables from dab file
+func loadEnvVars(service bundlefile.Service) ([]kobject.EnvVar, string) {
 	envs := []kobject.EnvVar{}
 	for _, env := range service.Env {
 		character := "="
@@ -76,8 +76,8 @@ func loadEnvVarsfromBundle(service bundlefile.Service) ([]kobject.EnvVar, string
 	return envs, ""
 }
 
-// load Ports from bundles file
-func loadPortsfromBundle(service bundlefile.Service) ([]kobject.Ports, string) {
+// load ports from dab file
+func loadPorts(service bundlefile.Service) ([]kobject.Ports, string) {
 	ports := []kobject.Ports{}
 	for _, port := range service.Ports {
 		var p api.Protocol
@@ -98,7 +98,7 @@ func loadPortsfromBundle(service bundlefile.Service) ([]kobject.Ports, string) {
 	return ports, ""
 }
 
-// load Bundlefile into KomposeObject
+// load dab file into KomposeObject
 func (b *Bundle) LoadFile(file string) kobject.KomposeObject {
 	komposeObject := kobject.KomposeObject{
 		ServiceConfigs: make(map[string]kobject.ServiceConfig),
@@ -129,13 +129,13 @@ func (b *Bundle) LoadFile(file string) kobject.KomposeObject {
 		}
 		serviceConfig.Image = image
 
-		envs, err := loadEnvVarsfromBundle(service)
+		envs, err := loadEnvVars(service)
 		if err != "" {
 			logrus.Fatalf("Failed to load envvar from bundles file: " + err)
 		}
 		serviceConfig.Environment = envs
 
-		ports, err := loadPortsfromBundle(service)
+		ports, err := loadPorts(service)
 		if err != "" {
 			logrus.Fatalf("Failed to load ports from bundles file: " + err)
 		}

pkg/loader/compose/compose.go

@@ -36,8 +36,8 @@ import (
 type Compose struct {
 }
 
-// load Environment Variable from compose file
-func loadEnvVarsfromCompose(e map[string]string) []kobject.EnvVar {
+// load environment variables from compose file
+func loadEnvVars(e map[string]string) []kobject.EnvVar {
 	envs := []kobject.EnvVar{}
 	for k, v := range e {
 		envs = append(envs, kobject.EnvVar{
@@ -48,8 +48,8 @@ func loadEnvVarsfromCompose(e map[string]string) []kobject.EnvVar {
 	return envs
 }
 
-// Load Ports from compose file
-func loadPortsFromCompose(composePorts []string) ([]kobject.Ports, error) {
+// Load ports from compose file
+func loadPorts(composePorts []string) ([]kobject.Ports, error) {
 	ports := []kobject.Ports{}
 	character := ":"
 	for _, port := range composePorts {
@@ -87,7 +87,7 @@ func loadPortsFromCompose(composePorts []string) ([]kobject.Ports, error) {
 	return ports, nil
 }
 
-// load Docker Compose file into KomposeObject
+// load compose file into KomposeObject
 func (c *Compose) LoadFile(file string) kobject.KomposeObject {
 	komposeObject := kobject.KomposeObject{
 		ServiceConfigs: make(map[string]kobject.ServiceConfig),
@@ -152,11 +152,11 @@ func (c *Compose) LoadFile(file string) kobject.KomposeObject {
 			serviceConfig.ContainerName = composeServiceConfig.ContainerName
 
 			// load environment variables
-			envs := loadEnvVarsfromCompose(composeServiceConfig.Environment.ToMap())
+			envs := loadEnvVars(composeServiceConfig.Environment.ToMap())
 			serviceConfig.Environment = envs
 
 			// load ports
-			ports, err := loadPortsFromCompose(composeServiceConfig.Ports)
+			ports, err := loadPorts(composeServiceConfig.Ports)
 			if err != nil {
 				logrus.Fatalf("%q failed to load ports from compose file: %v", name, err)
 			}

pkg/transformer/kubernetes/k8sutils.go

@@ -223,7 +223,7 @@ func PortsExist(name string, service kobject.ServiceConfig) bool {
 	}
 }
 
-// create a kubernetes Service
+// create a k8s service
 func CreateService(name string, service kobject.ServiceConfig, objects []runtime.Object) *api.Service {
 	svc := InitSvc(name, service)
 
@@ -238,6 +238,7 @@ func CreateService(name string, service kobject.ServiceConfig, objects []runtime
 	return svc
 }
 
+// load configurations to k8s objects
 func UpdateKubernetesObjects(name string, service kobject.ServiceConfig, objects []runtime.Object) {
 	// Configure the environment variables.
 	envs := ConfigEnvs(name, service)

pkg/transformer/kubernetes/kubernetes.go

@@ -214,7 +214,7 @@ func ConfigEnvs(name string, service kobject.ServiceConfig) []api.EnvVar {
 	return envs
 }
 
-// Generate a Kubernetes artifacts for each input type service
+// Generate a Kubernetes artifact for each input type service
 func CreateKubernetesObjects(name string, service kobject.ServiceConfig, opt kobject.ConvertOptions) []runtime.Object {
 	var objects []runtime.Object
 
@@ -231,6 +231,7 @@ func CreateKubernetesObjects(name string, service kobject.ServiceConfig, opt kob
 	return objects
 }
 
+// Maps komposeObject to k8s objects
 func (k *Kubernetes) Transform(komposeObject kobject.KomposeObject, opt kobject.ConvertOptions) []runtime.Object {
 	// this will hold all the converted data
 	var allobjects []runtime.Object
@@ -252,7 +253,7 @@ func (k *Kubernetes) Transform(komposeObject kobject.KomposeObject, opt kobject.
 	return allobjects
 }
 
-// updateController updates the given object with the given pod template update function and ObjectMeta update function
+// Updates the given object with the given pod template update function and ObjectMeta update function
 func UpdateController(obj runtime.Object, updateTemplate func(*api.PodTemplateSpec), updateMeta func(meta *api.ObjectMeta)) {
 	switch t := obj.(type) {
 	case *api.ReplicationController:
@@ -273,6 +274,7 @@ func UpdateController(obj runtime.Object, updateTemplate func(*api.PodTemplateSp
 	}
 }
 
+// Submit deployment and svc to k8s endpoint
 func CreateObjects(client *client.Client, objects []runtime.Object) {
 	for _, v := range objects {
 		switch t := v.(type) {

pkg/transformer/openshift/openshift.go

@@ -62,6 +62,7 @@ func initDeploymentConfig(name string, service kobject.ServiceConfig, replicas i
 	return dc
 }
 
+// Maps komposeObject to openshift objects
 func (k *OpenShift) Transform(komposeObject kobject.KomposeObject, opt kobject.ConvertOptions) []runtime.Object {
 	// this will hold all the converted data
 	var allobjects []runtime.Object