Makefile

#
# Copyright (C) 2021 CloudTruth, Inc.
#
os_name := $(shell uname -s)
rustup_exists := $(shell which rustup)
openapi_gen_version := v5.3.1
cicd_dir := cicd
test_dir := tests
client_dir := crates/cloudtruth-restapi
# convenience for looping
subdirs := $(cicd_dir)
subdirs += $(test_dir)

.DEFAULT = all
.PHONY = all
.PHONY += cargo
.PHONY += ci
.PHONY += clean
.PHONY += cli
.PHONY += client
.PHONY += help
.PHONY += help_text
.PHONY += image
.PHONY += integration
.PHONY += fix
.PHONY += format
.PHONY += help-text
.PHONY += lint
.PHONY += lint_fix
.PHONY += lint_python
.PHONY += lint_rust
.PHONY += lint_shell
.PHONY += precommit
.PHONY += prerequisites
.PHONY += shell
.PHONY += subdir_action
.PHONY += subdir_lint
.PHONY += subdir_precommit
.PHONY += targets
.PHONY += test

all: precommit

### Commands for outside the container

image:
ifeq ($(os_name),Darwin)
# passing in gid fails on MacOS
	docker build --build-arg user_uid=$(shell id -u) -t cloudtruth/cli . -f Dockerfile.dev
else
	docker build --build-arg user_uid=$(shell id -u) --build-arg user_gid=$(shell id -g) -t cloudtruth/cli . -f Dockerfile.dev
endif

shell:
	docker run --rm --privileged=true \
		--group-add $(shell stat -c '%g' /var/run/docker.sock) \
		-v $(PWD):/home/dev/cli \
		-v $(HOME)/.cargo:/home/dev/.cargo \
		-v /var/run/docker.sock:/var/run/docker.sock \
		-it cloudtruth/cli

### Commands for either outside or inside the container

# the client must be generated before building the Rust program that uses it
cargo: $(client_dir)
	cargo build

ci:
	make -C $(cicd_dir)

clean:
	rm -rf target/

# client needs to re-generated when the openapi.yaml changes
client: $(client_dir)
$(client_dir): openapi.yml patch_client.py
	docker info
	rm -rf $(client_dir)/src
	docker run --rm \
		-v "$(shell pwd):/local" \
		--user "$(shell id -u):$(shell id -g)" \
		openapitools/openapi-generator-cli:$(openapi_gen_version) generate \
		-i /local/openapi.yml \
		-g rust \
		-o /local/$(client_dir) \
		--additional-properties=packageName=cloudtruth-restapi,packageVersion=1.0.0,supportAsync=false,enumUnknownDefaultCase=true \
		> generator.log
	python3 patch_client.py
	cd $(client_dir) && cargo fmt --all && cargo build

# apply both formatting fixes and linting fixes
fix: format lint_fix

# apply formatting fixes to the working directory
format:
	cargo fmt --all
	python3 -m black .
	ruff check . --fix
	taplo fmt

help_text:
	@rm -rf $(shell ls examples/help-text/*)
	cargo xtask generate-help-text --verbose

lint: lint_shell lint_rust lint_python lint_toml

lint_python:
	python3 -m black --quiet --check .
	ruff check .

lint_rust:
	cargo fmt --all -- --check
	cargo clippy --workspace --all-features --tests -- -D warnings

lint_shell:
	git ls-files | grep -v -E '^$(client_dir)' | grep -E '\.sh$$' | xargs shellcheck

lint_toml:
	taplo check

# apply linting fixes
lint_fix:
	cargo clippy --workspace --all-features --fix --allow-staged --allow-dirty -- -D warnings
	python3 -m black .

subdir_action:
	@for sd in $(subdirs) ; do \
  		echo "Performing $(SUBDIR_ACTION) in $$sd directory" && make -C $$sd $(SUBDIR_ACTION) || exit 1; \
  	done

subdir_precommit:
	make subdir_action SUBDIR_ACTION=precommit

precommit: cargo test lint subdir_precommit

prerequisites:
ifeq ($(rustup_exists),'')
	curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
endif
ifeq ($(rustup_exists),'')
	$(error "You need to add ~/.cargo/bin to your PATH")
endif
# update rust release channels and rustup itself
	rustup update
# autoinstalls rust toolchain specified by rust-toolchain.toml in repo
	rustup show
# we use minimal profile in rust-toolchain.toml for CICD builds.
# for dev environment, install default profile components
	rustup component add rustfmt clippy rust-docs

	cargo +stable install cargo-binstall
	cargo +stable binstall --no-confirm taplo-cli cargo-nextest

ifeq ($(os_name),Darwin)
	brew install shellcheck
else ifeq ($(os_name),Linux)
	sudo apt-get install shellcheck pkg-config
else
	@echo "Did not install shellcheck"
endif
	python3 -m pip install --user --upgrade black yamllint ruff
ifeq ('',$(shell which ruff))
	$(error Need to add python packages to your PATH)
endif

test:
	RUST_BACKTRACE=1 cargo xtest

integration-test:
	make -C $(test_dir) $@

help: targets

targets:
	@echo ""
	@echo "cargo            - builds rust target"
	@echo "ci               - builds auto-generated CI artifacts"
	@echo "clean            - clean out build targets"
	@echo "client           - generate and build the cloudtruth-restapi library"
	@echo "image            - make the cloudtruth/cli docker container for development"
	@echo "integration-test - runs the integration test against the live server"
	@echo "fix			    - fix formatting and linting issues:"
	@echo "format		    - fix formatting issues"
	@echo "help_text	    - Regenerate help text for test cases"
	@echo "lint             - checks for formatting and lint issues"
	@echo "lint_fix		    - fix linting issues"
	@echo "precommit        - build rust targets, tests, and lints the files"
	@echo "prerequisites    - install prerequisites"
	@echo "shell            - drop into the cloudtruth/cli docker container for development"
	@echo "test             - runs the cargo tests"
	@echo ""