mirror of
https://github.com/apple/container.git
synced 2026-09-18 05:35:37 +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
81 lines
2.7 KiB
Swift
81 lines
2.7 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 ContainerLog
|
|
import ContainerResource
|
|
import ContainerizationError
|
|
import Foundation
|
|
import Logging
|
|
import SwiftProtobuf
|
|
|
|
extension Application {
|
|
public struct ImageInspect: AsyncLoggableCommand {
|
|
public static let configuration = CommandConfiguration(
|
|
commandName: "inspect",
|
|
abstract: "Display information about one or more images")
|
|
|
|
@OptionGroup
|
|
public var logOptions: Flags.Logging
|
|
|
|
@Argument(help: "Images to inspect")
|
|
var images: [String]
|
|
|
|
public init() {}
|
|
|
|
struct InspectError: Error {
|
|
let succeeded: [String]
|
|
let failed: [(String, Error)]
|
|
}
|
|
|
|
public func run() async throws {
|
|
var printable: [ImageDetail] = []
|
|
var succeededImages: [String] = []
|
|
var allErrors: [(String, Error)] = []
|
|
|
|
let result = try await ClientImage.get(names: images)
|
|
|
|
for image in result.images {
|
|
guard !Utility.isInfraImage(name: image.reference) else { continue }
|
|
printable.append(try await image.details())
|
|
succeededImages.append(image.reference)
|
|
}
|
|
|
|
for missing in result.error {
|
|
allErrors.append((missing, ContainerizationError(.notFound, message: "Image not found")))
|
|
}
|
|
|
|
if !printable.isEmpty {
|
|
try Output.emit(Output.renderJSON(printable))
|
|
}
|
|
|
|
if !allErrors.isEmpty {
|
|
for (name, error) in allErrors {
|
|
log.error(
|
|
"image inspect failed",
|
|
metadata: [
|
|
"name": "\(name)",
|
|
"error": "\(error.localizedDescription)",
|
|
])
|
|
}
|
|
|
|
throw InspectError(succeeded: succeededImages, failed: allErrors)
|
|
}
|
|
}
|
|
}
|
|
}
|