From abd6eda6c9ed25e59e6d4251a969e96d63f3d6d8 Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Mon, 27 May 2019 14:52:04 +0200 Subject: [PATCH 1/6] generate execution policy from makefile * make generate now generates on `./...` instead of `.` --- Makefile | 3 ++- provisioner/powershell/execution_policy.go | 2 ++ provisioner/powershell/executionpolicy_enumer.go | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 684df6966..0efe1938e 100644 --- a/Makefile +++ b/Makefile @@ -50,6 +50,7 @@ deps: @go get golang.org/x/tools/cmd/goimports @go get golang.org/x/tools/cmd/stringer @go get -u github.com/mna/pigeon + @go get github.com/alvaroloes/enumer dev: deps ## Build and install a development build @grep 'const VersionPrerelease = ""' version/version.go > /dev/null ; if [ $$? -eq 0 ]; then \ @@ -95,7 +96,7 @@ fmt-examples: # generate runs `go generate` to build the dynamically generated # source files. generate: deps ## Generate dynamically generated code - go generate . + go generate ./... gofmt -w common/bootcommand/boot_command.go goimports -w common/bootcommand/boot_command.go gofmt -w command/plugin.go diff --git a/provisioner/powershell/execution_policy.go b/provisioner/powershell/execution_policy.go index 5338282bc..5941aba3c 100644 --- a/provisioner/powershell/execution_policy.go +++ b/provisioner/powershell/execution_policy.go @@ -1,3 +1,5 @@ +//go:generate enumer -transform snake -trimprefix ExecutionPolicy -type ExecutionPolicy + package powershell import ( diff --git a/provisioner/powershell/executionpolicy_enumer.go b/provisioner/powershell/executionpolicy_enumer.go index 881a74b20..b8157b9cf 100644 --- a/provisioner/powershell/executionpolicy_enumer.go +++ b/provisioner/powershell/executionpolicy_enumer.go @@ -1,4 +1,4 @@ -// Code generated by "enumer -transform snake -trimprefix ExecutionPolicy -type ExecutionPolicy provisioner/powershell/execution_policy.go"; DO NOT EDIT. +// Code generated by "enumer -transform snake -trimprefix ExecutionPolicy -type ExecutionPolicy"; DO NOT EDIT. // package powershell From 26d0448142c2326858501b7c07081b2d968d335e Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Mon, 27 May 2019 15:06:49 +0200 Subject: [PATCH 2/6] Makefile: split install-build-deps vs install-gen-deps --- Makefile | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/Makefile b/Makefile index 0efe1938e..84cfce78d 100644 --- a/Makefile +++ b/Makefile @@ -21,21 +21,19 @@ GOLDFLAGS=-X $(GIT_IMPORT).GitCommit=$(GIT_COMMIT)$(GIT_DIRTY) export GOLDFLAGS -.PHONY: bin checkversion ci default deps fmt fmt-docs fmt-examples generate releasebin test testacc testrace updatedeps +.PHONY: bin checkversion ci default install-build-deps install-gen-deps fmt fmt-docs fmt-examples generate releasebin test testacc testrace -default: deps generate testrace dev releasebin package dev fmt fmt-check mode-check fmt-docs fmt-examples +default: install-build-deps install-gen-deps generate testrace dev releasebin package dev fmt fmt-check mode-check fmt-docs fmt-examples -ci: testrace +ci: testrace ## Test in continuous integration -release: deps test releasebin package ## Build a release build +release: install-build-deps test releasebin package ## Build a release build -bin: deps ## Build debug/test build - @go get github.com/mitchellh/gox +bin: install-build-deps ## Build debug/test build @echo "WARN: 'make bin' is for debug / test builds only. Use 'make release' for release builds." @GO111MODULE=off sh -c "$(CURDIR)/scripts/build.sh" -releasebin: deps - @go get github.com/mitchellh/gox +releasebin: install-build-deps @grep 'const VersionPrerelease = "dev"' version/version.go > /dev/null ; if [ $$? -eq 0 ]; then \ echo "ERROR: You must remove prerelease tags from version/version.go prior to release."; \ exit 1; \ @@ -46,13 +44,16 @@ package: $(if $(VERSION),,@echo 'VERSION= needed to release; Use make package skip compilation'; exit 1) @sh -c "$(CURDIR)/scripts/dist.sh $(VERSION)" -deps: +install-build-deps: ## Install dependencies for bin build + @go get github.com/mitchellh/gox + +install-gen-deps: ## Install dependencies for code generation @go get golang.org/x/tools/cmd/goimports @go get golang.org/x/tools/cmd/stringer @go get -u github.com/mna/pigeon @go get github.com/alvaroloes/enumer -dev: deps ## Build and install a development build +dev: ## Build and install a development build @grep 'const VersionPrerelease = ""' version/version.go > /dev/null ; if [ $$? -eq 0 ]; then \ echo "ERROR: You must add prerelease tags to version/version.go prior to making a dev build."; \ exit 1; \ @@ -95,7 +96,7 @@ fmt-examples: # generate runs `go generate` to build the dynamically generated # source files. -generate: deps ## Generate dynamically generated code +generate: install-gen-deps ## Generate dynamically generated code go generate ./... gofmt -w common/bootcommand/boot_command.go goimports -w common/bootcommand/boot_command.go @@ -105,23 +106,20 @@ test: fmt-check mode-check vet ## Run unit tests @go test $(TEST) $(TESTARGS) -timeout=3m # testacc runs acceptance tests -testacc: deps generate ## Run acceptance tests +testacc: install-build-deps generate ## Run acceptance tests @echo "WARN: Acceptance tests will take a long time to run and may cost money. Ctrl-C if you want to cancel." PACKER_ACC=1 go test -v $(TEST) $(TESTARGS) -timeout=45m testrace: fmt-check mode-check vet ## Test with race detection enabled @GO111MODULE=off go test -race $(TEST) $(TESTARGS) -timeout=3m -p=8 -check-vendor-vs-mod: +check-vendor-vs-mod: ## Check that go modules and vendored code are on par @GO111MODULE=on go mod vendor @git diff --exit-code --ignore-space-change --ignore-space-at-eol -- vendor ; if [ $$? -eq 1 ]; then \ echo "ERROR: vendor dir is not on par with go modules definition." && \ exit 1; \ fi -updatedeps: - @echo "INFO: Packer deps are managed by go modules. See .github/CONTRIBUTING.md" - vet: ## Vet Go code @go vet $(VET) ; if [ $$? -eq 1 ]; then \ echo "ERROR: Vet found problems in the code."; \ From 768736425ed035e97f9ab64486943c7b896b1e22 Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Mon, 27 May 2019 15:07:49 +0200 Subject: [PATCH 3/6] Makefile: remove unused golang.org/x/tools/cmd/stringer dep --- Makefile | 1 - 1 file changed, 1 deletion(-) diff --git a/Makefile b/Makefile index 84cfce78d..993620a07 100644 --- a/Makefile +++ b/Makefile @@ -49,7 +49,6 @@ install-build-deps: ## Install dependencies for bin build install-gen-deps: ## Install dependencies for code generation @go get golang.org/x/tools/cmd/goimports - @go get golang.org/x/tools/cmd/stringer @go get -u github.com/mna/pigeon @go get github.com/alvaroloes/enumer From deb2212e9e8c31826b9b5e6aa11a351fb72d490b Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Mon, 27 May 2019 15:37:03 +0200 Subject: [PATCH 4/6] Makefile: use `go fmt` fmt-check no runs go fmt and then a git diff; this should also fail on line ending diffs --- .circleci/config.yml | 6 ++++++ Makefile | 20 +++++++------------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 36731d4b5..68f56531a 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -27,6 +27,11 @@ jobs: - checkout - run: GO111MODULE=on go run . --help - run: make check-vendor-vs-mod + check-fmt: + <<: *golang + steps: + - checkout + - run: make fmt-check build_linux: <<: *golang environment: @@ -74,6 +79,7 @@ workflows: jobs: - build - check-vendor-vs-mod + - check-fmt - build_linux: filters: tags: diff --git a/Makefile b/Makefile index 993620a07..5c4067fd3 100644 --- a/Makefile +++ b/Makefile @@ -8,9 +8,6 @@ GOOS=$(shell go env GOOS) GOARCH=$(shell go env GOARCH) GOPATH=$(shell go env GOPATH) -# gofmt -UNFORMATTED_FILES=$(shell find . -not -path "./vendor/*" -name "*.go" | xargs gofmt -s -l) - EXECUTABLE_FILES=$(shell find . -type f -executable | egrep -v '^\./(website/[vendor|tmp]|vendor/|\.git|bin/|scripts/|pkg/)' | egrep -v '.*(\.sh|\.bats|\.git)' | egrep -v './provisioner/(ansible|inspec)/test-fixtures/exit1') # Get the git commit @@ -64,17 +61,14 @@ dev: ## Build and install a development build @cp $(GOPATH)/bin/packer pkg/$(GOOS)_$(GOARCH) fmt: ## Format Go code - @gofmt -w -s main.go $(UNFORMATTED_FILES) + @go fmt ./... -fmt-check: ## Check go code formatting - @echo "==> Checking that code complies with gofmt requirements..." - @if [ ! -z "$(UNFORMATTED_FILES)" ]; then \ - echo "gofmt needs to be run on the following files:"; \ - echo "$(UNFORMATTED_FILES)" | xargs -n1; \ +fmt-check: fmt ## Check go code formatting + @echo "==> Checking that code complies with go fmt requirements..." + @git diff --exit-code; if [ $$? -eq 1 ]; then \ + echo "Found files that are not fmt'ed."; \ echo "You can use the command: \`make fmt\` to reformat code."; \ exit 1; \ - else \ - echo "Check passed."; \ fi mode-check: ## Check that only certain files are executable @@ -97,9 +91,9 @@ fmt-examples: # source files. generate: install-gen-deps ## Generate dynamically generated code go generate ./... - gofmt -w common/bootcommand/boot_command.go + go fmt -w common/bootcommand/boot_command.go goimports -w common/bootcommand/boot_command.go - gofmt -w command/plugin.go + go fmt -w command/plugin.go test: fmt-check mode-check vet ## Run unit tests @go test $(TEST) $(TESTARGS) -timeout=3m From 5a0b5e3944a1bb846b8a16a44a268aca4badc9e1 Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Mon, 27 May 2019 15:42:58 +0200 Subject: [PATCH 5/6] Makefile: don't run fmt-check in test/testrace * this is now run on a different circle ci track --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 5c4067fd3..5dbdeaf3d 100644 --- a/Makefile +++ b/Makefile @@ -95,7 +95,7 @@ generate: install-gen-deps ## Generate dynamically generated code goimports -w common/bootcommand/boot_command.go go fmt -w command/plugin.go -test: fmt-check mode-check vet ## Run unit tests +test: mode-check vet ## Run unit tests @go test $(TEST) $(TESTARGS) -timeout=3m # testacc runs acceptance tests @@ -103,7 +103,7 @@ testacc: install-build-deps generate ## Run acceptance tests @echo "WARN: Acceptance tests will take a long time to run and may cost money. Ctrl-C if you want to cancel." PACKER_ACC=1 go test -v $(TEST) $(TESTARGS) -timeout=45m -testrace: fmt-check mode-check vet ## Test with race detection enabled +testrace: mode-check vet ## Test with race detection enabled @GO111MODULE=off go test -race $(TEST) $(TESTARGS) -timeout=3m -p=8 check-vendor-vs-mod: ## Check that go modules and vendored code are on par From 36ee40b2a15d371ee7028c1e0ba6ec617748f7c1 Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Mon, 27 May 2019 16:00:20 +0200 Subject: [PATCH 6/6] test that go generated code if what is should be --- .circleci/config.yml | 6 ++++++ Makefile | 12 ++++++++++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 68f56531a..9413f3034 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -32,6 +32,11 @@ jobs: steps: - checkout - run: make fmt-check + check-generate: + <<: *golang + steps: + - checkout + - run: make generate-check build_linux: <<: *golang environment: @@ -80,6 +85,7 @@ workflows: - build - check-vendor-vs-mod - check-fmt + - check-generate - build_linux: filters: tags: diff --git a/Makefile b/Makefile index 5dbdeaf3d..f9518936d 100644 --- a/Makefile +++ b/Makefile @@ -91,9 +91,17 @@ fmt-examples: # source files. generate: install-gen-deps ## Generate dynamically generated code go generate ./... - go fmt -w common/bootcommand/boot_command.go + go fmt common/bootcommand/boot_command.go goimports -w common/bootcommand/boot_command.go - go fmt -w command/plugin.go + go fmt command/plugin.go + +generate-check: generate ## Check go code generation is on par + @echo "==> Checking that auto-generated code is not changed..." + @git diff --exit-code; if [ $$? -eq 1 ]; then \ + echo "Found diffs in go generated code."; \ + echo "You can use the command: \`make generate\` to reformat code."; \ + exit 1; \ + fi test: mode-check vet ## Run unit tests @go test $(TEST) $(TESTARGS) -timeout=3m