Move cardano-testnet configuration paths to module in cardano-node

Author: palas

cardano-node/cardano-node.cabal

@@ -84,6 +84,7 @@ library
                         Cardano.Node.Run
                         Cardano.Node.Startup
                         Cardano.Node.STM
+                        Cardano.Node.Testnet.Paths
                         Cardano.Node.TraceConstraints
                         Cardano.Node.Tracing
                         Cardano.Node.Tracing.API

cardano-node/src/Cardano/Node/Testnet/Paths.hs

@@ -0,0 +1,64 @@
+-- | Shared path conventions for cardano-testnet output directories.
+--
+-- Both @cardano-testnet@ (producer) and consumers of generated
+-- testnet configurations depend on this module so that directory
+-- layout changes are kept in sync at compile time.
+module Cardano.Node.Testnet.Paths
+  ( defaultNodeName
+  , defaultNodeDataDir
+  , defaultUtxoKeyDir
+  , defaultUtxoSKeyPath
+  , defaultUtxoVKeyPath
+  , defaultUtxoAddrPath
+  , defaultSocketDir
+  , defaultSocketName
+  , defaultSocketPath
+  , defaultConfigFile
+  , defaultPortFile
+  ) where
+
+import           System.FilePath ((</>))
+
+-- | The name of a node: @"node" <> show n@
+defaultNodeName :: Int -> String
+defaultNodeName n = "node" <> show n
+
+-- | Relative path to a node's data directory: @"node-data" </> defaultNodeName n@
+defaultNodeDataDir :: Int -> FilePath
+defaultNodeDataDir n = "node-data" </> defaultNodeName n
+
+-- | Relative path to a UTxO key directory: @"utxo-keys" </> "utxo" <> show n@
+defaultUtxoKeyDir :: Int -> FilePath
+defaultUtxoKeyDir n = "utxo-keys" </> "utxo" <> show n
+
+-- | Relative path to a UTxO signing key: @defaultUtxoKeyDir n </> "utxo.skey"@
+defaultUtxoSKeyPath :: Int -> FilePath
+defaultUtxoSKeyPath n = defaultUtxoKeyDir n </> "utxo.skey"
+
+-- | Relative path to a UTxO verification key: @defaultUtxoKeyDir n </> "utxo.vkey"@
+defaultUtxoVKeyPath :: Int -> FilePath
+defaultUtxoVKeyPath n = defaultUtxoKeyDir n </> "utxo.vkey"
+
+-- | Relative path to a UTxO address file: @defaultUtxoKeyDir n </> "utxo.addr"@
+defaultUtxoAddrPath :: Int -> FilePath
+defaultUtxoAddrPath n = defaultUtxoKeyDir n </> "utxo.addr"
+
+-- | Socket directory name: @"socket"@
+defaultSocketDir :: FilePath
+defaultSocketDir = "socket"
+
+-- | Socket file name: @"sock"@
+defaultSocketName :: FilePath
+defaultSocketName = "sock"
+
+-- | Relative path to a node's socket: @defaultSocketDir </> defaultNodeName n </> defaultSocketName@
+defaultSocketPath :: Int -> FilePath
+defaultSocketPath n = defaultSocketDir </> defaultNodeName n </> defaultSocketName
+
+-- | Main node configuration file name: @"configuration.yaml"@
+defaultConfigFile :: FilePath
+defaultConfigFile = "configuration.yaml"
+
+-- | Relative path to a node's port file: @defaultNodeDataDir n </> "port"@
+defaultPortFile :: Int -> FilePath
+defaultPortFile n = defaultNodeDataDir n </> "port"

cardano-testnet/changelog.d/20260409_move_testnet_paths_to_node.md

@@ -0,0 +1,4 @@
+
+### Maintenance
+
+- Moved shared testnet path conventions into `Cardano.Node.Testnet.Paths` module in `cardano-node`, and replaced some inline string literals.

cardano-testnet/src/Testnet/Defaults.hs

@@ -99,6 +99,8 @@ import           Numeric.Natural
 import           System.FilePath ((</>))
 
 import           Test.Cardano.Ledger.Core.Rational
+import           Cardano.Node.Testnet.Paths (defaultNodeName, defaultNodeDataDir, defaultUtxoSKeyPath,
+                   defaultUtxoVKeyPath)
 import           Testnet.Start.Types
 import           Testnet.Types
 
@@ -568,14 +570,6 @@ defaultSpoColdSKeyFp n = defaultSpoKeysDir n </> "cold.skey"
 defaultSpoName :: Int -> String
 defaultSpoName n = "pool" <> show n
 
--- | The name of a node (which doesn't have to be a SPO)
-defaultNodeName :: Int -> String
-defaultNodeName n = "node" <> show n
-
--- | The relative path of the node data dir, where the database is stored
-defaultNodeDataDir :: Int -> String
-defaultNodeDataDir n = "node-data" </> defaultNodeName n
-
 -- | The relative path where the SPO keys for the node are stored
 defaultSpoKeysDir :: Int -> String
 defaultSpoKeysDir n = "pools-keys" </> defaultSpoName n
@@ -619,8 +613,8 @@ defaultDelegatorStakeKeyPair n =
 defaultUtxoKeys :: Int -> KeyPair PaymentKey
 defaultUtxoKeys n =
   KeyPair
-    { verificationKey = File $ "utxo-keys" </> "utxo" <> show n </> "utxo.vkey"
-    , signingKey = File $ "utxo-keys" </> "utxo" <> show n </> "utxo.skey"
+    { verificationKey = File $ defaultUtxoVKeyPath n
+    , signingKey = File $ defaultUtxoSKeyPath n
     }
 
 

cardano-testnet/src/Testnet/Filepath.hs

@@ -20,6 +20,8 @@ import           Hedgehog.Extras.Stock.IO.Network.Sprocket (Sprocket (..))
 
 import           RIO (Display (..))
 
+import           Cardano.Node.Testnet.Paths (defaultSocketDir)
+
 
 makeSprocket
   :: TmpAbsolutePath
@@ -42,7 +44,7 @@ makeTmpRelPath :: TmpAbsolutePath -> FilePath
 makeTmpRelPath (TmpAbsolutePath fp) = makeRelative (makeTmpBaseAbsPath (TmpAbsolutePath fp)) fp
 
 makeSocketDir :: TmpAbsolutePath -> FilePath
-makeSocketDir fp = makeTmpRelPath fp </> "socket"
+makeSocketDir fp = makeTmpRelPath fp </> defaultSocketDir
 
 makeTmpBaseAbsPath :: TmpAbsolutePath -> FilePath
 makeTmpBaseAbsPath (TmpAbsolutePath fp) = addTrailingPathSeparator $ takeDirectory fp

cardano-testnet/src/Testnet/Runtime.hs

@@ -53,6 +53,7 @@ import qualified System.Process as IO
 import           System.Process (waitForProcess)
 
 import           Testnet.Filepath
+import           Cardano.Node.Testnet.Paths (defaultSocketName)
 import qualified Testnet.Ping as Ping
 import           Testnet.Process.Run (ProcessError (..), initiateProcess)
 import           Testnet.Process.RunIO (execCli_, execKesAgentControl_, liftIOAnnotated,
@@ -135,7 +136,7 @@ startNode tp node ipv4 port _testnetMagic nodeCmd = GHC.withFrozenCallStack $ do
   let nodeStdoutFile = logDir </> node </> "stdout.log"
       nodeStderrFile = logDir </> node </> "stderr.log"
       nodePidFile = logDir </> node </> "node.pid"
-      socketRelPath = socketDir </> node </> "sock"
+      socketRelPath = socketDir </> node </> defaultSocketName
       sprocket = Sprocket tempBaseAbsPath socketRelPath
 
   hNodeStdout <- retryOpenFile nodeStdoutFile IO.WriteMode

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

@@ -64,6 +64,8 @@ import           System.FilePath ((</>))
 
 import           Testnet.Components.Configuration
 import qualified Testnet.Defaults as Defaults
+import           Cardano.Node.Testnet.Paths (defaultConfigFile, defaultPortFile,
+                   defaultUtxoAddrPath)
 import           Testnet.Filepath
 import           Testnet.Handlers (interruptNodesOnSigINT)
 import           Testnet.Orphans ()
@@ -131,7 +133,7 @@ createTestnetEnv
     testnetOptions genesisOptions onChainParams
     (TmpAbsolutePath tmpAbsPath)
 
-  let configurationFile = tmpAbsPath </> "configuration.yaml"
+  let configurationFile = tmpAbsPath </> defaultConfigFile
   -- Add Byron, Shelley and Alonzo genesis hashes to node configuration
   config <- case genesisHashesPolicy of
     WithHashes -> createConfigJson (TmpAbsolutePath tmpAbsPath) sbe
@@ -152,7 +154,7 @@ createTestnetEnv
 
     -- Write port file
     case Map.lookup i portNumbersMap of
-      Just port -> liftIOAnnotated $ writeFile (nodeDataDir </> "port") (show port)
+      Just port -> liftIOAnnotated $ writeFile (tmpAbsPath </> defaultPortFile i) (show port)
       Nothing -> throwString $ "Port not found for node " <> show i
 
     producers <- mapM (idToRemoteAddressP2P portNumbersMap) $ NodeId <$> NEL.filter (/= i) nodeIds
@@ -247,7 +249,7 @@ cardanoTestnet
         , cardanoKESSource
         } = testnetOptions
       nPools = cardanoNumPools testnetOptions
-      nodeConfigFile = tmpAbsPath </> "configuration.yaml"
+      nodeConfigFile = tmpAbsPath </> defaultConfigFile
       byronGenesisFile = tmpAbsPath </> "byron-genesis.json"
       shelleyGenesisFile = tmpAbsPath </> "shelley-genesis.json"
 
@@ -260,7 +262,7 @@ cardanoTestnet
 
   wallets <- forM [1..3] $ \idx -> do
     let utxoKeys@KeyPair{verificationKey} = makePathsAbsolute $ Defaults.defaultUtxoKeys idx
-    let paymentAddrFile = tmpAbsPath </> "utxo-keys" </> "utxo" <> show idx </> "utxo.addr"
+    let paymentAddrFile = tmpAbsPath </> defaultUtxoAddrPath idx
 
     execCli_
       [ "latest", "address", "build"
@@ -279,7 +281,7 @@ cardanoTestnet
   -- Read port numbers from disk (written by createTestnetEnv)
   portNumbers <- forM (NEL.zip (1 :| [2..]) cardanoNodes) $ \(i, _nodeOption) -> do
     let nodeDataDir = tmpAbsPath </> Defaults.defaultNodeDataDir i
-        portPath = nodeDataDir </> "port"
+        portPath = tmpAbsPath </> defaultPortFile i
     portStr <- liftIOAnnotated $ readFile portPath
     let port = read portStr :: PortNumber
     let topologyPath = nodeDataDir </> "topology.json"