fixing gofmt, go_vet, gocyclo, golint errors

Author: murali-reddy

app/controllers/network_policy_controller.go

@@ -36,7 +36,7 @@ import (
 // by one or more network policy chains, till there is a match which will accept the packet, or gets
 // dropped by the rule in the pod chain, if there is no match.
 
-// strcut to hold information required by NetworkPolicyController
+// NetworkPolicyController strcut to hold information required by NetworkPolicyController
 type NetworkPolicyController struct {
 	nodeIP          net.IP
 	nodeHostName    string
@@ -81,7 +81,7 @@ type protocolAndPort struct {
 	port     string
 }
 
-// Run: runs forver till we recive notification on stopCh
+// Run runs forver till we recive notification on stopCh
 func (npc *NetworkPolicyController) Run(stopCh <-chan struct{}, wg *sync.WaitGroup) {
 	t := time.NewTicker(npc.syncPeriod)
 	defer t.Stop()
@@ -117,7 +117,7 @@ func (npc *NetworkPolicyController) Run(stopCh <-chan struct{}, wg *sync.WaitGro
 	}
 }
 
-// OnPodUpdate: handles updates to pods from the Kubernetes api server
+// OnPodUpdate handles updates to pods from the Kubernetes api server
 func (npc *NetworkPolicyController) OnPodUpdate(podUpdate *watchers.PodUpdate) {
 	glog.Infof("Received pod update namspace:%s pod name:%s", podUpdate.Pod.Namespace, podUpdate.Pod.Name)
 	if watchers.PodWatcher.HasSynced() && watchers.NetworkPolicyWatcher.HasSynced() {
@@ -130,7 +130,7 @@ func (npc *NetworkPolicyController) OnPodUpdate(podUpdate *watchers.PodUpdate) {
 	}
 }
 
-// OnNetworkPolicyUpdate: handles updates to network policy from the kubernetes api server
+// OnNetworkPolicyUpdate handles updates to network policy from the kubernetes api server
 func (npc *NetworkPolicyController) OnNetworkPolicyUpdate(networkPolicyUpdate *watchers.NetworkPolicyUpdate) {
 	if watchers.PodWatcher.HasSynced() && watchers.NetworkPolicyWatcher.HasSynced() {
 		err := npc.Sync()
@@ -142,7 +142,7 @@ func (npc *NetworkPolicyController) OnNetworkPolicyUpdate(networkPolicyUpdate *w
 	}
 }
 
-// OnNamespaceUpdate: handles updates to namespace from kubernetes api server
+// OnNamespaceUpdate handles updates to namespace from kubernetes api server
 func (npc *NetworkPolicyController) OnNamespaceUpdate(namespaceUpdate *watchers.NamespaceUpdate) {
 
 	// namespace (and annotations on it) has no significance in GA ver of network policy
@@ -598,7 +598,7 @@ func (npc *NetworkPolicyController) getFirewallEnabledPods(nodeIp string) (*map[
 		}
 		if npc.v1NetworkPolicy {
 			podNeedsFirewall := false
-			for _, policyObj:= range watchers.NetworkPolicyWatcher.List() {
+			for _, policyObj := range watchers.NetworkPolicyWatcher.List() {
 				policy, _ := policyObj.(*networking.NetworkPolicy)
 
 				// we are only interested in the network policies in same namespace that of pod
@@ -652,7 +652,7 @@ func buildNetworkPoliciesInfo() (*[]networkPolicyInfo, error) {
 
 	NetworkPolicies := make([]networkPolicyInfo, 0)
 
-	for _, policyObj:= range watchers.NetworkPolicyWatcher.List() {
+	for _, policyObj := range watchers.NetworkPolicyWatcher.List() {
 
 		policy, ok := policyObj.(*networking.NetworkPolicy)
 		if !ok {
@@ -747,7 +747,7 @@ func buildBetaNetworkPoliciesInfo() (*[]networkPolicyInfo, error) {
 
 	NetworkPolicies := make([]networkPolicyInfo, 0)
 
-	for _, policyObj:= range watchers.NetworkPolicyWatcher.List() {
+	for _, policyObj := range watchers.NetworkPolicyWatcher.List() {
 
 		policy, _ := policyObj.(*apiextensions.NetworkPolicy)
 		newPolicy := networkPolicyInfo{
@@ -806,13 +806,11 @@ func getNameSpaceDefaultPolicy(namespace string) (string, error) {
 				err := json.Unmarshal([]byte(networkPolicyAnnotation), &annot)
 				if err == nil {
 					return annot["ingress"]["isolation"], nil
-				} else {
-					glog.Errorf("Skipping invalid network-policy for namespace \"%s\": %s", namespace, err)
-					return "DefaultAllow", errors.New("Invalid NetworkPolicy.")
 				}
-			} else {
-				return "DefaultAllow", nil
+				glog.Errorf("Skipping invalid network-policy for namespace \"%s\": %s", namespace, err)
+				return "DefaultAllow", errors.New("Invalid NetworkPolicy.")
 			}
+			return "DefaultAllow", nil
 		}
 	}
 	return "", errors.New("Failed to get the default ingress policy for the namespace: " + namespace)
@@ -857,7 +855,7 @@ func getNodeIP(node *apiv1.Node) (net.IP, error) {
 	return nil, errors.New("host IP unknown")
 }
 
-// Cleanup: cleanup configurations done
+// Cleanup cleanup configurations done
 func (npc *NetworkPolicyController) Cleanup() {
 
 	glog.Infof("Cleaning up iptables configuration permanently done by kube-router")
@@ -941,6 +939,7 @@ func (npc *NetworkPolicyController) Cleanup() {
 	glog.Infof("Successfully cleaned the iptables configuration done by kube-router")
 }
 
+// NewNetworkPolicyController returns new NetworkPolicyController object
 func NewNetworkPolicyController(clientset *kubernetes.Clientset, config *options.KubeRouterConfig) (*NetworkPolicyController, error) {
 
 	npc := NetworkPolicyController{}

app/controllers/network_routes_controller.go

@@ -33,7 +33,7 @@ import (
 	"k8s.io/client-go/kubernetes"
 )
 
-// struct to hold necessary information required by controller
+// NetworkRoutingController is struct to hold necessary information required by controller
 type NetworkRoutingController struct {
 	nodeIP               net.IP
 	nodeHostName         string
@@ -68,7 +68,7 @@ const (
 	podSubnetIpSetName   = "kube-router-pod-subnets"
 )
 
-// Run: run forever till until we are notified on stop channel
+// Run runs forever till until we are notified on stop channel
 func (nrc *NetworkRoutingController) Run(stopCh <-chan struct{}, wg *sync.WaitGroup) {
 	cidr, err := utils.GetPodCidrFromCniSpec("/etc/cni/net.d/10-kuberouter.conf")
 	if err != nil {
@@ -310,7 +310,7 @@ func (nrc *NetworkRoutingController) getClusterIps() ([]string, error) {
 	return clusterIpList, nil
 }
 
-// AdvertiseClusterIp:  advertises the service cluster ip the configured peers
+// AdvertiseClusterIp  advertises the service cluster ip the configured peers
 func (nrc *NetworkRoutingController) AdvertiseClusterIp(clusterIp string) error {
 
 	attrs := []bgp.PathAttributeInterface{
@@ -523,7 +523,7 @@ func (nrc *NetworkRoutingController) injectRoute(path *table.Path) error {
 	return netlink.RouteReplace(route)
 }
 
-// Cleanup: performs the cleanup of configurations done
+// Cleanup performs the cleanup of configurations done
 func (nrc *NetworkRoutingController) Cleanup() {
 	err := deletePodEgressRule()
 	if err != nil {
@@ -770,10 +770,9 @@ func (nrc *NetworkRoutingController) enablePolicyBasedRouting() error {
 		f, err := os.OpenFile("/etc/iproute2/rt_tables", os.O_APPEND|os.O_WRONLY, 0600)
 		if err != nil {
 			return fmt.Errorf("Failed to enable required policy based routing. Failed to create custom route table to route tunneled traffic properly due to: %s", err.Error())
-		} else {
-			if _, err = f.WriteString("77 kube-router"); err != nil {
-				return fmt.Errorf("Failed to enable required policy based routing.Failed to add custom router table entry in /etc/iproute2/rt_tables due to: %s", err.Error())
-			}
+		}
+		if _, err = f.WriteString("77 kube-router"); err != nil {
+			return fmt.Errorf("Failed to enable required policy based routing.Failed to add custom router table entry in /etc/iproute2/rt_tables due to: %s", err.Error())
 		}
 	}
 
@@ -797,7 +796,7 @@ func (nrc *NetworkRoutingController) enablePolicyBasedRouting() error {
 	return nil
 }
 
-// OnNodeUpdate: Handle updates from Node watcher. Node watcher calls this method whenever there is
+// OnNodeUpdate Handle updates from Node watcher. Node watcher calls this method whenever there is
 // new node is added or old node is deleted. So peer up with new node and drop peering
 // from old node
 func (nrc *NetworkRoutingController) OnNodeUpdate(nodeUpdate *watchers.NodeUpdate) {
@@ -849,14 +848,13 @@ func (nrc *NetworkRoutingController) startBgpServer() error {
 		if !ok {
 			return errors.New("Could not find ASN number for the node. Node need to be annotated with ASN number " +
 				"details to start BGP server.")
-		} else {
-			glog.Infof("Found ASN for the node to be %s from the node annotations", nodeasn)
-			asnNo, err := strconv.ParseUint(nodeasn, 0, 32)
-			if err != nil {
-				return errors.New("Failed to parse ASN number specified for the the node")
-			}
-			nodeAsnNumber = uint32(asnNo)
 		}
+		glog.Infof("Found ASN for the node to be %s from the node annotations", nodeasn)
+		asnNo, err := strconv.ParseUint(nodeasn, 0, 32)
+		if err != nil {
+			return errors.New("Failed to parse ASN number specified for the the node")
+		}
+		nodeAsnNumber = uint32(asnNo)
 		nrc.nodeAsnNumber = nodeAsnNumber
 	}
 
@@ -964,6 +962,7 @@ func getNodeSubnet(nodeIp net.IP) (net.IPNet, string, error) {
 	return net.IPNet{}, "", errors.New("Failed to find interface with specified node ip")
 }
 
+// NewNetworkRoutingController returns new NetworkRoutingController object
 func NewNetworkRoutingController(clientset *kubernetes.Clientset,
 	kubeRouterConfig *options.KubeRouterConfig) (*NetworkRoutingController, error) {
 	// TODO: Remove lookup, ipset.New already does this.

app/controllers/network_services_controller.go

@@ -27,7 +27,6 @@ import (
 )
 
 const (
-	// name of the dummy interface to which cluster ip are assigned
 	KUBE_DUMMY_IF      = "kube-dummy-if"
 	IFACE_NOT_FOUND    = "Link not found"
 	IFACE_HAS_ADDR     = "file exists"
@@ -66,7 +65,7 @@ var (
 // the kubernetes api server and syncs the ipvs configuration to reflect state of services
 // and endpoints
 
-// struct for storing information needed by the controller
+// NetworkServicesController struct stores information needed by the controller
 type NetworkServicesController struct {
 	nodeIP        net.IP
 	nodeHostName  string
@@ -104,7 +103,7 @@ type endpointsInfo struct {
 // map of all endpoints, with unique service id(namespace name, service name, port) as key
 type endpointsInfoMap map[string][]endpointsInfo
 
-// Run: periodically sync ipvs configuration to reflect desired state of services and endpoints
+// Run periodically sync ipvs configuration to reflect desired state of services and endpoints
 func (nsc *NetworkServicesController) Run(stopCh <-chan struct{}, wg *sync.WaitGroup) error {
 
 	t := time.NewTicker(nsc.syncPeriod)
@@ -172,7 +171,7 @@ func (nsc *NetworkServicesController) sync() {
 	nsc.publishMetrics(nsc.serviceMap)
 }
 
-// OnEndpointsUpdate:  handle change in endpoints update from the API server
+// OnEndpointsUpdate handle change in endpoints update from the API server
 func (nsc *NetworkServicesController) OnEndpointsUpdate(endpointsUpdate *watchers.EndpointsUpdate) {
 
 	nsc.mu.Lock()
@@ -194,7 +193,7 @@ func (nsc *NetworkServicesController) OnEndpointsUpdate(endpointsUpdate *watcher
 	}
 }
 
-// OnServiceUpdate: handle change in service update from the API server
+// OnServiceUpdate handle change in service update from the API server
 func (nsc *NetworkServicesController) OnServiceUpdate(serviceUpdate *watchers.ServiceUpdate) {
 
 	nsc.mu.Lock()
@@ -260,7 +259,7 @@ func (nsc *NetworkServicesController) syncIpvsServices(serviceInfoMap serviceInf
 		activeServiceEndpointMap[clusterServiceId] = make([]string, 0)
 
 		// create IPVS service for the service to be exposed through the nodeport
-		var ipvsNodeportSvc*ipvs.Service
+		var ipvsNodeportSvc *ipvs.Service
 		var nodeServiceId string
 		if svc.nodePort != 0 {
 			ipvsNodeportSvc, err = ipvsAddService(nsc.nodeIP, protocol, uint16(svc.nodePort), svc.sessionAffinity)
@@ -436,7 +435,7 @@ func shuffle(endPoints []endpointsInfo) []endpointsInfo {
 func buildEndpointsInfo() endpointsInfoMap {
 	endpointsMap := make(endpointsInfoMap)
 	for _, ep := range watchers.EndpointsWatcher.List() {
-		for _, epSubset:= range ep.Subsets {
+		for _, epSubset := range ep.Subsets {
 			for _, port := range epSubset.Ports {
 				svcId := generateServiceId(ep.Namespace, ep.Name, port.Name)
 				endpoints := make([]endpointsInfo, 0)
@@ -781,7 +780,7 @@ func getKubeDummyInterface() (netlink.Link, error) {
 	return dummyVipInterface, nil
 }
 
-// Cleanup: clean all the configurations (IPVS, iptables, links) done
+// Cleanup cleans all the configurations (IPVS, iptables, links) done
 func (nsc *NetworkServicesController) Cleanup() {
 	// cleanup ipvs rules by flush
 	glog.Infof("Cleaning up IPVS configuration permanently")
@@ -824,6 +823,7 @@ func (nsc *NetworkServicesController) Cleanup() {
 	glog.Infof("Successfully cleaned the ipvs configuration done by kube-router")
 }
 
+// NewNetworkServicesController returns NetworkServicesController object
 func NewNetworkServicesController(clientset *kubernetes.Clientset, config *options.KubeRouterConfig) (*NetworkServicesController, error) {
 
 	var err error

app/server.go

@@ -16,11 +16,13 @@ import (
 	"k8s.io/client-go/tools/clientcmd"
 )
 
+// KubeRouter holds the information needed to run server
 type KubeRouter struct {
 	Client *kubernetes.Clientset
 	Config *options.KubeRouterConfig
 }
 
+// NewKubeRouterDefault returns a KubeRouter object
 func NewKubeRouterDefault(config *options.KubeRouterConfig) (*KubeRouter, error) {
 
 	var clientconfig *rest.Config
@@ -46,6 +48,7 @@ func NewKubeRouterDefault(config *options.KubeRouterConfig) (*KubeRouter, error)
 	return &KubeRouter{Client: clientset, Config: config}, nil
 }
 
+// CleanupConfigAndExit performs Cleanup on all three controllers
 func CleanupConfigAndExit() {
 	npc := controllers.NetworkPolicyController{}
 	npc.Cleanup()
@@ -104,6 +107,7 @@ func (kr *KubeRouter) stopApiWatchers() {
 	watchers.StopNodeWatcher()
 }
 
+// Run starts the controllers and waits forever till we get SIGINT or SIGTERM
 func (kr *KubeRouter) Run() error {
 
 	var err error

app/watchers/endpoints_watcher.go

@@ -81,7 +81,7 @@ func (ew *endpointsWatcher) List() []*api.Endpoints {
 	for i, ins := range objList {
 		epInstances[i] = ins.(*api.Endpoints)
 	}
-	return epInstances 
+	return epInstances
 }
 
 func (ew *endpointsWatcher) HasSynced() bool {

app/watchers/node_watcher.go

@@ -64,7 +64,7 @@ func (nw *nodeWatcher) List() []*api.Node {
 	for i, ins := range objList {
 		nodeInstances[i] = ins.(*api.Node)
 	}
-	return nodeInstances 
+	return nodeInstances
 }
 
 func (nw *nodeWatcher) HasSynced() bool {

app/watchers/pods_watcher.go

@@ -72,7 +72,7 @@ func (pw *podWatcher) List() []*api.Pod {
 	for i, ins := range objList {
 		podInstances[i] = ins.(*api.Pod)
 	}
-	return podInstances 
+	return podInstances
 }
 
 func (pw *podWatcher) ListByNamespaceAndLabels(namespace string, labelsToMatch labels.Set) (ret []*api.Pod, err error) {

app/watchers/services_watcher.go

@@ -67,7 +67,7 @@ func (svcw *serviceWatcher) RegisterHandler(handler ServiceUpdatesHandler) {
 func (svcw *serviceWatcher) List() []*api.Service {
 	objList := svcw.serviceLister.List()
 	svcInstances := make([]*api.Service, len(objList))
-	for i, ins := range objList{
+	for i, ins := range objList {
 		svcInstances[i] = ins.(*api.Service)
 	}
 	return svcInstances

utils/node.go

@@ -9,6 +9,7 @@ import (
 	apiv1 "k8s.io/client-go/pkg/api/v1"
 )
 
+// GetNodeObject returns the node API object for the node
 func GetNodeObject(clientset *kubernetes.Clientset, hostnameOverride string) (*apiv1.Node, error) {
 
 	// assuming kube-router is running as pod, first check env NODE_NAME

utils/pod_cidr.go

@@ -11,6 +11,7 @@ import (
 	"k8s.io/client-go/kubernetes"
 )
 
+// GetPodCidrFromCniSpec gets pod CIDR allocated to the node from CNI spec file and returns it
 func GetPodCidrFromCniSpec(cniConfFilePath string) (net.IPNet, error) {
 	netconfig, err := libcni.ConfFromFile(cniConfFilePath)
 	if err != nil {
@@ -25,6 +26,8 @@ func GetPodCidrFromCniSpec(cniConfFilePath string) (net.IPNet, error) {
 	return net.IPNet(ipamConfig.Subnet), nil
 }
 
+// InsertPodCidrInCniSpec inserts the pod CIDR allocated to the node by kubernetes controlller manager
+// and stored it in the CNI specification
 func InsertPodCidrInCniSpec(cniConfFilePath string, cidr string) error {
 	file, err := ioutil.ReadFile(cniConfFilePath)
 	if err != nil {
@@ -45,6 +48,7 @@ func InsertPodCidrInCniSpec(cniConfFilePath string, cidr string) error {
 	return nil
 }
 
+// GetPodCidrFromNodeSpec reads the pod CIDR allocated to the node from API node object and returns it
 func GetPodCidrFromNodeSpec(clientset *kubernetes.Clientset, hostnameOverride string) (string, error) {
 	node, err := GetNodeObject(clientset, hostnameOverride)
 	if err != nil {