Merge pull request #258 from istalker2/lint

Fixes gofmt and golint warnings

Author: pigmej

cmd/deploy.go

@@ -24,7 +24,8 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var Deploy *cobra.Command = initDeployCommand()
+// Deploy is the deploy CLI command object
+var Deploy = initDeployCommand()
 
 func deploy(cmd *cobra.Command, args []string) {
 	url, err := cmd.Flags().GetString("url")

cmd/run_test.go

@@ -59,12 +59,12 @@ func TestLabelFlag(t *testing.T) {
 
 // TestParseArg tests how key-value arguments are parsed in command line interface
 func TestParseArg(t *testing.T) {
-	table := []struct{
-		arg string
-		key string
+	table := []struct {
+		arg   string
+		key   string
 		value string
 		error bool
-	} {
+	}{
 		{"x=y", "x", "y", false},
 		{"x:y", "x", "y", false},
 		{"x = y", "x", "y", false},

e2e/example_runner.go

@@ -35,11 +35,11 @@ import (
 	"k8s.io/client-go/pkg/runtime"
 )
 
-type ExamplesFramework struct {
+type examplesFramework struct {
 	*utils.AppControllerManager
 }
 
-func (f *ExamplesFramework) CreateExample(exampleName string) {
+func (f *examplesFramework) CreateExample(exampleName string) {
 	// list all files in directory, for each file run Create
 	fqDir := filepath.Join(utils.TestContext.Examples, exampleName)
 	By("Creating example from directory " + fqDir)
@@ -52,7 +52,7 @@ func (f *ExamplesFramework) CreateExample(exampleName string) {
 	}
 }
 
-func (f *ExamplesFramework) Create(fileName string) {
+func (f *examplesFramework) Create(fileName string) {
 	// Load data from filepath
 	// try to serialize it into Unstructured or UnstructuredList
 	data, err := ioutil.ReadFile(fileName)
@@ -74,7 +74,7 @@ func (f *ExamplesFramework) Create(fileName string) {
 	})
 }
 
-func (f *ExamplesFramework) handleItemCreation(ust *runtime.Unstructured) {
+func (f *examplesFramework) handleItemCreation(ust *runtime.Unstructured) {
 	// based on kind of item - instantiate correct object and wrap it with resource definition
 	// if unstructured is of kind Dependency - just create it as is
 	encodedData, err := json.Marshal(ust)
@@ -98,13 +98,13 @@ func (f *ExamplesFramework) handleItemCreation(ust *runtime.Unstructured) {
 	Expect(err).NotTo(HaveOccurred())
 }
 
-func (f *ExamplesFramework) handleListCreation(ustList *runtime.UnstructuredList) {
+func (f *examplesFramework) handleListCreation(ustList *runtime.UnstructuredList) {
 	for _, ust := range ustList.Items {
 		f.handleItemCreation(ust)
 	}
 }
 
-func (f *ExamplesFramework) VerifyStatus(task string, options interfaces.DependencyGraphOptions) {
+func (f *examplesFramework) VerifyStatus(task string, options interfaces.DependencyGraphOptions) {
 	var depReport report.DeploymentReport
 	Eventually(
 		func() bool {
@@ -123,7 +123,7 @@ func (f *ExamplesFramework) VerifyStatus(task string, options interfaces.Depende
 		300*time.Second, 5*time.Second).Should(BeTrue(), strings.Join(depReport.AsText(0), "\n"))
 }
 
-func (f *ExamplesFramework) CreateRunAndVerify(exampleName string, options interfaces.DependencyGraphOptions) {
+func (f *examplesFramework) CreateRunAndVerify(exampleName string, options interfaces.DependencyGraphOptions) {
 	By("Creating example " + exampleName)
 	f.CreateExample(exampleName)
 	By("Running appcontroller scheduler")

e2e/examples_test.go

@@ -23,7 +23,7 @@ import (
 
 var _ = Describe("Examples Suite", func() {
 	options := interfaces.DependencyGraphOptions{ReplicaCount: 1}
-	framework := ExamplesFramework{testutils.NewAppControllerManager()}
+	framework := examplesFramework{testutils.NewAppControllerManager()}
 
 	It("Example 'simple' should finish", func() {
 		framework.CreateRunAndVerify("simple", options)

e2e/flows_test.go

@@ -27,7 +27,7 @@ import (
 )
 
 var _ = Describe("Flows Suite", func() {
-	framework := FlowFramework{ExamplesFramework{testutils.NewAppControllerManager()}}
+	framework := FlowFramework{examplesFramework{testutils.NewAppControllerManager()}}
 
 	It("Example 'flows' should finish and create one graph replica", func() {
 		framework.CreateRunAndVerify("flows", interfaces.DependencyGraphOptions{MinReplicaCount: 1})
@@ -107,7 +107,7 @@ var _ = Describe("Flows Suite", func() {
 })
 
 type FlowFramework struct {
-	ExamplesFramework
+	examplesFramework
 }
 
 func (ff FlowFramework) countPods(prefix string, equal bool) int {

e2e/utils/appcmanager.go

@@ -33,6 +33,7 @@ const (
 	appcontrollerPod = "k8s-appcontroller"
 )
 
+// AppControllerManager is the test controller exposes remote AC operations and test primitives for dependency graphs
 type AppControllerManager struct {
 	Client    client.Interface
 	Clientset *kubernetes.Clientset
@@ -42,10 +43,12 @@ type AppControllerManager struct {
 	acPod *v1.Pod
 }
 
+// Run runs dependency graph deployment with default settings
 func (a *AppControllerManager) Run() string {
 	return a.RunWithOptions(interfaces.DependencyGraphOptions{MinReplicaCount: 1})
 }
 
+// RunWithOptions runs dependency graph deployment with given settings
 func (a *AppControllerManager) RunWithOptions(options interfaces.DependencyGraphOptions) string {
 	sched := scheduler.New(a.Client, nil, 0)
 
@@ -54,6 +57,7 @@ func (a *AppControllerManager) RunWithOptions(options interfaces.DependencyGraph
 	return task
 }
 
+// DeleteAppControllerPod deletes pod, where AppController is running
 func (a *AppControllerManager) DeleteAppControllerPod() {
 	By("Removing pod  " + appcontrollerPod)
 	err := a.Client.Pods().Delete(appcontrollerPod, nil)
@@ -64,6 +68,7 @@ func (a *AppControllerManager) DeleteAppControllerPod() {
 	}, 20*time.Second, 1*time.Second).Should(BeTrue(), "Appcontroller pod wasn't removed in time")
 }
 
+// Prepare starts AppController pod
 func (a *AppControllerManager) Prepare() {
 	appControllerObj := &v1.Pod{
 		ObjectMeta: v1.ObjectMeta{
@@ -105,6 +110,7 @@ func (a *AppControllerManager) Prepare() {
 	}, 120*time.Second, 5*time.Second).Should(BeTrue())
 }
 
+// BeforeEach is an action executed before each test
 func (a *AppControllerManager) BeforeEach() {
 	var err error
 	a.Clientset, err = KubeClient()
@@ -127,6 +133,7 @@ func (a *AppControllerManager) BeforeEach() {
 	a.Prepare()
 }
 
+// AfterEach is an action executed after each test
 func (a *AppControllerManager) AfterEach() {
 	By("Dumping appcontroller logs")
 	if CurrentGinkgoTestDescription().Failed && a.acPod != nil {
@@ -137,6 +144,7 @@ func (a *AppControllerManager) AfterEach() {
 	RemoveServiceAccountFromAdmins(a.Clientset)
 }
 
+// NewAppControllerManager creates new instance of AppControllerManager
 func NewAppControllerManager() *AppControllerManager {
 	appc := &AppControllerManager{}
 	BeforeEach(appc.BeforeEach)

e2e/utils/utils.go

@@ -31,16 +31,20 @@ import (
 	"k8s.io/client-go/pkg/api/v1"
 	"k8s.io/client-go/pkg/apis/rbac/v1alpha1"
 	"k8s.io/client-go/rest"
-	"k8s.io/client-go/tools/clientcmd")
+	"k8s.io/client-go/tools/clientcmd"
+)
 
 var yamlDocumentDelimiter = regexp.MustCompile("(?m)^---")
+
 const rbacServiceAccountAdmin = "system:serviceaccount-admin"
 
+// TContext is a structure for CLI flags
 type TContext struct {
 	Examples string
 	Version  string
 }
 
+// SkipIf14 makes test to be skipped when running on k8s 1.4
 func SkipIf14() {
 	if strings.Contains(TestContext.Version, "1.4") {
 		Skip("This test is disabled on kubernetes of versions 1.4")
@@ -71,6 +75,7 @@ func AddServiceAccountToAdmins(c kubernetes.Interface) {
 	Expect(err).NotTo(HaveOccurred(), "Failed to create role binding for serviceaccounts")
 }
 
+// RemoveServiceAccountFromAdmins removes system:serviceaccounts from cluster-admin ClusterRole
 func RemoveServiceAccountFromAdmins(c kubernetes.Interface) {
 	if IsVersionOlderThan16() {
 		return
@@ -80,6 +85,7 @@ func RemoveServiceAccountFromAdmins(c kubernetes.Interface) {
 	Expect(err).NotTo(HaveOccurred(), "Failed to remove serviceaccount from cluster-admin role")
 }
 
+// TestContext holds e2e CLI flags
 var TestContext = TContext{}
 
 var url string
@@ -90,6 +96,7 @@ func init() {
 	flag.StringVar(&url, "cluster-url", "http://127.0.0.1:8080", "apiserver address to use with restclient")
 }
 
+// SanitizedVersion parses K8s 2-component version string into float64 representation
 func SanitizedVersion() float64 {
 	var dirtyVersion string
 	if strings.HasPrefix(TestContext.Version, "v") {
@@ -102,20 +109,24 @@ func SanitizedVersion() float64 {
 	return version
 }
 
+// IsVersionOlderThan16 returns true, if k8s version is less than 1.6
 func IsVersionOlderThan16() bool {
 	return SanitizedVersion() < 1.6
 }
 
+// Logf prints formatted message to the tests log
 func Logf(format string, a ...interface{}) {
 	fmt.Fprintf(GinkgoWriter, format, a...)
 }
 
+// LoadConfig loads k8s client config
 func LoadConfig() *rest.Config {
 	config, err := clientcmd.BuildConfigFromFlags(url, "")
 	Expect(err).NotTo(HaveOccurred())
 	return config
 }
 
+// KubeClient returns client to standard k8s entities
 func KubeClient() (*kubernetes.Clientset, error) {
 	Logf("Using master %v\n", url)
 	config := LoadConfig()
@@ -130,11 +141,13 @@ func GetAcClient(namespace string) (client.Interface, error) {
 	return client, err
 }
 
+// DeleteNS deletes k8s namespace
 func DeleteNS(clientset *kubernetes.Clientset, namespace *v1.Namespace) {
 	defer GinkgoRecover()
 	clientset.Namespaces().Delete(namespace.Name, nil)
 }
 
+// WaitForPod waits for k8s pod to get to specified running phase
 func WaitForPod(clientset *kubernetes.Clientset, namespace string, name string, phase v1.PodPhase) *v1.Pod {
 	defer GinkgoRecover()
 	var podUpdated *v1.Pod
@@ -151,6 +164,7 @@ func WaitForPod(clientset *kubernetes.Clientset, namespace string, name string,
 	return podUpdated
 }
 
+// WaitForPodNotToBeCreated waits for pod to be created
 func WaitForPodNotToBeCreated(clientset *kubernetes.Clientset, namespace string, name string) {
 	defer GinkgoRecover()
 	Consistently(func() bool {
@@ -160,6 +174,7 @@ func WaitForPodNotToBeCreated(clientset *kubernetes.Clientset, namespace string,
 	}).Should(BeTrue())
 }
 
+// DumpLogs dumps pod logs
 func DumpLogs(clientset *kubernetes.Clientset, pods ...*v1.Pod) {
 	for _, pod := range pods {
 		dumpLogs(clientset, pod)
@@ -176,11 +191,12 @@ func dumpLogs(clientset *kubernetes.Clientset, pod *v1.Pod) {
 	Expect(err).NotTo(HaveOccurred())
 }
 
+// ForEachYamlDocument executes action for each YAML document (parts of YAML file separated by "---")
 func ForEachYamlDocument(data []byte, action func([]byte)) {
 	matches := yamlDocumentDelimiter.FindAllIndex(data, -1)
 	lastStart := 0
 	for _, doc := range matches {
-		action(data[lastStart: doc[0]])
+		action(data[lastStart:doc[0]])
 		lastStart = doc[1]
 	}
 	action(data[lastStart:])