mirror of
https://github.com/apple/container.git
synced 2026-07-13 04:57:08 +00:00
Saehej Kang
9fd15f01bf
## Type of Change - [x] Bug fix - [ ] New feature - [x] Breaking change - [ ] Documentation update ## Motivation and Context Adds backward-compatible JSON decoding/encoding fallback for `Attachment` and `NetworkStatus` to prevent `keyNotFound` errors when communicating with older `container-apiserver` versions. Temporary fix but closes #1196 ## Testing Tests ✅ based on comment [here](https://github.com/apple/container/issues/1196#issuecomment-3902754548) --------- Co-authored-by: Ed Saipetch <ed@twentybelow.com>
103 lines
4.2 KiB
Swift
103 lines
4.2 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
// Copyright © 2026 Apple Inc. and the container project authors.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import ContainerizationExtras
|
|
|
|
/// A snapshot of a network interface for a sandbox.
|
|
public struct Attachment: Codable, Sendable {
|
|
/// The network ID associated with the attachment.
|
|
public let network: String
|
|
/// The hostname associated with the attachment.
|
|
public let hostname: String
|
|
/// The CIDR address describing the interface IPv4 address, with the prefix length of the subnet.
|
|
public let ipv4Address: CIDRv4
|
|
/// The IPv4 gateway address.
|
|
public let ipv4Gateway: IPv4Address
|
|
/// The CIDR address describing the interface IPv6 address, with the prefix length of the subnet.
|
|
/// The address is nil if the IPv6 subnet could not be determined at network creation time.
|
|
public let ipv6Address: CIDRv6?
|
|
/// The MAC address associated with the attachment (optional).
|
|
public let macAddress: MACAddress?
|
|
/// The MTU for the network interface.
|
|
public let mtu: UInt32?
|
|
|
|
public init(
|
|
network: String,
|
|
hostname: String,
|
|
ipv4Address: CIDRv4,
|
|
ipv4Gateway: IPv4Address,
|
|
ipv6Address: CIDRv6?,
|
|
macAddress: MACAddress?,
|
|
mtu: UInt32? = nil
|
|
) {
|
|
self.network = network
|
|
self.hostname = hostname
|
|
self.ipv4Address = ipv4Address
|
|
self.ipv4Gateway = ipv4Gateway
|
|
self.ipv6Address = ipv6Address
|
|
self.macAddress = macAddress
|
|
self.mtu = mtu
|
|
}
|
|
|
|
enum CodingKeys: String, CodingKey {
|
|
case network
|
|
case hostname
|
|
case ipv4Address
|
|
case ipv4Gateway
|
|
case ipv6Address
|
|
case macAddress
|
|
case mtu
|
|
// TODO: retain for deserialization compatibility for now, remove later
|
|
case address
|
|
case gateway
|
|
}
|
|
|
|
/// Create a configuration from the supplied Decoder, initializing missing
|
|
/// values where possible to reasonable defaults.
|
|
public init(from decoder: Decoder) throws {
|
|
let container = try decoder.container(keyedBy: CodingKeys.self)
|
|
|
|
network = try container.decode(String.self, forKey: .network)
|
|
hostname = try container.decode(String.self, forKey: .hostname)
|
|
if let address = try? container.decode(CIDRv4.self, forKey: .ipv4Address) {
|
|
ipv4Address = address
|
|
} else {
|
|
ipv4Address = try container.decode(CIDRv4.self, forKey: .address)
|
|
}
|
|
if let gateway = try? container.decode(IPv4Address.self, forKey: .ipv4Gateway) {
|
|
ipv4Gateway = gateway
|
|
} else {
|
|
ipv4Gateway = try container.decode(IPv4Address.self, forKey: .gateway)
|
|
}
|
|
ipv6Address = try container.decodeIfPresent(CIDRv6.self, forKey: .ipv6Address)
|
|
macAddress = try container.decodeIfPresent(MACAddress.self, forKey: .macAddress)
|
|
mtu = try container.decodeIfPresent(UInt32.self, forKey: .mtu)
|
|
}
|
|
|
|
/// Encode the configuration to the supplied Encoder.
|
|
public func encode(to encoder: Encoder) throws {
|
|
var container = encoder.container(keyedBy: CodingKeys.self)
|
|
|
|
try container.encode(network, forKey: .network)
|
|
try container.encode(hostname, forKey: .hostname)
|
|
try container.encode(ipv4Address, forKey: .ipv4Address)
|
|
try container.encode(ipv4Gateway, forKey: .ipv4Gateway)
|
|
try container.encodeIfPresent(ipv6Address, forKey: .ipv6Address)
|
|
try container.encodeIfPresent(macAddress, forKey: .macAddress)
|
|
try container.encodeIfPresent(mtu, forKey: .mtu)
|
|
}
|
|
}
|