Makefile

# Heavily inspired by Reth: https://github.com/paradigmxyz/reth/blob/d599393771f9d7d137ea4abf271e1bd118184c73/Makefile
.DEFAULT_GOAL := help

GIT_TAG ?= $(shell git describe --tags --abbrev=0)

BUILD_PATH = "target"

FUNCTIONAL_TESTS_DIR  = functional-tests
FUNCTIONAL_TESTS_DATADIR = _dd
DOCKER_DIR = docker
DOCKER_DATADIR = data

# Cargo profile for builds. Default is for local builds, CI uses an override.
PROFILE ?= release

# Extra flags for Cargo
CARGO_INSTALL_EXTRA_FLAGS ?=

# List of features to use for building
FEATURES ?=

# The docker image name
DOCKER_IMAGE_NAME ?=

##@ Help

.PHONY: help
help: ## Display this help.
	@awk 'BEGIN {FS = ":.*##"; printf "Usage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-25s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

##@ Build

.PHONY: build
build: ## Build the workspace into the `target` directory.
	cargo build --workspace --bin "strata-client" --features "$(FEATURES)" --profile "$(PROFILE)"

##@ Test

UNIT_TEST_ARGS := --locked --workspace -E 'kind(lib)' -E 'kind(bin)' -E 'kind(proc-macro)'
COV_FILE := lcov.info

.PHONY: test-unit
test-unit: ## Run unit tests.
	-cargo install cargo-nextest --locked
	cargo nextest run $(UNIT_TEST_ARGS)

.PHONY: cov-unit
cov-unit: ## Run unit tests with coverage.
	rm -f $(COV_FILE)
	cargo llvm-cov nextest --lcov --output-path $(COV_FILE) $(UNIT_TEST_ARGS)

.PHONY: cov-report-html
cov-report-html: ## Generate an HTML coverage report and open it in the browser.
	cargo llvm-cov --open --workspace --locked nextest

.PHONY: test-int
test-int: ## Run integration tests
	cargo nextest run -p "integration-tests" --status-level=fail --no-capture

.PHONY: mutants-test
mutants-test: ## Runs `nextest` under `cargo-mutants`. Caution: This can take *really* long to run.
	cargo mutants --workspace -j2

.PHONY: sec
sec: ## Check for security advisories on any dependencies.
	cargo audit #  HACK: not denying warnings as we depend on `yaml-rust` via `format-serde-error` which is unmaintained

##@ Functional Tests
.PHONY: ensure-poetry
ensure-poetry:
	@if ! command -v poetry &> /dev/null; then \
		echo "poetry not found. Please install it by the following the instructions from: https://python-poetry.org/docs/#installation" \
		exit 1; \
    fi

.PHONY: activate
activate: ensure-poetry ## Activate poetry environment for integration tests.
	cd $(FUNCTIONAL_TESTS_DIR) && poetry install --no-root

.PHONY: clean-dd
clean-dd: ## Remove the data directory used by functional tests.
	rm -rf $(FUNCTIONAL_TESTS_DIR)/$(FUNCTIONAL_TESTS_DATADIR) 2>/dev/null

.PHONY: clean-cargo
clean-cargo: ## cargo clean
	cargo clean 2>/dev/null

.PHONY: clean-docker-data
clean-docker-data: ## Remove docker data files inside /docker/.data
	rm -rf $(DOCKER_DIR)/$(DOCKER_DATADIR) 2>/dev/null

.PHONY: clean-poetry
clean-poetry: ## Remove poetry virtual environment
	cd $(FUNCTIONAL_TESTS_DIR) && rm -rf .venv 2>/dev/null

.PHONY: clean
clean: clean-dd clean-docker-data clean-cargo clean-poetry ## clean functional tests directory, cargo clean, clean docker data, clean poetry virtual environment
	@echo "\n\033[36m======== CLEAN_COMPLETE ========\033[0m\n"

.PHONY: docker-up
docker-up: ## docker compose up
	cd $(DOCKER_DIR) && docker compose up -d

.PHONY: docker-down
docker-down: ## docker compose down
	cd $(DOCKER_DIR) && docker compose down && \
	rm -rf $(DOCKER_DIR)/$(DOCKER_DATADIR) 2>/dev/null


.PHONY: test-functional
test-functional: ensure-poetry activate clean-dd ## Runs functional tests.
	cd $(FUNCTIONAL_TESTS_DIR) && ./run_test.sh

##@ Code Quality

.PHONY: fmt-check-ws
fmt-check-ws: ## Check formatting issues but do not fix automatically.
	cargo fmt --check

.PHONY: fmt-ws
fmt-ws: ## Format source code in the workspace.
	cargo fmt --all

.PHONY: ensure-taplo
ensure-taplo:
	@if ! command -v taplo &> /dev/null; then \
		echo "taplo not found. Please install it by following the instructions from: https://taplo.tamasfe.dev/cli/installation/binary.html" \
		exit 1; \
    fi

.PHONY: fmt-check-toml
fmt-check-toml: ensure-taplo ## Runs `taplo` to check that TOML files are properly formatted
	taplo fmt --check

.PHONY: fmt-toml
fmt-toml: ensure-taplo ## Runs `taplo` to format TOML files
	taplo fmt

.PHONY: fmt-check-func-tests
fmt-check-func-tests: ensure-poetry activate ## Check formatting of python files inside `test` directory.
	cd $(FUNCTIONAL_TESTS_DIR) && poetry run ruff format --check

.PHONY: fmt-func-tests
fmt-func-tests: ensure-poetry activate ## Apply formatting of python files inside `test` directory.
	cd $(FUNCTIONAL_TESTS_DIR) && poetry run ruff format

.PHONY: lint-check-ws
lint-check-ws: ## Checks for lint issues in the workspace.
	cargo clippy \
	--workspace \
	--bin "strata-client" \
	--lib \
	--examples \
	--tests \
	--benches \
	--all-features \
	--no-deps \
	-- -D warnings

.PHONY: lint-fix-ws
lint-fix-ws: ## Lints the workspace and applies fixes where possible.
	cargo clippy \
	--workspace \
	--bin "strata-client" \
	--lib \
	--examples \
	--tests \
	--benches \
	--all-features \
	--fix \
	--no-deps \
	-- -D warnings

ensure-codespell:
	@if ! command -v codespell &> /dev/null; then \
		echo "codespell not found. Please install it by running the command 'pip install codespell' or refer to the following link for more information: https://github.com/codespell-project/codespell" \
		exit 1; \
    fi

.PHONY: lint-codespell
lint-check-codespell: ensure-codespell ## Runs `codespell` to check for spelling errors.
	codespell

.PHONY: lint-fix-codespell
lint-fix-codespell: ensure-codespell ## Runs `codespell` to fix spelling errors if possible.
	codespell -w

.PHONY: lint-toml
lint-check-toml: ensure-taplo ## Lints TOML files
	taplo lint

.PHONY: lint-check-func-tests
lint-check-func-tests: ensure-poetry activate ## Lints the functional tests
	cd $(FUNCTIONAL_TESTS_DIR) && poetry run ruff check

.PHONY: lint-fix-func-tests
lint-fix-func-tests: ensure-poetry activate ## Lints the functional tests and applies fixes where possible
	cd $(FUNCTIONAL_TESTS_DIR) && poetry run ruff check --fix

.PHONY: lint
lint: fmt-check-ws fmt-check-func-tests fmt-check-toml lint-check-ws lint-check-func-tests lint-check-codespell ## Runs all lints and checks for issues without trying to fix them.
	@echo "\n\033[36m======== OK: Lints and Formatting ========\033[0m\n"

.PHONY: lint-fix
lint-fix: fmt-toml fmt-ws lint-fix-ws lint-fix-codespell ## Runs all lints and applies fixes where possible.
	@echo "\n\033[36m======== OK: Lints and Formatting Fixes ========\033[0m\n"

.PHONY: rustdocs
rustdocs: ## Runs `cargo docs` to generate the Rust documents in the `target/doc` directory.
	RUSTDOCFLAGS="\
	--show-type-layout \
	--enable-index-page -Z unstable-options \
	-A rustdoc::private-doc-tests \
	-D warnings" \
	cargo doc \
	--workspace \
	--no-deps

.PHONY: test-doc
test-doc: ## Runs doctests on the workspace.
	cargo test --doc --workspace

.PHONY: test
test: ## Runs all tests in the workspace including unit and docs tests.
	make test-unit && \
	make test-doc

.PHONY: pr
pr: lint sec rustdocs test-doc test-unit test-int test-functional ## Runs lints (without fixing), audit, docs, and tests (run this before creating a PR).
	@echo "\n\033[36m======== CHECKS_COMPLETE ========\033[0m\n"
	@test -z "$$(git status --porcelain)" || echo "WARNNG: You have uncommitted changes"
	@echo "All good to create a PR!"