Optionally configure mgs and internal dns ports for omicron-dev.

This completes the set of omicron-dev ports used in the simulated workflow that
includes `run-all` and a second nexus:

https://github.com/oxidecomputer/omicron/blob/main/docs/how-to-run-simulated.adoc#using-both-omicron-dev-run-all-and-running-nexus-manually

Author: jmcarp

dev-tools/omicron-dev/Cargo.toml

@@ -22,7 +22,6 @@ nexus-config.workspace = true
 nexus-test-interface.workspace = true
 nexus-test-utils = { workspace = true, features = ["omicron-dev"] }
 omicron-nexus.workspace = true
-omicron-test-utils.workspace = true
 omicron-workspace-hack.workspace = true
 oxide-tokio-rt.workspace = true
 # See omicron-rpaths for more about the "pq-sys" dependency.

dev-tools/omicron-dev/src/main.rs

@@ -11,7 +11,6 @@ use libc::SIGINT;
 use nexus_config::NexusConfig;
 use nexus_test_interface::NexusServer;
 use nexus_test_utils::resource_helpers::DiskTest;
-use omicron_test_utils::COCKROACHDB_DEFAULT_LISTEN_PORT;
 use signal_hook_tokio::Signals;
 use std::fs;
 
@@ -49,12 +48,18 @@ enum OmicronDevCmd {
 
 #[derive(Clone, Debug, Args)]
 struct RunAllArgs {
-    /// Nexus external API listen port.  Use `0` to request any available port.
+    /// Nexus external API listen port. Use `0` to request any available port.
     #[clap(long, action)]
     nexus_listen_port: Option<u16>,
     /// CockroachDB listen port. Use `0` to request any available port.
-    #[clap(long, default_value_t = COCKROACHDB_DEFAULT_LISTEN_PORT)]
-    db_listen_port: u16,
+    #[clap(long)]
+    db_listen_port: Option<u16>,
+    /// Internal DNS listen port. Use `0` to request any available port.
+    #[clap(long)]
+    internal_dns_listen_port: Option<u16>,
+    /// Management gateway listen port. Use `0` to request any available port.
+    #[clap(long)]
+    mgs_listen_port: Option<u16>,
     /// Override the gateway server configuration file.
     #[clap(long, default_value = DEFAULT_SP_SIM_CONFIG)]
     gateway_config: Utf8PathBuf,
@@ -92,14 +97,18 @@ impl RunAllArgs {
         }
 
         println!("omicron-dev: setting up all services ... ");
-        let cptestctx =
-            nexus_test_utils::omicron_dev_setup_with_config::<
-                omicron_nexus::Server,
-            >(
-                &mut config, 0, self.gateway_config.clone(), self.db_listen_port
-            )
-            .await
-            .context("error setting up services")?;
+        let cptestctx = nexus_test_utils::omicron_dev_setup_with_config::<
+            omicron_nexus::Server,
+        >(
+            &mut config,
+            0,
+            self.gateway_config.clone(),
+            self.db_listen_port,
+            self.internal_dns_listen_port,
+            self.mgs_listen_port,
+        )
+        .await
+        .context("error setting up services")?;
 
         println!("omicron-dev: Adding disks to first sled agent");
 

nexus/test-utils/src/nexus_test.rs

@@ -361,10 +361,14 @@ pub async fn omicron_dev_setup_with_config<N: NexusServer>(
     config: &mut NexusConfig,
     extra_sled_agents: u16,
     gateway_config_file: Utf8PathBuf,
-    listen_port: u16,
+    db_listen_port: Option<u16>,
+    internal_dns_listen_port: Option<u16>,
+    mgs_listen_port: Option<u16>,
 ) -> Result<ControlPlaneTestContext<N>> {
     let mut starter = ControlPlaneStarter::<N>::new("omicron-dev", config);
-    starter.db_listen_port(listen_port);
+    starter.db_listen_port(db_listen_port);
+    starter.internal_dns_listen_port(internal_dns_listen_port);
+    starter.mgs_listen_port(mgs_listen_port);
 
     let log = &starter.logctx.log;
     debug!(log, "Ensuring seed tarball exists");

nexus/test-utils/src/starter.rs

@@ -168,6 +168,8 @@ pub struct ControlPlaneStarter<'a, N: NexusServer> {
     pub simulated_upstairs: Arc<sim::SimulatedUpstairs>,
 
     db_listen_port: u16,
+    internal_dns_listen_port: u16,
+    mgs_listen_port: Option<u16>,
 }
 
 type StepInitFn<'a, N> = Box<
@@ -219,11 +221,25 @@ impl<'a, N: NexusServer> ControlPlaneStarter<'a, N> {
                 simulated_upstairs_log,
             )),
             db_listen_port: dev::db::COCKROACHDB_DEFAULT_LISTEN_PORT,
+            internal_dns_listen_port: 0,
+            mgs_listen_port: None,
         }
     }
 
-    pub fn db_listen_port(&mut self, port: u16) {
-        self.db_listen_port = port;
+    pub fn db_listen_port(&mut self, port: Option<u16>) {
+        if let Some(port) = port {
+            self.db_listen_port = port;
+        }
+    }
+
+    pub fn internal_dns_listen_port(&mut self, port: Option<u16>) {
+        if let Some(port) = port {
+            self.internal_dns_listen_port = port;
+        }
+    }
+
+    pub fn mgs_listen_port(&mut self, port: Option<u16>) {
+        self.mgs_listen_port = port;
     }
 
     pub async fn init_with_steps(
@@ -1212,7 +1228,18 @@ impl<'a, N: NexusServer> ControlPlaneStarter<'a, N> {
     /// Set up an internal DNS server on the first sled agent
     pub async fn start_internal_dns(&mut self) {
         let log = self.logctx.log.new(o!("component" => "internal_dns_server"));
-        let dns = dns_server::TransientServer::new(&log).await.unwrap();
+        let dns_addr = SocketAddrV6::new(
+            Ipv6Addr::LOCALHOST,
+            self.internal_dns_listen_port,
+            0,
+            0,
+        );
+        let dns = dns_server::TransientServer::new_with_address(
+            &log,
+            dns_addr.into(),
+        )
+        .await
+        .unwrap();
 
         let SocketAddr::V6(dns_address) = dns.dns_server.local_address() else {
             panic!("Unsupported IPv4 DNS address");
@@ -1633,7 +1660,7 @@ pub(crate) async fn setup_with_config_impl<N: NexusServer>(
                         builder
                             .start_gateway(
                                 SwitchLocation::Switch0,
-                                None,
+                                builder.mgs_listen_port,
                                 mgs_config,
                             )
                             .boxed()
@@ -1677,7 +1704,7 @@ pub(crate) async fn setup_with_config_impl<N: NexusServer>(
                             builder
                                 .start_gateway(
                                     SwitchLocation::Switch1,
-                                    None,
+                                    builder.mgs_listen_port,
                                     gateway_config_file,
                                 )
                                 .boxed()

test-utils/src/lib.rs

@@ -15,8 +15,6 @@ use headers::authorization::Credentials;
 pub mod certificates;
 pub mod dev;
 
-pub use dev::db::COCKROACHDB_DEFAULT_LISTEN_PORT;
-
 #[macro_use]
 extern crate slog;