bad9a82df8
Running `make dev` runs `hclfmt`, but this isn't checked as part of CI. That makes it possible to merge un-formatted HCL and Nomad jobspecs that later will make for dirty git staging areas when developers pull master. This changeset adds HCL linting to the `make check` target.
404 lines
13 KiB
Makefile
404 lines
13 KiB
Makefile
SHELL = bash
|
|
PROJECT_ROOT := $(patsubst %/,%,$(dir $(abspath $(lastword $(MAKEFILE_LIST)))))
|
|
THIS_OS := $(shell uname)
|
|
|
|
GIT_COMMIT := $(shell git rev-parse HEAD)
|
|
GIT_DIRTY := $(if $(shell git status --porcelain),+CHANGES)
|
|
|
|
GO_LDFLAGS := "-X github.com/hashicorp/nomad/version.GitCommit=$(GIT_COMMIT)$(GIT_DIRTY)"
|
|
GO_TAGS ?= codegen_generated
|
|
|
|
GO_TEST_CMD = $(if $(shell which gotestsum),gotestsum --,go test)
|
|
|
|
ifeq ($(origin GOTEST_PKGS_EXCLUDE), undefined)
|
|
GOTEST_PKGS ?= "./..."
|
|
else
|
|
GOTEST_PKGS=$(shell go list ./... | sed 's/github.com\/hashicorp\/nomad/./' | egrep -v "^($(GOTEST_PKGS_EXCLUDE))(/.*)?$$")
|
|
endif
|
|
|
|
default: help
|
|
|
|
ifeq (,$(findstring $(THIS_OS),Darwin Linux FreeBSD Windows))
|
|
$(error Building Nomad is currently only supported on Darwin and Linux.)
|
|
endif
|
|
|
|
# On Linux we build for Linux and Windows
|
|
ifeq (Linux,$(THIS_OS))
|
|
|
|
ifeq ($(CI),true)
|
|
$(info Running in a CI environment, verbose mode is disabled)
|
|
else
|
|
VERBOSE="true"
|
|
endif
|
|
|
|
|
|
ALL_TARGETS += linux_386 \
|
|
linux_amd64 \
|
|
linux_arm \
|
|
linux_arm64 \
|
|
windows_386 \
|
|
windows_amd64
|
|
|
|
endif
|
|
|
|
# On MacOS, we only build for MacOS
|
|
ifeq (Darwin,$(THIS_OS))
|
|
ALL_TARGETS += darwin_amd64
|
|
endif
|
|
|
|
# On FreeBSD, we only build for FreeBSD
|
|
ifeq (FreeBSD,$(THIS_OS))
|
|
ALL_TARGETS += freebsd_amd64
|
|
endif
|
|
|
|
# include per-user customization after all variables are defined
|
|
-include GNUMakefile.local
|
|
|
|
pkg/darwin_amd64/nomad: $(SOURCE_FILES) ## Build Nomad for darwin/amd64
|
|
@echo "==> Building $@ with tags $(GO_TAGS)..."
|
|
@CGO_ENABLED=1 GOOS=darwin GOARCH=amd64 \
|
|
go build \
|
|
-trimpath \
|
|
-ldflags $(GO_LDFLAGS) \
|
|
-tags "$(GO_TAGS)" \
|
|
-o "$@"
|
|
|
|
pkg/freebsd_amd64/nomad: $(SOURCE_FILES) ## Build Nomad for freebsd/amd64
|
|
@echo "==> Building $@..."
|
|
@CGO_ENABLED=1 GOOS=freebsd GOARCH=amd64 \
|
|
go build \
|
|
-trimpath \
|
|
-ldflags $(GO_LDFLAGS) \
|
|
-tags "$(GO_TAGS)" \
|
|
-o "$@"
|
|
|
|
pkg/linux_386/nomad: $(SOURCE_FILES) ## Build Nomad for linux/386
|
|
@echo "==> Building $@ with tags $(GO_TAGS)..."
|
|
@CGO_ENABLED=1 GOOS=linux GOARCH=386 \
|
|
go build \
|
|
-trimpath \
|
|
-ldflags $(GO_LDFLAGS) \
|
|
-tags "$(GO_TAGS)" \
|
|
-o "$@"
|
|
|
|
pkg/linux_amd64/nomad: $(SOURCE_FILES) ## Build Nomad for linux/amd64
|
|
@echo "==> Building $@ with tags $(GO_TAGS)..."
|
|
@CGO_ENABLED=1 GOOS=linux GOARCH=amd64 \
|
|
go build \
|
|
-trimpath \
|
|
-ldflags $(GO_LDFLAGS) \
|
|
-tags "$(GO_TAGS)" \
|
|
-o "$@"
|
|
|
|
pkg/linux_arm/nomad: $(SOURCE_FILES) ## Build Nomad for linux/arm
|
|
@echo "==> Building $@ with tags $(GO_TAGS)..."
|
|
@CGO_ENABLED=1 GOOS=linux GOARCH=arm CC=arm-linux-gnueabihf-gcc-5 \
|
|
go build \
|
|
-trimpath \
|
|
-ldflags $(GO_LDFLAGS) \
|
|
-tags "$(GO_TAGS)" \
|
|
-o "$@"
|
|
|
|
pkg/linux_arm64/nomad: $(SOURCE_FILES) ## Build Nomad for linux/arm64
|
|
@echo "==> Building $@ with tags $(GO_TAGS)..."
|
|
@CGO_ENABLED=1 GOOS=linux GOARCH=arm64 CC=aarch64-linux-gnu-gcc-5 \
|
|
go build \
|
|
-trimpath \
|
|
-ldflags $(GO_LDFLAGS) \
|
|
-tags "$(GO_TAGS)" \
|
|
-o "$@"
|
|
|
|
# If CGO support for Windows is ever required, set the following variables
|
|
# in the environment for `go build` for both the windows/amd64 and the
|
|
# windows/386 targets:
|
|
# CC=i686-w64-mingw32-gcc
|
|
# CXX=i686-w64-mingw32-g++
|
|
pkg/windows_386/nomad: $(SOURCE_FILES) ## Build Nomad for windows/386
|
|
@echo "==> Building $@ with tags $(GO_TAGS)..."
|
|
@CGO_ENABLED=1 GOOS=windows GOARCH=386 \
|
|
go build \
|
|
-trimpath \
|
|
-ldflags $(GO_LDFLAGS) \
|
|
-tags "$(GO_TAGS)" \
|
|
-o "$@.exe"
|
|
|
|
pkg/windows_amd64/nomad: $(SOURCE_FILES) ## Build Nomad for windows/amd64
|
|
@echo "==> Building $@ with tags $(GO_TAGS)..."
|
|
@CGO_ENABLED=1 GOOS=windows GOARCH=amd64 \
|
|
go build \
|
|
-trimpath \
|
|
-ldflags $(GO_LDFLAGS) \
|
|
-tags "$(GO_TAGS)" \
|
|
-o "$@.exe"
|
|
|
|
pkg/linux_ppc64le/nomad: $(SOURCE_FILES) ## Build Nomad for linux/arm64
|
|
@echo "==> Building $@ with tags $(GO_TAGS)..."
|
|
@CGO_ENABLED=1 GOOS=linux GOARCH=ppc64le \
|
|
go build \
|
|
-trimpath \
|
|
-ldflags $(GO_LDFLAGS) \
|
|
-tags "$(GO_TAGS)" \
|
|
-o "$@"
|
|
|
|
pkg/linux_s390x/nomad: $(SOURCE_FILES) ## Build Nomad for linux/arm64
|
|
@echo "==> Building $@ with tags $(GO_TAGS)..."
|
|
@CGO_ENABLED=1 GOOS=linux GOARCH=s390x \
|
|
go build \
|
|
-trimpath \
|
|
-ldflags $(GO_LDFLAGS) \
|
|
-tags "$(GO_TAGS)" \
|
|
-o "$@"
|
|
|
|
# Define package targets for each of the build targets we actually have on this system
|
|
define makePackageTarget
|
|
|
|
pkg/$(1).zip: pkg/$(1)/nomad
|
|
@echo "==> Packaging for $(1)..."
|
|
@zip -j pkg/$(1).zip pkg/$(1)/*
|
|
|
|
endef
|
|
|
|
# Reify the package targets
|
|
$(foreach t,$(ALL_TARGETS),$(eval $(call makePackageTarget,$(t))))
|
|
|
|
.PHONY: bootstrap
|
|
bootstrap: deps lint-deps git-hooks # Install all dependencies
|
|
|
|
.PHONY: deps
|
|
deps: ## Install build and development dependencies
|
|
@echo "==> Updating build dependencies..."
|
|
GO111MODULE=on go get -u github.com/kardianos/govendor
|
|
GO111MODULE=on go get -u github.com/hashicorp/go-bindata/go-bindata@master
|
|
GO111MODULE=on go get -u github.com/elazarl/go-bindata-assetfs/go-bindata-assetfs@master
|
|
GO111MODULE=on go get -u github.com/a8m/tree/cmd/tree
|
|
GO111MODULE=on go get -u github.com/magiconair/vendorfmt/cmd/vendorfmt
|
|
GO111MODULE=on go get -u gotest.tools/gotestsum
|
|
GO111MODULE=on go get -u github.com/fatih/hclfmt
|
|
GO111MODULE=on go get -u github.com/golang/protobuf/protoc-gen-go@v1.3.4
|
|
|
|
# The tag here must correspoond to codec version nomad uses, e.g. v1.1.5.
|
|
# Though, v1.1.5 codecgen has a bug in code generator, so using a specific sha
|
|
# here instead.
|
|
GO111MODULE=on go get -u github.com/hashicorp/go-msgpack/codec/codecgen@f51b5189210768cf0d476580cf287620374d4f02
|
|
|
|
.PHONY: lint-deps
|
|
lint-deps: ## Install linter dependencies
|
|
@echo "==> Updating linter dependencies..."
|
|
GO111MODULE=on go get -u github.com/golangci/golangci-lint/cmd/golangci-lint
|
|
GO111MODULE=on go get -u github.com/client9/misspell/cmd/misspell
|
|
|
|
.PHONY: git-hooks
|
|
git-dir = $(shell git rev-parse --git-dir)
|
|
git-hooks: $(git-dir)/hooks/pre-push
|
|
$(git-dir)/hooks/%: dev/hooks/%
|
|
cp $^ $@
|
|
chmod 755 $@
|
|
|
|
.PHONY: check
|
|
check: ## Lint the source code
|
|
@echo "==> Linting source code..."
|
|
@golangci-lint run -j 1
|
|
|
|
@echo "==> Spell checking website..."
|
|
@misspell -error -source=text website/pages/
|
|
|
|
@echo "==> Check proto files are in-sync..."
|
|
@$(MAKE) proto
|
|
@if (git status -s | grep -q .pb.go); then echo the following proto files are out of sync; git status -s | grep .pb.go; exit 1; fi
|
|
|
|
@echo "==> Check format of jobspecs and HCL files..."
|
|
@$(MAKE) hclfmt
|
|
@if (git status -s | grep -q -e '\.hcl$$' -e '\.nomad$$'); then echo the following HCL files are out of sync; git status -s | grep -e '\.hcl$$' -e '\.nomad$$'; exit 1; fi
|
|
|
|
@echo "==> Check API package is isolated from rest"
|
|
@if go list --test -f '{{ join .Deps "\n" }}' ./api | grep github.com/hashicorp/nomad/ | grep -v -e /vendor/ -e /nomad/api/ -e nomad/api.test; then echo " /api package depends the ^^ above internal nomad packages. Remove such dependency"; exit 1; fi
|
|
|
|
@echo "==> Check non-vendored packages"
|
|
@if go list --test -tags "$(GO_TAGS)" -f '{{join .Deps "\n"}}' . | grep -v github.com/hashicorp/nomad.test | xargs go list -tags "$(GO_TAGS)" -f '{{if not .Standard}}{{.ImportPath}}{{end}}' | grep -v -e github.com/hashicorp/nomad; then echo " found referenced packages ^^ that are not vendored"; exit 1; fi
|
|
|
|
.PHONY: checkscripts
|
|
checkscripts: ## Lint shell scripts
|
|
@echo "==> Linting scripts..."
|
|
@find scripts -type f -name '*.sh' | xargs shellcheck
|
|
|
|
.PHONY: generate-all
|
|
generate-all: generate-structs proto generate-examples
|
|
|
|
.PHONY: generate-structs
|
|
generate-structs: LOCAL_PACKAGES = $(shell go list ./... | grep -v '/vendor/')
|
|
generate-structs: ## Update generated code
|
|
@echo "--> Running go generate..."
|
|
@go generate $(LOCAL_PACKAGES)
|
|
|
|
.PHONY: proto
|
|
proto:
|
|
@echo "--> Generating proto bindings..."
|
|
@for file in $$(git ls-files "*.proto" | grep -v "vendor\/.*.proto"); do \
|
|
protoc -I . -I ../../.. --go_out=plugins=grpc:. $$file; \
|
|
done
|
|
|
|
.PHONY: generate-examples
|
|
generate-examples: command/job_init.bindata_assetfs.go
|
|
|
|
command/job_init.bindata_assetfs.go: command/assets/*
|
|
go-bindata-assetfs -pkg command -o command/job_init.bindata_assetfs.go ./command/assets/...
|
|
|
|
.PHONY: vendorfmt
|
|
vendorfmt:
|
|
@echo "--> Formatting vendor/vendor.json"
|
|
test -x $(GOPATH)/bin/vendorfmt || go get -u github.com/magiconair/vendorfmt/cmd/vendorfmt
|
|
vendorfmt
|
|
|
|
.PHONY: changelogfmt
|
|
changelogfmt:
|
|
@echo "--> Making [GH-xxxx] references clickable..."
|
|
@sed -E 's|([^\[])\[GH-([0-9]+)\]|\1[[GH-\2](https://github.com/hashicorp/nomad/issues/\2)]|g' CHANGELOG.md > changelog.tmp && mv changelog.tmp CHANGELOG.md
|
|
|
|
## We skip the terraform directory as there are templated hcl configurations
|
|
## that do not successfully compile without rendering
|
|
.PHONY: hclfmt
|
|
hclfmt:
|
|
@echo "--> Formatting HCL"
|
|
@find . -path ./terraform -prune -o -name 'upstart.nomad' -prune -o \( -name '*.nomad' -o -name '*.hcl' \) -exec \
|
|
sh -c 'hclfmt -w {} || echo in path {}' ';'
|
|
|
|
.PHONY: dev
|
|
dev: GOOS=$(shell go env GOOS)
|
|
dev: GOARCH=$(shell go env GOARCH)
|
|
dev: GOPATH=$(shell go env GOPATH)
|
|
dev: DEV_TARGET=pkg/$(GOOS)_$(GOARCH)/nomad
|
|
dev: vendorfmt changelogfmt hclfmt ## Build for the current development platform
|
|
@echo "==> Removing old development build..."
|
|
@rm -f $(PROJECT_ROOT)/$(DEV_TARGET)
|
|
@rm -f $(PROJECT_ROOT)/bin/nomad
|
|
@rm -f $(GOPATH)/bin/nomad
|
|
@$(MAKE) --no-print-directory \
|
|
$(DEV_TARGET) \
|
|
GO_TAGS="$(GO_TAGS) $(NOMAD_UI_TAG)"
|
|
@mkdir -p $(PROJECT_ROOT)/bin
|
|
@mkdir -p $(GOPATH)/bin
|
|
@cp $(PROJECT_ROOT)/$(DEV_TARGET) $(PROJECT_ROOT)/bin/
|
|
@cp $(PROJECT_ROOT)/$(DEV_TARGET) $(GOPATH)/bin
|
|
|
|
.PHONY: prerelease
|
|
prerelease: GO_TAGS=ui codegen_generated release
|
|
prerelease: generate-all ember-dist static-assets ## Generate all the static assets for a Nomad release
|
|
|
|
.PHONY: release
|
|
release: GO_TAGS=ui codegen_generated release
|
|
release: clean $(foreach t,$(ALL_TARGETS),pkg/$(t).zip) ## Build all release packages which can be built on this platform.
|
|
@echo "==> Results:"
|
|
@tree --dirsfirst $(PROJECT_ROOT)/pkg
|
|
|
|
.PHONY: test
|
|
test: ## Run the Nomad test suite and/or the Nomad UI test suite
|
|
@if [ ! $(SKIP_NOMAD_TESTS) ]; then \
|
|
make test-nomad; \
|
|
fi
|
|
@if [ $(RUN_WEBSITE_TESTS) ]; then \
|
|
make test-website; \
|
|
fi
|
|
@if [ $(RUN_UI_TESTS) ]; then \
|
|
make test-ui; \
|
|
fi
|
|
@if [ $(RUN_E2E_TESTS) ]; then \
|
|
make e2e-test; \
|
|
fi
|
|
|
|
.PHONY: test-nomad
|
|
test-nomad: dev ## Run Nomad test suites
|
|
@echo "==> Running Nomad test suites:"
|
|
$(if $(ENABLE_RACE),GORACE="strip_path_prefix=$(GOPATH)/src") $(GO_TEST_CMD) \
|
|
$(if $(ENABLE_RACE),-race) $(if $(VERBOSE),-v) \
|
|
-cover \
|
|
-timeout=15m \
|
|
-tags "$(GO_TAGS)" \
|
|
$(GOTEST_PKGS) $(if $(VERBOSE), >test.log ; echo $$? > exit-code)
|
|
@if [ $(VERBOSE) ] ; then \
|
|
bash -C "$(PROJECT_ROOT)/scripts/test_check.sh" ; \
|
|
fi
|
|
|
|
.PHONY: e2e-test
|
|
e2e-test: dev ## Run the Nomad e2e test suite
|
|
@echo "==> Running Nomad E2E test suites:"
|
|
go test \
|
|
$(if $(ENABLE_RACE),-race) $(if $(VERBOSE),-v) \
|
|
-cover \
|
|
-timeout=900s \
|
|
-tags "$(GO_TAGS)" \
|
|
github.com/hashicorp/nomad/e2e/vault/ \
|
|
-integration
|
|
|
|
.PHONY: clean
|
|
clean: GOPATH=$(shell go env GOPATH)
|
|
clean: ## Remove build artifacts
|
|
@echo "==> Cleaning build artifacts..."
|
|
@rm -rf "$(PROJECT_ROOT)/bin/"
|
|
@rm -rf "$(PROJECT_ROOT)/pkg/"
|
|
@rm -f "$(GOPATH)/bin/nomad"
|
|
|
|
.PHONY: testcluster
|
|
testcluster: ## Bring up a Linux test cluster using Vagrant. Set PROVIDER if necessary.
|
|
vagrant up nomad-server01 \
|
|
nomad-server02 \
|
|
nomad-server03 \
|
|
nomad-client01 \
|
|
nomad-client02 \
|
|
nomad-client03 \
|
|
$(if $(PROVIDER),--provider $(PROVIDER))
|
|
|
|
.PHONY: static-assets
|
|
static-assets: ## Compile the static routes to serve alongside the API
|
|
@echo "--> Generating static assets"
|
|
@go-bindata-assetfs -pkg agent -prefix ui -modtime 1480000000 -tags ui -o bindata_assetfs.go ./ui/dist/...
|
|
@mv bindata_assetfs.go command/agent
|
|
|
|
.PHONY: test-ui
|
|
test-ui: ## Run Nomad UI test suite
|
|
@echo "--> Installing JavaScript assets"
|
|
@cd ui && npm rebuild node-sass
|
|
@cd ui && yarn install
|
|
@echo "--> Running ember tests"
|
|
@cd ui && npm test
|
|
|
|
.PHONY: ember-dist
|
|
ember-dist: ## Build the static UI assets from source
|
|
@echo "--> Installing JavaScript assets"
|
|
@cd ui && yarn install --silent
|
|
@cd ui && npm rebuild node-sass
|
|
@echo "--> Building Ember application"
|
|
@cd ui && npm run build
|
|
|
|
.PHONY: dev-ui
|
|
dev-ui: ember-dist static-assets
|
|
@$(MAKE) NOMAD_UI_TAG="ui" dev ## Build a dev binary with the UI baked in
|
|
|
|
HELP_FORMAT=" \033[36m%-25s\033[0m %s\n"
|
|
.PHONY: help
|
|
help: ## Display this usage information
|
|
@echo "Valid targets:"
|
|
@grep -E '^[^ ]+:.*?## .*$$' $(MAKEFILE_LIST) | \
|
|
sort | \
|
|
awk 'BEGIN {FS = ":.*?## "}; \
|
|
{printf $(HELP_FORMAT), $$1, $$2}'
|
|
@echo ""
|
|
@echo "This host will build the following targets if 'make release' is invoked:"
|
|
@echo $(ALL_TARGETS) | sed 's/^/ /'
|
|
|
|
.PHONY: ui-screenshots
|
|
ui-screenshots:
|
|
@echo "==> Collecting UI screenshots..."
|
|
# Build the screenshots image if it doesn't exist yet
|
|
@if [[ "$$(docker images -q nomad-ui-screenshots 2> /dev/null)" == "" ]]; then \
|
|
docker build --tag="nomad-ui-screenshots" ./scripts/screenshots; \
|
|
fi
|
|
@docker run \
|
|
--rm \
|
|
--volume "$(shell pwd)/scripts/screenshots/screenshots:/screenshots" \
|
|
nomad-ui-screenshots
|
|
|
|
.PHONY: ui-screenshots-local
|
|
ui-screenshots-local:
|
|
@echo "==> Collecting UI screenshots (local)..."
|
|
@cd scripts/screenshots/src && SCREENSHOTS_DIR="../screenshots" node index.js
|