#!/usr/bin/env just --justfile
main_crate := 'sqlite-compressions'
# How to call the current just executable. Note that just_executable() may have `\` in Windows paths, so we need to quote it.
just := quote(just_executable())
# Define the name of the extension binary
bin_name := snakecase(main_crate)
# Allow override of the sqlite3 executable name
sqlite3 := 'sqlite3'
# cargo-binstall needs a workaround due to caching when used in CI
binstall_args := if env('CI', '') != '' {'--no-confirm --no-track --disable-telemetry'} else {''}
# location of the coverage output, used by CI
coverage_lcov := 'target/llvm-cov/lcov.info'
# if running in CI, treat warnings as errors by setting RUSTFLAGS and RUSTDOCFLAGS to '-D warnings' unless they are already set
# Use `CI=true just ci-test` to run the same tests as in GitHub CI.
# Use `just env-info` to see the current values of RUSTFLAGS and RUSTDOCFLAGS
ci_mode := if env('CI', '') != '' {'1'} else {''}
export RUSTFLAGS := env('RUSTFLAGS', if ci_mode == '1' {'-D warnings'} else {''})
export RUSTDOCFLAGS := env('RUSTDOCFLAGS', if ci_mode == '1' {'-D warnings'} else {''})
export RUST_BACKTRACE := env('RUST_BACKTRACE', if ci_mode == '1' {'1'} else {'0'})
@_default:
{{just}} --list
# Run benchmarks
bench:
cargo bench
open target/criterion/report/index.html
# Run integration tests and save its output as the new expected output
bless *args: (cargo-install 'cargo-insta')
cargo insta test --accept --unreferenced=delete {{args}}
# Build the project
build: build-lib build-ext
# Build extension binary
build-ext *args:
cargo build --example {{bin_name}} --no-default-features --features default_loadable_extension {{args}}
# Build the lib
build-lib:
cargo build --workspace
# Quick compile without building a binary
check:
cargo check --workspace --all-features --all-targets
# Generate LCOV coverage report for CI to upload to codecov.io
ci-coverage: env-info && \
(_coverage '--lcov' '--output-path' coverage_lcov)
rm -rf {{quote(parent_directory(coverage_lcov))}}
mkdir -p {{quote(parent_directory(coverage_lcov))}}
# Run all tests as expected by CI
ci-test: env-info test-fmt check clippy test test-ext test-doc && assert-git-is-clean
# Compile default features with minimal dependencies on the configured MSRV
ci-test-msrv:
{{just}} ci_mode=0 env-info _check-msrv-default
{{just}} assert-git-is-clean
# Set toolchain and run ci-test-msrv
ci-test-msrv-with-toolchain:
RUSTUP_TOOLCHAIN="$({{just}} get-msrv)" {{just}} ci-test-msrv
# Clean all build artifacts
clean:
cargo clean
# Run cargo clippy to lint the code
clippy *args:
cargo clippy --workspace --all-features --all-targets {{args}}
cargo clippy --no-default-features --features default_loadable_extension {{args}}
# Generate and open the HTML coverage report
coverage: (_coverage '--open')
# Clean, collect, and aggregate coverage using the requested report arguments
_coverage *report_args: (cargo-install 'cargo-llvm-cov')
cargo llvm-cov clean --workspace
cargo llvm-cov --no-report --workspace --all-targets
cargo llvm-cov --no-report --example {{bin_name}} --no-default-features --features default_loadable_extension
cargo llvm-cov report --include-build-script {{report_args}}
cross-build-ext *args:
cross build --example {{bin_name}} --no-default-features --features default_loadable_extension {{args}}
cross-build-ext-aarch64: (cross-build-ext '--target=aarch64-unknown-linux-gnu' '--release')
cross-test-ext-aarch64:
docker run \
--rm \
-v "$(pwd):/workspace" \
-w /workspace \
--entrypoint sh \
-e EXTENSION_FILE=target/aarch64-unknown-linux-gnu/release/examples/lib{{bin_name}} \
--platform linux/arm64 \
arm64v8/ubuntu \
-c 'apt-get update && apt-get install -y sqlite3 && tests/test-ext.sh'
# Build and open code documentation
docs *args='--open':
DOCS_RS=1 cargo doc --no-deps {{args}} --workspace --all-features
# Print environment info
env-info:
@echo "Running for '{{main_crate}}' crate {{if ci_mode == '1' {'in CI mode'} else {'in dev mode'} }} on {{os()}} / {{arch()}}"
@echo "PWD {{justfile_directory()}}"
{{just}} --version
rustc --version
cargo --version
rustup --version
@echo "RUSTFLAGS='$RUSTFLAGS'"
@echo "RUSTDOCFLAGS='$RUSTDOCFLAGS'"
@echo "RUST_BACKTRACE='$RUST_BACKTRACE'"
# Reformat all code `cargo fmt`. If nightly is available, use it for better results
fmt:
#!/usr/bin/env bash
set -euo pipefail
if (rustup toolchain list | grep nightly && rustup component list --toolchain nightly | grep rustfmt) &> /dev/null; then
echo 'Reformatting Rust code using nightly Rust fmt to sort imports'
cargo +nightly fmt --all -- --config imports_granularity=Module,group_imports=StdExternalCrate
else
echo 'Reformatting Rust with the stable cargo fmt. Install nightly with `rustup install nightly` for better results'
cargo fmt --all
fi
# Reformat all Cargo.toml files using cargo-sort
fmt-toml *args: (cargo-install 'cargo-sort')
cargo sort --workspace --grouped {{args}}
# Get a package field from the metadata
get-crate-field field package=main_crate: (assert-cmd 'jq')
@cargo metadata --no-deps --format-version 1 | jq -e -r '.packages | map(select(.name == "{{package}}")) | first | .{{field}} // error("Field \"{{field}}\" is missing in Cargo.toml for package {{package}}")'
# Get the minimum supported Rust version (MSRV) for the crate
get-msrv package=main_crate: (get-crate-field 'rust_version' package)
# Find the minimum supported Rust version (MSRV), update Cargo.toml, and test minimal dependencies
msrv: (cargo-install 'cargo-msrv')
cargo msrv find --write-msrv --ignore-lockfile -- {{just}} _check-msrv-default
# Compile the crate's default features using a dynamically generated minimal Cargo.lock
_check-msrv-default: (cargo-install 'cargo-minimal-versions') (cargo-install 'cargo-hack')
#!/usr/bin/env bash
set -euo pipefail
# cargo-msrv probes with rustup, but nested cargo subcommands may otherwise
# fall back to the default Cargo and emit flags unsupported by the candidate rustc.
toolchain="$(rustc --version | cut -d' ' -f2)"
export RUSTUP_TOOLCHAIN="$toolchain"
export CARGO="$(rustup which --toolchain "$toolchain" cargo)"
cargo minimal-versions check --direct --package {{main_crate}}
# Run cargo-release
release *args='': (cargo-install 'release-plz')
release-plz {{args}}
# Check semver compatibility with prior published version. Install it with `cargo install cargo-semver-checks`
semver *args: (cargo-install 'cargo-semver-checks')
cargo semver-checks --all-features {{args}}
# Switch to the minimum rusqlite version
set-min-rusqlite-version:
#!/usr/bin/env bash
set -euo pipefail
MIN_RUSQL_VER="$(grep '^rusqlite =.*version = ">=' Cargo.toml | sed -E 's/.*version = "[^"0-9]*([0-9.-]+).*/\1/')"
echo "Switching to minimum rusqlite version: $MIN_RUSQL_VER"
cargo update -p rusqlite --precise "$MIN_RUSQL_VER"
# Run all unit and integration tests
test: \
( test-one-lib ) \
( test-one-lib '--no-default-features' '--features' 'gzip,brotli,bzip2,bsdiff4,bsdiffraw' ) \
( test-one-lib '--no-default-features' '--features' 'trace,brotli' ) \
( test-one-lib '--no-default-features' '--features' 'trace,bsdiff4' ) \
( test-one-lib '--no-default-features' '--features' 'trace,bsdiffraw' ) \
( test-one-lib '--no-default-features' '--features' 'trace,bzip2' ) \
( test-one-lib '--no-default-features' '--features' 'trace,gzip' )
cargo test --doc # do not enable --all-features here as it will cause sqlite runtime errors
# Test documentation generation
test-doc: (docs '')
# Test extension by loading it into sqlite and running SQL tests
test-ext: build-ext
./tests/test-ext.sh
# Test code formatting
test-fmt: && (fmt-toml '--check' '--check-format')
cargo fmt --all -- --check
# Find unused dependencies. Uses `cargo-udeps`
udeps: (cargo-install 'cargo-udeps')
cargo +nightly udeps --workspace --all-features --all-targets
# Update all dependencies, including breaking changes. Requires nightly toolchain (install with `rustup install nightly`)
update:
cargo +nightly -Z unstable-options update --breaking
cargo update
# Ensure that a certain command is available
[private]
assert-cmd command:
@if ! type {{command}} > /dev/null; then \
echo "Command '{{command}}' could not be found. Please make sure it has been installed on your computer." ;\
exit 1 ;\
fi
# Make sure the git repo has no uncommitted changes
[private]
assert-git-is-clean:
@if [ -n "$(git status --untracked-files --porcelain)" ]; then \
>&2 echo "ERROR: git repo is no longer clean. Make sure compilation and tests artifacts are in the .gitignore, and no repo files are modified." ;\
>&2 echo "######### git status ##########" ;\
git status ;\
git --no-pager diff ;\
exit 1 ;\
fi
# Check if a certain Cargo command is installed, and install it if needed
[private]
cargo-install $COMMAND $INSTALL_CMD='' *args='':
#!/usr/bin/env bash
set -euo pipefail
if ! command -v $COMMAND > /dev/null; then
echo "$COMMAND could not be found. Installing..."
if ! command -v cargo-binstall > /dev/null; then
set -x
cargo install ${INSTALL_CMD:-$COMMAND} --locked {{args}}
{ set +x; } 2>/dev/null
else
set -x
cargo binstall ${INSTALL_CMD:-$COMMAND} {{binstall_args}} --locked {{args}}
{ set +x; } 2>/dev/null
fi
fi
[private]
is-sqlite3-available:
if ! command -v {{sqlite3}} > /dev/null; then \
echo "{{sqlite3}} executable could not be found" ;\
exit 1 ;\
fi
echo "Found {{sqlite3}} executable:"
{{sqlite3}} --version
[private]
test-one-lib *args:
@echo "### TEST {{args}} #######################################################################################################################"
cargo test {{args}}