Something went wrong. Try again.
Monorepo for Tangled
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170set shell := ["bash", "-eu", "-o", "pipefail", "-c"]default: @just --listgen-config: cargo run -p knot-server -- config-template > example.tomlfmt: cargo fmt --allfmt-check: cargo fmt --all --checkclippy: cargo clippy --locked -p 'knot-*' --all-targets -- -D warningstest: cargo test --locked -p 'knot-*'fuzz crate='knot-pack' target='pack' time='60': cd crates/{{crate}}/fuzz && RUSTUP_TOOLCHAIN=nightly cargo fuzz run {{target}} -- -max_total_time={{time}}fuzz-ci: (fuzz "knot-pack" "pkt" "30") (fuzz "knot-pack" "pack" "30") (fuzz "knot-pack" "receive_commands" "30") (fuzz "knot-pack" "upload_args" "30") (fuzz "knot-git" "patch" "30") (fuzz "knot-cobs" "cob_change" "30") (fuzz "knot-cobs" "cob_ref" "30") (fuzz "knot-atproto" "pubkey" "30") (fuzz "knot-atproto" "did_document" "30") (fuzz "knot-edge" "spki" "30") (fuzz "knot-edge" "spki_pin" "30") (fuzz "knot-lfs" "transfer" "30") (fuzz "knot-lfs" "batch" "30") (fuzz "knot-lfs" "pointer" "30")bench filter='': cargo bench -p knot-bench --bench pack -- {{filter}} cargo bench -p knot-bench --bench cob -- {{filter}} cargo bench -p knot-bench --bench projection -- {{filter}}bench-scaling: cargo bench -p knot-bench --bench coldstartinstrument-tests: cargo test --locked -p knot-bench --features instrument --testsdifferential: cargo test -p knot-pack --test differentialt55xx *tests: internal_docs/t55xx/run.sh {{tests}}ci: fmt-check clippy test checks instrument-tests fuzz-cichecks: require-tools check-no-subprocess (check-no-banned-deps "no-sql" "an embedded database" "rusqlite|libsqlite3-sys|sqlx|sqlx-core|sled|fjall|redb") (check-no-banned-deps "no-native-git" "a native git or TLS shim" "git2|libgit2-sys|openssl-sys|zlib-ng|zlib-ng-sys") check-no-string-ids check-no-unguarded-receive check-fuzz-targets-enumerated check-workflow-toolchainrequire-tools: #!/usr/bin/env bash set -euo pipefail missing="" for tool in cargo comm cut find grep head just mktemp rm sed sort tr; do command -v "$tool" >/dev/null 2>&1 || missing="$missing $tool" done if [ -n "$missing" ]; then echo "require-tools failed, these aren't on PATH:$missing" >&2 exit 1 fi echo "ok: every tool the checks below run is on PATH"check-no-subprocess: #!/usr/bin/env bash set -euo pipefail hits=$(grep -rn --include="*.rs" --exclude-dir=_lex "process::Command" crates/*/src || [ $? = 1 ]) if [ -n "$hits" ]; then echo "no-subprocess check failed: server source spawns processes" >&2 echo "$hits" >&2 exit 1 fi echo "ok: no process spawning in server source"check-no-banned-deps name subject pattern: #!/usr/bin/env bash set -euo pipefail tree=$(cargo tree --locked -p knot-server --edges normal,build --prefix none | sort -u) hits=$(printf '%s\n' "$tree" | grep -iE '^({{pattern}}) v' || [ $? = 1 ]) if [ -n "$hits" ]; then echo "{{name}} check failed: {{subject}} is in the knot-server dependency tree" >&2 echo "$hits" >&2 exit 1 fi echo "ok: {{subject}} isn't in the knot-server dependency tree"check-no-string-ids: #!/usr/bin/env bash set -euo pipefail declared=$(grep -nE 'pub fn .*(-> *String|: *String\b)' crates/knot-types/src/ids.rs || [ $? = 1 ]) hits=$(printf '%s\n' "$declared" | grep -v 'fn to_hex' || [ $? = 1 ]) if [ -n "$hits" ]; then echo "no-string-ids check failed: a String-typed id crosses the knot-types boundary" >&2 echo "$hits" >&2 exit 1 fi echo "ok: no String-typed id crosses the knot-types boundary"check-no-unguarded-receive: #!/usr/bin/env bash set -euo pipefail called=$(grep -rn --include="*.rs" 'receive_pack(\|receive_pack_with_limits(' crates/*/src || [ $? = 1 ]) hits=$(printf '%s\n' "$called" | grep -v 'pub fn ' || [ $? = 1 ]) if [ -n "$hits" ]; then echo "no-unguarded-receive check failed: server source calls the unguarded receive path, use receive_pack_guarded" >&2 echo "$hits" >&2 exit 1 fi echo "ok: the unguarded receive path is reached only from tests"check-fuzz-targets-enumerated: #!/usr/bin/env bash set -euo pipefail disk=$(mktemp) recipe=$(mktemp) triplet=$(mktemp) trap 'rm -f "$disk" "$recipe" "$triplet"' EXIT find crates -path '*/fuzz/fuzz_targets/*.rs' -not -path '*/target/*' | sed -E 's#crates/([^/]+)/fuzz/fuzz_targets/(.+)\.rs#\1 \2#' | sort -u > "$disk" just --show fuzz-ci | grep -oE '\(fuzz "[^"]+" "[^"]+" "[^"]+"' | sed -E 's#\(fuzz "([^"]+)" "([^"]+)" "([^"]+)"#\1 \2 \3#' | sort -u > "$triplet" cut -d' ' -f1,2 "$triplet" > "$recipe" while read -r crate target secs; do if ! [[ "$secs" =~ ^[1-9][0-9]*$ ]]; then echo "fuzz-targets-enumerated check failed: target '$crate $target' runs for '$secs', not a positive number of seconds" >&2 exit 1 fi done < "$triplet" missing=$(comm -23 "$disk" "$recipe") extra=$(comm -13 "$disk" "$recipe") if [ -n "$missing" ] || [ -n "$extra" ]; then echo "fuzz-targets-enumerated check failed: the fuzz-ci recipe and the targets on disk disagree" >&2 if [ -n "$missing" ]; then echo "on disk but absent from fuzz-ci:" >&2 echo "$missing" >&2 fi if [ -n "$extra" ]; then echo "in fuzz-ci but no matching target on disk:" >&2 echo "$extra" >&2 fi exit 1 fi while read -r crate target; do manifest="crates/$crate/fuzz/Cargo.toml" if ! grep -qF "name = \"$target\"" "$manifest" || ! grep -qF "path = \"fuzz_targets/$target.rs\"" "$manifest"; then echo "fuzz-targets-enumerated check failed: $manifest has no [[bin]] declaring target '$target'" >&2 exit 1 fi entry=$(grep -oE 'knot_[a-z0-9_]+::fuzz::[a-z0-9_]+' "crates/$crate/fuzz/fuzz_targets/$target.rs" | head -1 | sed -E 's#.*::fuzz::##' || true) smoke="crates/$crate/tests/fuzz_smoke.rs" if [ -z "$entry" ] || ! grep -qE "fuzz::${entry}\(" "$smoke"; then echo "fuzz-targets-enumerated check failed: target '$target' entry point $(echo "$crate" | tr - _)::fuzz::$entry has no smoke-test coverage in $smoke" >&2 exit 1 fi done < "$disk" echo "ok: every fuzz target is enumerated in fuzz-ci, declared in its fuzz manifest, and smoke-tested"check-workflow-toolchain: #!/usr/bin/env bash set -euo pipefail locked=$(sed -n '/^ "fenix": {/,/^ }/p' ../flake.lock | sed -nE 's/.*"rev": "([0-9a-f]{40})".*/\1/p' | head -1) if [ -z "$locked" ]; then echo "workflow-toolchain check failed: no fenix node with a revision in flake.lock" >&2 exit 1 fi used=$(grep -hoE 'github:nix-community/fenix/[0-9a-f]{40}' ../.tangled/workflows/*.yml | sed -E 's#.*/##' | sort -u || [ $? = 1 ]) if [ -z "$used" ]; then echo "workflow-toolchain check failed: no workflow in ../.tangled/workflows references a fenix revision" >&2 exit 1 fi if [ "$used" != "$locked" ]; then echo "workflow-toolchain check failed: flake.lock records fenix $locked and the workflows reference '$used'" >&2 exit 1 fi echo "ok: every workflow builds with the fenix revision flake.lock records"