Make golint happy and add codecov

.travis.yml

@@ -15,6 +15,7 @@ addons:
 script:
 - set -e
 - make test
+- go test -race -coverprofile=coverage.txt -covermode=atomic ./pkg/controller/
 - make build
 
 after_success:
@@ -33,6 +34,7 @@ after_success:
     docker push stefanprodan/flagger:latest;
     docker push stefanprodan/flagger:$TRAVIS_TAG;
   fi
+- bash <(curl -s https://codecov.io/bash)
 
 deploy:
 - provider: script

pkg/apis/flagger/v1alpha1/types.go

@@ -67,19 +67,23 @@ type CanaryStatus struct {
 	FailedChecks   int    `json:"failedChecks"`
 }
 
+// CanaryService is used to create ClusterIP services
+// and Istio Virtual Service
 type CanaryService struct {
 	Port     int32    `json:"port"`
 	Gateways []string `json:"gateways"`
 	Hosts    []string `json:"hosts"`
 }
 
+// CanaryAnalysis is used to describe how the analysis should be done
 type CanaryAnalysis struct {
 	Threshold  int            `json:"threshold"`
 	MaxWeight  int            `json:"maxWeight"`
 	StepWeight int            `json:"stepWeight"`
 	Metrics    []CanaryMetric `json:"metrics"`
 }
 
+// CanaryMetric hold the reference to Istio metrics used for canary analysis
 type CanaryMetric struct {
 	Name      string `json:"name"`
 	Interval  string `json:"interval"`

pkg/controller/controller.go

@@ -27,6 +27,7 @@ import (
 
 const controllerAgentName = "flagger"
 
+// Controller is managing the canary objects and schedules canary deployments
 type Controller struct {
 	kubeClient    kubernetes.Interface
 	istioClient   istioclientset.Interface
@@ -126,6 +127,7 @@ func NewController(
 	return ctrl
 }
 
+// Run starts the K8s workers and the canary scheduler
 func (c *Controller) Run(threadiness int, stopCh <-chan struct{}) error {
 	defer utilruntime.HandleCrash()
 	defer c.workqueue.ShutDown()
@@ -151,8 +153,6 @@ func (c *Controller) Run(threadiness int, stopCh <-chan struct{}) error {
 			return nil
 		}
 	}
-
-	return nil
 }
 
 func (c *Controller) processNextWorkItem() bool {

pkg/controller/deployer.go

@@ -21,6 +21,7 @@ import (
 	"k8s.io/client-go/kubernetes"
 )
 
+// CanaryDeployer is managing the operations for Kubernetes deployment kind
 type CanaryDeployer struct {
 	kubeClient    kubernetes.Interface
 	istioClient   istioclientset.Interface
@@ -123,7 +124,7 @@ func (c *CanaryDeployer) IsNewSpec(cd *flaggerv1.Canary) (bool, error) {
 	return false, nil
 }
 
-// SyncStatus updates the canary status state
+// SetFailedChecks updates the canary failed checks counter
 func (c *CanaryDeployer) SetFailedChecks(cd *flaggerv1.Canary, val int) error {
 	cd.Status.FailedChecks = val
 	cd, err := c.flaggerClient.FlaggerV1alpha1().Canaries(cd.Namespace).Update(cd)
@@ -133,7 +134,7 @@ func (c *CanaryDeployer) SetFailedChecks(cd *flaggerv1.Canary, val int) error {
 	return nil
 }
 
-// SyncStatus updates the canary status state
+// SetState updates the canary status state
 func (c *CanaryDeployer) SetState(cd *flaggerv1.Canary, state string) error {
 	cd.Status.State = state
 	cd, err := c.flaggerClient.FlaggerV1alpha1().Canaries(cd.Namespace).Update(cd)
@@ -217,9 +218,8 @@ func (c *CanaryDeployer) createPrimaryDeployment(cd *flaggerv1.Canary) error {
 	if err != nil {
 		if errors.IsNotFound(err) {
 			return fmt.Errorf("deployment %s.%s not found, retrying", canaryName, cd.Namespace)
-		} else {
-			return err
 		}
+		return err
 	}
 
 	primaryDep, err := c.kubeClient.AppsV1().Deployments(cd.Namespace).Get(primaryName, metav1.GetOptions{})
@@ -273,9 +273,8 @@ func (c *CanaryDeployer) createPrimaryHpa(cd *flaggerv1.Canary) error {
 		if errors.IsNotFound(err) {
 			return fmt.Errorf("HorizontalPodAutoscaler %s.%s not found, retrying",
 				cd.Spec.AutoscalerRef.Name, cd.Namespace)
-		} else {
-			return err
 		}
+		return err
 	}
 	primaryHpaName := fmt.Sprintf("%s-primary", cd.Spec.AutoscalerRef.Name)
 	primaryHpa, err := c.kubeClient.AutoscalingV2beta1().HorizontalPodAutoscalers(cd.Namespace).Get(primaryHpaName, metav1.GetOptions{})

pkg/controller/observer.go

@@ -11,11 +11,12 @@ import (
 	"time"
 )
 
+// CanaryObserver is used to query the Istio Prometheus db
 type CanaryObserver struct {
 	metricsServer string
 }
 
-type VectorQueryResponse struct {
+type vectorQueryResponse struct {
 	Data struct {
 		Result []struct {
 			Metric struct {
@@ -27,7 +28,7 @@ type VectorQueryResponse struct {
 	}
 }
 
-func (c *CanaryObserver) queryMetric(query string) (*VectorQueryResponse, error) {
+func (c *CanaryObserver) queryMetric(query string) (*vectorQueryResponse, error) {
 	promURL, err := url.Parse(c.metricsServer)
 	if err != nil {
 		return nil, err
@@ -63,7 +64,7 @@ func (c *CanaryObserver) queryMetric(query string) (*VectorQueryResponse, error)
 		return nil, fmt.Errorf("error response: %s", string(b))
 	}
 
-	var values VectorQueryResponse
+	var values vectorQueryResponse
 	err = json.Unmarshal(b, &values)
 	if err != nil {
 		return nil, fmt.Errorf("error unmarshaling result: %s, '%s'", err.Error(), string(b))
@@ -72,7 +73,7 @@ func (c *CanaryObserver) queryMetric(query string) (*VectorQueryResponse, error)
 	return &values, nil
 }
 
-// istio_requests_total
+// GetDeploymentCounter returns the requests success rate using istio_requests_total metric
 func (c *CanaryObserver) GetDeploymentCounter(name string, namespace string, metric string, interval string) (float64, error) {
 	if c.metricsServer == "fake" {
 		return 100, nil
@@ -109,7 +110,7 @@ func (c *CanaryObserver) GetDeploymentCounter(name string, namespace string, met
 	return *rate, nil
 }
 
-// istio_request_duration_seconds_bucket
+// GetDeploymentHistogram returns the 99P requests delay using istio_request_duration_seconds_bucket metrics
 func (c *CanaryObserver) GetDeploymentHistogram(name string, namespace string, metric string, interval string) (time.Duration, error) {
 	if c.metricsServer == "fake" {
 		return 1, nil
@@ -143,6 +144,8 @@ func (c *CanaryObserver) GetDeploymentHistogram(name string, namespace string, m
 	return ms, nil
 }
 
+// CheckMetricsServer call Prometheus status endpoint and returns an error if
+// the API is unreachable
 func CheckMetricsServer(address string) (bool, error) {
 	promURL, err := url.Parse(address)
 	if err != nil {

pkg/controller/router.go

@@ -17,6 +17,8 @@ import (
 	"k8s.io/client-go/kubernetes"
 )
 
+// CanaryRouter is managing the operations for Kubernetes service kind
+// and Istio virtual services
 type CanaryRouter struct {
 	kubeClient    kubernetes.Interface
 	istioClient   istioclientset.Interface

pkg/logging/logger.go

@@ -8,6 +8,7 @@ import (
 	"go.uber.org/zap/zapcore"
 )
 
+// NewLogger returns a zap sugared logger configured with json format and caller id
 func NewLogger(logLevel string) (*zap.SugaredLogger, error) {
 	level := zap.NewAtomicLevelAt(zapcore.InfoLevel)
 	switch logLevel {
@@ -59,6 +60,7 @@ func NewLogger(logLevel string) (*zap.SugaredLogger, error) {
 	return logger.Sugar(), nil
 }
 
+// Console writes to stdout if the console env var exists
 func Console(a ...interface{}) (n int, err error) {
 	if os.Getenv("console") != "" {
 		return fmt.Fprintln(os.Stdout, a...)

pkg/server/server.go

@@ -9,6 +9,7 @@ import (
 	"go.uber.org/zap"
 )
 
+// ListenAndServe starts a web server and waits for SIGTERM
 func ListenAndServe(port string, timeout time.Duration, logger *zap.SugaredLogger, stopCh <-chan struct{}) {
 	mux := http.DefaultServeMux
 	mux.Handle("/metrics", promhttp.Handler())