housekeeping: shellcheck for tests/functional/binary-cache.sh

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
This commit is contained in:
Cameron Dart 2024-06-03 13:39:01 -07:00 committed by John Ericson
parent 4a28ba7877
commit aeed835a2e

View file

@ -14,9 +14,9 @@ clearStore
clearCache clearCache
outPath=$(nix-build dependencies.nix --no-out-link) outPath=$(nix-build dependencies.nix --no-out-link)
nix copy --to file://$cacheDir $outPath nix copy --to file://"$cacheDir" "$outPath"
readarray -t paths < <(nix path-info --all --json --store file://$cacheDir | jq 'keys|sort|.[]' -r) readarray -t paths < <(nix path-info --all --json --store file://"$cacheDir" | jq 'keys|sort|.[]' -r)
[[ "${#paths[@]}" -eq 3 ]] [[ "${#paths[@]}" -eq 3 ]]
for path in "${paths[@]}"; do for path in "${paths[@]}"; do
[[ "$path" =~ -dependencies-input-0$ ]] \ [[ "$path" =~ -dependencies-input-0$ ]] \
@ -25,16 +25,16 @@ for path in "${paths[@]}"; do
done done
# Test copying build logs to the binary cache. # Test copying build logs to the binary cache.
expect 1 nix log --store file://$cacheDir $outPath 2>&1 | grep 'is not available' expect 1 nix log --store file://"$cacheDir" "$outPath" 2>&1 | grep 'is not available'
nix store copy-log --to file://$cacheDir $outPath nix store copy-log --to file://"$cacheDir" "$outPath"
nix log --store file://$cacheDir $outPath | grep FOO nix log --store file://"$cacheDir" "$outPath" | grep FOO
rm -rf $TEST_ROOT/var/log/nix rm -rf "$TEST_ROOT/var/log/nix"
expect 1 nix log $outPath 2>&1 | grep 'is not available' expect 1 nix log "$outPath" 2>&1 | grep 'is not available'
nix log --substituters file://$cacheDir $outPath | grep FOO nix log --substituters file://"$cacheDir" "$outPath" | grep FOO
# Test copying build logs from the binary cache. # Test copying build logs from the binary cache.
nix store copy-log --from file://$cacheDir $(nix-store -qd $outPath)^'*' nix store copy-log --from file://"$cacheDir" "$(nix-store -qd "$outPath")"^'*'
nix log $outPath | grep FOO nix log "$outPath" | grep FOO
basicDownloadTests() { basicDownloadTests() {
# No uploading tests bcause upload with force HTTP doesn't work. # No uploading tests bcause upload with force HTTP doesn't work.
@ -46,15 +46,15 @@ basicDownloadTests() {
nix-env --substituters "file://$cacheDir" -f dependencies.nix -qas \* | grep -- "---" nix-env --substituters "file://$cacheDir" -f dependencies.nix -qas \* | grep -- "---"
nix-store --substituters "file://$cacheDir" --no-require-sigs -r $outPath nix-store --substituters "file://$cacheDir" --no-require-sigs -r "$outPath"
[ -x $outPath/program ] [ -x "$outPath/program" ]
# But with the right configuration, "nix-env -qas" should also work. # But with the right configuration, "nix-env -qas" should also work.
clearStore clearStore
clearCacheCache clearCacheCache
echo "WantMassQuery: 1" >> $cacheDir/nix-cache-info echo "WantMassQuery: 1" >> "$cacheDir/nix-cache-info"
nix-env --substituters "file://$cacheDir" -f dependencies.nix -qas \* | grep -- "--S" nix-env --substituters "file://$cacheDir" -f dependencies.nix -qas \* | grep -- "--S"
nix-env --substituters "file://$cacheDir" -f dependencies.nix -qas \* | grep -- "--S" nix-env --substituters "file://$cacheDir" -f dependencies.nix -qas \* | grep -- "--S"
@ -62,12 +62,12 @@ basicDownloadTests() {
x=$(nix-env -f dependencies.nix -qas \* --prebuilt-only) x=$(nix-env -f dependencies.nix -qas \* --prebuilt-only)
[ -z "$x" ] [ -z "$x" ]
nix-store --substituters "file://$cacheDir" --no-require-sigs -r $outPath nix-store --substituters "file://$cacheDir" --no-require-sigs -r "$outPath"
nix-store --check-validity $outPath nix-store --check-validity "$outPath"
nix-store -qR $outPath | grep input-2 nix-store -qR "$outPath" | grep input-2
echo "WantMassQuery: 0" >> $cacheDir/nix-cache-info echo "WantMassQuery: 0" >> "$cacheDir/nix-cache-info"
} }
@ -83,22 +83,22 @@ basicDownloadTests
# Test whether Nix notices if the NAR doesn't match the hash in the NAR info. # Test whether Nix notices if the NAR doesn't match the hash in the NAR info.
clearStore clearStore
nar=$(ls $cacheDir/nar/*.nar.xz | head -n1) nar=$(find "$cacheDir/nar/" -type f -name "*.nar.xz" | head -n1)
mv $nar $nar.good mv "$nar" "$nar".good
mkdir -p $TEST_ROOT/empty mkdir -p "$TEST_ROOT/empty"
nix-store --dump $TEST_ROOT/empty | xz > $nar nix-store --dump "$TEST_ROOT/empty" | xz > "$nar"
expect 1 nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o $TEST_ROOT/result 2>&1 | tee $TEST_ROOT/log expect 1 nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o "$TEST_ROOT/result" 2>&1 | tee "$TEST_ROOT/log"
grepQuiet "hash mismatch" $TEST_ROOT/log grepQuiet "hash mismatch" "$TEST_ROOT/log"
mv $nar.good $nar mv "$nar".good "$nar"
# Test whether this unsigned cache is rejected if the user requires signed caches. # Test whether this unsigned cache is rejected if the user requires signed caches.
clearStore clearStore
clearCacheCache clearCacheCache
if nix-store --substituters "file://$cacheDir" -r $outPath; then if nix-store --substituters "file://$cacheDir" -r "$outPath"; then
echo "unsigned binary cache incorrectly accepted" echo "unsigned binary cache incorrectly accepted"
exit 1 exit 1
fi fi
@ -107,131 +107,134 @@ fi
# Test whether fallback works if a NAR has disappeared. This does not require --fallback. # Test whether fallback works if a NAR has disappeared. This does not require --fallback.
clearStore clearStore
mv $cacheDir/nar $cacheDir/nar2 mv "$cacheDir/nar" "$cacheDir/nar2"
nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o $TEST_ROOT/result nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o "$TEST_ROOT/result"
mv $cacheDir/nar2 $cacheDir/nar mv "$cacheDir/nar2" "$cacheDir/nar"
# Test whether fallback works if a NAR is corrupted. This does require --fallback. # Test whether fallback works if a NAR is corrupted. This does require --fallback.
clearStore clearStore
mv $cacheDir/nar $cacheDir/nar2 mv "$cacheDir/nar" "$cacheDir/nar2"
mkdir $cacheDir/nar mkdir "$cacheDir/nar"
for i in $(cd $cacheDir/nar2 && echo *); do touch $cacheDir/nar/$i; done for i in $(cd "$cacheDir/nar2" && echo *); do touch "$cacheDir"/nar/"$i"; done
(! nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o $TEST_ROOT/result) (! nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o "$TEST_ROOT/result")
nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o $TEST_ROOT/result --fallback nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o "$TEST_ROOT/result" --fallback
rm -rf $cacheDir/nar rm -rf "$cacheDir/nar"
mv $cacheDir/nar2 $cacheDir/nar mv "$cacheDir/nar2" "$cacheDir/nar"
# Test whether building works if the binary cache contains an # Test whether building works if the binary cache contains an
# incomplete closure. # incomplete closure.
clearStore clearStore
rm -v $(grep -l "StorePath:.*dependencies-input-2" $cacheDir/*.narinfo) rm -v "$(grep -l "StorePath:.*dependencies-input-2" "$cacheDir"/*.narinfo)"
nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o $TEST_ROOT/result 2>&1 | tee $TEST_ROOT/log nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o "$TEST_ROOT/result" 2>&1 | tee "$TEST_ROOT/log"
grepQuiet "copying path.*input-0" $TEST_ROOT/log grepQuiet "copying path.*input-0" "$TEST_ROOT/log"
grepQuiet "copying path.*input-2" $TEST_ROOT/log grepQuiet "copying path.*input-2" "$TEST_ROOT/log"
grepQuiet "copying path.*top" $TEST_ROOT/log grepQuiet "copying path.*top" "$TEST_ROOT/log"
# Idem, but without cached .narinfo. # Idem, but without cached .narinfo.
clearStore clearStore
clearCacheCache clearCacheCache
nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o $TEST_ROOT/result 2>&1 | tee $TEST_ROOT/log nix-build --substituters "file://$cacheDir" --no-require-sigs dependencies.nix -o "$TEST_ROOT/result" 2>&1 | tee "$TEST_ROOT/log"
grepQuiet "don't know how to build" $TEST_ROOT/log grepQuiet "don't know how to build" "$TEST_ROOT/log"
grepQuiet "building.*input-1" $TEST_ROOT/log grepQuiet "building.*input-1" "$TEST_ROOT/log"
grepQuiet "building.*input-2" $TEST_ROOT/log grepQuiet "building.*input-2" "$TEST_ROOT/log"
grepQuiet "copying path.*input-0" $TEST_ROOT/log grepQuiet "copying path.*input-0" "$TEST_ROOT/log"
grepQuiet "copying path.*top" $TEST_ROOT/log grepQuiet "copying path.*top" "$TEST_ROOT/log"
# Create a signed binary cache. # Create a signed binary cache.
clearCache clearCache
clearCacheCache clearCacheCache
nix key generate-secret --key-name test.nixos.org-1 > $TEST_ROOT/sk1 nix key generate-secret --key-name test.nixos.org-1 > "$TEST_ROOT/sk1"
publicKey=$(nix key convert-secret-to-public < $TEST_ROOT/sk1) publicKey=$(nix key convert-secret-to-public < "$TEST_ROOT/sk1")
nix key generate-secret --key-name test.nixos.org-1 > $TEST_ROOT/sk2 nix key generate-secret --key-name test.nixos.org-1 > "$TEST_ROOT/sk2"
badKey=$(nix key convert-secret-to-public < $TEST_ROOT/sk2) badKey=$(nix key convert-secret-to-public < "$TEST_ROOT/sk2")
nix key generate-secret --key-name foo.nixos.org-1 > $TEST_ROOT/sk3 nix key generate-secret --key-name foo.nixos.org-1 > "$TEST_ROOT/sk3"
otherKey=$(nix key convert-secret-to-public < $TEST_ROOT/sk3) otherKey=$(nix key convert-secret-to-public < "$TEST_ROOT/sk3")
_NIX_FORCE_HTTP= nix copy --to file://$cacheDir?secret-key=$TEST_ROOT/sk1 $outPath _NIX_FORCE_HTTP='' nix copy --to file://"$cacheDir"?secret-key="$TEST_ROOT"/sk1 "$outPath"
# Downloading should fail if we don't provide a key. # Downloading should fail if we don't provide a key.
clearStore clearStore
clearCacheCache clearCacheCache
(! nix-store -r $outPath --substituters "file://$cacheDir") (! nix-store -r "$outPath" --substituters "file://$cacheDir")
# And it should fail if we provide an incorrect key. # And it should fail if we provide an incorrect key.
clearStore clearStore
clearCacheCache clearCacheCache
(! nix-store -r $outPath --substituters "file://$cacheDir" --trusted-public-keys "$badKey") (! nix-store -r "$outPath" --substituters "file://$cacheDir" --trusted-public-keys "$badKey")
# It should succeed if we provide the correct key. # It should succeed if we provide the correct key.
nix-store -r $outPath --substituters "file://$cacheDir" --trusted-public-keys "$otherKey $publicKey" nix-store -r "$outPath" --substituters "file://$cacheDir" --trusted-public-keys "$otherKey $publicKey"
# It should fail if we corrupt the .narinfo. # It should fail if we corrupt the .narinfo.
clearStore clearStore
cacheDir2=$TEST_ROOT/binary-cache-2 cacheDir2=$TEST_ROOT/binary-cache-2
rm -rf $cacheDir2 rm -rf "$cacheDir2"
cp -r $cacheDir $cacheDir2 cp -r "$cacheDir" "$cacheDir2"
for i in $cacheDir2/*.narinfo; do for i in "$cacheDir2"/*.narinfo; do
grep -v References $i > $i.tmp grep -v References "$i" > "$i".tmp
mv $i.tmp $i mv "$i".tmp "$i"
done done
clearCacheCache clearCacheCache
(! nix-store -r $outPath --substituters "file://$cacheDir2" --trusted-public-keys "$publicKey") (! nix-store -r "$outPath" --substituters "file://$cacheDir2" --trusted-public-keys "$publicKey")
# If we provide a bad and a good binary cache, it should succeed. # If we provide a bad and a good binary cache, it should succeed.
nix-store -r $outPath --substituters "file://$cacheDir2 file://$cacheDir" --trusted-public-keys "$publicKey" nix-store -r "$outPath" --substituters "file://$cacheDir2 file://$cacheDir" --trusted-public-keys "$publicKey"
unset _NIX_FORCE_HTTP unset _NIX_FORCE_HTTP
# Test 'nix verify --all' on a binary cache. # Test 'nix verify --all' on a binary cache.
nix store verify -vvvvv --all --store file://$cacheDir --no-trust nix store verify -vvvvv --all --store file://"$cacheDir" --no-trust
# Test local NAR caching. # Test local NAR caching.
narCache=$TEST_ROOT/nar-cache narCache=$TEST_ROOT/nar-cache
rm -rf $narCache rm -rf "$narCache"
mkdir $narCache mkdir "$narCache"
[[ $(nix store cat --store "file://$cacheDir?local-nar-cache=$narCache" $outPath/foobar) = FOOBAR ]] [[ $(nix store cat --store "file://$cacheDir?local-nar-cache=$narCache" "$outPath/foobar") = FOOBAR ]]
rm -rfv "$cacheDir/nar" rm -rfv "$cacheDir/nar"
[[ $(nix store cat --store "file://$cacheDir?local-nar-cache=$narCache" $outPath/foobar) = FOOBAR ]] [[ $(nix store cat --store "file://$cacheDir?local-nar-cache=$narCache" "$outPath/foobar") = FOOBAR ]]
(! nix store cat --store file://$cacheDir $outPath/foobar) (! nix store cat --store file://"$cacheDir" "$outPath/foobar")
# Test NAR listing generation. # Test NAR listing generation.
clearCache clearCache
# preserve quotes variables in the single-quoted string
# shellcheck disable=SC2016
outPath=$(nix-build --no-out-link -E ' outPath=$(nix-build --no-out-link -E '
with import ./config.nix; with import ./config.nix;
mkDerivation { mkDerivation {
@ -240,16 +243,18 @@ outPath=$(nix-build --no-out-link -E '
} }
') ')
nix copy --to file://$cacheDir?write-nar-listing=1 $outPath nix copy --to file://"$cacheDir"?write-nar-listing=1 "$outPath"
diff -u \ diff -u \
<(jq -S < $cacheDir/$(basename $outPath | cut -c1-32).ls) \ <(jq -S < "$cacheDir/$(basename "$outPath" | cut -c1-32).ls") \
<(echo '{"version":1,"root":{"type":"directory","entries":{"bar":{"type":"regular","size":4,"narOffset":232},"link":{"type":"symlink","target":"xyzzy"}}}}' | jq -S) <(echo '{"version":1,"root":{"type":"directory","entries":{"bar":{"type":"regular","size":4,"narOffset":232},"link":{"type":"symlink","target":"xyzzy"}}}}' | jq -S)
# Test debug info index generation. # Test debug info index generation.
clearCache clearCache
# preserve quotes variables in the single-quoted string
# shellcheck disable=SC2016
outPath=$(nix-build --no-out-link -E ' outPath=$(nix-build --no-out-link -E '
with import ./config.nix; with import ./config.nix;
mkDerivation { mkDerivation {
@ -258,14 +263,16 @@ outPath=$(nix-build --no-out-link -E '
} }
') ')
nix copy --to "file://$cacheDir?index-debug-info=1&compression=none" $outPath nix copy --to "file://$cacheDir?index-debug-info=1&compression=none" "$outPath"
diff -u \ diff -u \
<(cat $cacheDir/debuginfo/02623eda209c26a59b1a8638ff7752f6b945c26b.debug | jq -S) \ <(jq -S < "$cacheDir"/debuginfo/02623eda209c26a59b1a8638ff7752f6b945c26b.debug) \
<(echo '{"archive":"../nar/100vxs724qr46phz8m24iswmg9p3785hsyagz0kchf6q6gf06sw6.nar","member":"lib/debug/.build-id/02/623eda209c26a59b1a8638ff7752f6b945c26b.debug"}' | jq -S) <(echo '{"archive":"../nar/100vxs724qr46phz8m24iswmg9p3785hsyagz0kchf6q6gf06sw6.nar","member":"lib/debug/.build-id/02/623eda209c26a59b1a8638ff7752f6b945c26b.debug"}' | jq -S)
# Test against issue https://github.com/NixOS/nix/issues/3964 # Test against issue https://github.com/NixOS/nix/issues/3964
#
# preserve quotes variables in the single-quoted string
# shellcheck disable=SC2016
expr=' expr='
with import ./config.nix; with import ./config.nix;
mkDerivation { mkDerivation {
@ -275,22 +282,22 @@ expr='
} }
' '
outPath=$(nix-build --no-out-link -E "$expr") outPath=$(nix-build --no-out-link -E "$expr")
docPath=$(nix-store -q --references $outPath) docPath=$(nix-store -q --references "$outPath")
# $ nix-store -q --tree $outPath # $ nix-store -q --tree $outPath
# ...-multi-output # ...-multi-output
# +---...-multi-output-doc # +---...-multi-output-doc
nix copy --to "file://$cacheDir" $outPath nix copy --to "file://$cacheDir" "$outPath"
hashpart() { hashpart() {
basename "$1" | cut -c1-32 basename "$1" | cut -c1-32
} }
# break the closure of out by removing doc # break the closure of out by removing doc
rm $cacheDir/$(hashpart $docPath).narinfo rm "$cacheDir/$(hashpart "$docPath")".narinfo
nix-store --delete $outPath $docPath nix-store --delete "$outPath" "$docPath"
# -vvv is the level that logs during the loop # -vvv is the level that logs during the loop
timeout 60 nix-build --no-out-link -E "$expr" --option substituters "file://$cacheDir" \ timeout 60 nix-build --no-out-link -E "$expr" --option substituters "file://$cacheDir" \
--option trusted-binary-caches "file://$cacheDir" --no-require-sigs --option trusted-binary-caches "file://$cacheDir" --no-require-sigs