Files
container/Sources/ContainerCommands/Container/ContainerDelete.swift
T
J Logan f3b33ffc45 Cleans up option groups, container subcommand help. (#647)
- Part of #515.
- Add titles to option groups for container subcommands.
- Order option groups and container subcommand options alphabetically.
- Use `container-id` and `container-ids` consistently as argument names.
- Shorten long valueNames to avoid option column overflow in help output
where possible.
- Replace customShort and customLong with short, long, and shortAndLong
where possible.
- Always place global options and arguments after alphabetized
command-specific options.
- Rename RunCommand to ContainerRun and relocate it.
- Rename Executable to ContainerCLI.

## Type of Change
- [ ] Bug fix
- [ ] New feature  
- [x] Breaking change (if you're depending on `RunCommand`, renamed).
- [ ] Documentation update

## Motivation and Context
See #385.

## Testing
- [ ] Tested locally
- [ ] Added/updated tests
- [ ] Added/updated docs
2025-09-22 16:36:07 -07:00

123 lines
4.6 KiB
Swift

//===----------------------------------------------------------------------===//
// Copyright © 2025 Apple Inc. and the container project authors. All rights reserved.
//
// 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 ContainerClient
import ContainerizationError
import Foundation
extension Application {
public struct ContainerDelete: AsyncParsableCommand {
public init() {}
public static let configuration = CommandConfiguration(
commandName: "delete",
abstract: "Delete one or more containers",
aliases: ["rm"])
@Flag(name: .shortAndLong, help: "Remove all containers")
var all = false
@Flag(name: .shortAndLong, help: "Delete containers even if they are running")
var force = false
@OptionGroup
var global: Flags.Global
@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 ID(s) conflict with the --all flag"
)
}
}
public mutating func run() async throws {
let set = Set<String>(containerIds)
var containers = [ClientContainer]()
if all {
containers = try await ClientContainer.list()
} else {
let ctrs = try await ClientContainer.list()
containers = ctrs.filter { c in
set.contains(c.id)
}
// If one of the containers requested isn't present, let's throw. We don't need to do
// this for --all as --all should be perfectly usable with no containers to remove; otherwise,
// it'd be quite clunky.
if containers.count != set.count {
let missing = set.filter { id in
!containers.contains { c in
c.id == id
}
}
throw ContainerizationError(
.notFound,
message: "failed to delete one or more containers: \(missing)"
)
}
}
var failed = [String]()
let force = self.force
let all = self.all
try await withThrowingTaskGroup(of: String?.self) { group in
for container in containers {
group.addTask {
do {
if container.status == .running && !force {
guard all else {
throw ContainerizationError(.invalidState, message: "container is running")
}
return nil // Skip running container when using --all
}
try await container.delete(force: force)
print(container.id)
return nil
} catch {
log.error("failed to delete container \(container.id): \(error)")
return container.id
}
}
}
for try await ctr in group {
guard let ctr else {
continue
}
failed.append(ctr)
}
}
if failed.count > 0 {
throw ContainerizationError(
.internalError,
message: "delete failed for one or more containers: \(failed)"
)
}
}
}
}