mirror of
https://github.com/trailofbits/buttercup
synced 2026-06-21 14:11:39 +00:00
Ronald Eytchison
87 lines
2.0 KiB
Makefile
87 lines
2.0 KiB
Makefile
SHELL := /bin/bash
|
|
|
|
PY_IMPORT = seed_gen
|
|
|
|
ALL_PY_SRCS := $(shell find src -name '*.py') \
|
|
$(shell find test -name '*.py')
|
|
|
|
# Optionally overriden by the user, if they're using a virtual environment manager.
|
|
VENV ?= env
|
|
|
|
# On Windows, venv scripts/shims are under `Scripts` instead of `bin`.
|
|
VENV_BIN := $(VENV)/bin
|
|
ifeq ($(OS),Windows_NT)
|
|
VENV_BIN := $(VENV)/Scripts
|
|
endif
|
|
|
|
# Optionally overridden by the user in the `release` target.
|
|
BUMP_ARGS :=
|
|
|
|
# Optionally overridden by the user in the `test` target.
|
|
TESTS :=
|
|
|
|
# Optionally overridden by the user/CI, to limit the installation to a specific
|
|
# subset of development dependencies.
|
|
INSTALL_EXTRA := dev
|
|
|
|
# If the user selects a specific test pattern to run, set `pytest` to fail fast
|
|
# and only run tests that match the pattern.
|
|
# Otherwise, run all tests and enable coverage assertions, since we expect
|
|
# complete test coverage.
|
|
ifneq ($(TESTS),)
|
|
TEST_ARGS := -x -k $(TESTS)
|
|
COV_ARGS :=
|
|
else
|
|
TEST_ARGS :=
|
|
COV_ARGS := --fail-under 100
|
|
endif
|
|
|
|
.PHONY: all
|
|
all:
|
|
@echo "Run my targets individually!"
|
|
|
|
.PHONY: dev
|
|
dev: $(VENV)/pyvenv.cfg
|
|
.PHONY: run
|
|
run: $(VENV)/pyvenv.cfg
|
|
# Once we can specify the default VENV name in uv, use `uv run` here
|
|
# https://github.com/astral-sh/uv/issues/1422
|
|
@. $(VENV_BIN)/activate && seed-gen $(ARGS)
|
|
|
|
$(VENV)/pyvenv.cfg: pyproject.toml
|
|
uv venv $(VENV)
|
|
@. $(VENV_BIN)/activate && uv pip install -e '.[$(INSTALL_EXTRA)]'
|
|
|
|
.PHONY: lint
|
|
lint: $(VENV)/pyvenv.cfg
|
|
. $(VENV_BIN)/activate && \
|
|
ruff format --check && \
|
|
ruff check && \
|
|
mypy
|
|
. $(VENV_BIN)/activate && \
|
|
interrogate -c pyproject.toml .
|
|
|
|
.PHONY: reformat
|
|
reformat:
|
|
. $(VENV_BIN)/activate && \
|
|
ruff format && \
|
|
ruff check --fix
|
|
|
|
.PHONY: test tests
|
|
test tests: $(VENV)/pyvenv.cfg
|
|
. $(VENV_BIN)/activate && \
|
|
pytest --cov=$(PY_IMPORT) $(T) $(TEST_ARGS) && \
|
|
python -m coverage report -m $(COV_ARGS)
|
|
|
|
.PHONY: doc
|
|
doc:
|
|
@echo "No documentation set up"
|
|
|
|
.PHONY: package
|
|
package: $(VENV)/pyvenv.cfg
|
|
uv build
|
|
|
|
.PHONY: edit
|
|
edit:
|
|
$(EDITOR) $(ALL_PY_SRCS)
|