Files
container/Sources/ContainerCommands/System/SystemStatus.swift
T
Raj 3366916e80 Consolidate CLI formatting infrastructure (#1385)
## 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
2026-04-07 09:50:51 -07:00

126 lines
5.1 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 ContainerPlugin
import ContainerizationError
import Foundation
import Logging
extension Application {
public struct SystemStatus: AsyncLoggableCommand {
public static let configuration = CommandConfiguration(
commandName: "status",
abstract: "Show the status of `container` services"
)
@Option(name: .shortAndLong, help: "Launchd prefix for services")
var prefix: String = "com.apple.container."
@Option(name: .long, help: "Format of the output")
var format: ListFormat = .table
@OptionGroup
public var logOptions: Flags.Logging
public init() {}
struct PrintableStatus: Codable {
let status: String
let appRoot: String
let installRoot: String
let logRoot: String?
let apiServerVersion: String
let apiServerCommit: String
let apiServerBuild: String
let apiServerAppName: String
}
public func run() async throws {
let isRegistered = try ServiceManager.isRegistered(fullServiceLabel: "\(prefix)apiserver")
if !isRegistered {
if format == .json {
let status = PrintableStatus(
status: "unregistered",
appRoot: "",
installRoot: "",
logRoot: nil,
apiServerVersion: "",
apiServerCommit: "",
apiServerBuild: "",
apiServerAppName: ""
)
try Output.emit(Output.renderJSON(status))
} else {
print("apiserver is not running and not registered with launchd")
}
Application.exit(withError: ExitCode(1))
}
// Now ping our friendly daemon. Fail after 10 seconds with no response.
do {
let systemHealth = try await ClientHealthCheck.ping(timeout: .seconds(10))
if format == .json {
let status = PrintableStatus(
status: "running",
appRoot: systemHealth.appRoot.path(percentEncoded: false),
installRoot: systemHealth.installRoot.path(percentEncoded: false),
logRoot: systemHealth.logRoot?.string,
apiServerVersion: systemHealth.apiServerVersion,
apiServerCommit: systemHealth.apiServerCommit,
apiServerBuild: systemHealth.apiServerBuild,
apiServerAppName: systemHealth.apiServerAppName
)
try Output.emit(Output.renderJSON(status))
} else {
let rows: [[String]] = [
["FIELD", "VALUE"],
["status", "running"],
["appRoot", systemHealth.appRoot.path(percentEncoded: false)],
["installRoot", systemHealth.installRoot.path(percentEncoded: false)],
["logRoot", systemHealth.logRoot?.string ?? ""],
["apiserver.version", systemHealth.apiServerVersion],
["apiserver.commit", systemHealth.apiServerCommit],
["apiserver.build", systemHealth.apiServerBuild],
["apiserver.appName", systemHealth.apiServerAppName],
]
let formatter = TableOutput(rows: rows)
print(formatter.format())
}
} catch {
if format == .json {
let status = PrintableStatus(
status: "not running",
appRoot: "",
installRoot: "",
logRoot: nil,
apiServerVersion: "",
apiServerCommit: "",
apiServerBuild: "",
apiServerAppName: ""
)
try Output.emit(Output.renderJSON(status))
} else {
print("apiserver is not running")
}
Application.exit(withError: ExitCode(1))
}
}
}
}