incorporate latest boilerplate changes (flyteorg#53)

This reflects changes done in flyteorg/boilerplate#4

Makefile

@@ -1,6 +1,10 @@
 export REPOSITORY=flytestdlib
 include boilerplate/lyft/golang_test_targets/Makefile
 
+.PHONY: update_boilerplate
+update_boilerplate:
+	@boilerplate/update.sh
+
 # Generate golden files. Add test packages that generate golden files here.
 golden:
 	go test ./cli/pflags/api -update
@@ -19,8 +23,7 @@ compile:
 	mkdir -p ./bin
 	go build -o pflags ./cli/pflags/main.go && mv ./pflags ./bin
 
-gen-config:
-	which pflags || (go get github.com/lyft/flytestdlib/cli/pflags)
+gen-config: download_tooling
 	@go generate ./...
 
 .PHONY: test_unit_codecov

boilerplate/lyft/golang_support_tools/go.mod

@@ -0,0 +1,12 @@
+module github.com/lyft/boilerplate
+
+go 1.13
+
+require (
+	github.com/golangci/golangci-lint v1.22.2
+	github.com/lyft/flytestdlib v0.2.31
+	github.com/vektra/mockery v0.0.0-20181123154057-e78b021dcbb5
+	github.com/alvaroloes/enumer v1.1.2
+)
+
+replace github.com/vektra/mockery => github.com/enghabu/mockery v0.0.0-20191009061720-9d0c8670c2f0

boilerplate/lyft/golang_support_tools/tools.go

@@ -0,0 +1,10 @@
+// +build tools
+
+package tools
+
+import (
+	_ "github.com/golangci/golangci-lint/cmd/golangci-lint"
+	_ "github.com/lyft/flytestdlib/cli/pflags"
+	_ "github.com/vektra/mockery/cmd/mockery"
+	_ "github.com/alvaroloes/enumer"
+)

boilerplate/lyft/golang_test_targets/Makefile

@@ -1,19 +1,33 @@
+# WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
+# ONLY EDIT THIS FILE FROM WITHIN THE 'LYFT/BOILERPLATE' REPOSITORY:
+#
+# TO OPT OUT OF UPDATES, SEE https://github.com/lyft/boilerplate/blob/master/Readme.rst
+
+
+.PHONY: download_tooling
+download_tooling: #download dependencies (including test deps) for the package
+	@boilerplate/lyft/golang_test_targets/download_tooling.sh
+
 .PHONY: lint
-lint: #lints the package for common code smells
-	# install outside of current module, workaround https://github.com/golang/go/issues/30515
-	which golangci-lint || (cd /tmp && go get github.com/golangci/golangci-lint/cmd/golangci-lint && cd -)
-	golangci-lint run
+lint: download_tooling #lints the package for common code smells
+	GL_DEBUG=linters_output,env golangci-lint run --deadline=5m --exclude deprecated -v
 
 # If code is failing goimports linter, this will fix.
 # skips 'vendor'
 .PHONY: goimports
 goimports:
 	@boilerplate/lyft/golang_test_targets/goimports
 
-.PHONY: install
-install: #download dependencies (including test deps) for the package
+.PHONY: mod_download
+mod_download: #download dependencies (including test deps) for the package
 	go mod download
 
+.PHONY: install
+install: download_tooling mod_download
+
+.PHONY: show
+show: go list -m all
+
 .PHONY: test_unit
 test_unit:
 	go test -cover ./... -race
@@ -28,4 +42,5 @@ test_unit_cover:
 
 .PHONY: test_unit_visual
 test_unit_visual:
-	go test ./... -coverprofile /tmp/cover.out -covermode=count; go tool cover -html=/tmp/cover.out
+	go test ./... -coverprofile /tmp/cover.out -covermode=count; go tool cover -html=/tmp/cover.out 
+

boilerplate/lyft/golang_test_targets/Readme.rst

@@ -1,7 +1,7 @@
 Golang Test Targets
 ~~~~~~~~~~~~~~~~~~~
 
-Provides an ``install`` make target that uses ``dep`` install golang dependencies.
+Provides an ``install`` make target that uses ``go mod`` to install golang dependencies.
 
 Provides a ``lint`` make target that uses golangci to lint your code.
 
@@ -17,7 +17,7 @@ Provides a ``test_benchmark`` target for benchmark tests.
 
 Add ``lyft/golang_test_targets`` to your ``boilerplate/update.cfg`` file.
 
-Make sure you're using ``dep`` for dependency management.
+Make sure you're using ``go mod`` for dependency management.
 
 Provide a ``.golangci`` configuration (the lint target requires it).
 

boilerplate/lyft/golang_test_targets/download_tooling.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+# Everything in this file needs to be installed outside of current module
+# The reason we cannot turn off module entirely and install is that we need the replace statement in go.mod
+# because we are installing a mockery fork. Turning it off would result installing the original not the fork.
+# We also want to version all the other tools.  We also want to be able to run go mod tidy without removing the version
+# pins.  To facilitate this, we're maintaining two sets of go.mod/sum files - the second one only for tooling.  This is
+# the same approach that go 1.14 will take as well.
+# See:
+#   https://github.com/lyft/flyte/issues/129
+#   https://github.com/golang/go/issues/30515 for some background context
+#   https://github.com/go-modules-by-example/index/blob/5ec250b4b78114a55001bd7c9cb88f6e07270ea5/010_tools/README.md
+
+set -e
+
+# List of tools to go get
+# In the format of "<cli>:<package>" or ":<package>" if no cli
+tools=(
+  "github.com/vektra/mockery/cmd/mockery"
+  "github.com/lyft/flytestdlib/cli/pflags"
+  "github.com/golangci/golangci-lint/cmd/golangci-lint"
+  "github.com/alvaroloes/enumer"
+)
+
+tmp_dir=$(mktemp -d -t gotooling-XXX)
+echo "Using temp directory ${tmp_dir}"
+cp -R boilerplate/lyft/golang_support_tools/* $tmp_dir
+pushd "$tmp_dir"
+
+for tool in "${tools[@]}"
+do
+    echo "Installing ${tool}"
+    GO111MODULE=on go install $tool
+done
+
+popd

boilerplate/lyft/golang_test_targets/goimports

@@ -1,3 +1,8 @@
 #!/usr/bin/env bash
 
+# WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
+# ONLY EDIT THIS FILE FROM WITHIN THE 'LYFT/BOILERPLATE' REPOSITORY:
+# 
+# TO OPT OUT OF UPDATES, SEE https://github.com/lyft/boilerplate/blob/master/Readme.rst
+
 goimports -w $(find . -type f -name '*.go' -not -path "./vendor/*" -not -path "./pkg/client/*")

boilerplate/update.cfg

@@ -1,2 +1,3 @@
 lyft/golang_test_targets
 lyft/golangci_file
+lyft/golang_support_tools

boilerplate/update.sh

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+
+# WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
+# ONLY EDIT THIS FILE FROM WITHIN THE 'LYFT/BOILERPLATE' REPOSITORY:
+# 
+# TO OPT OUT OF UPDATES, SEE https://github.com/lyft/boilerplate/blob/master/Readme.rst
+
+set -e
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
+
+OUT="$(mktemp -d)"
+git clone [email protected]:lyft/boilerplate.git "${OUT}"
+
+echo "Updating the update.sh script."
+cp "${OUT}/boilerplate/update.sh" "${DIR}/update.sh"
+echo ""
+
+
+CONFIG_FILE="${DIR}/update.cfg"
+README="https://github.com/lyft/boilerplate/blob/master/Readme.rst"
+
+if [ ! -f "$CONFIG_FILE" ]; then
+  echo "$CONFIG_FILE not found."
+  echo "This file is required in order to select which features to include." 
+  echo "See $README for more details."
+  exit 1
+fi
+
+if [ -z "$REPOSITORY" ]; then
+  echo '$REPOSITORY is required to run this script'
+  echo "See $README for more details."
+  exit 1
+fi
+
+while read directory; do
+  # TODO: Skip empty lines, whitespace only lines, and comment lines
+  echo "***********************************************************************************"
+  echo "$directory is configured in update.cfg."
+  echo "-----------------------------------------------------------------------------------"
+  echo "syncing files from source."
+  dir_path="${OUT}/boilerplate/${directory}"
+  rm -rf "${DIR}/${directory}"
+  mkdir -p $(dirname "${DIR}/${directory}")
+  cp -r "$dir_path" "${DIR}/${directory}"
+  if [ -f "${DIR}/${directory}/update.sh" ]; then
+    echo "executing ${DIR}/${directory}/update.sh"
+    "${DIR}/${directory}/update.sh"
+  fi
+  echo "***********************************************************************************"
+  echo ""
+done < "$CONFIG_FILE"
+
+rm -rf "${OUT}"