Makefile 6.53 KiB
# Cargo supports posix jobserver protocol to restrict its parallelism.
# XXX: we don't need to propagate -jN if N > 1, make jobserver got us covered.
# https://www.gnu.org/software/make/manual/html_node/POSIX-Jobserver.html
MAKE_JOBSERVER_ARGS = $(filter -j%, $(MAKEFLAGS))
ifneq ($(MAKE_JOBSERVER_ARGS),-j1)
MAKE_JOBSERVER_ARGS =
endif
# Select appropriate pytest parallelism flags.
PYTEST_NUMPROCESSES = $(patsubst -j%, --numprocesses=%, $(filter -j%, $(MAKEFLAGS)))
ifeq ($(PYTEST_NUMPROCESSES),)
PYTEST_NUMPROCESSES = --numprocesses=auto
endif
# It should be possible to keep the flags to the bare minimum.
# Hence, we don't use `override` here but add it to all build prerequisites.
CARGO_FLAGS := --features webui --all
PYTEST_FLAGS :=
# For clarity and an ability to turn it off without overriding whole CARGO_FLAGS
ERROR_INJECTION := --features error_injection
# Devs may want to drop this flag using make LOCKED=
LOCKED := --locked
.PHONY: default
default: ;
.PHONY: tarantool-patch
tarantool-patch:
if test ! -f tarantool-sys/VERSION || \
test "${VER_TNT}" != "$(cat tarantool-sys/VERSION)"; then \
echo "${VER_TNT}" > tarantool-sys/VERSION; \
fi
# CARGO_FLAGS_EXTRA is meant to be set outside the makefile by user
.PHONY: build
build: tarantool-patch
if test -f ~/.cargo/env; then . ~/.cargo/env; fi && $(CARGO_ENV) \
cargo build $(LOCKED) $(MAKE_JOBSERVER_ARGS) $(CARGO_FLAGS) $(CARGO_FLAGS_EXTRA)
# There are 4 build options. 3 for each build profile (dev, fast-release, release).
# They are intended to be consumed by tests/local development.
# Remaining `build-release-pkg` is intended for packages we ship as our release artifacts.
# For now the only difference is absence of error_injection feature.
.PHONY: build-dev
build-dev: override CARGO_FLAGS += --profile=dev $(ERROR_INJECTION)
build-dev: build
.PHONY: build-fast-release
build-fast-release: override CARGO_FLAGS += --profile=fast-release $(ERROR_INJECTION)
build-fast-release: build
.PHONY: build-release
build-release: override CARGO_FLAGS += --profile=release $(ERROR_INJECTION)
build-release: build
.PHONY: build-release-pkg
build-release-pkg: override CARGO_FLAGS += --profile=release
build-release-pkg: build
# We have to specify target to disable ASan for proc macros, build.rs, etc.
# See https://github.com/rust-lang/cargo/issues/6375#issuecomment-444900324.
DEFAULT_TARGET := $(shell cargo -vV | sed -n 's|host: ||p')
# TODO: drop nightly features once sanitizers are stable.
.PHONY: build-asan-dev
build-asan-dev: override CARGO_ENV = RUSTC_BOOTSTRAP=1 RUSTFLAGS=-Zsanitizer=address
build-asan-dev: override CARGO_FLAGS += --profile=asan-dev --target=$(DEFAULT_TARGET)build-asan-dev: build
# XXX: make sure we pass proper flags to cargo test so resulting picodata binary is reused
# can be reused for python tests without recompilation
# Note: tarantool and tlua are skipped intentionally, no need to run their doc tests in picodata
# Note: gostech-audit-log and picodata-plugin tests simply do not pass:
# https://git.picodata.io/picodata/picodata/picodata/-/issues/1084
# https://git.picodata.io/picodata/picodata/picodata/-/issues/1085
# Note: non-doc tests and doc tests are run separately. This is intended to prevent excessive
# memory usage caused by doc tests compilation model. Doc tests are compiled as part of actual test run.
# So, each parallel thread lanuched by cargo test spawns full blown compiler for each doctest
# which at the end leads to OOM.
.PHONY: test
test:
cargo test $(LOCKED) $(MAKE_JOBSERVER_ARGS) $(CARGO_FLAGS) $(CARGO_FLAGS_EXTRA) $(ERROR_INJECTION) \
--exclude gostech-audit-log \
--exclude picodata-plugin \
--exclude sbroad-core \
--exclude tarantool \
--exclude tlua \
--tests
cargo test $(LOCKED) $(MAKE_JOBSERVER_ARGS) $(CARGO_FLAGS) $(CARGO_FLAGS_EXTRA) $(ERROR_INJECTION) \
--exclude gostech-audit-log \
--exclude picodata-plugin \
--exclude sbroad-core \
--exclude tarantool \
--exclude tlua \
--doc -- --test-threads 2
poetry run pytest $(PYTEST_NUMPROCESSES) $(PYTEST_FLAGS) -vv --color=yes
.PHONY: generate
generate:
poetry run python test/generate_snapshot.py
.PHONY: lint
lint:
cargo fmt --check
cargo check $(LOCKED) $(MAKE_JOBSERVER_ARGS)
cargo clippy --version
cargo clippy \
$(LOCKED) $(MAKE_JOBSERVER_ARGS) $(CARGO_FLAGS) \
--features=load_test,error_injection \
--exclude picodata-plugin \
--exclude sbroad-core \
--exclude tarantool \
--exclude tlua \
-- --deny clippy::all --no-deps
RUSTDOCFLAGS="-Dwarnings -Arustdoc::private_intra_doc_links" \
cargo doc \
$(LOCKED) $(MAKE_JOBSERVER_ARGS) \
--workspace --no-deps --document-private-items \
--exclude=tlua --exclude=sbroad-core --exclude=tarantool
poetry run flake8 ./test
poetry run black ./test --check --diff
poetry run mypy ./test
.PHONY: fmt
fmt:
cargo fmt
poetry run black ./test
.PHONY: clean
clean: cargo clean || true
git submodule foreach --recursive 'git clean -dxf && git reset --hard'
find . -type d -name __pycache__ | xargs -n 500 rm -rf
.PHONY: benchmark
benchmark:
PICODATA_LOG_LEVEL=warn poetry run pytest test/manual/test_benchmark.py
.PHONY: flamegraph
flamegraph:
PICODATA_LOG_LEVEL=warn poetry run pytest test/manual/test_benchmark.py --with-flamegraph
.PHONY: k6
k6:
PICODATA_LOG_LEVEL=warn poetry run pytest test/manual/sql/test_sql_perf.py
.PHONY: install
install:
mkdir -p $(DESTDIR)/usr/bin
install -m 0755 target/*/picodata $(DESTDIR)/usr/bin/picodata
# IMPORTANT. This rule is primarily used in CI pack stage. It repeats
# the behavior of build.rs `build_webui()`, but uses a different out_dir
# `picodata-webui/dist` instead of `target/debug/build/picodata-webui`
.PHONY: build-webui-bundle
build-webui-bundle:
yarn --cwd webui install \
--prefer-offline \
--frozen-lockfile \
--no-progress \
--non-interactive
yarn --cwd webui vite build \
--outDir dist \
--emptyOutDir
.PHONY: reset-submodules
reset-submodules:
git submodule foreach --recursive 'git clean -dxf && git reset --hard'
git submodule update --init --recursive
.PHONY: install-cargo
install-cargo:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs |\
sh -s -- -y --profile default --default-toolchain 1.76.0
.PHONY: centos7-cmake3
centos7-cmake3:
if [ ! -L /usr/bin/cmake3 ] ; then \
[ -f /usr/bin/cmake ] && sudo rm /usr/bin/cmake; \
sudo ln -s /usr/bin/cmake3 /usr/bin/cmake; \
fi
sudo find {/opt,/usr} -name libgomp.spec -delete
publish-picodata-plugin:
cargo publish --dry-run -p picodata-plugin-proc-macro
cargo publish -p picodata-plugin-proc-macro
cargo publish --dry-run -p picodata-plugin
cargo publish -p picodata-plugin