Merge pull request #2094 from paritytech/reuse-base-path

Reuse base-path for config arguments

Author: DenzelPenzel

.gitignore

@@ -10,4 +10,5 @@ bins
 
 # nix
 result
-*.log
+*.log
+.idea

examples/0006-reuse-base-path.toml

@@ -0,0 +1,37 @@
+# Network Token Replacement Example: Custom Base Path
+#
+# This example demonstrates how to use network token replacement to customize
+# the --base-path argument while reusing zombienet's auto-generated base directory.
+#
+# The token {{'network'|zombie('base_path')}} gets replaced with the network's
+# temporary directory path at runtime (e.g., /tmp/zombie-abc123/alice/data),
+# allowing you to append custom suffixes like "/alice-custom-data".
+#
+# Available network token:
+# - {{'network'|zombie('base_path')}}  - Node-specific data path (tmpDir + /custom_data_path)
+
+[relaychain]
+default_image = "docker.io/paritypr/polkadot-debug:master"
+default_command = "polkadot"
+default_args = [ "-lparachain=debug" ]
+default_substrate_cli_args_version = "2"
+
+chain = "rococo-local"
+
+  [[relaychain.nodes]]
+  name = "alice"
+  validator = true
+  args = [
+    "--database=paritydb-experimental", 
+    "--base-path={{'network'|zombie('base_path')}}/alice-custom-data",
+  ]
+
+[[parachains]]
+id = 100
+default_substrate_cli_args_version = "2"
+
+  [parachains.collator]
+  name = "collator01"
+  image = "docker.io/parity/polkadot-parachain:latest"
+  command = "polkadot-parachain"
+  args = ["-lparachain=debug"]

javascript/packages/orchestrator/src/cmdGenerator.ts

@@ -312,11 +312,13 @@ export async function genCmd(
     );
   }
 
-  // set our base path
-  const basePathFlagIndex = args.findIndex((arg) => arg === "--base-path");
-  if (basePathFlagIndex >= 0) args.splice(basePathFlagIndex, 2);
-  args.push(...["--base-path", dataPath]);
-
+  // set our base path - only if user hasn't provided one
+  const hasUserBasePath = args.some(
+    (arg) => arg === "--base-path" || arg.startsWith("--base-path="),
+  );
+  if (!hasUserBasePath) {
+    args.push(...["--base-path", dataPath]);
+  }
   if (nodeSetup.substrateCliArgsVersion === SubstrateCliArgsVersion.V0)
     args.push("--unsafe-ws-external");
 

javascript/packages/orchestrator/src/network.ts

@@ -384,9 +384,14 @@ export class Network {
   replaceWithNetworInfo(placeholder: string): string {
     return placeholder.replace(
       TOKEN_PLACEHOLDER,
-      (_substring, nodeName, key: keyof NetworkNode) => {
-        const node = this.getNodeByName(nodeName);
-        return node[key];
+      (_substring, nodeNameOrNetwork, key: keyof NetworkNode) => {
+        if (nodeNameOrNetwork === "network") {
+          const key_to_use = (key as string) == "base_path" ? "tmpDir" : key;
+          return this[key_to_use as keyof Network];
+        } else {
+          const node = this.getNodeByName(nodeNameOrNetwork);
+          return node[key as keyof NetworkNode];
+        }
       },
     );
   }

javascript/packages/utils/src/fs.ts

@@ -161,8 +161,9 @@ export function readNetworkConfig(filepath: string): LaunchConfig {
   const configBasePath = path.dirname(filepath);
   const env = new Environment(new RelativeLoader([configBasePath]));
 
-  env.addFilter("zombie", function (nodeName, key) {
-    return `{{ZOMBIE:${nodeName}:${key}}}`;
+  // 'network' or 'node name' replacement keywords
+  env.addFilter("zombie", function (networkOrNodeName, key) {
+    return `{{ZOMBIE:${networkOrNodeName}:${key}}}`;
   });
 
   const temmplateContent = fs.readFileSync(filepath).toString();