Makefile

#   Copyright 2020 The Compose Specification Authors.

#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at

#       http://www.apache.org/licenses/LICENSE-2.0

#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.

IMAGE_PREFIX=composespec/conformance-tests-

ifeq ($(OS),Windows_NT)
	BINARY_EXT=.exe
endif

.PHONY: build
build: ## Build command line
	go build -o bin/compose-spec-$(GOOS)-$(GOARCH)$(BINARY_EXT) cmd/main.go

.PHONY: test
test: ## Run tests
	gotestsum ./...

# `go test -fuzz` runs one fuzz target of one package at a time: enumerate them.
FUZZTIME ?= 10s

.PHONY: fuzz
fuzz: ## Fuzz every parser for FUZZTIME (default 10s) each, e.g. make fuzz FUZZTIME=2m
	@pkgs=$$(go list ./...) || exit 1; \
	for pkg in $$pkgs; do \
		targets=$$(go test -list '^Fuzz' $$pkg) || exit 1; \
		for target in $$(echo "$$targets" | grep '^Fuzz'); do \
			echo "==> $$pkg $$target ($(FUZZTIME))"; \
			go test -run '^$$' -fuzz "^$$target\$$" -fuzztime $(FUZZTIME) $$pkg || exit 1; \
		done; \
	done

.PHONY: fmt
fmt: ## Format go files
	go fmt ./...

.PHONY: generate
generate: ## Regenerate derived sources (container-spec attribute list)
	go run ./internal/generate/containerspec

.PHONY: check-generate
check-generate: generate ## Fail if derived sources are out of sync
	git diff --exit-code types/container_spec_attributes.gen.go

.PHONY: deepcopy
deepcopy: build-validate-image
	docker run --rm -v .:/go/src $(IMAGE_PREFIX)validate goderive ./types/...

.PHONY: build-validate-image
build-validate-image:
	docker build . -f ci/Dockerfile -t $(IMAGE_PREFIX)validate

.PHONY: lint
lint: build-validate-image
	docker run --rm -v .:/go/src $(IMAGE_PREFIX)validate golangci-lint run --config ./.golangci.yml ./...

.PHONY: check-license
check-license: build-validate-image
	docker run --rm -v .:/go/src $(IMAGE_PREFIX)validate ltag -t scripts/validate/template --excludes "validate dotenv" --check -v

.PHONY: setup
setup: ## Setup the precommit hook
	@which pre-commit > /dev/null 2>&1 || (echo "pre-commit not installed see README." && false)
	@pre-commit install