Files
container/Sources/ContainerCommands/Container/ContainerStop.swift
T
Danny Canter 8fdfa29728 CLI: Rework ClientContainer (#1139)
ClientContainer was honestly extremely awkward. It could only be created
by passing either a ContainerConfiguration, or a Snapshot that had to be
obtained from calling a static method on the type itself. The type also
did not store a connection, so every single method got a new xpc
connection to the APIServer. This change aims to rework this type to be
just a generic client, that is *not* a client for one specific
container, but for any.

- Rename to ContainerClient
- Have list() return [ContainerSnapshot]
- Create a connection in the constructor
- Change all the callsites to use the new API
- Small, somewhat related, change to logs API in the APIServer. Now that
we don't need to call get() to grab a client anymore which was typically
what did "does this container exist" logic and gave a nice error
message, I added a small check in the APIServer to see if the container
exists and return mostly the same error message.
2026-02-04 09:52:09 -08:00

111 lines
4.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 ContainerResource
import ContainerizationError
import ContainerizationOS
import Foundation
import Logging
extension Application {
public struct ContainerStop: AsyncLoggableCommand {
public init() {}
public static let configuration = CommandConfiguration(
commandName: "stop",
abstract: "Stop one or more running containers")
@Flag(name: .shortAndLong, help: "Stop all running containers")
var all = false
@Option(name: .shortAndLong, help: "Signal to send to the containers")
var signal: String = "SIGTERM"
@Option(name: .shortAndLong, help: "Seconds to wait before killing the containers")
var time: Int32 = 5
@OptionGroup
public var logOptions: Flags.Logging
@Argument(help: "Container IDs")
var containerIds: [String] = []
public func validate() throws {
if containerIds.count == 0 && !all {
throw ContainerizationError(.invalidArgument, message: "no containers specified and --all not supplied")
}
if containerIds.count > 0 && all {
throw ContainerizationError(
.invalidArgument, message: "explicitly supplied container IDs conflict with the --all flag")
}
}
public mutating func run() async throws {
let set = Set<String>(containerIds)
let client = ContainerClient()
var containers = [ContainerSnapshot]()
if self.all {
containers = try await client.list()
} else {
containers = try await client.list().filter { c in
set.contains(c.id)
}
}
let opts = ContainerStopOptions(
timeoutInSeconds: self.time,
signal: try Signals.parseSignal(self.signal)
)
let failed = try await Self.stopContainers(client: client, containers: containers, stopOptions: opts, log: log)
if failed.count > 0 {
throw ContainerizationError(
.internalError,
message: "stop failed for one or more containers \(failed.joined(separator: ","))"
)
}
}
static func stopContainers(client: ContainerClient, containers: [ContainerSnapshot], stopOptions: ContainerStopOptions, log: Logger) async throws -> [String] {
var failed: [String] = []
try await withThrowingTaskGroup(of: ContainerSnapshot?.self) { group in
for container in containers {
group.addTask {
do {
try await client.stop(id: container.id, opts: stopOptions)
print(container.id)
return nil
} catch {
log.error("failed to stop container \(container.id): \(error)")
return container
}
}
}
for try await ctr in group {
guard let ctr else {
continue
}
failed.append(ctr.id)
}
}
return failed
}
}
}