fmt and linters

We're not yet ready for golint though.

Author: bpineau

Makefile

@@ -1,11 +1,35 @@
 
 all: build
 
+tools:
+	which gometalinter || ( go get -u github.com/alecthomas/gometalinter && gometalinter --install )
+	which glide || go get -u github.com/Masterminds/glide
+
+lint:
+	gometalinter -j 1 --vendor --disable-all \
+		--enable=errcheck \
+		--enable=vet \
+		--enable=vetshadow \
+		--enable=structcheck \
+		--enable=aligncheck \
+		--enable=deadcode \
+		--enable=ineffassign \
+		--enable=dupl \
+		--enable=gotype \
+		--enable=varcheck \
+		--enable=interfacer \
+		--enable=goconst \
+		--enable=megacheck \
+		--enable=unparam \
+		--enable=misspell \
+		--enable=gas \
+		--enable=goimports \
+		./...
+
 fmt:
 	go fmt ./...
 
 deps:
-	which glide || go get -u github.com/Masterminds/glide
 	glide install
 
 build:
@@ -20,4 +44,4 @@ clean:
 test:
 	go test -v ./...
 
-.PHONY: fmt install clean test all
+.PHONY: tools lint fmt install clean test all

cmd/execute.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"log"
 	"os"
 	"strings"
 
@@ -10,11 +11,11 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/bpineau/kube-alert/config"
-	"github.com/bpineau/kube-alert/pkg/log"
+	klog "github.com/bpineau/kube-alert/pkg/log"
 	"github.com/bpineau/kube-alert/pkg/run"
 )
 
-const AppName = "kube-alert"
+const appName = "kube-alert"
 
 var (
 	cfgFile   string
@@ -30,14 +31,14 @@ var (
 
 	// rootCmd represents the base command when called without any subcommands
 	rootCmd = &cobra.Command{
-		Use:   AppName,
+		Use:   appName,
 		Short: "Monitor pods",
 		Long:  "Monitor pods and alert on failure",
 
 		Run: func(cmd *cobra.Command, args []string) {
 			config := &config.AlertConfig{
 				DryRun:     viper.GetBool("dry-run"),
-				Logger:     log.New(viper.GetString("log.level"), viper.GetString("log.server"), viper.GetString("log.output")),
+				Logger:     klog.New(viper.GetString("log.level"), viper.GetString("log.server"), viper.GetString("log.output")),
 				DdAppKey:   viper.GetString("datadog.app-key"),
 				DdApiKey:   viper.GetString("datadog.api-key"),
 				HealthPort: viper.GetInt("healthcheck-port"),
@@ -58,44 +59,64 @@ func Execute() {
 func init() {
 	cobra.OnInitialize(initConfig)
 
-	defaultCfg := "/etc/" + AppName + "/" + AppName + ".yaml"
+	defaultCfg := "/etc/" + appName + "/" + appName + ".yaml"
 	rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", defaultCfg, "configuration file")
 
 	rootCmd.PersistentFlags().StringVarP(&apiServer, "api-server", "s", "", "kube api server url")
-	viper.BindPFlag("api-server", rootCmd.PersistentFlags().Lookup("api-server"))
+	if err := viper.BindPFlag("api-server", rootCmd.PersistentFlags().Lookup("api-server")); err != nil {
+		log.Fatal("Failed to bind cli argument:", err)
+	}
 
 	rootCmd.PersistentFlags().StringVarP(&kubeConf, "kube-config", "k", "", "kube config path")
-	viper.BindPFlag("kube-config", rootCmd.PersistentFlags().Lookup("kube-config"))
-	viper.BindEnv("kube-config", "KUBECONFIG")
+	if err := viper.BindPFlag("kube-config", rootCmd.PersistentFlags().Lookup("kube-config")); err != nil {
+		log.Fatal("Failed to bind cli argument:", err)
+	}
+	if err := viper.BindEnv("kube-config", "KUBECONFIG"); err != nil {
+		log.Fatal("Failed to bind cli argument:", err)
+	}
 
 	rootCmd.PersistentFlags().BoolVarP(&dryRun, "dry-run", "d", false, "dry-run mode")
-	viper.BindPFlag("dry-run", rootCmd.PersistentFlags().Lookup("dry-run"))
+	if err := viper.BindPFlag("dry-run", rootCmd.PersistentFlags().Lookup("dry-run")); err != nil {
+		log.Fatal("Failed to bind cli argument:", err)
+	}
 
 	rootCmd.PersistentFlags().StringVarP(&logLevel, "log-level", "v", "debug", "log level")
-	viper.BindPFlag("log.level", rootCmd.PersistentFlags().Lookup("log-level"))
+	if err := viper.BindPFlag("log.level", rootCmd.PersistentFlags().Lookup("log-level")); err != nil {
+		log.Fatal("Failed to bind cli argument:", err)
+	}
 
 	rootCmd.PersistentFlags().StringVarP(&logOutput, "log-output", "l", "stderr", "log output")
-	viper.BindPFlag("log.output", rootCmd.PersistentFlags().Lookup("log-output"))
+	if err := viper.BindPFlag("log.output", rootCmd.PersistentFlags().Lookup("log-output")); err != nil {
+		log.Fatal("Failed to bind cli argument:", err)
+	}
 
 	rootCmd.PersistentFlags().StringVarP(&logServer, "log-server", "r", "", "log server (if using syslog)")
-	viper.BindPFlag("log.server", rootCmd.PersistentFlags().Lookup("log-server"))
+	if err := viper.BindPFlag("log.server", rootCmd.PersistentFlags().Lookup("log-server")); err != nil {
+		log.Fatal("Failed to bind cli argument:", err)
+	}
 
 	rootCmd.PersistentFlags().StringVarP(&ddAppKey, "datadog-app-key", "a", "", "datadog app key")
-	viper.BindPFlag("datadog.app-key", rootCmd.PersistentFlags().Lookup("datadog-app-key"))
+	if err := viper.BindPFlag("datadog.app-key", rootCmd.PersistentFlags().Lookup("datadog-app-key")); err != nil {
+		log.Fatal("Failed to bind cli argument:", err)
+	}
 
 	rootCmd.PersistentFlags().StringVarP(&ddApiKey, "datadog-api-key", "i", "", "datadog api key")
-	viper.BindPFlag("datadog.api-key", rootCmd.PersistentFlags().Lookup("datadog-api-key"))
+	if err := viper.BindPFlag("datadog.api-key", rootCmd.PersistentFlags().Lookup("datadog-api-key")); err != nil {
+		log.Fatal("Failed to bind cli argument:", err)
+	}
 
 	rootCmd.PersistentFlags().IntVarP(&healthP, "healthcheck-port", "p", 0, "port for answering healthchecks")
-	viper.BindPFlag("healthcheck-port", rootCmd.PersistentFlags().Lookup("healthcheck-port"))
+	if err := viper.BindPFlag("healthcheck-port", rootCmd.PersistentFlags().Lookup("healthcheck-port")); err != nil {
+		log.Fatal("Failed to bind cli argument:", err)
+	}
 }
 
 func initConfig() {
 	viper.SetConfigType("yaml")
-	viper.SetConfigName(AppName)
+	viper.SetConfigName(appName)
 
 	// all possible config file paths, by priority
-	viper.AddConfigPath("/etc/" + AppName + "/")
+	viper.AddConfigPath("/etc/" + appName + "/")
 	if home, err := homedir.Dir(); err == nil {
 		viper.AddConfigPath(home)
 	}

config/config.go

@@ -2,6 +2,7 @@ package config
 
 import (
 	"fmt"
+
 	"github.com/bpineau/kube-alert/pkg/clientset"
 	"github.com/sirupsen/logrus"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

pkg/controllers/controllers.go

@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"os"
 	"os/signal"
-	"syscall"
 	"strings"
+	"syscall"
 	"time"
 
 	"github.com/bpineau/kube-alert/config"
@@ -31,17 +31,19 @@ type Controller interface {
 }
 
 type CommonController struct {
-	Conf       *config.AlertConfig
-	Queue      workqueue.RateLimitingInterface
-	Informer   cache.SharedIndexInformer
-	Handler    handlers.Handler
-	Name       string
-	ListWatch  cache.ListerWatcher
-	ObjType    runtime.Object
+	Conf      *config.AlertConfig
+	Queue     workqueue.RateLimitingInterface
+	Informer  cache.SharedIndexInformer
+	Handler   handlers.Handler
+	Name      string
+	ListWatch cache.ListerWatcher
+	ObjType   runtime.Object
 }
 
 func (c *CommonController) Start() {
-	c.Handler.Init(c.Conf)
+	if err := c.Handler.Init(c.Conf); err != nil {
+		c.Conf.Logger.Fatalf("Failed to init %s handler: %s", c.Name, err)
+	}
 
 	c.startInformer()
 	stopCh := make(chan struct{})

pkg/handlers/cs/cs.go

@@ -25,7 +25,7 @@ func (h *CsHandler) ObjectCreated(obj interface{}) (bool, string) {
 			continue
 		}
 		if c.Status != "True" {
-			return false, fmt.Sprintf("%s/%s is unhealthy: %s", cs.Name, c.Message)
+			return false, fmt.Sprintf("%s is unhealthy: %s", cs.Name, c.Message)
 		}
 	}
 

pkg/handlers/handlers.go

@@ -2,8 +2,8 @@ package handlers
 
 import (
 	"github.com/bpineau/kube-alert/config"
-	"github.com/bpineau/kube-alert/pkg/handlers/pod"
 	"github.com/bpineau/kube-alert/pkg/handlers/cs"
+	"github.com/bpineau/kube-alert/pkg/handlers/pod"
 )
 
 type Handler interface {
@@ -14,5 +14,5 @@ type Handler interface {
 
 var Handlers = map[string]Handler{
 	"pod": &pod.PodHandler{},
-	"cs": &cs.CsHandler{},
+	"cs":  &cs.CsHandler{},
 }

pkg/health/health.go

@@ -9,13 +9,17 @@ import (
 )
 
 func healthCheckReply(w http.ResponseWriter, r *http.Request) {
-	io.WriteString(w, "ok\n")
+	if _, err := io.WriteString(w, "ok\n"); err != nil {
+		fmt.Printf("Failed to reply to http healtcheck: %s\n", err)
+	}
 }
 
 func HealthCheckServe(c *config.AlertConfig) {
 	if c.HealthPort == 0 {
 		return
 	}
 	http.HandleFunc("/health", healthCheckReply)
-	http.ListenAndServe(fmt.Sprintf(":%d", c.HealthPort), nil)
+	if err := http.ListenAndServe(fmt.Sprintf(":%d", c.HealthPort), nil); err != nil {
+		panic(fmt.Sprintf("Failed to start http healtcheck: %s", err))
+	}
 }

pkg/log/log.go

@@ -4,9 +4,10 @@ import (
 	"io"
 	"os"
 
+	"log/syslog"
+
 	"github.com/sirupsen/logrus"
 	ls "github.com/sirupsen/logrus/hooks/syslog"
-	"log/syslog"
 )
 
 func New(logLevel string, logServer string, logOutput string) *logrus.Logger {

pkg/notifiers/datadog/datadog.go

@@ -15,7 +15,7 @@ var tags = []string{
 
 func (l *DdNotifier) Notify(c *config.AlertConfig, title string, msg string) error {
 	if c.DdApiKey == "" {
-		c.Logger.Debug("Omiting datadog notification, api key missing")
+		c.Logger.Debug("Omitting datadog notification, api key missing")
 		return nil
 	}
 

pkg/run/run.go

@@ -7,8 +7,8 @@ import (
 
 	"github.com/bpineau/kube-alert/config"
 	"github.com/bpineau/kube-alert/pkg/controllers"
-	"github.com/bpineau/kube-alert/pkg/controllers/pod"
 	"github.com/bpineau/kube-alert/pkg/controllers/cs"
+	"github.com/bpineau/kube-alert/pkg/controllers/pod"
 	"github.com/bpineau/kube-alert/pkg/handlers"
 	"github.com/bpineau/kube-alert/pkg/health"
 )