mirror of
https://github.com/apple/container.git
synced 2026-07-13 21:17:05 +00:00
Raj
3366916e80
## Motivation and Context This PR consolidates duplicated list-output formatting across the CLI into shared rendering infrastructure. Currently, each list command has its own copy of the same json/quiet/table branching. This PR pulls that into shared rendering infrastructure in `ContainerCommands`: - `ListDisplayable` protocol for table + quiet output - `renderJSON`, `renderTable`, `renderList` as pure functions that return strings - `emit()` as the single stdout boundary (no-ops on empty strings to avoid blank-line regressions) - `JSONOptions` so all JSON encoding goes through one path, including volume inspect's pretty + ISO 8601 case JSON encoding remains separate from display formatting: each command still chooses its own JSON model, while `ListDisplayable` is used only for table and quiet output. `ImageList` remains the intentional exception for quiet mode so it can avoid unnecessary async work. This change also replaces inline `JSONEncoder` usage with `renderJSON`, removes the old `Codable+JSON.swift` helper, and moves `TableOutput` and `ListFormat` into `ContainerCommands`. It also adds unit tests for the shared rendering helpers and expands integration coverage for image, network, and registry list formatting. ## Testing - [x] Tested locally - [x] Added/updated tests - [ ] Added/updated docs
92 lines
3.2 KiB
Swift
92 lines
3.2 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
// Copyright © 2025-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 ArgumentParser
|
|
import ContainerAPIClient
|
|
import ContainerResource
|
|
import ContainerizationExtras
|
|
import Foundation
|
|
import SwiftProtobuf
|
|
|
|
extension Application {
|
|
public struct ContainerList: AsyncLoggableCommand {
|
|
public static let configuration = CommandConfiguration(
|
|
commandName: "list",
|
|
abstract: "List running containers",
|
|
aliases: ["ls"])
|
|
|
|
@Flag(name: .shortAndLong, help: "Include containers that are not running")
|
|
var all = false
|
|
|
|
@Option(name: .long, help: "Format of the output")
|
|
var format: ListFormat = .table
|
|
|
|
@Flag(name: .shortAndLong, help: "Only output the container ID")
|
|
var quiet = false
|
|
|
|
@OptionGroup
|
|
public var logOptions: Flags.Logging
|
|
|
|
public init() {}
|
|
|
|
public func run() async throws {
|
|
let client = ContainerClient()
|
|
let filters = self.all ? ContainerListFilters.all : ContainerListFilters(status: .running)
|
|
let containers = try await client.list(filters: filters)
|
|
let items = containers.map { PrintableContainer($0) }
|
|
try Output.render(json: items, display: items, format: format, quiet: quiet)
|
|
}
|
|
}
|
|
}
|
|
|
|
extension PrintableContainer: ListDisplayable {
|
|
static var tableHeader: [String] {
|
|
["ID", "IMAGE", "OS", "ARCH", "STATE", "ADDR", "CPUS", "MEMORY", "STARTED"]
|
|
}
|
|
|
|
var tableRow: [String] {
|
|
[
|
|
self.configuration.id,
|
|
self.configuration.image.reference,
|
|
self.configuration.platform.os,
|
|
self.configuration.platform.architecture,
|
|
self.status.rawValue,
|
|
self.networks.map { $0.ipv4Address.description }.joined(separator: ","),
|
|
"\(self.configuration.resources.cpus)",
|
|
"\(self.configuration.resources.memoryInBytes / (1024 * 1024)) MB",
|
|
self.startedDate?.ISO8601Format() ?? "",
|
|
]
|
|
}
|
|
|
|
var quietValue: String {
|
|
self.configuration.id
|
|
}
|
|
}
|
|
|
|
struct PrintableContainer: Codable, Sendable {
|
|
let status: RuntimeStatus
|
|
let configuration: ContainerConfiguration
|
|
let networks: [Attachment]
|
|
let startedDate: Date?
|
|
|
|
init(_ container: ContainerSnapshot) {
|
|
self.status = container.status
|
|
self.configuration = container.configuration
|
|
self.networks = container.networks
|
|
self.startedDate = container.startedDate
|
|
}
|
|
}
|