Improve usability of switch port settings (#7966)

This PR aims to improve the usability of the switch port settings API by
returning data of similar shape and content as what users provide when
the create the switch port settings.

Issues resolved:
* Before this PR, you only need one call to create a complete switch
port settings object, but you have to perform several lookups to get the
complete switch port configuration. We were already returning the object
ids of the nested objects, so it makes a lot of sense to just return the
actual object (especially since the user supplied the entire object when
they configured it)
* The `HashMap<String_of_link_name, T>` pattern also did not give the
expected behavior in our go client generation. Changing this to a
`Vec<T_with_link_name_inside>` matches what the user provides during
creation and also resolves this behavior.
* Some of our `Vec<T>` fields can be empty but must be present. In the
Go client, an empty array is omitted from the json object. We needed to
add a `default` annotation to these fields so Serde handles this
situation correctly.

## Related
- oxidecomputer/oxide.go#278
- oxidecomputer/terraform-provider-oxide#426

Closes #5780

Author: internet-diglett

common/src/api/external/mod.rs

@@ -2466,7 +2466,7 @@ pub struct SwitchPort {
 #[derive(
     ObjectIdentity, Clone, Debug, Deserialize, JsonSchema, Serialize, PartialEq,
 )]
-pub struct SwitchPortSettings {
+pub struct SwitchPortSettingsIdentity {
     #[serde(flatten)]
     pub identity: IdentityMetadata,
 }
@@ -2475,9 +2475,9 @@ pub struct SwitchPortSettings {
 /// convenience data structure for getting a complete view of a particular
 /// port's settings.
 #[derive(Clone, Debug, Deserialize, JsonSchema, Serialize, PartialEq)]
-pub struct SwitchPortSettingsView {
-    /// The primary switch port settings handle.
-    pub settings: SwitchPortSettings,
+pub struct SwitchPortSettings {
+    #[serde(flatten)]
+    pub identity: IdentityMetadata,
 
     /// Switch port settings included from other switch port settings groups.
     pub groups: Vec<SwitchPortSettingsGroups>,
@@ -2488,13 +2488,6 @@ pub struct SwitchPortSettingsView {
     /// Layer 2 link settings.
     pub links: Vec<SwitchPortLinkConfig>,
 
-    /// Link-layer discovery protocol (LLDP) settings.
-    pub link_lldp: Vec<LldpLinkConfig>,
-
-    /// TX equalization settings.  These are optional, and most links will not
-    /// need them.
-    pub tx_eq: Vec<Option<TxEqConfig>>,
-
     /// Layer 3 interface settings.
     pub interfaces: Vec<SwitchInterfaceConfig>,
 
@@ -2508,7 +2501,7 @@ pub struct SwitchPortSettingsView {
     pub bgp_peers: Vec<BgpPeer>,
 
     /// Layer 3 IP address settings.
-    pub addresses: Vec<SwitchPortAddressConfig>,
+    pub addresses: Vec<SwitchPortAddressView>,
 }
 
 /// This structure maps a port settings object to a port settings groups. Port
@@ -2633,13 +2626,6 @@ pub struct SwitchPortLinkConfig {
     /// The port settings this link configuration belongs to.
     pub port_settings_id: Uuid,
 
-    /// The link-layer discovery protocol service configuration id for this
-    /// link.
-    pub lldp_link_config_id: Option<Uuid>,
-
-    /// The tx_eq configuration id for this link.
-    pub tx_eq_config_id: Option<Uuid>,
-
     /// The name of this link.
     pub link_name: String,
 
@@ -2656,6 +2642,13 @@ pub struct SwitchPortLinkConfig {
 
     /// Whether or not the link has autonegotiation enabled.
     pub autoneg: bool,
+
+    /// The link-layer discovery protocol service configuration for this
+    /// link.
+    pub lldp_link_config: Option<LldpLinkConfig>,
+
+    /// The tx_eq configuration for this link.
+    pub tx_eq_config: Option<TxEqConfig>,
 }
 
 /// A link layer discovery protocol (LLDP) service configuration.
@@ -2683,7 +2676,7 @@ pub struct LldpLinkConfig {
     pub system_description: Option<String>,
 
     /// The LLDP management IP TLV.
-    pub management_ip: Option<oxnet::IpNet>,
+    pub management_ip: Option<IpAddr>,
 }
 
 /// Information about LLDP advertisements from other network entities directly
@@ -2746,18 +2739,6 @@ pub struct TxEqConfig {
     pub post1: Option<i32>,
 }
 
-impl From<crate::api::internal::shared::TxEqConfig> for TxEqConfig {
-    fn from(x: crate::api::internal::shared::TxEqConfig) -> TxEqConfig {
-        TxEqConfig {
-            pre1: x.pre1,
-            pre2: x.pre2,
-            main: x.main,
-            post2: x.post2,
-            post1: x.post1,
-        }
-    }
-}
-
 /// Describes the kind of an switch interface.
 #[derive(Clone, Debug, Deserialize, JsonSchema, Serialize, PartialEq)]
 #[serde(rename_all = "snake_case")]
@@ -2825,7 +2806,7 @@ pub struct SwitchPortRouteConfig {
     pub dst: oxnet::IpNet,
 
     /// The route's gateway address.
-    pub gw: oxnet::IpNet,
+    pub gw: IpAddr,
 
     /// The VLAN identifier for the route. Use this if the gateway is reachable
     /// over an 802.1Q tagged L2 segment.
@@ -2981,6 +2962,33 @@ pub struct SwitchPortAddressConfig {
     pub interface_name: String,
 }
 
+/// An IP address configuration for a port settings object.
+#[derive(Clone, Debug, Deserialize, JsonSchema, Serialize, PartialEq)]
+pub struct SwitchPortAddressView {
+    /// The port settings object this address configuration belongs to.
+    pub port_settings_id: Uuid,
+
+    /// The id of the address lot this address is drawn from.
+    pub address_lot_id: Uuid,
+
+    /// The name of the address lot this address is drawn from.
+    pub address_lot_name: Name,
+
+    /// The id of the address lot block this address is drawn from.
+    pub address_lot_block_id: Uuid,
+
+    /// The IP address and prefix.
+    pub address: oxnet::IpNet,
+
+    /// An optional VLAN ID
+    pub vlan_id: Option<u16>,
+
+    /// The interface name this address belongs to.
+    // TODO: https://github.com/oxidecomputer/omicron/issues/3050
+    // Use `Name` instead of `String` for `interface_name` type
+    pub interface_name: String,
+}
+
 /// The current state of a BGP peer.
 #[derive(Clone, Debug, Deserialize, JsonSchema, Serialize, PartialEq)]
 #[serde(rename_all = "snake_case")]

nexus/db-model/src/switch_port.rs

@@ -47,6 +47,28 @@ impl_enum_type!(
     Sfp28x4 => b"Sfp28x4"
 );
 
+impl PartialEq<params::SwitchPortGeometry> for SwitchPortGeometry {
+    fn eq(&self, other: &params::SwitchPortGeometry) -> bool {
+        match self {
+            Self::Qsfp28x1 => {
+                return matches!(other, params::SwitchPortGeometry::Qsfp28x1);
+            }
+            Self::Qsfp28x2 => {
+                return matches!(other, params::SwitchPortGeometry::Qsfp28x2);
+            }
+            Self::Sfp28x4 => {
+                return matches!(other, params::SwitchPortGeometry::Sfp28x4);
+            }
+        }
+    }
+}
+
+impl PartialEq<SwitchPortGeometry> for params::SwitchPortGeometry {
+    fn eq(&self, other: &SwitchPortGeometry) -> bool {
+        other.eq(self)
+    }
+}
+
 impl_enum_type!(
     SwitchLinkFecEnum:
 
@@ -286,9 +308,9 @@ impl SwitchPortSettings {
     }
 }
 
-impl Into<external::SwitchPortSettings> for SwitchPortSettings {
-    fn into(self) -> external::SwitchPortSettings {
-        external::SwitchPortSettings { identity: self.identity() }
+impl Into<external::SwitchPortSettingsIdentity> for SwitchPortSettings {
+    fn into(self) -> external::SwitchPortSettingsIdentity {
+        external::SwitchPortSettingsIdentity { identity: self.identity() }
     }
 }
 
@@ -407,21 +429,6 @@ impl SwitchPortLinkConfig {
     }
 }
 
-impl Into<external::SwitchPortLinkConfig> for SwitchPortLinkConfig {
-    fn into(self) -> external::SwitchPortLinkConfig {
-        external::SwitchPortLinkConfig {
-            port_settings_id: self.port_settings_id,
-            lldp_link_config_id: self.lldp_link_config_id,
-            tx_eq_config_id: self.tx_eq_config_id,
-            link_name: self.link_name.clone(),
-            mtu: self.mtu.into(),
-            fec: self.fec.map(|fec| fec.into()),
-            speed: self.speed.into(),
-            autoneg: self.autoneg,
-        }
-    }
-}
-
 #[derive(
     Queryable,
     Insertable,
@@ -486,7 +493,7 @@ impl Into<external::LldpLinkConfig> for LldpLinkConfig {
             chassis_id: self.chassis_id.clone(),
             system_name: self.system_name.clone(),
             system_description: self.system_description.clone(),
-            management_ip: self.management_ip.map(|a| a.into()),
+            management_ip: self.management_ip.map(|a| a.ip()),
         }
     }
 }
@@ -625,7 +632,7 @@ impl Into<external::SwitchPortRouteConfig> for SwitchPortRouteConfig {
             port_settings_id: self.port_settings_id,
             interface_name: self.interface_name.clone(),
             dst: self.dst.into(),
-            gw: self.gw.into(),
+            gw: self.gw.ip(),
             vlan_id: self.vid.map(Into::into),
             rib_priority: self.rib_priority.map(Into::into),
         }