Files
container/Sources/CLI/Image/ImageSave.swift
Morris Richman dd6bdc20cf Expose Command Structs for Plugins (#603)
## Type of Change
- [ ] Bug fix
- [x] New feature  
- [ ] Breaking change
- [ ] Documentation update

## Motivation and Context
Plugins technically exist, but to add shortcuts or to do existing things
with functions in `container` requires calling a compiled binary. This
pull request aims to remove that hurdle and instability by exposing
commands as a new `ContainerCommands ` target.

Simply import `ContainerCommands` and you can access almost
any command as if it were a native part of the binary. This makes
plugin development significantly easier.

Closes #609.
2025-09-17 15:24:26 -07:00

102 lines
3.5 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 Containerization
import ContainerizationError
import ContainerizationOCI
import Foundation
import TerminalProgress
extension Application {
public struct ImageSave: AsyncParsableCommand {
public init() {}
public static let configuration = CommandConfiguration(
commandName: "save",
abstract: "Save an image as an OCI compatible tar archive"
)
@OptionGroup
var global: Flags.Global
@Option(
help: "Platform string in the form 'os/arch/variant'. Example 'linux/arm64/v8', 'linux/amd64'. This takes precedence over --os and --arch"
)
var platform: String?
@Option(
help: "Set OS if image can target multiple operating systems"
)
var os: String?
@Option(
name: [.customLong("arch"), .customShort("a")],
help: "Set arch if image can target multiple architectures"
)
var arch: String?
@Option(
name: .shortAndLong, help: "Path to save the image tar archive", completion: .file(),
transform: { str in
URL(fileURLWithPath: str, relativeTo: .currentDirectory()).absoluteURL.path(percentEncoded: false)
})
var output: String
@Argument var references: [String]
public func run() async throws {
var p: Platform?
if let platform {
p = try Platform(from: platform)
} else if let arch {
p = try Platform(from: "\(os ?? "linux")/\(arch)")
} else if let os {
p = try Platform(from: "\(os)/\(arch ?? Arch.hostArchitecture().rawValue)")
}
let progressConfig = try ProgressConfig(
description: "Saving image(s)"
)
let progress = ProgressBar(config: progressConfig)
defer {
progress.finish()
}
progress.start()
var images: [ImageDescription] = []
for reference in references {
do {
images.append(try await ClientImage.get(reference: reference).description)
} catch {
print("failed to get image for reference \(reference): \(error)")
}
}
guard images.count == references.count else {
throw ContainerizationError(.invalidArgument, message: "failed to save image(s)")
}
try await ClientImage.save(references: references, out: output, platform: p)
progress.finish()
for reference in references {
print(reference)
}
}
}
}