Makefile

#
# Copyright (c) 2020 Red Hat, Inc.
#
# 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.
#

include .bingo/Variables.mk

VALE_VERSION ?= v3.21.0
ADDLICENSE_VERSION ?= v1.2.0
VALE := $(GOBIN)/vale
ADDLICENSE := $(GOBIN)/addlicense

.DEFAULT_GOAL := rosa

# Wrapper script entry points used by make convenience targets.
RUN_CHECKS_SCRIPT := ./hack/run-checks.sh

# Ensure go modules are enabled:
export GO111MODULE=on
export GOPROXY=https://proxy.golang.org
# Use Go's documented toolchain switching, since some repackaged toolchains default to local-only.
export GOTOOLCHAIN=auto
# Let the selected Go binary provide its own GOROOT to avoid mixed-toolchain builds.
unexport GOROOT
# Use the selected toolchain binary for Bingo-managed tool builds.
GO := $(shell go env GOROOT)/bin/go

# Disable CGO so that we always generate static binaries:
export CGO_ENABLED=0

# Unset GOFLAG for CI and ensure we've got nothing accidently set
unexport GOFLAGS

# Version from the exact tag on HEAD; empty (uses the fallback in pkg/info/info.go)
# when HEAD is not tagged.
VERSION ?= $(shell git describe --tags --exact-match 2>/dev/null | sed 's/^v//')

.PHONY: rosa
rosa:
	go build -ldflags="-X github.com/openshift/rosa/pkg/info.Build=$(shell git rev-parse --short HEAD) $(if $(VERSION),-X github.com/openshift/rosa/pkg/info.DefaultVersion=$(VERSION),)" ./cmd/rosa

.PHONY: test
test:
	go test $(GO_TEST_FLAGS) $(shell go list ./... | grep -v /tests/)

.PHONY: coverage
coverage:
	go test -coverprofile=cover.out -covermode=atomic -p 1 $(GO_TEST_FLAGS) $(shell go list ./... | grep -v /tests/)

.PHONY: coverage-changed-files
coverage-changed-files:
	./hack/coverage-changed-files.sh

.PHONY: install
install:
	go install -ldflags="-X github.com/openshift/rosa/pkg/info.Build=$(shell git rev-parse --short HEAD) $(if $(VERSION),-X github.com/openshift/rosa/pkg/info.DefaultVersion=$(VERSION),)" ./cmd/rosa

.PHONY: fmt
fmt: $(GCI)
	GCI_BIN="$(GCI)" ./hack/fmt.sh

.PHONY: fmt-staged
fmt-staged: $(GCI)
	GCI_BIN="$(GCI)" ./hack/fmt-staged.sh

.PHONY: fmt-check
fmt-check: $(GCI)
	@test -z "$$(gofmt -s -l cmd pkg tests)"
	@test -z "$$($(GCI) list -s standard -s default -s "prefix(k8s)" -s "prefix(sigs.k8s)" -s "prefix(github.com)" -s "prefix(gitlab)" -s "prefix(github.com/openshift/rosa)" --custom-order --skip-generated --skip-vendor cmd pkg tests)"

.PHONY: lint
LINT_NEW_FROM_REV ?= $(PULL_BASE_SHA)
LINT_NEW_FROM_REV_FLAG := $(if $(LINT_NEW_FROM_REV),--new-from-rev=$(LINT_NEW_FROM_REV))
lint: $(GOLANGCI_LINT)
	$(GOLANGCI_LINT) run --timeout 15m0s $(LINT_OUTPUT_FLAGS) $(LINT_NEW_FROM_REV_FLAG) ./...

$(VALE):
	CGO_ENABLED=1 GOBIN="$(GOBIN)" go install github.com/vale-cli/vale/v3/cmd/vale@$(VALE_VERSION)

$(ADDLICENSE):
	GOBIN="$(GOBIN)" go install github.com/google/addlicense@$(ADDLICENSE_VERSION)

.PHONY: vale
vale: $(VALE)

.PHONY: docs-lint
docs-lint: $(VALE)
	"$(VALE)" --minAlertLevel=error --glob='!.vale.ini' --glob='!vendor/**' .
>>>>>>> a2d803bc9 (ROSAENG-6524 | chore: add license and documentation checks)

.PHONY: govulncheck
govulncheck: $(GOVULNCHECK) rosa
	GOVULNCHECK_BIN="$(GOVULNCHECK)" ./hack/govulncheck.sh

.PHONY: commits/check
commits/check:
	@./hack/commit-msg-verify.sh

.PHONY: install-hooks
install-hooks:
	@if ! command -v pre-commit &> /dev/null; then \
		echo "Error: pre-commit is not installed."; \
		echo "See https://pre-commit.com/#install for installation instructions"; \
		exit 1; \
	fi
	@hooks_path=$$(git config --local core.hooksPath 2>/dev/null || true); \
	if [ "$$hooks_path" = ".githooks" ]; then \
		echo "Detected legacy core.hooksPath=.githooks (from the old hook system)."; \
		echo "Unsetting it so pre-commit hooks are picked up correctly..."; \
		git config --unset core.hooksPath; \
	fi
	@pre-commit install --install-hooks --hook-type pre-commit --hook-type commit-msg --hook-type pre-push
	@echo "Installed pre-commit hooks (pre-commit, commit-msg, pre-push). YOU MUST RUN THESE HOOKS ON EVERY COMMIT AND PUSH."

.PHONY: license-check
license-check: $(ADDLICENSE)
	@echo "Checking for missing license headers..."
	@ADDLICENSE="$(ADDLICENSE)" bash scripts/add-license-header.sh -check

.PHONY: license-add
license-add: $(ADDLICENSE)
	@echo "Adding license headers to files..."
	@ADDLICENSE="$(ADDLICENSE)" bash scripts/add-license-header.sh

.PHONY: license-add-staged
license-add-staged: $(ADDLICENSE)
	@ADDLICENSE="$(ADDLICENSE)" ./hack/license-add-staged.sh

.PHONY: basic-checks
basic-checks:
	@$(RUN_CHECKS_SCRIPT) basic

.PHONY: pre-commit-checks
pre-commit-checks:
	@$(MAKE) --no-print-directory fmt-staged
	@$(MAKE) --no-print-directory license-add-staged

.PHONY: pre-push-checks
pre-push-checks:
	@$(RUN_CHECKS_SCRIPT) pre-push

.PHONY: run-checks
run-checks:
	@$(RUN_CHECKS_SCRIPT) $(filter-out $@,$(MAKECMDGOALS))

PASSTHROUGH_MAKE_TARGETS := run-checks
ifneq (,$(filter $(PASSTHROUGH_MAKE_TARGETS),$(MAKECMDGOALS)))
PASSTHROUGH_ARG_GOALS := $(filter-out $(PASSTHROUGH_MAKE_TARGETS),$(MAKECMDGOALS))
$(foreach goal,$(PASSTHROUGH_ARG_GOALS),$(eval .PHONY: $(goal)))
$(foreach goal,$(PASSTHROUGH_ARG_GOALS),$(eval $(goal):;@:))
endif

.PHONY: diff
diff:
	git diff --exit-code

.PHONY: verify
verify: fmt
	go mod tidy
	go mod vendor
	$(MAKE) diff

.PHONY: clean
clean:
	rm -rf \
		./cover.out \
		rosa \
		rosa-darwin-amd64 \
		rosa-darwin-arm64 \
		rosa-linux-amd64 \
		rosa-linux-arm64 \
		rosa-windows-amd64.exe \
		*.sha256 \
		$(NULL)

.PHONY: generate
generate: $(GO_BINDATA) mocks
	$(GO_BINDATA) -nometadata -nocompress -pkg assets -o ./assets/bindata.go ./templates/...
	go generate ./...

.PHONY: codecov
codecov: coverage
	@./hack/codecov.sh

mocks: $(MOCKGEN)
	$(MOCKGEN) -source=pkg/aws/api_interface/iam_api_client.go -package=mocks -destination=pkg/aws/mocks/iam_api_client_mock.go
	$(MOCKGEN) -source=pkg/aws/api_interface/organizations_api_client.go -package=mocks -destination=pkg/aws/mocks/organizations_api_client_mock.go
	$(MOCKGEN) -source=pkg/aws/api_interface/sts_api_client.go -package=mocks -destination=pkg/aws/mocks/sts_api_client_mock.go
	$(MOCKGEN) -source=pkg/aws/api_interface/cloudformation_api_client.go -package=mocks -destination=pkg/aws/mocks/cloudformation_api_client_mock.go
	$(MOCKGEN) -source=pkg/aws/api_interface/servicequotas_api_client.go -package=mocks -destination=pkg/aws/mocks/servicequotas_api_client_mock.go
	$(MOCKGEN) -source=pkg/aws/api_interface/ec2_api_client.go -package=mocks -destination=pkg/aws/mocks/ec2_api_client_mock.go
	$(MOCKGEN) -source=pkg/aws/api_interface/s3_api_client.go -package=mocks -destination=pkg/aws/mocks/s3_api_client_mock.go
	$(MOCKGEN) -source=pkg/aws/api_interface/secretsmanager_api_client.go -package=mocks -destination=pkg/aws/mocks/secretsmanager_api_client_mock.go
	$(MOCKGEN) -source=pkg/aws/client.go -package=aws -destination=pkg/aws/client_mock.go
	$(MOCKGEN) -source=pkg/version/version.go -package=version -destination=pkg/version/version_mock.go
	$(MOCKGEN) -source=pkg/version/retriever.go -package=version -destination=pkg/version/retriever_mock.go
	$(MOCKGEN) -source=cmd/verify/rosa/cmd.go -package=rosa -destination=cmd/verify/rosa/cmd_mock.go
	$(MOCKGEN) -source=pkg/clients/http.go -package=clients -destination=pkg/clients/http_mock.go
	$(MOCKGEN) -source=pkg/cache/service.go -package=cache -destination=pkg/cache/service_mock.go
	$(MOCKGEN) -source=pkg/cache/cache.go -package=cache -destination=pkg/cache/cache_mock.go
	$(MOCKGEN) -source=pkg/network/network.go -package=network -destination=pkg/network/network_mock.go
	$(MOCKGEN) -source=pkg/machinepool/machinepool.go -package=machinepool -destination=pkg/machinepool/machinepool_mock.go
	$(MOCKGEN) -source=pkg/kubeletconfig/config.go -package=kubeletconfig -destination=pkg/kubeletconfig/capability_checker_mock.go
	$(MOCKGEN) -source=cmd/create/idp/cmd.go -package=mocks -destination=cmd/create/idp/mocks/identityprovider.go


.PHONY: e2e_test
e2e_test: install
	ginkgo run \
        --label-filter $(LabelFilter)\
        --timeout 5h \
        -r \
        --focus-file tests/e2e/.* \
		$(NULL)

.PHONY: generate-docs
generate-docs:
	go run ./tools/gendocs

# verifies changes to .goreleaser.yaml
.PHONY: check-release-config
check-release-config:
	$(GORELEASER) check

.PHONY: changelog-bootstrap
changelog-bootstrap:
	./hack/changelog-generate.sh --bootstrap

.PHONY: changelog-generate
changelog-generate:
	@test -n "$(TAG)"
	./hack/changelog-generate.sh --tag "$(TAG)" $(if $(PREVIOUS_TAG),--previous-tag "$(PREVIOUS_TAG)",)

.PHONY: changelog-pr
changelog-pr:
	./hack/changelog-pr.sh $(if $(TAG),--tag "$(TAG)",) $(if $(PREVIOUS_TAG),--previous-tag "$(PREVIOUS_TAG)",)

# builds a snap shot release in /dist
.PHONY: local-release
local-release:
	$(GORELEASER) release --snapshot --clean

# builds and publishes a latest release from tag set as env-ver GORELEASER_PREVIOUS_TAG
# leave GORELEASER_PREVIOUS_TAG empty to build from last release tag
.PHONY: release
release:
	bash ./hack/build_cli.sh