chore(Makefile): add checks to Makefile

Author: nathanielc

.circleci/config.yml

@@ -25,7 +25,9 @@ jobs:
             - flux-gomod-                              # Matches a new branch.
       # Run tests
       - run: make checkfmt
+      - run: make checktidy
       - run: make vet
+      - run: make staticcheck
       - run: make test
       - save_cache:
           name: Saving GOCACHE

Makefile

@@ -11,7 +11,7 @@
 #    * All recursive Makefiles must support the targets: all and clean.
 #
 
-SUBDIRS = ast internal/scanner
+SUBDIRS = ast/asttest internal/scanner
 
 GO_ARGS=-tags '$(GO_TAGS)'
 
@@ -39,19 +39,23 @@ bin/$(GOOS)/cmpgen: ./ast/asttest/cmpgen/main.go
 	$(GO_BUILD) -o $@ ./ast/asttest/cmpgen
 
 fmt: $(SOURCES_NO_VENDOR)
-	goimports -w $^
+	go fmt ./...
 
 checkfmt:
+	./etc/checkfmt.sh
+
+tidy:
 	GO111MODULE=on go mod tidy
-	@if ! git --no-pager diff --exit-code -- go.mod go.sum; then \
-		>&2 echo "modules are not tidy, please run 'go mod tidy'"; \
-		exit 1; \
-	fi
-	go fmt ./...
-	@if ! git --no-pager diff --quiet; then \
-		>&2 echo "files are not formatted, please run 'go fmt ./...'"; \
-		exit 1; \
-	fi
+
+checktidy:
+	./etc/checktidy.sh
+
+checkgenerate:
+	./etc/checkgenerate.sh
+
+staticcheck:
+	GO111MODULE=on go mod vendor # staticcheck looks in vendor for dependencies.
+	GO111MODULE=on go run honnef.co/go/tools/cmd/staticcheck ./...
 
 test:
 	$(GO_TEST) ./...
@@ -70,5 +74,20 @@ release:
 
 
 
-.PHONY: all clean fmt test test-race vet bench checkfmt release $(SUBDIRS)
+.PHONY: all \
+	clean \
+	fmt \
+	checkfmt \
+	tidy \
+	checktidt \
+	generate \
+	checkgenerate \
+	staticcheck \
+	test \
+	test-race \
+	vet \
+	bench \
+	checkfmt \
+	release \
+	$(SUBDIRS)
 

ast/Makefile

@@ -1,9 +1,26 @@
-all: cmpopts.go
+# List any generated files here
+TARGETS = cmpopts.go
+# List any source files used to generate the targets here
+SOURCES = ../ast.go gen.go ../../bin/$(GOOS)/cmpgen
+# List any directories that have their own Makefile here
+SUBDIRS =
 
-cmpopts.go: ../ast.go gen.go ../../bin/$(GOOS)/cmpgen
-	PATH=../../bin/${GOOS}:${PATH} $(GO_GENERATE) -x ./...
+# Default target
+all: $(SUBDIRS) $(TARGETS)
 
-clean:
-	rm -f cmpopts.go
+# Recurse into subdirs for same make goal
+$(SUBDIRS):
+	$(MAKE) -C $@ $(MAKECMDGOALS)
 
-.PHONY: all clean
+# Clean all targets recursively
+clean: $(SUBDIRS)
+	rm -f $(TARGETS)
+
+# Define go generate if not already defined
+GO_GENERATE := go generate
+
+# Run go generate for the targets
+$(TARGETS): $(SOURCES)
+	PATH=../../bin/${GOOS}:${PATH} $(GO_GENERATE) -x
+
+.PHONY: all clean $(SUBDIRS)

ast/asttest/Makefile

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+HAS_FMT_ERR=0
+# For every Go file in the project, excluding vendor...
+for file in $(go list -f '{{$dir := .Dir}}{{range .GoFiles}}{{printf "%s/%s\n" $dir .}}{{end}}' ./...); do
+  # ... if file does not contain standard generated code comment (https://golang.org/s/generatedcode)...
+  if ! grep -Exq '^// Code generated .* DO NOT EDIT\.$' $file; then
+    FMT_OUT="$(gofmt -l -d -e $file)" # gofmt exits 0 regardless of whether it's formatted.
+    # ... and if gofmt had any output...
+    if [[ -n "$FMT_OUT" ]]; then
+      if [ "$HAS_FMT_ERR" -eq "0" ]; then
+        # Only print this once.
+        HAS_FMT_ERR=1
+        echo 'Commit includes files that are not gofmt-ed' && \
+        echo 'run "make fmt"' && \
+        echo ''
+      fi
+      echo "$FMT_OUT" # Print output and continue, so developers don't fix one file at a t
+    fi
+   fi
+done
+
+## print at the end too... sometimes it is nice to see what to do at the end.
+if [ "$HAS_FMT_ERR" -eq "1" ]; then
+    echo 'Commit includes files that are not gofmt-ed' && \
+    echo 'run "make fmt"' && \
+    echo ''
+fi
+exit "$HAS_FMT_ERR"

etc/checkfmt.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -e
+
+make clean
+make all
+
+status=$(git status --porcelain)
+if [ -n "$status" ]; then
+  >&2 echo "generated code is not accurate, please run make generate"
+  >&2 echo -e "Files changed:\n$status"
+  exit 1
+fi

etc/checkgenerate.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -e
+
+export GO111MODULE=on
+go mod tidy
+
+if ! git --no-pager diff --exit-code -- go.mod go.sum; then
+  >&2 echo "modules are not tidy, please run 'go mod tidy'"
+  exit 1
+fi

etc/checktidy.sh

@@ -1,6 +1,7 @@
 module github.com/influxdata/flux
 
 require (
+	github.com/BurntSushi/toml v0.3.1 // indirect
 	github.com/Masterminds/semver v1.4.2
 	github.com/andreyvit/diff v0.0.0-20170406064948-c7f18ee00883
 	github.com/apache/arrow/go/arrow v0.0.0-20181031164735-a56c009257a7
@@ -36,6 +37,8 @@ require (
 	golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9 // indirect
 	golang.org/x/exp v0.0.0-20181112044915-a3060d491354
 	golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a // indirect
+	golang.org/x/tools v0.0.0-20181221154417-3ad2d988d5e2 // indirect
 	gonum.org/v1/gonum v0.0.0-20181121035319-3f7ecaa7e8ca
 	gopkg.in/src-d/go-git.v4 v4.8.1
+	honnef.co/go/tools v0.0.0-20181108184350-ae8f1f9103cc
 )

go.mod

@@ -1,3 +1,5 @@
+github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
+github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/Masterminds/semver v1.4.2 h1:WBLTQ37jOCzSLtXNdoo8bNM8876KhNqOKvrlGITgsTc=
 github.com/Masterminds/semver v1.4.2/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y=
 github.com/OneOfOne/xxhash v1.2.2 h1:KMrpdQIwFcEqXDklaen+P1axHaj9BSKzvpUUfnHldSE=
@@ -168,7 +170,10 @@ golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
 golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/tools v0.0.0-20180525024113-a5b4c53f6e8b h1:7tibmaEqrQYA+q6ri7NQjuxqSwechjtDHKq6/e85S38=
 golang.org/x/tools v0.0.0-20180525024113-a5b4c53f6e8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20181221154417-3ad2d988d5e2 h1:M7NLB69gFpUH4s6SJLwXiVs45aZfVjqGKynfNFKSGcI=
+golang.org/x/tools v0.0.0-20181221154417-3ad2d988d5e2/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 gonum.org/v1/gonum v0.0.0-20181121035319-3f7ecaa7e8ca h1:PupagGYwj8+I4ubCxcmcBRk3VlUWtTg5huQpZR9flmE=
 gonum.org/v1/gonum v0.0.0-20181121035319-3f7ecaa7e8ca/go.mod h1:Y+Yx5eoAFn32cQvJDxZx5Dpnq+c3wtXuadVZAcxbbBo=
 gonum.org/v1/netlib v0.0.0-20181029234149-ec6d1f5cefe6 h1:4WsZyVtkthqrHTbDCJfiTs8IWNYE4uvsSDgaV6xpp+o=
@@ -188,3 +193,5 @@ gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME=
 gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
 gopkg.in/yaml.v2 v2.2.1 h1:mUhvW9EsL+naU5Q3cakzfE91YhliOondGd6ZrsDBHQE=
 gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+honnef.co/go/tools v0.0.0-20181108184350-ae8f1f9103cc h1:VdiEcF0DrrUbDdrLBceS0h7LE60ebD5yRYLLXi0ezIs=
+honnef.co/go/tools v0.0.0-20181108184350-ae8f1f9103cc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

go.sum

@@ -1,11 +1,26 @@
-GO_GENERATE := go generate $(GO_ARGS)
+# List any generated files here
+TARGETS = scanner.gen.go unicode.rl
+# List any source files used to generate the targets here
+SOURCES = gen.go scanner.rl unicode2ragel.rb
+# List any directories that have their own Makefile here
+SUBDIRS =
 
-all: scanner.gen.go
+# Default target
+all: $(SUBDIRS) $(TARGETS)
 
-scanner.gen.go: scanner.rl unicode2ragel.rb
-	$(GO_GENERATE) -x
+# Recurse into subdirs for same make goal
+$(SUBDIRS):
+	$(MAKE) -C $@ $(MAKECMDGOALS)
+
+# Clean all targets recursively
+clean: $(SUBDIRS)
+	rm -f $(TARGETS)
 
-clean:
-	rm -f scanner.gen.go unicode.rl
+# Define go generate if not already defined
+GO_GENERATE := go generate
+
+# Run go generate for the targets
+$(TARGETS): $(SOURCES)
+	$(GO_GENERATE) -x
 
-.PHONY: all clean
+.PHONY: all clean $(SUBDIRS)

internal/scanner/Makefile

@@ -0,0 +1,5 @@
+package scanner
+
+//go:generate ruby unicode2ragel.rb -e utf8 -o unicode.rl
+//go:generate ragel -I. -Z scanner.rl -o scanner.gen.go
+//go:generate sh -c "go fmt scanner.gen.go > /dev/null"

internal/scanner/gen.go

@@ -7,10 +7,6 @@ import (
 	"github.com/influxdata/flux/internal/token"
 )
 
-//go:generate ruby unicode2ragel.rb -e utf8 -o unicode.rl
-//go:generate ragel -I. -Z scanner.rl -o scanner.gen.go
-//go:generate sh -c "go fmt scanner.gen.go > /dev/null"
-
 // Scanner is used to tokenize a flux program.
 type Scanner struct {
 	f           *token.File

internal/scanner/scanner.go

@@ -4,6 +4,7 @@ package flux
 
 import (
 	_ "github.com/goreleaser/goreleaser"
+	_ "honnef.co/go/tools/cmd/staticcheck"
 )
 
 // This package is a workaround for adding additional paths to the go.mod file