{{ message }}
Repository navigation
Expand file tree
/
Copy pathjustfile
More file actions
executable file
·1377 lines (1179 loc) · 41.9 KB
/
Copy pathjustfile
File metadata and controls
executable file
·1377 lines (1179 loc) · 41.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env -S just --working-directory . --justfile
# Whether coverage should be measured when running tests. Use `create-coverage-report` to create a report from the collected data.
coverage := env("COVERAGE_REPORT", "false")
# The output directory for documentation artifacts
output_dir := "output"
# Lists all available recipes.
default:
just --list
# Adds pre-commit and pre-push git hooks
[private]
add-hooks:
#!/usr/bin/env bash
set -euo pipefail
echo just run-pre-commit-hook > .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit
echo just run-pre-push-hook > .git/hooks/pre-push
chmod +x .git/hooks/pre-push
cat > .git/hooks/prepare-commit-msg <<'EOL'
#!/bin/sh
COMMIT_MSG_FILE=$1
COMMIT_SOURCE=$2
SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE"
if test -z "$COMMIT_SOURCE"; then
/usr/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE"
fi
EOL
chmod +x .git/hooks/prepare-commit-msg
# Shows the environment used by `cargo-llvm-cov`.
[private]
cargo-llvm-cov-show-env cargo_options='+stable' options='':
cargo {{ cargo_options }} llvm-cov show-env --sh {{ options }}
# Updates the local cargo index and displays which crates would be updated
[private]
dry-update:
cargo update --dry-run --verbose
# Ensures that one or more required commands are installed
[private]
ensure-command +command:
#!/usr/bin/env bash
set -euo pipefail
read -r -a commands <<< "{{ command }}"
for cmd in "${commands[@]}"; do
if ! command -v "$cmd" > /dev/null 2>&1 ; then
printf "Couldn't find required executable '%s'\n" "$cmd" >&2
exit 1
fi
done
# Retrieves the configured target directory for cargo.
[private]
get-cargo-target-directory:
just ensure-command cargo jq
cargo metadata --format-version 1 | jq -r .target_directory
# Gets names of all workspace members
[private]
get-workspace-members:
just ensure-command cargo jq
cargo metadata --format-version=1 | jq -r '.workspace_members[] | capture("/(?<name>[a-z-]+)#.*").name'
# Gets metadata version of a workspace member
[private]
get-workspace-member-version package:
#!/usr/bin/env bash
set -euo pipefail
version="$(cargo metadata --format-version=1 |jq -r --arg pkg {{ package }} '.workspace_members[] | capture("/(?<name>[a-z-]+)#(?<version>[0-9.]+)") | select(.name == $pkg).version')"
if (( $? != 0 )); then
exit 1
fi
readonly version="$version"
if [[ -z "$version" ]]; then
printf "No version found for package %s\n" {{ package }} >&2
exit 1
fi
printf "$version\n"
# Installs a `set` of ALPM packages.
[private]
install-alpm-package-set set:
#!/usr/bin/env bash
set -euo pipefail
readonly set="{{ set }}"
# Sets of basic default packages for various targets.
#
# Overrides take place in the switch case, when adding packages to the (initially empty) `packages` array.
readonly build_book=(
cargo-depgraph
graphviz
lychee
mdbook
mdbook-mermaid
)
readonly check_commits=(
git
cocogitto
codespell
committed
ripgrep
)
readonly check_dependencies=(cargo-deny)
readonly check_licenses=(
git
reuse
)
readonly check_links=(lychee)
readonly check_rust=(
cargo-hack
clang
python
)
readonly check_shell=(
ripgrep
shellcheck
tangler
)
readonly check_spelling=(codespell)
readonly check_unused=(
cargo-machete
jq
)
readonly dev=(
biome
cargo-insta
git-cliff
miniserve
release-plz
voa-verifiers-arch
watchexec
)
readonly docs=(
clang
jq
python
uv
)
readonly format=(
biome
cargo-sort-derives
clang
mado
taplo
uv
)
readonly lint_website=(
biome
nodejs
pnpm
zola
)
readonly manpages=(
clang
lowdown
rust-script
)
readonly pkgbuild=(alpm-pkgbuild-bridge)
readonly publish=(
clang
jq
maturin
uv
zig
)
readonly python_dev=(
maturin
uv
zig
)
readonly rust_dev=(rustup)
readonly test=(
cargo-nextest
clang
meson
)
readonly test_containerized=(podman)
readonly test_coverage=(
cargo-hack
cargo-llvm-cov
cargo-nextest
clang
jq
maturin
meson
python
uv
)
readonly test_readmes=(
clang
diffutils
jq
meson
rust-script
tangler
)
# Start with an empty set of packages and add to it in the below switch-case.
packages=()
case "$set" in
all)
packages+=(
"${build_book[@]}"
"${check_commits[@]}"
"${check_spelling[@]}"
"${check_shell[@]}"
"${check_rust[@]}"
"${check_unused[@]}"
"${check_dependencies[@]}"
"${check_licenses[@]}"
"${check_links[@]}"
"${dev[@]}"
"${docs[@]}"
"${format[@]}"
"${lint_website[@]}"
"${manpages[@]}"
"${pkgbuild[@]}"
"${python_dev[@]}"
"${rust_dev[@]}"
"${test[@]}"
"${test_containerized[@]}"
"${test_coverage[@]}"
"${test_readmes[@]}"
)
;;
book)
packages+=(
"${build_book[@]}"
"${docs[@]}"
"${lint_website[@]}"
)
;;
commits)
packages+=("${check_commits[@]}")
;;
containerized)
packages+=(
"${test_coverage[@]}"
"${test_containerized[@]}"
)
;;
coverage)
packages+=("${test_coverage[@]}")
;;
docs)
packages+=("${docs[@]}")
;;
dependencies)
packages+=("${check_dependencies[@]}")
;;
formatting)
packages+=("${format[@]}")
;;
licenses)
packages+=("${check_licenses[@]}")
;;
lint-website)
packages+=("${lint_website[@]}")
;;
links)
packages+=("${check_links[@]}")
;;
manpages)
packages+=("${manpages[@]}")
;;
publish)
packages+=("${publish[@]}")
;;
python-dev)
packages+=(
"${pkgbuild[@]}"
"${python_dev[@]}"
"${rust_dev[@]}"
)
;;
readmes)
packages+=("${test_readmes[@]}")
;;
rust)
packages+=("${check_rust[@]}")
;;
rust-dev)
packages+=(
"${pkgbuild[@]}"
"${rust_dev[@]}"
)
;;
shell)
packages+=("${check_shell[@]}")
;;
spelling)
packages+=("${check_spelling[@]}")
;;
test)
packages+=("${test[@]}")
;;
unused)
packages+=("${check_unused[@]}")
;;
*)
printf 'Invalid package set %s' "$set" >&2
exit 1
esac
just ensure-command pacman run0
# Deduplicate using an associative array
declare -A unique_packages
for package in "${packages[@]}"; do
if [[ ! "${unique_packages[$package]+_}" ]]; then
unique_packages["$package"]=1
fi
done
# Use run0 when not root
command=()
id="$(id -u)"
if (( $? != 0 )); then
exit 1
fi
readonly id="$id"
if (( "$id" > 0 )); then
command+=(run0)
fi
command+=(
pacman -Su --needed --noconfirm
)
"${command[@]}" "${!unique_packages[@]}"
# Checks if a string matches a workspace member exactly
[private]
is-workspace-member package:
#!/usr/bin/env bash
set -euo pipefail
workspace_members="$(just get-workspace-members)"
if (( $? != 0 )); then
exit 1
fi
mapfile -t workspace_members <<< "$workspace_members"
for name in "${workspace_members[@]}"; do
if [[ "$name" == {{ package }} ]]; then
exit 0
fi
done
exit 1
# Runs checks and tests before creating a commit.
[private]
run-pre-commit-hook: check docs test-docs
just test --features cli
# Runs checks before pushing commits to remote repository.
[private]
run-pre-push-hook: check-commits
# Builds the documentation book using mdbook and stages all necessary rustdocs alongside
[group('build')]
build-book:
#!/usr/bin/env bash
set -euo pipefail
just ensure-command cargo cargo-depgraph dot jq lychee mdbook mdbook-mermaid
# Build the local dependency graph.
cargo depgraph --workspace-only | dot -Tpng > resources/docs/src/api-docs/dependency_graph.png
cargo_target_dir="$(just get-cargo-target-directory)"
if (( $? != 0 )); then
exit 1
fi
readonly cargo_target_dir="$cargo_target_dir"
readonly output_dir="{{ output_dir }}"
readonly rustdoc_dir="$output_dir/docs/rustdoc/"
workspace_members="$(just get-workspace-members)"
if (( $? != 0 )); then
exit 1
fi
mapfile -t workspace_members <<< "$workspace_members"
just docs
mdbook-mermaid install resources/docs/
mdbook build resources/docs/
# move rust docs to their own namespaced dir
mkdir -p "$rustdoc_dir"
for name in "${workspace_members[@]}"; do
cp -r "$cargo_target_dir/doc/${name//-/_}" "$rustdoc_dir"
done
# move python docs
cp -r "$cargo_target_dir/pdoc/" "$output_dir/docs/pdoc"
cp -r "$cargo_target_dir/doc/"{search.*,src,static.files,trait.impl,type.impl} "$rustdoc_dir"
cp -r "$cargo_target_dir/doc/"*.{js,html} "$rustdoc_dir"
if [[ ! -f "alpm-lint-website/themes/linkita/theme.toml" ]]; then
echo "The alpm-lint-website linkita submodule does not exist"
echo "Did you clone the submodule? Check the contribution guidelines."
exit 1
fi
just --justfile alpm-lint-website/justfile build
cp -r alpm-lint-website/public "$output_dir/docs/lints"
lychee --root-dir "$output_dir/docs" "$output_dir/docs/api-docs/"
# Build local documentation
[group('build')]
docs:
#!/usr/bin/env bash
set -euo pipefail
RUSTDOCFLAGS='-D warnings' cargo doc --document-private-items --no-deps
cargo_target_dir="$(just get-cargo-target-directory)"
if (( $? != 0 )); then
exit 1
fi
readonly cargo_target_dir="$cargo_target_dir"
uv run --directory python-alpm pdoc -d google -o "$cargo_target_dir/pdoc/" alpm
# Render `manpages`, `shell_completions` or `specifications` (`kind`) of a given package (`pkg`).
[group('build')]
generate kind pkg:
#!/usr/bin/bash
set -Eeuo pipefail
readonly output_dir="{{ output_dir }}"
readonly pkg="{{ pkg }}"
readonly kind="{{ kind }}"
mkdir --parents "$output_dir"
script="$(mktemp --suffix=.ers)"
readonly script="$script"
# remove temporary script file on exit
cleanup() (
if [[ -n "${script:-}" ]]; then
rm -f "$script"
fi
)
trap cleanup EXIT
case "$kind" in
manpages|shell_completions)
modules=()
case "$pkg" in
alpm-db)
modules+=("::desc" "::files")
;;
alpm-repo-db)
modules+=("::desc" "::files")
;;
*)
modules+=("")
;;
esac
for module in "${modules[@]}"; do
sed "s/PKG/$pkg/;s#PATH#$PWD/$pkg#g;s/KIND/$kind/g;s/MODULE/$module/g" > "$script" < .rust-script/allgen.ers
chmod +x "$script"
"$script" "$output_dir/$kind"
done
;;
specifications)
output_kind=manpages
mkdir -p "$output_dir/$output_kind/"
for file in "$PWD/$pkg/resources/specification/"*.md; do
file_name="$(basename "$file")"
output_file="${file_name/.md}"
section="${output_file/*.}"
lowdown -s -t man -M section="$section" -o "$output_dir/$output_kind/$output_file" "$file"
done
;;
*)
printf 'Only "manpages", "shell_completions" or "specifications" are supported targets.\n'
exit 1
esac
# Generates shell completions
[group('build')]
generate-completions:
just generate shell_completions alpm-buildinfo
just generate shell_completions alpm-db
just generate shell_completions alpm-lint
just generate shell_completions alpm-mtree
just generate shell_completions alpm-pkginfo
just generate shell_completions alpm-repo-db
just generate shell_completions alpm-srcinfo
# Generates all manpages and specifications
[group('build')]
generate-manpages-and-specs:
just generate manpages alpm-buildinfo
just generate manpages alpm-db
just generate manpages alpm-lint
just generate manpages alpm-mtree
just generate manpages alpm-pkginfo
just generate manpages alpm-srcinfo
just generate specifications alpm-buildinfo
just generate specifications alpm-db
just generate specifications alpm-mtree
just generate specifications alpm-package
just generate specifications alpm-pkginfo
just generate specifications alpm-repo
just generate specifications alpm-repo-db
just generate specifications alpm-srcinfo
just generate specifications alpm-state-repo
just generate specifications alpm-types
[doc('Builds the Python alpm package for a given platform (`platform`).
Supported platforms are `all` (prepares sdist and wheels for x86_64, aarch64 and riscv64),
`sdist` (only source distribution), `current` (builds wheel for current platform) or any valid `--target` value for maturin')]
[group('build')]
[working-directory('python-alpm')]
build-python platform="current":
#!/usr/bin/env bash
set -euo pipefail
readonly platform="{{ platform }}"
just ensure-command maturin zig
case "$platform" in
"all")
# We use zig cc to create manylinux compatible wheels
# this skips the need for running this in a manylinux container
just ensure-command rustup
rustup target add x86_64-unknown-linux-gnu aarch64-unknown-linux-gnu riscv64gc-unknown-linux-gnu
maturin sdist -o dist
maturin build --release --zig --target=x86_64-unknown-linux-gnu -o dist
maturin build --release --zig --target=aarch64-unknown-linux-gnu -o dist
maturin build --release --zig --target=riscv64gc-unknown-linux-gnu -o dist
;;
"sdist")
maturin sdist -o dist
;;
"current")
maturin build --release --zig -o dist
;;
*)
just ensure-command rustup
rustup target add "$platform"
maturin build --release --zig --target="$platform" -o dist
esac
# Runs all benchmarks.
[group('check')]
bench:
# --bench '*', otherwise a lot of noise about 'ignored' non-benchmark tests
cargo bench --bench '*'
# Checks source code formatting
[group('check')]
check-formatting:
just ensure-command biome cargo-sort-derives mado taplo uv
just --fmt --check
biome check --indent-style=space --expand=always renovate.json
# We're using nightly to properly group imports, see rustfmt.toml
cargo +nightly fmt -- --check
taplo format --check
# Checks for consistent sorting of rust derives
cargo sort-derives --check
mado check
uv run --directory python-alpm ruff format --check
# Runs all check targets
[group('check')]
[parallel]
check: check-spelling check-formatting check-shell-code check-rust-code check-dependencies check-python-code check-unused-deps check-licenses check-links
# Checks commit messages for correctness
[group('check')]
check-commits:
#!/usr/bin/env bash
set -euo pipefail
just ensure-command codespell cog committed rg
readonly default_branch="${CI_DEFAULT_BRANCH:-main}"
if ! git rev-parse --verify "origin/$default_branch" > /dev/null 2>&1; then
printf "The default branch '%s' does not exist!\n" "$default_branch" >&2
exit 1
fi
tmpdir="$(mktemp --dry-run --directory)"
readonly check_tmpdir="$tmpdir"
mkdir -p "$check_tmpdir"
# remove temporary dir on exit
cleanup() (
if [[ -n "${check_tmpdir:-}" ]]; then
rm -rf "${check_tmpdir}"
fi
)
trap cleanup EXIT
for commit in $(git rev-list "origin/${default_branch}.."); do
printf "Checking commit %s\n" "$commit"
commit_message="$(git show -s --format=%B "$commit")"
codespell_config="$(mktemp --tmpdir="$check_tmpdir")"
# either use the commit's .codespellrc or create one
if git show "$commit:.codespellrc" > /dev/null 2>&1; then
git show "$commit:.codespellrc" > "$codespell_config"
else
printf "[codespell]\nskip = .cargo,.git,target,.env,Cargo.lock\nignore-words-list = crate\n" > "$codespell_config"
fi
if ! rg -q "Signed-off-by: " <<< "$commit_message"; then
printf "Commit %s ❌️\n" "$commit" >&2
printf "The commit message lacks a \"Signed-off-by\" line.\n" >&2
printf "%s\n" \
" Please use:" \
" git rebase --signoff main && git push --force-with-lease" \
" See https://developercertificate.org/ for more details." >&2
exit 1
elif ! codespell --config "$codespell_config" - <<< "$commit_message"; then
printf "Commit %s ❌️\n" "$commit" >&2
printf "The spelling of the commit message needs improvement.\n" >&2
exit 1
elif ! cog verify "$commit_message"; then
printf "Commit %s ❌️\n" "$commit" >&2
printf "%s\n" \
"The commit message is not a conventional commit message:" \
"$commit_message" \
"See https://www.conventionalcommits.org/en/v1.0.0/ for more details." >&2
exit 1
elif ! committed "$commit"; then
printf "Commit %s ❌️\n" "$commit" >&2
printf "%s\n" \
"The commit message does not meet the required standards:" \
"$commit_message"
exit 1
else
printf "Commit %s ✅️\n\n" "$commit"
fi
done
# Checks for issues with dependencies
[group('check')]
check-dependencies: dry-update
cargo deny --features cli check
# Checks licensing status
[group('check')]
check-licenses:
just ensure-command reuse
reuse lint
# Check for stale links in documentation
[group('check')]
check-links:
just ensure-command lychee
lychee .
# Checks the Rust source code using cargo-clippy.
[group('check')]
check-rust-code:
just ensure-command cargo cargo-clippy
cargo clippy --features cli --all-targets --workspace -- -D warnings
# Checks the Rust source code using cargo-clippy (in all relevant feature permutations) in succession.
[group('check')]
check-rust-code-all:
just ensure-command cargo cargo-clippy cargo-hack
cargo +stable hack --exclude-features _winnow-debug --feature-powerset clippy --all-targets --locked -- -D warnings
# Checks the Python source code using ruff and mypy.
[group('check')]
check-python-code:
uv run --directory python-alpm ruff check
uv run --directory python-alpm mypy --strict .
# Checks shell code using shellcheck.
[group('check')]
check-shell-code:
just check-shell-readme alpm-buildinfo
just check-shell-readme alpm-mtree
just check-shell-readme alpm-pkginfo
just check-shell-readme alpm-srcinfo
just check-shell-recipe 'test-readme alpm-buildinfo'
just check-shell-recipe 'test-readme alpm-pkginfo'
just check-shell-recipe 'test-readme alpm-srcinfo'
just check-shell-recipe 'test-readme alpm-db'
just check-shell-recipe build-book
just check-shell-recipe check-commits
just check-shell-recipe check-unused-deps
just check-shell-recipe ci-publish
just check-shell-recipe containerized-integration-tests
just check-shell-recipe 'generate shell_completions alpm-buildinfo'
just check-shell-recipe 'install-alpm-package-set all'
just check-shell-recipe 'is-workspace-member alpm-buildinfo'
just check-shell-recipe 'prepare-release alpm-buildinfo'
just check-shell-recipe 'release alpm-buildinfo'
just check-shell-recipe 'release python-alpm'
just check-shell-recipe flaky
just check-shell-recipe test
just check-shell-recipe test-docs
just check-shell-recipe test-docs-all
just check-shell-recipe test-python
just check-shell-recipe docs
just check-shell-recipe 'ensure-command test'
just check-shell-recipe virtualized-integration-tests
just check-shell-recipe build-python
just check-shell-script alpm-srcinfo/tests/generate_srcinfo.bash
just check-shell-script .cargo/runner.sh
# Checks the script examples of a project's README using shellcheck.
[group('check')]
check-shell-readme project:
just ensure-command shellcheck tangler
tangler bash < {{ project }}/README.md | shellcheck --shell bash -
# Checks justfile recipe relying on shell semantics using shellcheck.
[group('check')]
check-shell-recipe recipe:
just ensure-command rg shellcheck
just --verbose --verbose --dry-run {{ recipe }} 2>&1 | rg --ignore-case --invert-match '===> Running recipe' | shellcheck -
# Checks a shell script using shellcheck.
[group('check')]
check-shell-script file:
just ensure-command shellcheck
shellcheck --shell bash {{ file }}
# Checks common spelling mistakes
[group('check')]
check-spelling:
just ensure-command codespell
codespell
# Checks for unused dependencies
[group('check')]
check-unused-deps:
#!/usr/bin/env bash
set -euo pipefail
just ensure-command cargo-machete
workspace_members="$(just get-workspace-members)"
if (( $? != 0 )); then
exit 1
fi
mapfile -t workspace_members <<< "$workspace_members"
for name in "${workspace_members[@]}"; do
cargo machete "$name"
done
# Adds needed git configuration for the local repository
[group('dev')]
configure-git:
# Enforce gpg signed keys for this repository
git config commit.gpgsign true
just add-hooks
# Installs all tools required for development
[group('dev')]
dev-install:
just install-alpm-package-set all
just install-rust-dev-tools
# Installs all binaries of the workspace
[group('dev')]
install-workspace-binaries:
#!/usr/bin/env bash
set -euo pipefail
workspace_members="$(just get-workspace-members)"
if (( $? != 0 )); then
exit 1
fi
mapfile -t workspace_members <<< "$workspace_members"
# Workspace members without a binary
ignored_members=(
alpm-common
alpm-compress
alpm-db
alpm-lint-config
alpm-package
alpm-parsers
alpm-pkgbuild
alpm-state-repo
alpm-repo
alpm-repo-db
alpm-types
python-alpm
)
for name in "${workspace_members[@]}"; do
# Make sure we don't try to install any of the ignored binaries.
skip=false
for ignored in "${ignored_members[@]}"; do
if [[ "$name" == "$ignored" ]]; then
skip=true
break
fi
done
if [ "$skip" = true ]; then
continue
fi
echo "Installing $name"
cargo install --locked --path "$name" --features cli
done
# Fixes common issues. Files need to be git add'ed
[group('dev')]
fix:
#!/usr/bin/env bash
set -euo pipefail
just ensure-command biome cargo codespell git uv
if ! git diff-files --quiet ; then
echo "Working tree has changes. Please stage them: git add ."
exit 1
fi
codespell --write-changes
just --unstable --fmt
biome format --write --indent-style=space --expand=always renovate.json
cargo clippy --fix --allow-staged
# fmt must be last as clippy's changes may break formatting
cargo +nightly fmt
uv run --directory python-alpm ruff format
uv run --directory python-alpm ruff check --fix
# Installs all Rust tools required for development
[group('dev')]
install-rust-dev-tools:
rustup default stable
rustup component add clippy
# Install nightly as we use it for formatting rules and test coverage.
rustup toolchain install nightly
rustup component add --toolchain nightly rustfmt
# llvm-tools-preview for code coverage
rustup component add llvm-tools-preview
rustup component add --toolchain nightly llvm-tools-preview
# Continuously run integration tests for a given number of rounds
[group('test')]
flaky test='just test-readme alpm-buildinfo' rounds='999999999999':
#!/usr/bin/bash
set -euo pipefail
seq 1 {{ rounds }} | while read -r counter; do
printf "Running flaky tests (%d/{{ rounds }})...\n" "$counter"
sleep 1
{{ test }}
echo
done
# Cleans up all temporary untracked directories, including build caches and such.
[group('dev')]
clean:
# Rust
rm -rf target
# Python
rm -rf python-alpm/.mypy_cache
rm -rf python-alpm/.ruff_cache
rm -rf python-alpm/.venv
# Book
rm -rf "{{ output_dir }}"
# Serves the documentation book using miniserve
[group('dev')]
serve-book: build-book
just ensure-command miniserve
miniserve --index=index.html {{ output_dir }}/docs
# Watches the documentation book contents and rebuilds on change using mdbook (useful for development)
[group('dev')]
watch-book:
just ensure-command watchexec
watchexec --exts md,toml,js --delay-run 5s -- just build-book
# Runs integration tests guarded by the `_containerized-integration-test` feature, located in modules named `containerized` (accepts `cargo nextest run` options via `options`).
[group('test')]
containerized-integration-tests *options='--locked --workspace':
#!/usr/bin/env bash
set -euo pipefail
readonly coverage="{{ coverage }}"
read -r -a options <<< "{{ options }}"
if [[ "$coverage" == "true" ]]; then
just ensure-command bash cargo cargo-llvm-cov cargo-nextest jq podman
# shellcheck source=/dev/null
source <(just cargo-llvm-cov-show-env)
cargo +stable llvm-cov clean --workspace
else
just ensure-command bash cargo cargo-nextest jq podman
fi
cargo +stable build --examples --bins
cargo +stable nextest run --features _containerized-integration-test,cli --filterset 'kind(test) and binary_id(/::containerized$/)' "${options[@]}"
[doc('Creates code coverage report for all projects from all available sources.
When providing `with-docs` to the `mode` parameter, this also includes doc test coverage in the report (requires nightly).
The `metrics_name` parameter can be used to override the metrics name in the `coverage-metrics.txt` file used by GitLab.')]
[group('test')]
create-coverage-report output_type="cobertura" mode="without-docs" metrics_name="Test-coverage":
#!/usr/bin/env bash
set -euo pipefail
readonly metrics_name="{{ metrics_name }}"
readonly mode="{{ mode }}"
readonly output_type="{{ output_type }}"
cargo_target_dir="$(just get-cargo-target-directory)"
if (( $? != 0 )); then
exit 1
fi
readonly cargo_target_dir="$cargo_target_dir"
just ensure-command cargo-llvm-cov cargo-nextest jq
# Default options for cargo.
cargo_options=(+stable)
cargo_llvm_cov_options=()
# Creates a coverage report.
create_report() {
printf "Creating %s report %s\n" "$output_type" "$reporting_style..."
mkdir --parents "$cargo_target_dir/llvm-cov/"
# shellcheck source=/dev/null
source <(just cargo-llvm-cov-show-env "${cargo_options[@]}")
# NOTE: Here, we are not calling `cargo-llvm-cov clean` because we assume that it has been done in the recipe that generated the profraw data already.
# Create cobertura coverage report
cargo "${cargo_options[@]}" llvm-cov report "${cargo_llvm_cov_options[@]}"
}
# Writes to '$CARGO_TARGET_DIR/llvm-cov/coverage-metrics.txt' for Gitlab CI metrics consumption.
# See also: https://docs.gitlab.com/ci/testing/metrics_reports/
#
# Running this function, it is assumed, that create_report has been run before.
create_metrics() {
printf 'Creating coverage metrics...\n'
# Get total coverage percentage from summary
percentage="$(cargo "${cargo_options[@]}" llvm-cov report "${cargo_llvm_cov_metrics_options[@]}" | jq '.data[0].totals.lines.percent')"
if (( $? != 0 )); then
exit 1
fi
# Trim percentage to 4 decimal places.
percentage="$(LC_NUMERIC=C printf "%.4f\n" "$percentage")"
if (( $? != 0 )); then
exit 1
fi
printf "%s %s\n" "$metrics_name" "$percentage" > "$cargo_target_dir/llvm-cov/coverage-metrics.txt"
printf "Test-coverage: %s%%\n" "$percentage"
}
You can’t perform that action at this time.