propagate custom-dns flag to all run containers

jstuczyn · jstuczyn · commit b464c71bef25 · 2025-12-08T11:05:28.000Z
diff --git a/docker/localnet/nym-binaries-localnet.Dockerfile b/docker/localnet/nym-binaries-localnet.Dockerfile
@@ -20,6 +20,7 @@ FROM rust:1.91.1 AS builder
 
 RUN apt update && apt install -y \
     iproute2 \
+    netcat-openbsd \
     net-tools \
     wireguard-tools \
     golang-go \
diff --git a/tools/internal/localnet-orchestrator/src/cli/down.rs b/tools/internal/localnet-orchestrator/src/cli/down.rs
@@ -11,7 +11,7 @@ pub(crate) struct Args {
 }
 
 pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
-    LocalnetOrchestrator::new(args.common)
+    LocalnetOrchestrator::new(&args.common)
         .await?
         .stop_localnet()
         .await
diff --git a/tools/internal/localnet-orchestrator/src/cli/initialise_contracts.rs b/tools/internal/localnet-orchestrator/src/cli/initialise_contracts.rs
@@ -52,7 +52,7 @@ pub(crate) struct Args {
 }
 
 pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
-    let mut orchestrator = LocalnetOrchestrator::new(args.common).await?;
+    let mut orchestrator = LocalnetOrchestrator::new(&args.common).await?;
 
     if orchestrator.state != LocalnetState::RunningNyxd {
         bail!(
diff --git a/tools/internal/localnet-orchestrator/src/cli/initialise_nym_api.rs b/tools/internal/localnet-orchestrator/src/cli/initialise_nym_api.rs
@@ -32,7 +32,7 @@ pub(crate) struct Args {
 }
 
 pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
-    let mut orchestrator = LocalnetOrchestrator::new(args.common).await?;
+    let mut orchestrator = LocalnetOrchestrator::new(&args.common).await?;
 
     if orchestrator.state != LocalnetState::DeployedNymContracts {
         bail!(
@@ -45,6 +45,7 @@ pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
         .initialise_nym_api(nym_api::Config {
             cosmwasm_optimizer_image: args.cosmwasm_optimizer_image,
             monorepo_root: args.monorepo_root,
+            custom_dns: args.common.custom_dns,
             allow_cached_build: args.allow_cached_build,
         })
         .await?;
diff --git a/tools/internal/localnet-orchestrator/src/cli/initialise_nym_nodes.rs b/tools/internal/localnet-orchestrator/src/cli/initialise_nym_nodes.rs
@@ -19,10 +19,6 @@ pub(crate) struct Args {
     #[clap(long)]
     monorepo_root: Option<PathBuf>,
 
-    /// Specify custom dns to be used by the nym-node containers
-    #[clap(long)]
-    custom_dns: Option<String>,
-
     /// Specify whether internal service providers should run in open proxy mode
     #[clap(long)]
     open_proxy: bool,
@@ -32,7 +28,7 @@ pub(crate) struct Args {
 }
 
 pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
-    let mut orchestrator = LocalnetOrchestrator::new(args.common).await?;
+    let mut orchestrator = LocalnetOrchestrator::new(&args.common).await?;
 
     if orchestrator.state != LocalnetState::RunningNymApi {
         bail!(
@@ -44,7 +40,7 @@ pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
     orchestrator
         .initialise_nym_nodes(nym_nodes::Config {
             monorepo_root: args.monorepo_root,
-            custom_dns: args.custom_dns,
+            custom_dns: args.common.custom_dns,
             open_proxy: args.open_proxy,
         })
         .await?;
diff --git a/tools/internal/localnet-orchestrator/src/cli/initialise_nyxd.rs b/tools/internal/localnet-orchestrator/src/cli/initialise_nyxd.rs
@@ -29,7 +29,7 @@ pub(crate) struct Args {
 }
 
 pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
-    let mut orchestrator = LocalnetOrchestrator::new(args.common).await?;
+    let mut orchestrator = LocalnetOrchestrator::new(&args.common).await?;
     if orchestrator.state != LocalnetState::Uninitialised {
         bail!(
             "can't initialise nyxd as it appears to have already been initialised. the localnet is in {} state.",
@@ -41,6 +41,7 @@ pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
         .initialise_nyxd(nyxd::Config {
             nyxd_repo: args.nyxd_repo,
             nyxd_dockerfile_path: args.nyxd_dockerfile_path,
+            custom_dns: args.common.custom_dns,
             nyxd_tag: args.nyxd_tag,
         })
         .await?;
diff --git a/tools/internal/localnet-orchestrator/src/cli/purge.rs b/tools/internal/localnet-orchestrator/src/cli/purge.rs
@@ -26,7 +26,7 @@ pub(crate) struct Args {
 }
 
 pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
-    LocalnetOrchestrator::new(args.common)
+    LocalnetOrchestrator::new(&args.common)
         .await?
         .purge_localnet(purge::Config {
             remove_images: args.remove_images,
diff --git a/tools/internal/localnet-orchestrator/src/cli/rebuild_binaries_image.rs b/tools/internal/localnet-orchestrator/src/cli/rebuild_binaries_image.rs
@@ -22,7 +22,7 @@ pub(crate) struct Args {
 }
 
 pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
-    let orchestrator = LocalnetOrchestrator::new(args.common).await?;
+    let orchestrator = LocalnetOrchestrator::new(&args.common).await?;
 
     orchestrator
         .rebuild_binaries_image(rebuild_binaries_image::Config {
diff --git a/tools/internal/localnet-orchestrator/src/cli/run_gateway_probe_test.rs b/tools/internal/localnet-orchestrator/src/cli/run_gateway_probe_test.rs
@@ -16,18 +16,25 @@ pub(crate) struct Args {
     /// If not provided, it is going to get assumed that the current directory is the monorepo root
     #[clap(long)]
     monorepo_root: Option<PathBuf>,
+
+    /// additional, optional flags to pass when starting the gateway probe
+    /// e.g. "--ignore-egress-epoch-role --netstack-args='...'"
+    #[clap(long)]
+    probe_args: Option<String>,
 }
 
 pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
-    let orchestrator = LocalnetOrchestrator::new(args.common).await?;
-    if orchestrator.state != LocalnetState::RunningNymNodes {
-        bail!(
-            "can't test the gateway probe as the localnet does not appear to be running. the localnet is in {} state.",
-            orchestrator.state
-        )
-    }
+    let orchestrator = LocalnetOrchestrator::new(&args.common).await?;
+    // if orchestrator.state != LocalnetState::RunningNymNodes {
+    //     bail!(
+    //         "can't test the gateway probe as the localnet does not appear to be running. the localnet is in {} state.",
+    //         orchestrator.state
+    //     )
+    // }
 
-    orchestrator.run_gateway_probe(args.monorepo_root).await?;
+    orchestrator
+        .run_gateway_probe(args.monorepo_root, args.probe_args)
+        .await?;
 
     Ok(())
 }
diff --git a/tools/internal/localnet-orchestrator/src/cli/up.rs b/tools/internal/localnet-orchestrator/src/cli/up.rs
@@ -56,17 +56,13 @@ pub(crate) struct Args {
     #[clap(long, conflicts_with = "reproducible_builds")]
     allow_cached_build: bool,
 
-    /// Specify custom dns to be used by the nym-node containers
-    #[clap(long)]
-    custom_dns: Option<String>,
-
     /// Specify whether internal service providers should run in open proxy mode
     #[clap(long)]
     open_proxy: bool,
 }
 
 pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
-    let mut orchestrator = LocalnetOrchestrator::new(args.common).await?;
+    let mut orchestrator = LocalnetOrchestrator::new(&args.common).await?;
 
     // TODO: allow non-fresh state
     if orchestrator.state != LocalnetState::Uninitialised {
@@ -78,6 +74,7 @@ pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
             nyxd_setup: nyxd::Config {
                 nyxd_repo: args.nyxd_repo,
                 nyxd_dockerfile_path: args.nyxd_dockerfile_path,
+                custom_dns: args.common.custom_dns.clone(),
                 nyxd_tag: args.nyxd_tag,
             },
             contracts_setup: cosmwasm_contracts::Config {
@@ -91,11 +88,12 @@ pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {
             nym_api_setup: nym_api::Config {
                 cosmwasm_optimizer_image: args.cosmwasm_optimizer_image,
                 monorepo_root: args.monorepo_root.clone(),
+                custom_dns: args.common.custom_dns.clone(),
                 allow_cached_build: args.allow_cached_build,
             },
             nym_nodes_setup: nym_nodes::Config {
                 monorepo_root: args.monorepo_root,
-                custom_dns: args.custom_dns,
+                custom_dns: args.common.custom_dns,
                 open_proxy: args.open_proxy,
             },
         })
diff --git a/tools/internal/localnet-orchestrator/src/orchestrator/container_helpers/mod.rs b/tools/internal/localnet-orchestrator/src/orchestrator/container_helpers/mod.rs
@@ -258,12 +258,18 @@ where
 pub(crate) async fn run_container<T, S, I>(
     ctx: &LocalnetContext<T>,
     args: I,
+    dns: Option<String>,
 ) -> anyhow::Result<Vec<u8>>
 where
     I: IntoIterator<Item = S>,
     S: AsRef<OsStr>,
 {
-    let cmd_args = attach_run_container_args(args);
+    let mut cmd_args = attach_run_container_args(args);
+    if let Some(dns) = dns {
+        // --dns $DNS
+        cmd_args.insert(0, "--dns".into());
+        cmd_args.insert(1, dns.into());
+    }
 
     run_container_cmd(ctx, "run".into(), cmd_args).await
 }
diff --git a/tools/internal/localnet-orchestrator/src/orchestrator/helpers.rs b/tools/internal/localnet-orchestrator/src/orchestrator/helpers.rs
@@ -6,7 +6,9 @@ use crate::helpers::wasm_code;
 use crate::orchestrator::LocalnetOrchestrator;
 use crate::orchestrator::container_helpers::check_container_is_running;
 use crate::orchestrator::context::LocalnetContext;
+use crate::orchestrator::setup::nym_nodes::{GATEWAYS, MIXNODES};
 use anyhow::{Context, bail};
+use nym_mixnet_contract_common::NodeId;
 use nym_validator_client::nyxd::CosmWasmClient;
 use nym_validator_client::nyxd::cosmwasm_client::types::UploadResult;
 use nym_validator_client::{DirectSigningHttpRpcNyxdClient, QueryHttpRpcNyxdClient};
@@ -74,18 +76,17 @@ impl LocalnetOrchestrator {
         &self,
         ctx: &LocalnetContext<T>,
     ) -> anyhow::Result<bool> {
-        // HARDCODED: we assume 1 gateway and 3 mixnodes for now
         let mut running = 0;
-        for id in 0..4 {
-            if check_container_is_running(ctx, &self.nym_node_container_name(id)).await? {
+        for id in 1..=GATEWAYS + MIXNODES {
+            if check_container_is_running(ctx, &self.nym_node_container_name(id as NodeId)).await? {
                 running += 1;
             }
         }
         // either ALL containers must be running or NONE of them. we must not be in a zombie state
         if running == 0 {
             return Ok(false);
         }
-        if running == 4 {
+        if running == GATEWAYS + MIXNODES {
             return Ok(true);
         }
         bail!("only a subset of nym node containers is running! this is not allowed ({running}/4")
diff --git a/tools/internal/localnet-orchestrator/src/orchestrator/mod.rs b/tools/internal/localnet-orchestrator/src/orchestrator/mod.rs
@@ -9,6 +9,7 @@ use crate::orchestrator::container_helpers::{
 };
 use crate::orchestrator::context::ephemeral_context;
 use crate::orchestrator::network::Localnet;
+use crate::orchestrator::setup::nym_nodes::{GATEWAYS, MIXNODES};
 use crate::orchestrator::state::LocalnetState;
 use crate::orchestrator::storage::orchestrator::LocalnetOrchestratorStorage;
 use crate::orchestrator::storage::{
@@ -38,15 +39,16 @@ pub(crate) struct LocalnetOrchestrator {
 }
 
 impl LocalnetOrchestrator {
-    pub(crate) async fn new(args: CommonArgs) -> anyhow::Result<Self> {
+    pub(crate) async fn new(args: &CommonArgs) -> anyhow::Result<Self> {
         let orchestrator_data = args
             .orchestrator_db
+            .clone()
             .unwrap_or_else(default_orchestrator_db_file);
         let orchestrator_storage = LocalnetOrchestratorStorage::init(orchestrator_data).await?;
 
         // if network name has not been explicitly provided, we use the latest one created
         // or if this is the first one, we generate a new one
-        let network_name = match args.existing_network {
+        let network_name = match args.existing_network.clone() {
             // name provided => see if it existed
             Some(network_name) => {
                 // sanity check: try to load metadata (it will fail if entry does not exist)
@@ -79,7 +81,7 @@ impl LocalnetOrchestrator {
             }
         };
 
-        let localnet_directory = match args.localnet_storage_path {
+        let localnet_directory = match args.localnet_storage_path.clone() {
             Some(localnet_storage_path) => localnet_storage_path,
             None => {
                 if args.ephemeral {
@@ -190,9 +192,10 @@ impl LocalnetOrchestrator {
             return Ok(());
         }
 
-        // once implemented check for contracts, dkg, etc.
+        if self.check_nym_node_containers_are_running(&ctx).await? {
+            self.state = LocalnetState::RunningNymNodes;
+        }
 
-        warn!("unimplemented state resync");
         Ok(())
     }
 
diff --git a/tools/internal/localnet-orchestrator/src/orchestrator/setup/nym_api.rs b/tools/internal/localnet-orchestrator/src/orchestrator/setup/nym_api.rs
@@ -67,6 +67,7 @@ impl PemStorableKey for FakeDkgKey<'_> {
 pub(crate) struct Config {
     pub(crate) cosmwasm_optimizer_image: String,
     pub(crate) monorepo_root: Option<PathBuf>,
+    pub(crate) custom_dns: Option<String>,
     pub(crate) allow_cached_build: bool,
 }
 
@@ -100,13 +101,15 @@ struct NymApiSetup {
     ed25519_public_key_location: NamedTempFile,
     dkg_bypass_contract: ContractBeingInitialised,
     dkg_keys: Option<DKGKeys>,
+    custom_dns: Option<String>,
 }
 
 impl NymApiSetup {
     pub(crate) fn new(config: Config) -> anyhow::Result<Self> {
         let monorepo_root = monorepo_root_path(config.monorepo_root)?;
 
         Ok(NymApiSetup {
+            custom_dns: config.custom_dns,
             allow_cached_build: config.allow_cached_build,
             cosmwasm_optimizer_image: config.cosmwasm_optimizer_image,
             monorepo_root,
@@ -497,6 +500,7 @@ impl LocalnetOrchestrator {
                 "--announce-address",
                 "http://placeholder.nym",
             ],
+            ctx.data.custom_dns.clone(),
         )
         .await?;
 
@@ -554,6 +558,7 @@ nym-api -c /root/.nym/nym-api/default/localnet.env run --allow-illegal-ips --ann
                 "-c",
                 startup_cmd,
             ],
+            ctx.data.custom_dns.clone(),
         )
         .await?;
 
diff --git a/tools/internal/localnet-orchestrator/src/orchestrator/setup/nym_nodes.rs b/tools/internal/localnet-orchestrator/src/orchestrator/setup/nym_nodes.rs
@@ -35,8 +35,8 @@ use tracing::info;
 
 // for now just bond 3 mixnodes and 1 gateway
 // in the future this could be made configurable
-const GATEWAYS: usize = 1;
-const MIXNODES: usize = 3;
+pub(crate) const GATEWAYS: usize = 1;
+pub(crate) const MIXNODES: usize = 3;
 
 pub(crate) struct Config {
     pub(crate) monorepo_root: Option<PathBuf>,
@@ -189,7 +189,7 @@ impl LocalnetOrchestrator {
             args.push("mixnode");
         }
 
-        run_container(ctx, args).await?;
+        run_container(ctx, args, ctx.data.custom_dns.clone()).await?;
 
         // 2. retrieve current identity key
         let private_key_path = self.storage.nym_node_ed25519_private_key_path(node_id);
@@ -267,10 +267,6 @@ impl LocalnetOrchestrator {
         fs::write(env_path, &content)?;
 
         let mut args = Vec::new();
-        if let Some(dns) = &ctx.data.custom_dns {
-            args.push("--dns".to_string());
-            args.push(dns.to_string());
-        }
 
         let mut run_cmd = r#"CONTAINER_IP=$(hostname -i);
 nym-node -c /root/.nym/nym-nodes/default-nym-node/localnet.env run --accept-operator-terms-and-conditions --public-ips ${CONTAINER_IP} --local --unsafe-disable-noise --wireguard-userspace true --unsafe-disable-replay-protection"#.to_string();
@@ -292,7 +288,7 @@ nym-node -c /root/.nym/nym-nodes/default-nym-node/localnet.env run --accept-oper
         args.push(run_cmd);
 
         // 2. start the container
-        run_container(ctx, args).await?;
+        run_container(ctx, args, ctx.data.custom_dns.clone()).await?;
 
         Ok(())
     }
@@ -547,6 +543,7 @@ nym-node -c /root/.nym/nym-nodes/default-nym-node/localnet.env run --accept-oper
                 "-c",
                 &refresh_cache,
             ],
+            ctx.data.custom_dns.clone(),
         )
         .await?;
 
@@ -751,6 +748,7 @@ VALUES ({node_id}, '{identity}');
                 "-c",
                 &refresh_cache,
             ],
+            ctx.data.custom_dns.clone(),
         )
         .await?;
 
diff --git a/tools/internal/localnet-orchestrator/src/orchestrator/setup/nyxd.rs b/tools/internal/localnet-orchestrator/src/orchestrator/setup/nyxd.rs
diff --git a/tools/internal/localnet-orchestrator/src/orchestrator/test_cmds/gateway_probe.rs b/tools/internal/localnet-orchestrator/src/orchestrator/test_cmds/gateway_probe.rs

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ pub(crate) struct Args {`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {`
`14`		`- LocalnetOrchestrator::new(args.common)`
	`14`	`+ LocalnetOrchestrator::new(&args.common)`
`15`	`15`	`.await?`
`16`	`16`	`.stop_localnet()`
`17`	`17`	`.await`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ pub(crate) struct Args {`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {`
`55`		`- let mut orchestrator = LocalnetOrchestrator::new(args.common).await?;`
	`55`	`+ let mut orchestrator = LocalnetOrchestrator::new(&args.common).await?;`
`56`	`56`
`57`	`57`	`if orchestrator.state != LocalnetState::RunningNyxd {`
`58`	`58`	`bail!(`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ pub(crate) struct Args {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {`
`29`		`- LocalnetOrchestrator::new(args.common)`
	`29`	`+ LocalnetOrchestrator::new(&args.common)`
`30`	`30`	`.await?`
`31`	`31`	`.purge_localnet(purge::Config {`
`32`	`32`	`remove_images: args.remove_images,`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ pub(crate) struct Args {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`pub(crate) async fn execute(args: Args) -> anyhow::Result<()> {`
`25`		`- let orchestrator = LocalnetOrchestrator::new(args.common).await?;`
	`25`	`+ let orchestrator = LocalnetOrchestrator::new(&args.common).await?;`
`26`	`26`
`27`	`27`	`orchestrator`
`28`	`28`	`.rebuild_binaries_image(rebuild_binaries_image::Config {`