gateway: versionify; use progenitor client in tests (#8917)

Ticks another box on #8727.

Author: iliana

Cargo.lock

@@ -48,7 +48,7 @@ use types::ComponentFirmwareHashStatus;
 // call into each other. Since `gateway` is a lower-level service and never
 // calls into Nexus, the current scheme is okay.)
 progenitor::generate_api!(
-    spec = "../../openapi/gateway.json",
+    spec = "../../openapi/gateway/gateway-latest.json",
     interface = Positional,
     inner_type = slog::Logger,
     pre_hook = (|log: &slog::Logger, request: &reqwest::Request| {
@@ -70,6 +70,7 @@ progenitor::generate_api!(
         RotImageError = { derives = [ thiserror::Error, PartialEq, Eq, PartialOrd, Ord] },
         RotState = { derives = [PartialEq, Eq, PartialOrd, Ord] },
         SpComponentCaboose = { derives = [PartialEq, Eq] },
+        SpComponentInfo = { derives = [PartialEq, Eq] },
         SpIdentifier = { derives = [Copy, PartialEq, Hash, Eq] },
         SpIgnition = { derives = [PartialEq, Eq, PartialOrd, Ord] },
         SpIgnitionSystemType = { derives = [Copy, PartialEq, Eq, PartialOrd, Ord] },
@@ -82,6 +83,8 @@ progenitor::generate_api!(
         RotSlot = gateway_types::rot::RotSlot,
         Ena = ereport_types::Ena,
         Ereport = ereport_types::Ereport,
+        Ereports = ereport_types::Ereports,
+        TaskDump = gateway_types::task_dump::TaskDump,
         TypedUuidForEreporterRestartKind = omicron_uuid_kinds::EreporterRestartUuid,
         TypedUuidForMupdateKind = omicron_uuid_kinds::MupdateUuid,
     },

clients/gateway-client/src/lib.rs

@@ -81,8 +81,7 @@ impl MgsRunArgs {
         .await;
         println!("mgs-dev: MGS is running.");
 
-        let addr = gwtestctx.client.bind_address;
-        println!("mgs-dev: MGS API: http://{:?}", addr);
+        println!("mgs-dev: MGS API: {}", gwtestctx.client.baseurl());
 
         // Wait for a signal.
         let caught_signal = signal_stream.next().await;

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

@@ -231,7 +231,7 @@ SP DETAILS: type "Switch" slot 1
 
 ---------------------------------------------
 stderr:
-note: using MGS URL http://[::1]:REDACTED_PORT/
+note: using MGS URL http://[::1]:REDACTED_PORT
 =============================================
 EXECUTING COMMAND: omdb ["nexus", "background-tasks", "doc"]
 termination: Exited(0)

dev-tools/omdb/tests/successes.out

@@ -138,15 +138,12 @@ async fn test_omdb_success_cases(cptestctx: &ControlPlaneTestContext) {
     let postgres_url = cptestctx.database.listen_url();
     let nexus_internal_url =
         format!("http://{}/", cptestctx.internal_client.bind_address);
-    let mgs_url = format!(
-        "http://{}/",
-        cptestctx
-            .gateway
-            .get(&SwitchLocation::Switch0)
-            .expect("nexus_test always sets up MGS on switch 0")
-            .client
-            .bind_address
-    );
+    let mgs_url = cptestctx
+        .gateway
+        .get(&SwitchLocation::Switch0)
+        .expect("nexus_test always sets up MGS on switch 0")
+        .client
+        .baseurl();
     let ox_url = format!("http://{}/", cptestctx.oximeter.server_address());
     let ox_test_producer = cptestctx.producer.address().ip();
     let ch_url = format!("http://{}/", cptestctx.clickhouse.http_address());

dev-tools/omdb/tests/test_all_output.rs

@@ -149,8 +149,9 @@ impl RunAllArgs {
         );
         for (location, gateway) in &cptestctx.gateway {
             println!(
-                "omicron-dev: management gateway:    http://{} ({})",
-                gateway.client.bind_address, location,
+                "omicron-dev: management gateway:    {} ({})",
+                gateway.client.baseurl(),
+                location,
             );
         }
         println!("omicron-dev: silo name:             {}", cptestctx.silo_name,);

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

@@ -98,7 +98,7 @@ pub fn all_apis() -> Vec<ManagedApiConfig> {
         },
         ManagedApiConfig {
             title: "Oxide Management Gateway Service API",
-            versions: Versions::new_lockstep(semver::Version::new(0, 0, 1)),
+            versions: Versions::new_versioned(gateway_api::supported_versions()),
             description: "API for interacting with the Oxide \
                 control plane's gateway service",
             boundary: ApiBoundary::Internal,

dev-tools/openapi-manager/src/omicron.rs

@@ -14,6 +14,8 @@ gateway-types.workspace = true
 omicron-common.workspace = true
 omicron-uuid-kinds.workspace = true
 omicron-workspace-hack.workspace = true
+openapi-manager-types.workspace = true
 schemars.workspace = true
+semver.workspace = true
 serde.workspace = true
 uuid.workspace = true

gateway-api/Cargo.toml

@@ -26,10 +26,40 @@ use gateway_types::{
         SpComponentResetError, SpUpdateStatus,
     },
 };
+use openapi_manager_types::{
+    SupportedVersion, SupportedVersions, api_versions,
+};
 use schemars::JsonSchema;
 use serde::Deserialize;
 use uuid::Uuid;
 
+api_versions!([
+    // WHEN CHANGING THE API (part 1 of 2):
+    //
+    // +- Pick a new semver and define it in the list below.  The list MUST
+    // |  remain sorted, which generally means that your version should go at
+    // |  the very top.
+    // |
+    // |  Duplicate this line, uncomment the *second* copy, update that copy for
+    // |  your new API version, and leave the first copy commented out as an
+    // |  example for the next person.
+    // v
+    // (next_int, IDENT),
+    (1, INITIAL),
+]);
+
+// WHEN CHANGING THE API (part 2 of 2):
+//
+// The call to `api_versions!` above defines constants of type
+// `semver::Version` that you can use in your Dropshot API definition to specify
+// the version when a particular endpoint was added or removed.  For example, if
+// you used:
+//
+//     (2, ADD_FOOBAR)
+//
+// Then you could use `VERSION_ADD_FOOBAR` as the version in which endpoints
+// were added or removed.
+
 /// This endpoint is used to upload SP and ROT Hubris archives as well as phase 1 host OS
 /// images. The phase 1 image is 32 MiB, driven by the QSPI flash on hardware.
 const SP_COMPONENT_UPDATE_MAX_BYTES: usize = 64 * 1024 * 1024;

gateway-api/src/lib.rs

@@ -6,7 +6,6 @@
 
 use camino::Utf8Path;
 use camino::Utf8PathBuf;
-use dropshot::test_util::ClientTestContext;
 use dropshot::test_util::LogContext;
 use gateway_messages::SpPort;
 use omicron_gateway::MgsArguments;
@@ -18,7 +17,6 @@ use omicron_test_utils::dev::poll::CondCheckError;
 use qorb::resolver::AllBackends;
 use qorb::resolver::Resolver;
 use qorb::resolvers::fixed::FixedResolver;
-use slog::o;
 use sp_sim::SimRack;
 use sp_sim::SimulatedSp;
 use std::collections::HashSet;
@@ -37,8 +35,9 @@ pub const DEFAULT_SP_SIM_CONFIG: &str =
     concat!(env!("CARGO_MANIFEST_DIR"), "/configs/sp_sim_config.test.toml");
 
 pub struct GatewayTestContext {
-    pub client: ClientTestContext,
+    pub client: gateway_client::Client,
     pub server: omicron_gateway::Server,
+    pub port: u16,
     pub simrack: SimRack,
     pub logctx: LogContext,
     pub gateway_id: Uuid,
@@ -47,13 +46,6 @@ pub struct GatewayTestContext {
 }
 
 impl GatewayTestContext {
-    pub fn client(&self) -> gateway_client::Client {
-        gateway_client::Client::new(
-            &self.client.url("/").to_string(),
-            self.logctx.log.new(slog::o!("component" => "MgsClient")),
-        )
-    }
-
     pub fn mgs_backends(&self) -> watch::Receiver<AllBackends> {
         self.resolver_backends.clone()
     }
@@ -268,9 +260,9 @@ pub async fn test_setup_with_config(
         .dropshot_server_for_address(localhost_port_0)
         .unwrap()
         .local_addr();
-    let client = ClientTestContext::new(
-        server_addr,
-        log.new(o!("component" => "client test context")),
+    let client = gateway_client::Client::new(
+        &format!("http://{server_addr}"),
+        logctx.log.new(slog::o!("component" => "MgsClient")),
     );
 
     let mut resolver = FixedResolver::new(std::iter::once(server_addr));
@@ -279,6 +271,7 @@ pub async fn test_setup_with_config(
     GatewayTestContext {
         client,
         server,
+        port: server_addr.port(),
         simrack,
         logctx,
         gateway_id,