mirror of
https://github.com/apple/container.git
synced 2026-07-31 22:01:01 +00:00
Danny CanterandGitHub
f7d00aad48
This is not intended to be used to support `--filter` or similar on the CLIs list yet, it's solely to clean up our rather awkward use of `ContainerClient.list()` today in the CLI. The list RPC simply returns all of the containers we have created. Because of this, for a LOT of our commands we filter to what we need client side, which feels like a waste.. This change introduces a filter struct that we can provide an array of container IDs, labels, and the status of the containers to filter the `list()` output from. This additionally, because it was killing (pun not intended) me and I was already having to change this area for the `list()` additions, changes container kill slightly to return an error if you try and kill a container that doesn't exist.
114 lines
3.8 KiB
Swift
114 lines
3.8 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)
|
|
try printContainers(containers: containers, format: format)
|
|
}
|
|
|
|
private func createHeader() -> [[String]] {
|
|
[["ID", "IMAGE", "OS", "ARCH", "STATE", "ADDR", "CPUS", "MEMORY", "STARTED"]]
|
|
}
|
|
|
|
private func printContainers(containers: [ContainerSnapshot], format: ListFormat) throws {
|
|
if format == .json {
|
|
let printables = containers.map {
|
|
PrintableContainer($0)
|
|
}
|
|
let data = try JSONEncoder().encode(printables)
|
|
print(String(decoding: data, as: UTF8.self))
|
|
|
|
return
|
|
}
|
|
|
|
if self.quiet {
|
|
containers.forEach {
|
|
print($0.id)
|
|
}
|
|
return
|
|
}
|
|
|
|
var rows = createHeader()
|
|
for container in containers {
|
|
rows.append(container.asRow)
|
|
}
|
|
|
|
let formatter = TableOutput(rows: rows)
|
|
print(formatter.format())
|
|
}
|
|
}
|
|
}
|
|
|
|
extension ContainerSnapshot {
|
|
fileprivate var asRow: [String] {
|
|
[
|
|
self.id,
|
|
self.configuration.image.reference,
|
|
self.platform.os,
|
|
self.platform.architecture,
|
|
self.status.rawValue,
|
|
self.networks.compactMap { $0.ipv4Address.description }.joined(separator: ","),
|
|
"\(self.configuration.resources.cpus)",
|
|
"\(self.configuration.resources.memoryInBytes / (1024 * 1024)) MB",
|
|
self.startedDate.map { ISO8601DateFormatter().string(from: $0) } ?? "",
|
|
]
|
|
}
|
|
}
|
|
|
|
struct PrintableContainer: Codable {
|
|
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
|
|
}
|
|
}
|