Improve Makefile rules

1. Use file targets instead of .PHONY ones when possible.

2. Avoid generating files if they are up to date

3. Use proper prerequisites

Author: 2opremio

.circleci/config.yml

@@ -5,6 +5,7 @@ jobs:
     machine:
       image: ubuntu-1604:201903-01
     environment:
+        GO_VERSION: 1.12.6
         GOCACHE: /home/circleci/.cache/go-build/
         GOPATH: /home/circleci/go
     steps:
@@ -14,6 +15,15 @@ jobs:
                 - go-cache-{{ .Branch }}-{{ .Revision }}
                 - go-cache-{{ .Branch }}-
                 - go-cache-
+      - run:
+            name: Install Golang (needed for dependency calculation)
+            command: |
+                curl -OL https://storage.googleapis.com/golang/go${GO_VERSION}.linux-amd64.tar.gz
+                tar -xf go${GO_VERSION}.linux-amd64.tar.gz
+                sudo rm -rf /usr/local/go
+                sudo mv go /usr/local
+                mkdir -p "$HOME/go/bin"
+                go version
       - run: mkdir -p ./test-results/ginkgo
       - run: make eksctl-image
       - run: sudo chown -R circleci.circleci /home/circleci/.cache/go-build/ /home/circleci/go/pkg/mod/

CONTRIBUTING.md

@@ -64,7 +64,7 @@ Make sure you can run the tests and build the binary.
 ```bash 
 make install-build-deps
 make test
-make build
+make eksctl
 ```
 
 > NOTE: Windows users should install Docker for Windows and run `make eksctl-image` to build their code.

Makefile

@@ -1,3 +1,4 @@
+SHELL=bash -x
 built_at := $(shell date +%s)
 git_commit := $(shell git describe --dirty --always)
 
@@ -20,8 +21,10 @@ install-build-deps: ## Install dependencies (packages and tools)
 
 ##@ Build
 
-.PHONY: build
-build: generate-bindata-assets generate-kubernetes-types  ## Build eksctl
+gofiles = $(shell $1 | xargs go list -f '{{if not .Standard}}{{ $$dep := . }}{{range .GoFiles}}{{$$dep.Dir}}/{{.}} {{end}}{{end}}')
+godeps = $(call gofiles,go list -f '{{join .Deps "\n"}}' $1)
+
+eksctl: $(call godeps,./cmd/...) ## Build main binary
 	CGO_ENABLED=0 time go build -v -ldflags "-X $(version_pkg).gitCommit=$(git_commit) -X $(version_pkg).builtAt=$(built_at)" ./cmd/eksctl
 
 ##@ Testing & CI
@@ -50,11 +53,11 @@ lint: ## Run linter over the codebase
 	time "$(GOBIN)/gometalinter" ./pkg/... ./cmd/... ./integration/...
 
 .PHONY: test
-test: ## Run unit test (and re-generate code under test)
+test:
 	$(MAKE) lint
-	$(MAKE) generate-aws-mocks-test generate-bindata-assets-test generate-kubernetes-types-test
+	$(MAKE) check-generated-sources-up-to-date
 	$(MAKE) unit-test
-	$(MAKE) build-integration-test
+	$(MAKE) eksctl-integration-test
 
 .PHONY: unit-test
 unit-test: ## Run unit test only
@@ -64,14 +67,12 @@ unit-test: ## Run unit test only
 unit-test-race: ## Run unit test with race detection
 	CGO_ENABLED=1 time go test -race ./pkg/... ./cmd/... $(UNIT_TEST_ARGS)
 
-.PHONY: build-integration-test
-build-integration-test: ## Build integration test binary
-	time go test -tags integration ./integration/... -c -o ./eksctl-integration-test
+eksctl-integration-test: $(call gofiles,go list -f '{{join .Deps "\n"}}' `go list -tags integration -f '{{join .XTestImports " "}}' ./integration/...`) ## Build integration test binary
+	time go test -tags integration ./integration/... -c -o $@
 
 .PHONY: integration-test
-integration-test: build build-integration-test ## Run the integration tests (with cluster creation and cleanup)
-	cd integration; ../eksctl-integration-test -test.timeout 60m \
-		$(INTEGRATION_TEST_ARGS)
+integration-test: eksctl eksctl-integration-test ## Run the integration tests (with cluster creation and cleanup)
+	cd integration; ../eksctl-integration-test -test.timeout 60m $(INTEGRATION_TEST_ARGS)
 
 .PHONY: integration-test-container
 integration-test-container: eksctl-image ## Run the integration tests inside a Docker container
@@ -91,7 +92,7 @@ integration-test-container-pre-built: ## Run the integration tests inside a Dock
 
 TEST_CLUSTER ?= integration-test-dev
 .PHONY: integration-test-dev
-integration-test-dev: build build-integration-test ## Run the integration tests without cluster teardown. For use when developing integration tests.
+integration-test-dev: eksctl eksctl-integration-test ## Run the integration tests without cluster teardown. For use when developing integration tests.
 	./eksctl utils write-kubeconfig \
 		--auto-kubeconfig \
 		--name=$(TEST_CLUSTER)
@@ -111,54 +112,55 @@ delete-integration-test-dev-cluster: build ## Delete the test cluster for use wh
 
 ##@ Code Generation
 
-.PHONY: generate-bindata-assets
-generate-bindata-assets: ## Generate bindata assets (node bootstrap config files & add-on manifests)
-	chmod g-w  ./pkg/nodebootstrap/assets/*
-	env GOBIN=$(GOBIN) time go generate ./pkg/nodebootstrap ./pkg/addons/default
+AWS_SDK_MOCKS=$(wildcard pkg/eks/mocks/*API.go)
+
+GENERATED_FILES=pkg/addons/default/assets.go \
+pkg/nodebootstrap/assets.go \
+pkg/apis/eksctl.io/v1alpha5/zz_generated.deepcopy.go \
+pkg/ami/static_resolver_ami.go \
+site/content/usage/20-schema.md \
+$(AWS_SDK_MOCKS)
+
+.PHONY: regenerate-sources
+# TODO: generate-ami is broken (see https://github.com/weaveworks/eksctl/issues/949 ), include it when fixed
+regenerate-sources: $(GENERATED_FILES) # generate-ami ## Re-generate all the automatically-generated source files
+
+.PHONY: check-generated-files-up-to-date
+check-generated-sources-up-to-date: regenerate-sources
+	git diff --quiet -- $(GENERATED_FILES) || (git --no-pager diff $(GENERATED_FILES); exit 1)
 
-.PHONY: generate-bindata-assets-test
-generate-bindata-assets-test: generate-bindata-assets ## Test if generated bindata assets are checked-in
-	git diff --exit-code ./pkg/nodebootstrap/assets.go > /dev/null || (git --no-pager diff ./pkg/nodebootstrap/assets.go; exit 1)
-	git diff --exit-code ./pkg/addons/default/assets.go > /dev/null || (git --no-pager diff ./pkg/addons/default/assets.go; exit 1)
+pkg/addons/default/assets.go: $(wildcard pkg/addons/default/assets/*)
+	env GOBIN=$(GOBIN) time go generate ./$(@D)
+
+pkg	/nodebootstrap/assets.go: $(wildcard pkg/nodebootstrap/assets/*)
+	chmod g-w $^
+	env GOBIN=$(GOBIN) time go generate ./$(@D)
 
 .license-header: LICENSE
 	@# generate-groups.sh can't find the lincense header when using Go modules, so we provide one
 	printf "/*\n%s\n*/\n" "$$(cat LICENSE)" > $@
 
-.PHONY: generate-kubernetes-types
-generate-kubernetes-types: .license-header ## Generate Kubernetes API helpers
+pkg/apis/eksctl.io/v1alpha5/zz_generated.deepcopy.go: $(call godeps,./pkg/apis/...) .license-header ## Generate Kubernetes API helpers
 	time go mod download k8s.io/code-generator # make sure the code-generator is present
 	time env GOPATH="$$(go env GOPATH)" bash "$$(go env GOPATH)/pkg/mod/k8s.io/[email protected]/generate-groups.sh" \
-	  deepcopy,defaulter pkg/apis ./pkg/apis eksctl.io:v1alpha5 --go-header-file .license-header --output-base="$${PWD}" \
+	  deepcopy,defaulter _ ./pkg/apis eksctl.io:v1alpha5 --go-header-file .license-header --output-base="$${PWD}" \
 	  || (cat codegenheader.txt ; cat pkg/apis/eksctl.io/v1alpha5/zz_generated.deepcopy.go ; exit 1)
 
-.PHONY: generate-kubernetes-types-test
-generate-kubernetes-types-test: generate-kubernetes-types ## Test if generated Kubernetes API helpers are checked-in
-	git diff --exit-code ./pkg/nodebootstrap/assets.go > /dev/null || (git --no-pager diff ./pkg/nodebootstrap/assets.go; exit 1)
-
+# static_resolver_ami.go doesn't only depend on files (it should be refreshed whenever a release is made in AWS)
+# so we need to forcicly generate it
 .PHONY: generate-ami
 generate-ami: ## Generate the list of AMIs for use with static resolver. Queries AWS.
 	time go generate ./pkg/ami
 
-.PHONY: generate-schema
-generate-schema: ## Generate the schema file in the documentation site.
-	@go run ./cmd/schema/generate.go
+site/content/usage/20-schema.md: $(call godeps,cmd/schema/generate.go)
+	time go run ./cmd/schema/generate.go $@
 
-.PHONY: ami-check
-ami-check: generate-ami ## Check whether the AMIs have been updated and fail if they have. Designed for a automated test
-	git diff --exit-code pkg/ami/static_resolver_ami.go > /dev/null || (git --no-pager diff; exit 1)
-
-.PHONY: generate-aws-mocks
-generate-aws-mocks: ## Generate mocks for AWS SDK
+$(AWS_SDK_MOCKS): $(call godeps,pkg/eks/mocks/mocks.go)
 	mkdir -p vendor/github.com/aws/
 	@# Hack for Mockery to find the dependencies handled by `go mod`
 	ln -sfn "$$(go env GOPATH)/pkg/mod/github.com/aws/[email protected]" vendor/github.com/aws/aws-sdk-go
 	time env GOBIN=$(GOBIN) go generate ./pkg/eks/mocks
 
-.PHONY: generate-aws-mocks-test
-generate-aws-mocks-test: generate-aws-mocks ## Test if generated mocks for AWS SDK are checked-in
-	git diff --exit-code ./pkg/eks/mocks > /dev/null || (git --no-pager diff ./pkg/eks/mocks; exit 1)
-
 ##@ Docker
 
 ifeq ($(OS),Windows_NT)

cmd/schema/generate.go

@@ -4,14 +4,18 @@ import (
 	"github.com/alecthomas/jsonschema"
 	api "github.com/weaveworks/eksctl/pkg/apis/eksctl.io/v1alpha5"
 	"io/ioutil"
+	"os"
 	"sigs.k8s.io/yaml"
 	"strings"
 )
 
-const outputFile = "site/content/usage/20-schema.md"
-
 func main() {
 
+	if len(os.Args) != 2 {
+		panic("expected one argument with the output file")
+	}
+	outputFile := os.Args[1]
+
 	var document strings.Builder
 	document.WriteString(`---
 title: Config file schema

eksctl-image-builder.sh

@@ -4,9 +4,9 @@ export JUNIT_REPORT_DIR=/src/test-results/ginkgo
 mkdir -p "${JUNIT_REPORT_DIR}"
 
 make $TEST_TARGET
-make build \
+make eksctl \
     && cp ./eksctl /out/usr/local/bin/eksctl
-make build-integration-test \
+make eksctl-integration-test \
     && mkdir -p /out/usr/local/share/eksctl \
     && cp integration/*.yaml /out/usr/local/share/eksctl \
     && cp ./eksctl-integration-test /out/usr/local/bin/eksctl-integration-test

pkg/addons/default/generate.go

@@ -1,6 +1,3 @@
 package defaultaddons
 
-//go:generate curl --silent --location https://github.com/aws/amazon-vpc-cni-k8s/blob/957f835f437fd76953f37e6b409ba6426bb4ce37/config/v1.4/aws-k8s-cni.yaml?raw=1 --output assets/aws-node.yaml
-//go:generate curl --silent --location https://github.com/aws/amazon-vpc-cni-k8s/blob/957f835f437fd76953f37e6b409ba6426bb4ce37/config/v1.4/aws-k8s-cni-1.10.yaml?raw=1 --output assets/aws-node-1.10.yaml
-
 //go:generate ${GOBIN}/go-bindata -pkg ${GOPACKAGE} -prefix assets -nometadata -o assets.go assets