test(*): enforce gofmt

This PR enforces and suggests that the codebase should follow a specific
style using a combination of `gofmt`, `golint` and `go vet`. `gofmt` is
enforced; the latter are suggested and displayed.

Author: Matthew Fisher

Makefile

@@ -4,6 +4,12 @@
 
 include includes.mk
 
+# the filepath to this repository, relative to $GOPATH/src
+repo_path = github.com/deis/deis
+
+GO_PACKAGES = pkg/time version
+GO_PACKAGES_REPO_PATH = $(addprefix $(repo_path)/,$(GO_PACKAGES))
+
 COMPONENTS=builder cache controller database logger logspout publisher registry router store
 START_ORDER=publisher store logger logspout database cache registry controller builder router
 CLIENTS=client deisctl
@@ -67,7 +73,7 @@ release: check-registry
 
 deploy: build dev-release restart
 
-test: test-unit test-functional push test-integration
+test: test-style test-unit test-functional push test-integration
 
 test-functional:
 	@$(foreach C, $(COMPONENTS), $(MAKE) -C $(C) test-functional &&) echo done
@@ -81,3 +87,16 @@ test-integration:
 
 test-smoke:
 	$(MAKE) -C tests/ test-smoke
+
+test-style:
+# display output, then check
+	$(GOFMT) $(GO_PACKAGES)
+	@$(GOFMT) $(GO_PACKAGES) | read; if [ $$? == 0 ]; then echo "gofmt check failed."; exit 1; fi
+# FIXME: make this mandatory
+	-$(GOVET) $(GO_PACKAGES_REPO_PATH)
+# FIXME: make this mandatory
+	@for i in $(addsuffix /...,$(GO_PACKAGES)); do \
+		$(GOLINT) $$i; \
+	done
+	@$(foreach C, $(COMPONENTS), $(MAKE) -C $(C) test-style &&) echo done
+	@$(foreach C, $(CLIENTS), $(MAKE) -C $(C) test-style &&) echo done

builder/Makefile

@@ -1,6 +1,13 @@
 include ../includes.mk
 
-COMPONENT = builder
+# the filepath to this repository, relative to $GOPATH/src
+repo_path = github.com/deis/deis/builder
+
+GO_FILES = types.go utils.go utils_test.go
+GO_PACKAGES = bin
+GO_PACKAGES_REPO_PATH = $(addprefix $(repo_path)/,$(GO_PACKAGES))
+
+COMPONENT = $(notdir $(repo_path))
 IMAGE = $(IMAGE_PREFIX)$(COMPONENT):$(BUILD_TAG)
 DEV_IMAGE = $(DEV_REGISTRY)/$(IMAGE)
 BINARIES := extract-domain extract-types extract-version generate-buildhook get-app-config get-app-values publish-release-controller yaml2json-procfile
@@ -51,7 +58,7 @@ release:
 
 deploy: build dev-release restart
 
-test: test-unit test-functional
+test: test-style test-unit test-functional
 
 test-unit:
 	godep go test -v .
@@ -60,6 +67,15 @@ test-functional:
 	@docker history deis/test-etcd >/dev/null 2>&1 || docker pull deis/test-etcd:latest
 	GOPATH=`cd ../tests/ && godep path`:$(GOPATH) go test -v ./tests/...
 
+test-style:
+# display output, then check
+	$(GOFMT) $(GO_PACKAGES) $(GO_FILES)
+	@$(GOFMT) $(GO_PACKAGES) $(GO_FILES) | read; if [ $$? == 0 ]; then echo "gofmt check failed."; exit 1; fi
+# FIXME: make this mandatory
+	-$(GOVET) $(repo_path) $(GO_PACKAGES_REPO_PATH)
+# FIXME: make this mandatory
+	-$(GOLINT) ./...
+
 cedarish/build:
 	mkdir -p build
 	docker pull progrium/cedarish:latest

builder/utils_test.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 	"testing"
 	"time"
+
 	dtime "github.com/deis/deis/pkg/time"
 )
 

cache/Makefile

@@ -1,6 +1,12 @@
 include ../includes.mk
 
-COMPONENT = cache
+# the filepath to this repository, relative to $GOPATH/src
+repo_path = github.com/deis/deis/cache
+
+GO_PACKAGES = image
+GO_PACKAGES_REPO_PATH = $(addprefix $(repo_path)/,$(GO_PACKAGES))
+
+COMPONENT = $(notdir $(repo_path))
 IMAGE = $(IMAGE_PREFIX)$(COMPONENT):$(BUILD_TAG)
 DEV_IMAGE = $(DEV_REGISTRY)/$(IMAGE)
 BUILD_IMAGE = $(COMPONENT)-build
@@ -50,11 +56,20 @@ release:
 
 deploy: build dev-release restart
 
-test: test-unit test-functional
+test: test-style test-unit test-functional
 
 test-unit:
 	@echo no unit tests
 
+test-style:
+# display output, then check
+	$(GOFMT) $(GO_PACKAGES)
+	@$(GOFMT) $(GO_PACKAGES) | read; if [ $$? == 0 ]; then echo "gofmt check failed."; exit 1; fi
+# FIXME: make this mandatory
+	-$(GOVET) $(GO_PACKAGES_REPO_PATH)
+# FIXME: make this mandatory
+	-$(GOLINT) ./...
+
 test-functional:
 	@docker history deis/test-etcd >/dev/null 2>&1 || docker pull deis/test-etcd:latest
 	GOPATH=`cd ../tests/ && godep path`:$(GOPATH) go test -v ./tests/...

client/deis.py

@@ -47,7 +47,6 @@
 from itertools import cycle
 from threading import Event
 from threading import Thread
-import base64
 import glob
 import json
 import locale
@@ -181,7 +180,8 @@ def __init__(self):
             if os.path.exists(old_path):
                 try:
                     with open(old_path, 'r') as f:
-                        txt = f.read().replace('{', '{"', 1).replace(':', '":', 1).replace("'", '"')
+                        txt = f.read()
+                        txt = txt.replace('{', '{"', 1).replace(':', '":', 1).replace("'", '"')
                         settings = json.loads(txt)
                         os.remove(old_path)
                 except:
@@ -638,6 +638,7 @@ def apps_logs(self, args):
                     log_tag = line.split(': ')[0].split(' ')[1]
                     # colorize the log based on the tag
                     color = sum([ord(ch) for ch in log_tag]) % 6
+
                     def f(x):
                         return {
                             0: 'green',
@@ -797,7 +798,6 @@ def auth_login(self, args):
         if not urlparse.urlparse(controller).scheme:
             controller = "http://{}".format(controller)
         username = args.get('--username')
-        headers = {}
         if not username:
             username = raw_input('username: ')
         password = args.get('--password')
@@ -810,7 +810,7 @@ def auth_login(self, args):
         payload = {'username': username, 'password': password}
         # post credentials to the login URL
         response = self._session.post(url, data=payload, allow_redirects=False,
-            verify=ssl_verify)
+                                      verify=ssl_verify)
         if response.status_code == requests.codes.ok:
             # retrieve and save the API token for future requests
             self._settings['controller'] = controller
@@ -1562,8 +1562,9 @@ def tags_set(self, args):
         """
         Sets tags for an application.
 
-        A tag is a key/value pair used to tag an application's containers and is passed to the scheduler.
-        This is often used to restrict workloads to specific hosts matching the scheduler-configured metadata.
+        A tag is a key/value pair used to tag an application's containers and is passed to the
+        scheduler. This is often used to restrict workloads to specific hosts matching the
+        scheduler-configured metadata.
 
         Usage: deis tags:set [options] <key>=<value>...
 

database/Makefile

@@ -43,11 +43,14 @@ release:
 
 deploy: build dev-release restart
 
-test: test-unit test-functional
+test: test-style test-unit test-functional
 
 test-unit:
 	@echo no unit tests
 
+test-style:
+	@echo no style tests
+
 test-functional:
 	@docker history deis/mock-store >/dev/null 2>&1 || $(MAKE) -C ../tests/ mock-store
 	@docker history deis/test-etcd >/dev/null 2>&1 || docker pull deis/test-etcd:latest

deisctl/Makefile

@@ -1,6 +1,13 @@
 include ../includes.mk
 
-COMPONENT = deisctl
+# the filepath to this repository, relative to $GOPATH/src
+repo_path = github.com/deis/deis/deisctl
+
+GO_FILES = deisctl.go deisctl_test.go
+GO_PACKAGES = backend client cmd config utils
+GO_PACKAGES_REPO_PATH = $(addprefix $(repo_path)/,$(GO_PACKAGES))
+
+COMPONENT = $(notdir $(repo_path))
 IMAGE =  $(IMAGE_PREFIX)/$(COMPONENT):$(BUILD_TAG)
 
 build:
@@ -32,11 +39,16 @@ setup-root-gotools:
 setup-gotools:
 	go get -v github.com/golang/lint/golint
 
+test: test-style test-unit test-functional
+
 test-style:
-	go vet ./...
-	-golint ./...
+# display output, then check
+	$(GOFMT) $(GO_PACKAGES) $(GO_FILES)
+	@$(GOFMT) $(GO_PACKAGES) $(GO_FILES) | read; if [ $$? == 0 ]; then echo "gofmt check failed."; exit 1; fi
+# FIXME: make this mandatory
+	-$(GOVET) $(repo_path) $(GO_PACKAGES_REPO_PATH)
+# FIXME: make this mandatory
+	-$(GOLINT) ./...
 
 test-unit:
 	godep go test -v -cover ./...
-
-test: test-style test-unit

deisctl/backend/fleet/ssh.go

@@ -73,7 +73,7 @@ func runRemoteCommand(cmd string, addr string, timeout time.Duration) (exit int,
 	defer sshClient.Close()
 
 	err, exit = ssh.Execute(sshClient, cmd)
-	return 
+	return
 }
 
 func machineState(machID string) (*machine.MachineState, error) {

includes.mk

@@ -1,26 +1,36 @@
-ifndef DEIS_NUM_INSTANCES
-  DEIS_NUM_INSTANCES = 3
-endif
+SHELL = /bin/bash
 
-define echo_cyan
-  @echo "\033[0;36m$(subst ",,$(1))\033[0m"
-endef
-
-define echo_yellow
-  @echo "\033[0;33m$(subst ",,$(1))\033[0m"
-endef
+GO = godep go
+GOFMT = gofmt -l
+GOLINT = golint
+GOTEST = $(GO) test --cover --race -v
+GOVET = $(GO) vet
 
 SELF_DIR := $(dir $(lastword $(MAKEFILE_LIST)))
 DOCKER_HOST = $(shell echo $$DOCKER_HOST)
 REGISTRY = $(shell echo $$DEV_REGISTRY)
 GIT_SHA = $(shell git rev-parse --short HEAD)
+IMAGE_PREFIX := deis/
+
 ifndef BUILD_TAG
   BUILD_TAG = git-$(GIT_SHA)
 endif
+
 ifndef S3_BUCKET
   S3_BUCKET = deis-updates
 endif
-IMAGE_PREFIX := deis/
+
+ifndef DEIS_NUM_INSTANCES
+  DEIS_NUM_INSTANCES = 3
+endif
+
+define echo_cyan
+  @echo "\033[0;36m$(subst ",,$(1))\033[0m"
+endef
+
+define echo_yellow
+  @echo "\033[0;33m$(subst ",,$(1))\033[0m"
+endef
 
 check-docker:
 	@if [ -z $$(which docker) ]; then \

logger/Makefile

@@ -1,6 +1,13 @@
 include ../includes.mk
 
-COMPONENT = logger
+# the filepath to this repository, relative to $GOPATH/src
+repo_path = github.com/deis/deis/logger
+
+GO_FILES = main.go
+GO_PACKAGES = syslog syslogd
+GO_PACKAGES_REPO_PATH = $(addprefix $(repo_path)/,$(GO_PACKAGES))
+
+COMPONENT = $(notdir $(repo_path))
 IMAGE = $(IMAGE_PREFIX)$(COMPONENT):$(BUILD_TAG)
 DEV_IMAGE = $(DEV_REGISTRY)/$(IMAGE)
 BINARY_DEST_DIR = image/bin
@@ -46,8 +53,6 @@ release:
 
 deploy: build dev-release restart
 
-test: test-unit test-functional
-
 setup-root-gotools:
 	sudo GOPATH=/tmp/tmpGOPATH go get -u -v code.google.com/p/go.tools/cmd/cover
 	sudo GOPATH=/tmp/tmpGOPATH go get -u -v code.google.com/p/go.tools/cmd/vet
@@ -56,17 +61,24 @@ setup-root-gotools:
 setup-gotools:
 	go get -v github.com/golang/lint/golint
 
-test-style:
-	go vet -x ./...
-	-golint ./...
-
-test-unit: test-style
-	go test -v -cover ./syslog
+test: test-style test-unit test-functional
 
 test-functional:
 	@docker history deis/test-etcd >/dev/null 2>&1 || docker pull deis/test-etcd:latest
 	GOPATH=`cd ../tests/ && godep path`:$(GOPATH) go test -v ./tests/...
 
+test-style:
+# display output, then check
+	$(GOFMT) $(GO_PACKAGES) $(GO_FILES)
+	@$(GOFMT) $(GO_PACKAGES) $(GO_FILES) | read; if [ $$? == 0 ]; then echo "gofmt check failed."; exit 1; fi
+# FIXME: make this mandatory
+	-$(GOVET) $(repo_path) $(GO_PACKAGES_REPO_PATH)
+# FIXME: make this mandatory
+	-$(GOLINT) ./...
+
+test-unit: test-style
+	$(GOTEST) $(GO_PACKAGES_REPO_PATH)
+
 coverage:
 	go test -coverprofile coverage.out ./syslog
 	go tool cover -html=coverage.out