Merge pull request #6095 from IntersectMBO/smelc/cardano-testnet-custom-output-dir

cardano-tesnet: allow to specify output directory

Author: smelc

cardano-testnet/src/Parsers/Cardano.hs

@@ -57,6 +57,11 @@ pCardanoTestnetCliOptions envCli = CardanoTestnetOptions
       <>  OA.help "Enable new epoch state logging to logs/ledger-epoch-state.log"
       <>  OA.showDefault
       )
+  <*> optional (OA.strOption
+      (   OA.long "output-dir"
+      <>  OA.help "Directory where to store files, sockets, and so on. It is created if it doesn't exist. If unset, a temporary directory is used."
+      <>  OA.metavar "DIRECTORY"
+      ))
   where
     pAnyShelleyBasedEra' :: Parser AnyShelleyBasedEra
     pAnyShelleyBasedEra' =

cardano-testnet/src/Parsers/Run.hs

@@ -53,4 +53,4 @@ runTestnetCmd = \case
 
 runCardanoOptions :: CardanoTestnetCliOptions -> IO ()
 runCardanoOptions (CardanoTestnetCliOptions testnetOptions shelleyOptions) =
-  runTestnet $ cardanoTestnetDefault testnetOptions shelleyOptions
+  runTestnet testnetOptions $ cardanoTestnetDefault testnetOptions shelleyOptions

cardano-testnet/src/Testnet/Filepath.hs

@@ -25,6 +25,8 @@ makeSprocket
 makeSprocket tmpAbsPath node
   = Sprocket (makeTmpBaseAbsPath tmpAbsPath) (makeSocketDir tmpAbsPath </> node)
 
+-- TODO rename me: since the introduction of --output-dir in the cardano-testnet
+-- executable, this is a directory that can persist after the test ends.
 -- Temporary path used at runtime
 newtype TmpAbsolutePath = TmpAbsolutePath
   { unTmpAbsPath :: FilePath

cardano-testnet/src/Testnet/Property/Run.hs

@@ -1,3 +1,5 @@
+{-# LANGUAGE NamedFieldPuns #-}
+
 module Testnet.Property.Run
   ( runTestnet
   -- Ignore tests on various OSs
@@ -19,11 +21,12 @@ import           Data.Bool (bool)
 import           Data.String (IsString (..))
 import qualified System.Console.ANSI as ANSI
 import           System.Console.ANSI (Color (..), ColorIntensity (..), ConsoleLayer (..), SGR (..))
+import           System.Directory
 import qualified System.Exit as IO
 import qualified System.Info as SYS
 import qualified System.IO as IO
 
-import           Testnet.Property.Util (integrationWorkspace)
+import           Testnet.Property.Util (integration, integrationWorkspace)
 import           Testnet.Start.Types
 
 import           Hedgehog (Property)
@@ -35,11 +38,11 @@ import qualified Test.Tasty.Hedgehog as H
 import           Test.Tasty.Providers (testPassed)
 import           Test.Tasty.Runners (Result (resultShortDescription), TestTree)
 
-runTestnet :: (Conf -> H.Integration a) -> IO ()
-runTestnet tn = do
+runTestnet :: CardanoTestnetOptions -> (Conf -> H.Integration a) -> IO ()
+runTestnet tnOpts tn = do
   tvRunning <- STM.newTVarIO False
 
-  void . H.check $ testnetProperty $ \c -> do
+  void . H.check $ testnetProperty tnOpts $ \c -> do
     void $ tn c
     H.evalIO . STM.atomically $ STM.writeTVar tvRunning True
 
@@ -60,17 +63,30 @@ runTestnet tn = do
       IO.exitFailure
 
 
-testnetProperty :: (Conf -> H.Integration ()) -> H.Property
-testnetProperty tn = integrationWorkspace "testnet" $ \workspaceDir -> do
-  conf <- mkConf workspaceDir
-
-  -- Fork a thread to keep alive indefinitely any resources allocated by testnet.
-  void . H.evalM . liftResourceT . resourceForkIO . forever . liftIO $ IO.threadDelay 10000000
-
-  void $ tn conf
-
-  H.failure -- Intentional failure to force failure report
-
+testnetProperty :: CardanoTestnetOptions -> (Conf -> H.Integration ()) -> H.Property
+testnetProperty CardanoTestnetOptions{cardanoOutputDir} runTn =
+  case cardanoOutputDir of
+      Nothing -> do
+        integrationWorkspace "testnet" $ \workspaceDir -> do
+          mkConf workspaceDir >>= forkAndRunTestnet
+      Just userOutputDir ->
+        integration $ do
+          absUserOutputDir <- H.evalIO $ makeAbsolute userOutputDir
+          dirExists <- H.evalIO $ doesDirectoryExist absUserOutputDir
+          (if dirExists then
+            -- Likely dangerous, but who are we to judge the user?
+            H.note_ $ "Reusing " <> absUserOutputDir
+          else do
+            liftIO $ createDirectory absUserOutputDir
+            H.note_ $ "Created " <> absUserOutputDir)
+          conf <- mkConf absUserOutputDir
+          forkAndRunTestnet conf
+  where
+    forkAndRunTestnet conf = do
+      -- Fork a thread to keep alive indefinitely any resources allocated by testnet.
+      void $ H.evalM . liftResourceT . resourceForkIO . forever . liftIO $ IO.threadDelay 10000000
+      void $ runTn conf
+      H.failure -- Intentional failure to force failure report
 
 -- Ignore properties on various OSs
 

cardano-testnet/src/Testnet/Start/Types.hs

@@ -74,6 +74,7 @@ data CardanoTestnetOptions = CardanoTestnetOptions
   , cardanoNodeLoggingFormat :: NodeLoggingFormat
   , cardanoNumDReps :: NumDReps -- ^ The number of DReps to generate at creation
   , cardanoEnableNewEpochStateLogging :: Bool -- ^ if epoch state logging is enabled
+  , cardanoOutputDir :: Maybe FilePath -- ^ The output directory where to store files, sockets, and so on. If unset, a temporary directory is used.
   } deriving (Eq, Show)
 
 cardanoNumPools :: CardanoTestnetOptions -> NumPools
@@ -105,6 +106,7 @@ instance Default CardanoTestnetOptions where
     , cardanoNodeLoggingFormat = NodeLoggingFormatAsJson
     , cardanoNumDReps = 3
     , cardanoEnableNewEpochStateLogging = True
+    , cardanoOutputDir = Nothing
     }
 
 -- | Options that are implemented by writing fields in the Shelley genesis file.

cardano-testnet/test/cardano-testnet-golden/files/golden/help.cli

@@ -13,6 +13,7 @@ Usage: cardano-testnet cardano [--num-pool-nodes COUNT]
   [--nodeLoggingFormat LOGGING_FORMAT]
   [--num-dreps NUMBER]
   [--enable-new-epoch-state-logging]
+  [--output-dir DIRECTORY]
   --testnet-magic INT
   [--epoch-length SLOTS]
   [--slot-length SECONDS]

cardano-testnet/test/cardano-testnet-golden/files/golden/help/cardano.cli

@@ -11,6 +11,7 @@ Usage: cardano-testnet cardano [--num-pool-nodes COUNT]
   [--nodeLoggingFormat LOGGING_FORMAT]
   [--num-dreps NUMBER]
   [--enable-new-epoch-state-logging]
+  [--output-dir DIRECTORY]
   --testnet-magic INT
   [--epoch-length SLOTS]
   [--slot-length SECONDS]
@@ -44,6 +45,9 @@ Available options:
   --enable-new-epoch-state-logging
                            Enable new epoch state logging to
                            logs/ledger-epoch-state.log
+  --output-dir DIRECTORY   Directory where to store files, sockets, and so on.
+                           It is created if it doesn't exist. If unset, a
+                           temporary directory is used.
   --testnet-magic INT      Specify a testnet magic id.
   --epoch-length SLOTS     Epoch length, in number of slots (default: 500)
   --slot-length SECONDS    Slot length (default: 0.1)