Add INTEGRATION_TEST_DIRECTORY environment to support creating test-o…

…utput artifact in CI
cardano-foundation · Apr 23, 2024 · b2df380 · b2df380
1 parent 2e7d592
commit b2df380
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 7 deletions.
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -58,7 +58,10 @@ steps:
   - label: "Babbage integration tests (linux)"
     key: linux-tests-integration-babbage
     depends_on: linux-nix
-    command: nix shell 'nixpkgs#just' -c just babbage-integration-tests
+    command: |
+      INTEGRATION_TEST_DIRECTORY=./babbage-integration-tests-output nix shell 'nixpkgs#just' -c just babbage-integration-tests
+    artifact_paths:
+      - ./babbage-integration-tests-output/**
     agents:
       system: ${linux}
     env:
@@ -67,7 +70,10 @@ steps:
   - label: "Conway integration tests (linux)"
     key: linux-tests-integration-conway
     depends_on: linux-nix
-    command: nix shell 'nixpkgs#just' -c just conway-integration-tests
+    command: |
+      INTEGRATION_TEST_DIRECTORY=./conway-integration-tests-output nix shell 'nixpkgs#just' -c just conway-integration-tests
+    artifact_paths:
+      - ./conway-integration-tests-output/**
     agents:
       system: ${linux}
     env:

diff --git a/.gitignore b/.gitignore
@@ -75,3 +75,5 @@ test-output
 
 ## Membench uncompressed data
 lib/wallet-benchmarks/data/membench-snapshot
+babbage-integration-tests-output/test.log
+babbage-integration-tests-output/wallet.log
diff --git a/lib/integration/framework/Test/Integration/Framework/Setup.hs b/lib/integration/framework/Test/Integration/Framework/Setup.hs
@@ -75,6 +75,7 @@ import Cardano.Wallet.Launch.Cluster.Env
     )
 import Cardano.Wallet.Launch.Cluster.FileOf
     ( DirOf (..)
+    , absolutize
     , mkRelDirOf
     , toFilePath
     )
@@ -162,7 +163,8 @@ import System.Directory
     ( createDirectory
     )
 import System.Environment
-    ( setEnv
+    ( lookupEnv
+    , setEnv
     )
 import System.Environment.Extended
     ( envFromText
@@ -177,10 +179,14 @@ import System.IO.Temp.Extra
     )
 import System.Path
     ( absDir
+    , absRel
     , relDir
     , relFile
     , (</>)
     )
+import System.Path.Directory
+    ( createDirectoryIfMissing
+    )
 import Test.Integration.Framework.Cluster.Launch
     ( withLocalCluster
     )
@@ -241,14 +247,25 @@ withTestsSetup action = do
     -- Flush test output as soon as a line is printed.
     -- Set UTF-8, regardless of user locale.
 
+    -- possibly retrieve a directory from the environment
+    -- where to report test logs, and modified configuration files
+    testDataDir <- do
+        mDir <- lookupEnv "INTEGRATION_TEST_DIRECTORY"
+        traverse (fmap DirOf . absolutize . absRel) mDir
     withUtf8
         $
         -- This temporary directory will contain logs, and all other data
         -- produced by the integration tests.
-        withSystemTempDir stdoutTextTracer "test" skipCleanup
-        $ \testDir -> do
-            let clusterDir = DirOf $ absDir testDir
-            withTracers clusterDir $ action clusterDir
+        let run = withTracers <*> action
+        in case
+            testDataDir of
+                Nothing ->
+                    withSystemTempDir stdoutTextTracer "test" skipCleanup
+                        $ run . DirOf . absDir
+                Just dir -> do
+                    createDirectoryIfMissing True $ absDirOf dir
+                    run dir
+                    -- do not cleanup the directory if it was provided by the user
 
 mkFaucetFunds :: Cluster.TestnetMagic -> FaucetM FaucetFunds
 mkFaucetFunds testnetMagic = do