mirror of
https://github.com/apple/container.git
synced 2026-07-12 20:47:04 +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
106 lines
3.6 KiB
Swift
106 lines
3.6 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 Foundation
|
|
|
|
extension Application {
|
|
public struct SystemDF: AsyncLoggableCommand {
|
|
public static let configuration = CommandConfiguration(
|
|
commandName: "df",
|
|
abstract: "Show disk usage for images, containers, and volumes"
|
|
)
|
|
|
|
@Option(name: .long, help: "Format of the output")
|
|
var format: ListFormat = .table
|
|
|
|
@OptionGroup
|
|
public var logOptions: Flags.Logging
|
|
|
|
public init() {}
|
|
|
|
public func run() async throws {
|
|
let stats = try await ClientDiskUsage.get()
|
|
|
|
if format == .json {
|
|
try Output.emit(Output.renderJSON(stats, options: .prettySorted))
|
|
return
|
|
}
|
|
|
|
printTable(stats: stats)
|
|
}
|
|
|
|
private func printTable(stats: DiskUsageStats) {
|
|
var rows: [[String]] = []
|
|
|
|
// Header row
|
|
rows.append(["TYPE", "TOTAL", "ACTIVE", "SIZE", "RECLAIMABLE"])
|
|
|
|
// Images row
|
|
rows.append([
|
|
"Images",
|
|
"\(stats.images.total)",
|
|
"\(stats.images.active)",
|
|
formatSize(stats.images.sizeInBytes),
|
|
formatReclaimable(stats.images.reclaimable, total: stats.images.sizeInBytes),
|
|
])
|
|
|
|
// Containers row
|
|
rows.append([
|
|
"Containers",
|
|
"\(stats.containers.total)",
|
|
"\(stats.containers.active)",
|
|
formatSize(stats.containers.sizeInBytes),
|
|
formatReclaimable(stats.containers.reclaimable, total: stats.containers.sizeInBytes),
|
|
])
|
|
|
|
// Volumes row
|
|
rows.append([
|
|
"Local Volumes",
|
|
"\(stats.volumes.total)",
|
|
"\(stats.volumes.active)",
|
|
formatSize(stats.volumes.sizeInBytes),
|
|
formatReclaimable(stats.volumes.reclaimable, total: stats.volumes.sizeInBytes),
|
|
])
|
|
|
|
let tableFormatter = TableOutput(rows: rows)
|
|
print(tableFormatter.format())
|
|
}
|
|
|
|
private func formatSize(_ bytes: UInt64) -> String {
|
|
if bytes == 0 {
|
|
return "0 B"
|
|
}
|
|
let formatter = ByteCountFormatter()
|
|
formatter.countStyle = .file
|
|
return formatter.string(fromByteCount: Int64(bytes))
|
|
}
|
|
|
|
private func formatReclaimable(_ reclaimable: UInt64, total: UInt64) -> String {
|
|
let sizeStr = formatSize(reclaimable)
|
|
|
|
if total == 0 {
|
|
return "\(sizeStr) (0%)"
|
|
}
|
|
|
|
// Cap at 100% in case reclaimable > total (shouldn't happen but be defensive)
|
|
let percentage = min(100, Int(round(Double(reclaimable) / Double(total) * 100.0)))
|
|
return "\(sizeStr) (\(percentage)%)"
|
|
}
|
|
}
|
|
}
|