shellcheck: fix lint of scripts in tests

2022-08-16 21:00:00 +02:00
parent a59c3b4b8a
commit f184bb34e6
14 changed files with 82 additions and 59 deletions
--- a/test/ci/build-to-cachix.sh
+++ b/test/ci/build-to-cachix.sh
@@ -6,21 +6,21 @@

 set -euo pipefail

-CACHIX_SIGNING_KEY=${CACHIX_SIGNING_KEY:-}
+CACHIX_SIGNING_KEY="${CACHIX_SIGNING_KEY:-}"
 cachixCache=nix-bitcoin

 trap 'echo Error at line $LINENO' ERR

 tmpDir=$(mktemp -d -p /tmp)
-trap "rm -rf $tmpDir" EXIT
+trap 'rm -rf $tmpDir' EXIT

 ## Instantiate

-time nix-instantiate "$@" --add-root $tmpDir/drv --indirect > /dev/null
-printf "instantiated "; realpath $tmpDir/drv
+time nix-instantiate "$@" --add-root "$tmpDir/drv" --indirect > /dev/null
+printf "instantiated "; realpath "$tmpDir/drv"

-outPath=$(nix-store --query $tmpDir/drv)
-if nix path-info --store https://$cachixCache.cachix.org $outPath &>/dev/null; then
+outPath=$(nix-store --query "$tmpDir/drv")
+if nix path-info --store "https://${cachixCache}.cachix.org" "$outPath" &>/dev/null; then
    echo "$outPath has already been built successfully."
    exit 0
 fi
@@ -28,7 +28,7 @@ fi
 ## Build

 if [[ -v CIRRUS_CI ]]; then
-    cachix use $cachixCache
+    cachix use "$cachixCache"
 fi

 if [[ $CACHIX_SIGNING_KEY ]]; then
@@ -38,10 +38,10 @@ else
    buildCmd=nix-build
 fi

-$buildCmd --out-link $tmpDir/result $tmpDir/drv >/dev/null
+$buildCmd --out-link "$tmpDir/result" "$tmpDir/drv" >/dev/null

 if [[ $CACHIX_SIGNING_KEY ]]; then
-    cachix push $cachixCache $outPath
+    cachix push "$cachixCache" "$outPath"
 fi

-echo $outPath
+echo "$outPath"
--- a/test/ci/build.sh
+++ b/test/ci/build.sh
@@ -16,4 +16,5 @@ if [[ -v CIRRUS_CI ]]; then
    chmod o+rw /dev/kvm
 fi

+# shellcheck disable=SC2154
 "${BASH_SOURCE[0]%/*}/../run-tests.sh" --ci --scenario "$scenario"
--- a/test/lib/copy-src.sh
+++ b/test/lib/copy-src.sh
@@ -4,15 +4,18 @@
 tmp=$(mktemp -d '/tmp/nix-bitcoin-src.XXXXX')

 # Move source cache if it exists (atomic)
-mv /tmp/nix-bitcoin-src $tmp/src 2>/dev/null || true
+mv /tmp/nix-bitcoin-src "$tmp/src" 2>/dev/null || true

 atExit() {
    # Set the current src as the source cache (atomic)
-    mv -T $tmp/src /tmp/nix-bitcoin-src 2>/dev/null || true
-    rm -rf $tmp
+    mv -T "$tmp/src" /tmp/nix-bitcoin-src 2>/dev/null || true
+    rm -rf "$tmp"
 }
 trap "atExit" EXIT

-rsync -a --delete --exclude='.git*' "$scriptDir/../" $tmp/src
+# shellcheck disable=SC2154
+rsync -a --delete --exclude='.git*' "$scriptDir/../" "$tmp/src"
 echo "Copied src"
-_nixBitcoinInCopiedSrc=1 $tmp/src/test/run-tests.sh "${args[@]}"
+
+# shellcheck disable=SC2154
+_nixBitcoinInCopiedSrc=1 "$tmp/src/test/run-tests.sh" "${args[@]}"
--- a/test/lib/create-git-repo.sh
+++ b/test/lib/create-git-repo.sh
@@ -1,13 +1,15 @@
 # Create and maintain a minimal git repo at the root of the copied src
 (
+  # shellcheck disable=SC2154,SC2164
  cd "$scriptDir/.."
  amend=--amend
+
  if [[ ! -e .git ]]; then
    git init
    amend=
  fi
  git add .
  if ! git diff --quiet --cached; then
-    git commit -a $amend -m -
+    git commit -a "$amend" -m -
  fi
 ) >/dev/null
--- a/test/lib/make-container.sh
+++ b/test/lib/make-container.sh
@@ -57,6 +57,8 @@ if [[ $EUID != 0 ]]; then
    # NixOS containers require root permissions.
    # By using sudo here and not at the user's call-site extra-container can detect if it is running
    # inside an existing shell session (by checking an internal environment variable).
+    #
+    # shellcheck disable=SC2154
    exec sudo scenario="$scenario" scriptDir="$scriptDir" NIX_PATH="$NIX_PATH" PATH="$PATH" \
         scenarioOverridesFile="${scenarioOverridesFile:-}" "$scriptDir/lib/make-container.sh" "$@"
 fi
@@ -64,7 +66,7 @@ fi
 export containerName=nb-test
 containerCommand=shell

-while [[ $# > 0 ]]; do
+while [[ $# -gt 0 ]]; do
    case $1 in
        --command|-c)
            shift
@@ -77,14 +79,14 @@ while [[ $# > 0 ]]; do
 done

 containerBin=$(type -P extra-container) || true
-if [[ ! ($containerBin && $(realpath $containerBin) == *extra-container-0.10*) ]]; then
+if [[ ! ($containerBin && $(realpath "$containerBin") == *extra-container-0.10*) ]]; then
    echo "Building extra-container. Skip this step by adding extra-container 0.10 to PATH."
    nix-build --out-link /tmp/extra-container "$scriptDir"/../pkgs \
      -A pinned.extra-container >/dev/null
    export PATH="/tmp/extra-container/bin${PATH:+:}$PATH"
 fi

-read -d '' src <<EOF || true
+read -rd '' src <<EOF || true
 ((import "$scriptDir/tests.nix" {}).getTest "$scenario").container
 EOF
-exec extra-container $containerCommand -E "$src" "$@"
+exec extra-container "$containerCommand" -E "$src" "$@"
--- a/test/lib/make-test-vm.nix
+++ b/test/lib/make-test-vm.nix
@@ -16,9 +16,9 @@ let
  fixedTest = test.overrideAttrs (_: {
    # See `runTests` in nixpkgs/nixos/lib/testing-python.nix for the original definition of `buildCommand`
    buildCommand = ''
-      mkdir $out
+      mkdir "$out"
      LOGFILE=$out/output.xml tests='exec(os.environ["testScript"])' ${test.driver}/bin/nixos-test-driver
-      ln -s ${test.driver} $out/driver
+      ln -s ${test.driver} "$out/driver"
    '';
  });
 in
--- a/test/nixos-search/ci-test.sh
+++ b/test/nixos-search/ci-test.sh
@@ -6,15 +6,17 @@ cd "${BASH_SOURCE[0]%/*}"
 # Use cachix to cache the `flake-info` build
 cachixCache=nix-bitcoin

-nix run .#cachix -- use $cachixCache
+nix run .#cachix -- use "$cachixCache"

 # We're running in a basic, unprivileged container that doesn't support sandboxing.
 # Sandboxing is unnneeded because we're only building the 3rd-party `flake-info` tool.
 echo "sandbox = false" >> /etc/nix/nix.conf
-export PATH=$(nix shell -L .#flake-info .#cachix -c sh -c 'echo $PATH')
+
+# shellcheck disable=SC2016
+PATH=$(nix shell -L .#flake-info .#cachix -c sh -c 'echo $PATH')

 if [[ ${CACHIX_SIGNING_KEY:-} ]]; then
-    cachix push $cachixCache $(type -P flake-info);
+    cachix push "$cachixCache" "$(type -P flake-info)";
 fi

 echo "Running flake-info (nixos-search)"
--- a/test/run-tests.sh
+++ b/test/run-tests.sh
@@ -109,14 +109,18 @@ numCPUs=${numCPUs:-$(nproc)}
 # Min. 800 MiB needed to avoid 'out of memory' errors
 memoryMiB=${memoryMiB:-2048}

-export NIX_PATH=nixpkgs=$(nix eval --raw -f "$scriptDir/../pkgs/nixpkgs-pinned.nix" nixpkgs):nix-bitcoin=$(realpath "$scriptDir/..")
+NIX_PATH=nixpkgs=$(nix eval --raw -f "$scriptDir/../pkgs/nixpkgs-pinned.nix" nixpkgs):nix-bitcoin=$(realpath "$scriptDir/..")
+export NIX_PATH

 runAtExit=
 trap 'eval "$runAtExit"' EXIT

 # Support explicit scenario definitions
 if [[ $scenario = *' '* ]]; then
-    export scenarioOverridesFile=$(mktemp ${XDG_RUNTIME_DIR:-/tmp}/nb-scenario.XXX)
+    scenarioOverridesFile=$(mktemp "${XDG_RUNTIME_DIR:-/tmp}/nb-scenario.XXX")
+    export scenarioOverridesFile
+
+    # shellcheck disable=SC2016
    runAtExit+='rm -f "$scenarioOverridesFile";'
    echo "{ scenarios, pkgs, lib }: with lib; { tmp = $scenario; }" > "$scenarioOverridesFile"
    scenario=tmp
@@ -125,10 +129,11 @@ fi
 # Run the test. No temporary files are left on the host system.
 run() {
    # TMPDIR is also used by the test driver for VM tmp files
-    export TMPDIR=$(mktemp -d /tmp/nix-bitcoin-test.XXX)
-    runAtExit+="rm -rf $TMPDIR;"
+    TMPDIR=$(mktemp -d /tmp/nix-bitcoin-test.XXX)
+    export TMPDIR
+    runAtExit+="rm -rf ${TMPDIR};"

-    nix-build --out-link $TMPDIR/driver -E "((import \"$scriptDir/tests.nix\" {}).getTest \"$scenario\").vm" -A driver
+    nix-build --out-link "$TMPDIR/driver" -E "((import \"$scriptDir/tests.nix\" {}).getTest \"$scenario\").vm" -A driver

    # Variable 'tests' contains the Python code that is executed by the driver on startup
    if [[ $1 == --interactive ]]; then
@@ -150,14 +155,14 @@ run() {

    echo "VM stats: CPUs: $numCPUs, memory: $memoryMiB MiB"
    [[ $NB_TEST_ENABLE_NETWORK ]] || QEMU_NET_OPTS='restrict=on'
-    cd $TMPDIR # The VM creates a VDE control socket in $PWD
+    cd "$TMPDIR" # The VM creates a VDE control socket in $PWD
    env -i \
        NIX_PATH="$NIX_PATH" \
        TMPDIR="$TMPDIR" \
        USE_TMPDIR=1 \
        QEMU_OPTS="-smp $numCPUs -m $memoryMiB -nographic $QEMU_OPTS"  \
        QEMU_NET_OPTS="$QEMU_NET_OPTS" \
-        $TMPDIR/driver/bin/nixos-test-driver <(echo "$tests")
+        "$TMPDIR/driver/bin/nixos-test-driver" <(echo "$tests")
 }

 debug() {
@@ -179,18 +184,20 @@ container() {

 # Run a regular NixOS VM
 vm() {
-    export TMPDIR=$(mktemp -d /tmp/nix-bitcoin-vm.XXX)
+    TMPDIR=$(mktemp -d /tmp/nix-bitcoin-vm.XXX)
+    export TMPDIR
    runAtExit+="rm -rf $TMPDIR;"

-    nix-build --out-link $TMPDIR/vm -E "((import \"$scriptDir/tests.nix\" {}).getTest \"$scenario\").vmWithoutTests"
+    nix-build --out-link "$TMPDIR/vm" -E "((import \"$scriptDir/tests.nix\" {}).getTest \"$scenario\").vmWithoutTests"

    echo "VM stats: CPUs: $numCPUs, memory: $memoryMiB MiB"
    [[ $NB_TEST_ENABLE_NETWORK ]] || export QEMU_NET_OPTS="restrict=on,$QEMU_NET_OPTS"

+    # shellcheck disable=SC2211
    USE_TMPDIR=1 \
    NIX_DISK_IMAGE=$TMPDIR/img.qcow2 \
    QEMU_OPTS="-smp $numCPUs -m $memoryMiB -nographic $QEMU_OPTS"  \
-      $TMPDIR/vm/bin/run-*-vm
+      "$TMPDIR"/vm/bin/run-*-vm
 }

 doBuild() {
@@ -223,6 +230,7 @@ vmTestNixExpr() {
        memTotalKiB=$(awk '/MemTotal/ { print $2 }' /proc/meminfo)
        memAvailableKiB=$(awk '/MemAvailable/ { print $2 }' /proc/meminfo)
        # Round down to nearest multiple of 50 MiB for improved test build caching
+        # shellcheck disable=SC2017
        ((memAvailableMiB = memAvailableKiB / (1024 * 50) * 50))
        ((memAvailableMiB < memoryMiB)) && memoryMiB=$memAvailableMiB
        >&2 echo "VM stats: CPUs: $numCPUs, memory: $memoryMiB MiB"
@@ -276,10 +284,10 @@ nixosSearch() {

    if [[ $outLinkPrefix ]]; then
        # Add gcroots for flake-info
-        nix build $scriptDir/nixos-search#flake-info -o "$outLinkPrefix-flake-info"
+        nix build "$scriptDir/nixos-search#flake-info" -o "$outLinkPrefix-flake-info"
    fi
    echo "Running flake-info (nixos-search)"
-    nix run $scriptDir/nixos-search#flake-info -- flake "$scriptDir/.."
+    nix run "$scriptDir/nixos-search#flake-info" -- flake "$scriptDir/.."
 }

 # A basic subset of tests to keep the total runtime within
@@ -330,7 +338,7 @@ build() {
    buildTest "$@"
 }

-if [[ $# > 0 && $1 != -* ]]; then
+if [[ $# -gt 0 && $1 != -* ]]; then
    # An explicit command was provided
    command=$1
    shift