From e76df8781417dad9ab4f0a6c3b28917e35f204bf Mon Sep 17 00:00:00 2001
From: John Ericson <John.Ericson@Obsidian.Systems>
Date: Wed, 13 Dec 2023 11:26:14 -0500
Subject: [PATCH] Test `nix copy --substitute-on-destination`

It works with both `ssh://` and `ssh-ng://` now since #9600 (and
`ssh-ng:// didn't work before that).

Also, by making the two tests share code, we nudge ourselves towards
making sure there is feature parity.
---
 tests/functional/nix-copy-ssh-common.sh | 70 +++++++++++++++++++++++++
 tests/functional/nix-copy-ssh-ng.sh     | 16 +++---
 tests/functional/nix-copy-ssh.sh        | 19 +------
 3 files changed, 77 insertions(+), 28 deletions(-)
 create mode 100644 tests/functional/nix-copy-ssh-common.sh

diff --git a/tests/functional/nix-copy-ssh-common.sh b/tests/functional/nix-copy-ssh-common.sh
new file mode 100644
index 000000000..cc8314ff7
--- /dev/null
+++ b/tests/functional/nix-copy-ssh-common.sh
@@ -0,0 +1,70 @@
+proto=$1
+shift
+(( $# == 0 ))
+
+clearStore
+clearCache
+
+mkdir -p $TEST_ROOT/stores
+
+# Create path to copy back and forth
+outPath=$(nix-build --no-out-link dependencies.nix)
+
+storeQueryParam="store=${NIX_STORE_DIR}"
+
+realQueryParam () {
+    echo "real=$1$NIX_STORE_DIR"
+}
+
+remoteRoot="$TEST_ROOT/stores/$proto"
+
+clearRemoteStore () {
+    chmod -R u+w "$remoteRoot" || true
+    rm -rf "$remoteRoot"
+}
+
+clearRemoteStore
+
+remoteStore="${proto}://localhost?${storeQueryParam}&remote-store=${remoteRoot}%3f${storeQueryParam}%26$(realQueryParam "$remoteRoot")"
+
+# Copy to store
+
+args=()
+if [[ "$proto" == "ssh-ng" ]]; then
+    # TODO investigate discrepancy
+    args+=(--no-check-sigs)
+fi
+
+[ ! -f ${remoteRoot}${outPath}/foobar ]
+nix copy "${args[@]}" --to "$remoteStore" $outPath
+[ -f ${remoteRoot}${outPath}/foobar ]
+
+# Copy back from store
+
+clearStore
+
+[ ! -f $outPath/foobar ]
+nix copy --no-check-sigs --from "$remoteStore" $outPath
+[ -f $outPath/foobar ]
+
+# Check --substitute-on-destination, avoid corrupted store
+
+clearRemoteStore
+
+corruptedRoot=$TEST_ROOT/stores/corrupted
+corruptedStore="${corruptedRoot}?${storeQueryParam}&$(realQueryParam "$corruptedRoot")"
+
+# Copy it to the corrupted store
+nix copy --no-check-sigs "$outPath" --to "$corruptedStore"
+
+# Corrupt it in there
+corruptPath="${corruptedRoot}${outPath}"
+chmod +w "$corruptPath"
+echo "not supposed to be here" > "$corruptPath/foobarbaz"
+chmod -w "$corruptPath"
+
+# Copy from the corrupted store with the regular store as a
+# substituter. It must use the substituter not the source store in
+# order to avoid errors.
+NIX_CONFIG=$(echo -e "substituters = local\nrequire-sigs = false") \
+    nix copy --no-check-sigs --from "$corruptedStore" --to "$remoteStore" --substitute-on-destination "$outPath"
diff --git a/tests/functional/nix-copy-ssh-ng.sh b/tests/functional/nix-copy-ssh-ng.sh
index 463b5e0c4..62e99cd24 100644
--- a/tests/functional/nix-copy-ssh-ng.sh
+++ b/tests/functional/nix-copy-ssh-ng.sh
@@ -1,18 +1,14 @@
 source common.sh
 
-clearStore
-clearCache
+source nix-copy-ssh-common.sh "ssh-ng"
 
-remoteRoot=$TEST_ROOT/store2
-chmod -R u+w "$remoteRoot" || true
-rm -rf "$remoteRoot"
+clearStore
+clearRemoteStore
 
 outPath=$(nix-build --no-out-link dependencies.nix)
 
-nix store info --store "ssh-ng://localhost?store=$NIX_STORE_DIR&remote-store=$remoteRoot%3fstore=$NIX_STORE_DIR%26real=$remoteRoot$NIX_STORE_DIR"
+nix store info --store "$remoteStore"
 
 # Regression test for https://github.com/NixOS/nix/issues/6253
-nix copy --to "ssh-ng://localhost?store=$NIX_STORE_DIR&remote-store=$remoteRoot%3fstore=$NIX_STORE_DIR%26real=$remoteRoot$NIX_STORE_DIR" $outPath --no-check-sigs &
-nix copy --to "ssh-ng://localhost?store=$NIX_STORE_DIR&remote-store=$remoteRoot%3fstore=$NIX_STORE_DIR%26real=$remoteRoot$NIX_STORE_DIR" $outPath --no-check-sigs
-
-[ -f $remoteRoot$outPath/foobar ]
+nix copy --to "$remoteStore" $outPath --no-check-sigs &
+nix copy --to "$remoteStore" $outPath --no-check-sigs
diff --git a/tests/functional/nix-copy-ssh.sh b/tests/functional/nix-copy-ssh.sh
index eb801548d..12e8346bc 100644
--- a/tests/functional/nix-copy-ssh.sh
+++ b/tests/functional/nix-copy-ssh.sh
@@ -1,20 +1,3 @@
 source common.sh
 
-clearStore
-clearCache
-
-remoteRoot=$TEST_ROOT/store2
-chmod -R u+w "$remoteRoot" || true
-rm -rf "$remoteRoot"
-
-outPath=$(nix-build --no-out-link dependencies.nix)
-
-nix copy --to "ssh://localhost?store=$NIX_STORE_DIR&remote-store=$remoteRoot%3fstore=$NIX_STORE_DIR%26real=$remoteRoot$NIX_STORE_DIR" $outPath
-
-[ -f $remoteRoot$outPath/foobar ]
-
-clearStore
-
-nix copy --no-check-sigs --from "ssh://localhost?store=$NIX_STORE_DIR&remote-store=$remoteRoot%3fstore=$NIX_STORE_DIR%26real=$remoteRoot$NIX_STORE_DIR" $outPath
-
-[ -f $outPath/foobar ]
+source nix-copy-ssh-common.sh "ssh"