From 5716345adf2e794fd62229ea52352e74e92e8e63 Mon Sep 17 00:00:00 2001
From: regnat <rg@regnat.ovh>
Date: Tue, 10 Nov 2020 10:43:33 +0100
Subject: [PATCH 1/6] Add a test ensuring compatibility with an old daemon

This requires adding `nix` to its own closure which is a bit unfortunate,
but as it is optional (the test will be disabled if `OUTER_NIX` is unset) it
shouldn't be too much of an issue.

(Ideally this should go in another derivation so that we can build Nix and run
the test independently, but as the tests are running in the same derivation
as the build it's a bit complicated to do so).
---
 flake.nix                        | 9 +++++++++
 tests/common.sh.in               | 3 +--
 tests/local.mk                   | 2 +-
 tests/remote-store-old-daemon.sh | 7 +++++++
 tests/remote-store.sh            | 4 ++--
 5 files changed, 20 insertions(+), 5 deletions(-)
 create mode 100644 tests/remote-store-old-daemon.sh

diff --git a/flake.nix b/flake.nix
index e59ec9a35..3e236aaca 100644
--- a/flake.nix
+++ b/flake.nix
@@ -150,6 +150,11 @@
       # 'nix.perl-bindings' packages.
       overlay = final: prev: {
 
+        # An older version of Nix to test against when using the daemon.
+        # Currently using `nixUnstable` as the stable one doesn't respect
+        # `NIX_DAEMON_SOCKET_PATH` which is needed for the tests.
+        mainstream-nix = prev.nixUnstable;
+
         nix = with final; with commonDeps pkgs; stdenv.mkDerivation {
           name = "nix-${version}";
           inherit version;
@@ -158,6 +163,8 @@
 
           VERSION_SUFFIX = versionSuffix;
 
+          OUTER_NIX = mainstream-nix;
+
           outputs = [ "out" "dev" "doc" ];
 
           nativeBuildInputs = nativeBuildDeps;
@@ -486,6 +493,8 @@
         stdenv.mkDerivation {
           name = "nix";
 
+          OUTER_NIX = mainstream-nix;
+
           outputs = [ "out" "dev" "doc" ];
 
           nativeBuildInputs = nativeBuildDeps;
diff --git a/tests/common.sh.in b/tests/common.sh.in
index de44a4da4..277dd6dfa 100644
--- a/tests/common.sh.in
+++ b/tests/common.sh.in
@@ -57,7 +57,6 @@ clearStore() {
     mkdir "$NIX_STORE_DIR"
     rm -rf "$NIX_STATE_DIR"
     mkdir "$NIX_STATE_DIR"
-    nix-store --init
     clearProfiles
 }
 
@@ -73,7 +72,7 @@ startDaemon() {
     # Start the daemon, wait for the socket to appear.  !!!
     # ‘nix-daemon’ should have an option to fork into the background.
     rm -f $NIX_STATE_DIR/daemon-socket/socket
-    nix daemon &
+    ${NIX_DAEMON_COMMAND:-nix daemon} &
     for ((i = 0; i < 30; i++)); do
         if [ -e $NIX_DAEMON_SOCKET_PATH ]; then break; fi
         sleep 1
diff --git a/tests/local.mk b/tests/local.mk
index de095c117..dd9a0ad56 100644
--- a/tests/local.mk
+++ b/tests/local.mk
@@ -6,7 +6,7 @@ nix_tests = \
   gc-auto.sh \
   referrers.sh user-envs.sh logging.sh nix-build.sh misc.sh fixed.sh \
   gc-runtime.sh check-refs.sh filter-source.sh \
-  local-store.sh remote-store.sh export.sh export-graph.sh \
+  local-store.sh remote-store.sh remote-store-old-daemon.sh export.sh export-graph.sh \
   timeout.sh secure-drv-outputs.sh nix-channel.sh \
   multiple-outputs.sh import-derivation.sh fetchurl.sh optimise-store.sh \
   binary-cache.sh \
diff --git a/tests/remote-store-old-daemon.sh b/tests/remote-store-old-daemon.sh
new file mode 100644
index 000000000..ede7ce716
--- /dev/null
+++ b/tests/remote-store-old-daemon.sh
@@ -0,0 +1,7 @@
+# Test that the new Nix can properly talk to an old daemon.
+# If `$OUTER_NIX` isn't set (e.g. when bootsraping), just skip this test
+
+if [[ -n "$OUTER_NIX" ]]; then
+    export NIX_DAEMON_COMMAND=$OUTER_NIX/bin/nix-daemon
+    source remote-store.sh
+fi
diff --git a/tests/remote-store.sh b/tests/remote-store.sh
index f7ae1a2ed..31210ab47 100644
--- a/tests/remote-store.sh
+++ b/tests/remote-store.sh
@@ -23,12 +23,12 @@ startDaemon
 
 storeCleared=1 NIX_REMOTE_=$NIX_REMOTE $SHELL ./user-envs.sh
 
+nix-store --gc --max-freed 1K
+
 nix-store --dump-db > $TEST_ROOT/d1
 NIX_REMOTE= nix-store --dump-db > $TEST_ROOT/d2
 cmp $TEST_ROOT/d1 $TEST_ROOT/d2
 
-nix-store --gc --max-freed 1K
-
 killDaemon
 
 user=$(whoami)

From eab9cdbd75e739be33f9433cfba9ab354d084440 Mon Sep 17 00:00:00 2001
From: regnat <rg@regnat.ovh>
Date: Tue, 17 Nov 2020 14:33:09 +0100
Subject: [PATCH 2/6] Add a test for the migration of the db between versions

---
 tests/db-migration.sh | 25 +++++++++++++++++++++++++
 tests/local.mk        |  1 +
 2 files changed, 26 insertions(+)
 create mode 100644 tests/db-migration.sh

diff --git a/tests/db-migration.sh b/tests/db-migration.sh
new file mode 100644
index 000000000..e6a405770
--- /dev/null
+++ b/tests/db-migration.sh
@@ -0,0 +1,25 @@
+# Test that we can successfully migrate from an older db schema
+
+# Only run this if we have an older Nix available
+if [[ -z "$OUTER_NIX" ]]; then
+    exit 0
+fi
+
+source common.sh
+
+# Fill the db using the older Nix
+PATH_WITH_NEW_NIX="$PATH"
+export PATH="$OUTER_NIX/bin:$PATH"
+clearStore
+nix-build simple.nix --no-out-link
+nix-store --generate-binary-cache-key cache1.example.org $TEST_ROOT/sk1 $TEST_ROOT/pk1
+dependenciesOutPath=$(nix-build dependencies.nix --no-out-link --secret-key-files "$TEST_ROOT/sk1")
+fixedOutPath=$(IMPURE_VAR1=foo IMPURE_VAR2=bar nix-build fixed.nix -A good.0 --no-out-link)
+
+# Migrate to the new schema and ensure that everything's there
+export PATH="$PATH_WITH_NEW_NIX"
+info=$(nix path-info --json $dependenciesOutPath)
+[[ $info =~ '"ultimate":true' ]]
+[[ $info =~ 'cache1.example.org' ]]
+nix verify -r "$fixedOutPath"
+nix verify -r "$dependenciesOutPath" --sigs-needed 1 --trusted-public-keys $(cat $TEST_ROOT/pk1)
diff --git a/tests/local.mk b/tests/local.mk
index dd9a0ad56..01c35551f 100644
--- a/tests/local.mk
+++ b/tests/local.mk
@@ -7,6 +7,7 @@ nix_tests = \
   referrers.sh user-envs.sh logging.sh nix-build.sh misc.sh fixed.sh \
   gc-runtime.sh check-refs.sh filter-source.sh \
   local-store.sh remote-store.sh remote-store-old-daemon.sh export.sh export-graph.sh \
+  db-migration.sh \
   timeout.sh secure-drv-outputs.sh nix-channel.sh \
   multiple-outputs.sh import-derivation.sh fetchurl.sh optimise-store.sh \
   binary-cache.sh \

From a0866c8ea4bc66f9aacc7ad19139d57946b3df18 Mon Sep 17 00:00:00 2001
From: regnat <rg@regnat.ovh>
Date: Tue, 16 Mar 2021 13:43:08 +0100
Subject: [PATCH 3/6] Make the tests (optionnally) run in another derivation

That way we can run them without rebuilding Nix
---
 flake.nix          | 41 ++++++++++++++++++++++++++++++++++++-----
 tests/common.sh.in |  6 ++++++
 2 files changed, 42 insertions(+), 5 deletions(-)

diff --git a/flake.nix b/flake.nix
index 3e236aaca..c2e5db53a 100644
--- a/flake.nix
+++ b/flake.nix
@@ -144,6 +144,32 @@
             echo "file installer $out/install" >> $out/nix-support/hydra-build-products
           '';
 
+      testNixVersions = pkgs: client: daemon: with commonDeps pkgs; pkgs.stdenv.mkDerivation {
+        NIX_DAEMON_PACKAGE = daemon;
+        NIX_CLIENT_PACKAGE = client;
+        name = "nix-tests-${client.version}-against-${daemon.version}";
+        inherit version;
+
+        src = self;
+
+        VERSION_SUFFIX = versionSuffix;
+
+        nativeBuildInputs = nativeBuildDeps;
+        buildInputs = buildDeps ++ awsDeps;
+        propagatedBuildInputs = propagatedDeps;
+
+        enableParallelBuilding = true;
+
+        dontBuild = true;
+        doInstallCheck = true;
+
+        installPhase = ''
+          mkdir -p $out
+        '';
+        installCheckPhase = "make installcheck";
+
+      };
+
     in {
 
       # A Nixpkgs overlay that overrides the 'nix' and
@@ -153,7 +179,7 @@
         # An older version of Nix to test against when using the daemon.
         # Currently using `nixUnstable` as the stable one doesn't respect
         # `NIX_DAEMON_SOCKET_PATH` which is needed for the tests.
-        mainstream-nix = prev.nixUnstable;
+        nixStable = prev.nix;
 
         nix = with final; with commonDeps pkgs; stdenv.mkDerivation {
           name = "nix-${version}";
@@ -163,8 +189,6 @@
 
           VERSION_SUFFIX = versionSuffix;
 
-          OUTER_NIX = mainstream-nix;
-
           outputs = [ "out" "dev" "doc" ];
 
           nativeBuildInputs = nativeBuildDeps;
@@ -441,6 +465,15 @@
       checks = forAllSystems (system: {
         binaryTarball = self.hydraJobs.binaryTarball.${system};
         perlBindings = self.hydraJobs.perlBindings.${system};
+        installTests =
+          let pkgs = nixpkgsFor.${system}; in
+          pkgs.runCommand "install-tests" {
+            againstSelf = testNixVersions pkgs pkgs.nix pkgs.pkgs.nix;
+            againstCurrentUnstable = testNixVersions pkgs pkgs.nix pkgs.nixUnstable;
+            # Disabled because the latest stable version doesn't handle
+            # `NIX_DAEMON_SOCKET_PATH` which is required for the tests to work
+            # againstLatestStable = testNixVersions pkgs pkgs.nix pkgs.nixStable;
+          } "touch $out";
       });
 
       packages = forAllSystems (system: {
@@ -493,8 +526,6 @@
         stdenv.mkDerivation {
           name = "nix";
 
-          OUTER_NIX = mainstream-nix;
-
           outputs = [ "out" "dev" "doc" ];
 
           nativeBuildInputs = nativeBuildDeps;
diff --git a/tests/common.sh.in b/tests/common.sh.in
index 277dd6dfa..d31d3fbb8 100644
--- a/tests/common.sh.in
+++ b/tests/common.sh.in
@@ -29,6 +29,12 @@ unset XDG_CACHE_HOME
 mkdir -p $TEST_HOME
 
 export PATH=@bindir@:$PATH
+if [[ -n "${NIX_CLIENT_PACKAGE:-}" ]]; then
+  export PATH="$NIX_CLIENT_PACKAGE/bin":$PATH
+fi
+if [[ -n "${NIX_DAEMON_PACKAGE:-}" ]]; then
+  export NIX_DAEMON_COMMAND="$NIX_DAEMON_PACKAGE/bin/nix-daemon"
+fi
 coreutils=@coreutils@
 
 export dot=@dot@

From 81df1b5c687b7606f0159485c33bf5f7e2614eba Mon Sep 17 00:00:00 2001
From: regnat <rg@regnat.ovh>
Date: Tue, 16 Mar 2021 14:15:57 +0100
Subject: [PATCH 4/6] Remove the `remote-store-old-daemon` test

Doesn't make sense anymore with the new setup
---
 tests/local.mk                   | 2 +-
 tests/remote-store-old-daemon.sh | 7 -------
 2 files changed, 1 insertion(+), 8 deletions(-)
 delete mode 100644 tests/remote-store-old-daemon.sh

diff --git a/tests/local.mk b/tests/local.mk
index 01c35551f..e7e85f97e 100644
--- a/tests/local.mk
+++ b/tests/local.mk
@@ -6,7 +6,7 @@ nix_tests = \
   gc-auto.sh \
   referrers.sh user-envs.sh logging.sh nix-build.sh misc.sh fixed.sh \
   gc-runtime.sh check-refs.sh filter-source.sh \
-  local-store.sh remote-store.sh remote-store-old-daemon.sh export.sh export-graph.sh \
+  local-store.sh remote-store.sh export.sh export-graph.sh \
   db-migration.sh \
   timeout.sh secure-drv-outputs.sh nix-channel.sh \
   multiple-outputs.sh import-derivation.sh fetchurl.sh optimise-store.sh \
diff --git a/tests/remote-store-old-daemon.sh b/tests/remote-store-old-daemon.sh
deleted file mode 100644
index ede7ce716..000000000
--- a/tests/remote-store-old-daemon.sh
+++ /dev/null
@@ -1,7 +0,0 @@
-# Test that the new Nix can properly talk to an old daemon.
-# If `$OUTER_NIX` isn't set (e.g. when bootsraping), just skip this test
-
-if [[ -n "$OUTER_NIX" ]]; then
-    export NIX_DAEMON_COMMAND=$OUTER_NIX/bin/nix-daemon
-    source remote-store.sh
-fi

From be60c9ef50bf5fa653138802f63727fa0aadf50a Mon Sep 17 00:00:00 2001
From: regnat <rg@regnat.ovh>
Date: Tue, 16 Mar 2021 14:20:10 +0100
Subject: [PATCH 5/6] Fix the db-migration test

---
 tests/db-migration.sh | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/tests/db-migration.sh b/tests/db-migration.sh
index e6a405770..e0ff7d311 100644
--- a/tests/db-migration.sh
+++ b/tests/db-migration.sh
@@ -1,7 +1,8 @@
 # Test that we can successfully migrate from an older db schema
 
 # Only run this if we have an older Nix available
-if [[ -z "$OUTER_NIX" ]]; then
+# XXX: This assumes that the `daemon` package is older than the `client` one
+if [[ -z "$NIX_DAEMON_PACKAGE" ]]; then
     exit 0
 fi
 
@@ -9,7 +10,7 @@ source common.sh
 
 # Fill the db using the older Nix
 PATH_WITH_NEW_NIX="$PATH"
-export PATH="$OUTER_NIX/bin:$PATH"
+export PATH="$NIX_DAEMON_PACKAGE/bin:$PATH"
 clearStore
 nix-build simple.nix --no-out-link
 nix-store --generate-binary-cache-key cache1.example.org $TEST_ROOT/sk1 $TEST_ROOT/pk1

From 5ec873b127139ca90cc31967c25c9a34fb4cc3e4 Mon Sep 17 00:00:00 2001
From: regnat <rg@regnat.ovh>
Date: Tue, 16 Mar 2021 16:44:42 +0100
Subject: [PATCH 6/6] Shorten the test drv name

To prevent the OSX build to fail because of a too long socket path
---
 flake.nix | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/flake.nix b/flake.nix
index c2e5db53a..1cd54e702 100644
--- a/flake.nix
+++ b/flake.nix
@@ -147,7 +147,10 @@
       testNixVersions = pkgs: client: daemon: with commonDeps pkgs; pkgs.stdenv.mkDerivation {
         NIX_DAEMON_PACKAGE = daemon;
         NIX_CLIENT_PACKAGE = client;
-        name = "nix-tests-${client.version}-against-${daemon.version}";
+        # Must keep this name short as OSX has a rather strict limit on the
+        # socket path length, and this name appears in the path of the
+        # nix-daemon socket used in the tests
+        name = "nix-tests";
         inherit version;
 
         src = self;