Makefile

# Copyright 2025 DoorDash, 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.

GOBASE=$(shell pwd)
GOBIN=$(GOBASE)/bin

help:
	@echo "This is a helper makefile for oapi-codegen"
	@echo "Targets:"
	@echo "    generate:    regenerate all generated files"
	@echo "    test:        run all tests"
	@echo "    tidy         tidy go mod"
	@echo "    lint         lint the project"
	@echo "    notice       regenerate NOTICE.txt with third-party licenses"

$(GOBIN)/golangci-lint:
	# GOTOOLCHAIN=auto only for this install: golangci-lint's own go.mod requires a
	# newer Go than this project targets, and building the linter binary says nothing
	# about the Go version this module supports. actions/setup-go v6+ exports
	# GOTOOLCHAIN=local, which would otherwise make this install fail outright.
	GOBIN=$(GOBIN) GOTOOLCHAIN=auto go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.15.0

.PHONY: tools
tools: $(GOBIN)/golangci-lint

lint: tools
	# run the root module explicitly, to prevent recursive calls by re-invoking `make ...` top-level
	$(GOBIN)/golangci-lint run ./...
	# then, for all child modules, use a module-managed `Makefile`
	git ls-files '**/*go.mod' -z | xargs -0 -I{} bash -xc 'cd $$(dirname {}) && env GOBIN=$(GOBIN) make lint'

lint-ci: tools
	# for the root module, explicitly run the step, to prevent recursive calls
	$(GOBIN)/golangci-lint run ./... --timeout=5m
	# then, for all child modules, use a module-managed `Makefile`
	git ls-files '**/*go.mod' -z | xargs -0 -I{} bash -xc 'cd $$(dirname {}) && env GOBIN=$(GOBIN) make lint-ci'

generate:
	# for the root module, explicitly run the step, to prevent recursive calls
	go generate ./...
	# then, for all child modules, use a module-managed `Makefile`
	git ls-files '**/*go.mod' -z | xargs -0 -I{} bash -xc 'cd $$(dirname {}) && make generate'

test:
	# for the root module, explicitly run the step, to prevent recursive calls
	go test -cover ./...
	# then, for all child modules, use a module-managed `Makefile`
	git ls-files '**/*go.mod' -z | xargs -0 -I{} bash -xc 'cd $$(dirname {}) && make test'

tidy:
	# for the root module, explicitly run the step, to prevent recursive calls
	go mod tidy
	# then, for all child modules, use a module-managed `Makefile`
	git ls-files '**/*go.mod' -z | xargs -0 -I{} bash -xc 'cd $$(dirname {}) && make tidy'

tidy-ci:
	# for the root module, explicitly run the step, to prevent recursive calls
	go mod tidy -diff
	# then, for all child modules, use a module-managed `Makefile`
	git ls-files '**/*go.mod' -z | xargs -0 -I{} bash -xc 'cd $$(dirname {}) && make tidy-ci'

.PHONY: fetch-specs
fetch-specs:
	rm -rf ./testdata/specs
	git clone https://github.com/mockzilla/specs.git ./testdata/specs
	find ./testdata/specs -mindepth 1 -name ".*" -exec rm -rf {} +

test-integration:
	@go test -v -tags=integration -count=1 -timeout=30m . 2>&1 | \
		grep -v "^=== RUN\|^=== PAUSE\|^=== CONT\|^--- PASS:"

check-all: generate lint test test-integration
	@if [ -n "$$(git status --porcelain)" ]; then \
		echo >&2 "ERROR: generate command should not produce extra code"; \
		exit 1; \
	fi

gosec-examples:
	cd examples && make gosec

# go install github.com/securego/gosec/v2/cmd/gosec@v2.30.0 (keep in step with .github/workflows/ci.yml)
gosec: gosec-examples
	gosec -exclude-dir=.data -exclude-dir=examples ./...

check-fmt:
	# for the root module, check if files are formatted (only pkg and cmd dirs)
	@UNFORMATTED=$$(gofmt -l pkg cmd); \
	if [ -n "$$UNFORMATTED" ]; then \
		echo >&2 "ERROR: The following files are not formatted:"; \
		echo "$$UNFORMATTED"; \
		exit 1; \
	fi
	# then, for all child modules, use a module-managed `Makefile`
	git ls-files '**/*go.mod' -z | xargs -0 -I{} bash -xc 'cd $$(dirname {}) && make check-fmt'

build-ci: check-fmt tidy-ci lint-ci gosec

test-ci: test

@PHONY: docs-install
docs-install:
	@brew install mkdocs-material

@PHONY: docs-serve
docs-serve:
	@mkdocs serve

$(GOBIN)/go-licenses:
	GOBIN=$(GOBIN) go install github.com/google/go-licenses@latest

.PHONY: notice
notice: $(GOBIN)/go-licenses
	@echo "This product includes software developed by DoorDash, Inc." > NOTICE.txt
	@echo "Copyright 2025 DoorDash, Inc." >> NOTICE.txt
	@echo "" >> NOTICE.txt
	@echo "Bundled third-party components and their licenses:" >> NOTICE.txt
	@echo "--------------------------------------------------" >> NOTICE.txt
	@echo "" >> NOTICE.txt
	@$(GOBIN)/go-licenses report ./... 2>/dev/null | sort | awk -F',' 'BEGIN{n=1} {printf "%d) %s\n   Source: %s\n   License: %s\n\n", n++, $$1, $$2, $$3}'  >> NOTICE.txt
	@echo "--------------------------------------------------" >> NOTICE.txt
	@echo "This NOTICE file must be updated whenever this project adds," >> NOTICE.txt
	@echo "vendors, or bundles additional third-party components." >> NOTICE.txt
	@echo "" >> NOTICE.txt
	@echo "Generated NOTICE.txt"