chore: import upstream snapshot with attribution
container project - merge build / Invoke build (push) Successful in 1s
container project - merge build / Invoke build (push) Successful in 1s
This commit is contained in:
wehub-resource-sync
@@ -0,0 +1,287 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
// 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 ContainerLog
|
||||
import ContainerPersistence
|
||||
import ContainerPlugin
|
||||
import ContainerVersion
|
||||
import ContainerizationError
|
||||
import ContainerizationOS
|
||||
import Foundation
|
||||
import Logging
|
||||
import SystemPackage
|
||||
import TerminalProgress
|
||||
|
||||
// This logger is only used until `asyncCommand.run()`.
|
||||
// `log` is updated only once in the `validate()` method.
|
||||
private nonisolated(unsafe) var bootstrapLogger = {
|
||||
LoggingSystem.bootstrap({ _ in StderrLogHandler() })
|
||||
var log = Logger(label: "com.apple.container")
|
||||
log.logLevel = .info
|
||||
return log
|
||||
}()
|
||||
|
||||
public struct Application: AsyncLoggableCommand {
|
||||
@OptionGroup
|
||||
public var logOptions: Flags.Logging
|
||||
|
||||
public init() {}
|
||||
|
||||
public static let configuration = CommandConfiguration(
|
||||
commandName: "container",
|
||||
abstract: "A container platform for macOS",
|
||||
version: ReleaseVersion.singleLine(appName: "container CLI"),
|
||||
subcommands: [
|
||||
DefaultCommand.self,
|
||||
HelpCommand.self,
|
||||
],
|
||||
groupedSubcommands: [
|
||||
CommandGroup(
|
||||
name: "Container",
|
||||
subcommands: [
|
||||
ContainerCopy.self,
|
||||
ContainerCreate.self,
|
||||
ContainerDelete.self,
|
||||
ContainerExec.self,
|
||||
ContainerExport.self,
|
||||
ContainerInspect.self,
|
||||
ContainerKill.self,
|
||||
ContainerList.self,
|
||||
ContainerLogs.self,
|
||||
ContainerRun.self,
|
||||
ContainerStart.self,
|
||||
ContainerStats.self,
|
||||
ContainerStop.self,
|
||||
ContainerPrune.self,
|
||||
]
|
||||
),
|
||||
CommandGroup(
|
||||
name: "Image",
|
||||
subcommands: [
|
||||
BuildCommand.self,
|
||||
ImageCommand.self,
|
||||
RegistryCommand.self,
|
||||
]
|
||||
),
|
||||
CommandGroup(
|
||||
name: "Machine",
|
||||
subcommands: [
|
||||
MachineCommand.self
|
||||
]
|
||||
),
|
||||
CommandGroup(
|
||||
name: "Volume",
|
||||
subcommands: [
|
||||
VolumeCommand.self
|
||||
]
|
||||
),
|
||||
CommandGroup(
|
||||
name: "Other",
|
||||
subcommands: Self.otherCommands()
|
||||
),
|
||||
],
|
||||
// Hidden command to handle plugins on unrecognized input.
|
||||
defaultSubcommand: DefaultCommand.self
|
||||
)
|
||||
|
||||
public static func main() async throws {
|
||||
restoreCursorAtExit()
|
||||
|
||||
#if DEBUG
|
||||
let warning = "Running debug build. Performance may be degraded."
|
||||
let formattedWarning: String
|
||||
if isatty(FileHandle.standardError.fileDescriptor) == 1 {
|
||||
formattedWarning = "\u{001B}[33mWarning!\u{001B}[0m \(warning)\n"
|
||||
} else {
|
||||
formattedWarning = "Warning! \(warning)\n"
|
||||
}
|
||||
let warningData = Data(formattedWarning.utf8)
|
||||
FileHandle.standardError.write(warningData)
|
||||
#endif
|
||||
|
||||
let fullArgs = CommandLine.arguments
|
||||
let args = Array(fullArgs.dropFirst())
|
||||
|
||||
do {
|
||||
var command = try Application.parseAsRoot(args)
|
||||
if var asyncCommand = command as? AsyncParsableCommand {
|
||||
try await asyncCommand.run()
|
||||
} else {
|
||||
try command.run()
|
||||
}
|
||||
} catch {
|
||||
// --help/-h on the root command (e.g. `container --help`) is intercepted
|
||||
// by ArgumentParser and lands here.
|
||||
let containsHelp = fullArgs.contains("-h") || fullArgs.contains("--help")
|
||||
if fullArgs.count <= 2 && containsHelp {
|
||||
let pluginLoader = try? await createPluginLoader()
|
||||
await Self.printModifiedHelpText(pluginLoader: pluginLoader)
|
||||
return
|
||||
}
|
||||
let errorAsString: String = String(describing: error)
|
||||
if errorAsString.contains("XPC connection error") {
|
||||
let modifiedError = ContainerizationError(.interrupted, message: "\(error)\nEnsure container system service has been started with `container system start`.")
|
||||
Application.exit(withError: modifiedError)
|
||||
} else {
|
||||
Application.exit(withError: error)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public static func createPluginLoader() async throws -> PluginLoader {
|
||||
let installRootPath = CommandLine.executablePath
|
||||
.removingLastComponent()
|
||||
.removingLastComponent()
|
||||
// TODO: Remove when we convert PluginLoader to FilePath.
|
||||
let installRootURL = URL(fileURLWithPath: installRootPath.string)
|
||||
let pluginsURL = PluginLoader.userPluginsDir(installRoot: installRootURL)
|
||||
var directoryExists: ObjCBool = false
|
||||
_ = FileManager.default.fileExists(atPath: pluginsURL.path, isDirectory: &directoryExists)
|
||||
let userPluginsURL = directoryExists.boolValue ? pluginsURL : nil
|
||||
|
||||
// plugins built into the application installed as a macOS app bundle
|
||||
let appBundlePluginsURL = Bundle.main.resourceURL?.appending(path: "plugins")
|
||||
|
||||
// plugins built into the application installed as a Unix-like application
|
||||
let installRootPluginsPath =
|
||||
installRootPath
|
||||
.appending(FilePath.Component("libexec"))
|
||||
.appending(FilePath.Component("container"))
|
||||
.appending(FilePath.Component("plugins"))
|
||||
let installRootPluginsURL = URL(fileURLWithPath: installRootPluginsPath.string)
|
||||
let pluginDirectories = [
|
||||
userPluginsURL,
|
||||
appBundlePluginsURL,
|
||||
installRootPluginsURL,
|
||||
].compactMap { $0 }
|
||||
|
||||
let pluginFactories: [any PluginFactory] = [
|
||||
DefaultPluginFactory(logger: bootstrapLogger),
|
||||
AppBundlePluginFactory(logger: bootstrapLogger),
|
||||
]
|
||||
|
||||
guard let systemHealth = try? await ClientHealthCheck.ping(timeout: .seconds(10)) else {
|
||||
throw ContainerizationError(.timeout, message: "unable to retrieve application data root from API server")
|
||||
}
|
||||
return try PluginLoader(
|
||||
appRoot: systemHealth.appRoot,
|
||||
installRoot: systemHealth.installRoot,
|
||||
logRoot: systemHealth.logRoot,
|
||||
pluginDirectories: pluginDirectories,
|
||||
pluginFactories: pluginFactories,
|
||||
log: bootstrapLogger
|
||||
)
|
||||
}
|
||||
|
||||
/// Load the system configuration using `appRoot` / `installRoot` reported by the
|
||||
/// daemon. `container system start` MUST have previously been run to start the daemon.
|
||||
public static func loadContainerSystemConfig() async throws -> ContainerSystemConfig {
|
||||
let health = try await ClientHealthCheck.ping(timeout: .seconds(10))
|
||||
let appRoot = FilePath(health.appRoot.path(percentEncoded: false))
|
||||
let installRoot = FilePath(health.installRoot.path(percentEncoded: false))
|
||||
return try await ConfigurationLoader.load(
|
||||
configurationFiles: [
|
||||
ConfigurationLoader.configurationFile(in: appRoot, of: .appRoot),
|
||||
ConfigurationLoader.configurationFile(in: installRoot, of: .installRoot),
|
||||
]
|
||||
)
|
||||
}
|
||||
|
||||
public func validate() throws {
|
||||
// Not really a "validation", but a cheat to run this before
|
||||
// any of the commands do their business.
|
||||
let debugEnvVar = ProcessInfo.processInfo.environment["CONTAINER_DEBUG"]
|
||||
if self.logOptions.debug || debugEnvVar != nil {
|
||||
bootstrapLogger.logLevel = .debug
|
||||
}
|
||||
// Ensure we're not running under Rosetta.
|
||||
if try isTranslated() {
|
||||
throw ValidationError(
|
||||
"""
|
||||
`container` is currently running under Rosetta Translation, which could be
|
||||
caused by your terminal application. Please ensure this is turned off.
|
||||
"""
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
private static func otherCommands() -> [any ParsableCommand.Type] {
|
||||
guard #available(macOS 26, *) else {
|
||||
return [
|
||||
BuilderCommand.self,
|
||||
SystemCommand.self,
|
||||
]
|
||||
}
|
||||
|
||||
return [
|
||||
BuilderCommand.self,
|
||||
NetworkCommand.self,
|
||||
SystemCommand.self,
|
||||
]
|
||||
}
|
||||
|
||||
private static func restoreCursorAtExit() {
|
||||
let signalHandler: @convention(c) (Int32) -> Void = { signal in
|
||||
let exitCode = ExitCode(signal + 128)
|
||||
Application.exit(withError: exitCode)
|
||||
}
|
||||
// Termination by Ctrl+C.
|
||||
signal(SIGINT, signalHandler)
|
||||
// Termination using `kill`.
|
||||
signal(SIGTERM, signalHandler)
|
||||
// Normal and explicit exit.
|
||||
atexit {
|
||||
if let progressConfig = try? ProgressConfig() {
|
||||
let progressBar = ProgressBar(config: progressConfig)
|
||||
progressBar.resetCursor()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
extension Application {
|
||||
// Because we support plugins, we need to modify the help text to display
|
||||
// any if we found some.
|
||||
static func printModifiedHelpText(pluginLoader: PluginLoader?) async {
|
||||
let original = Application.helpMessage(for: Application.self)
|
||||
guard let pluginLoader else {
|
||||
print(addGroupSpacing(original))
|
||||
print("\nPLUGINS: not available, run `container system start`")
|
||||
return
|
||||
}
|
||||
let altered = pluginLoader.alterCLIHelpText(original: original)
|
||||
print(addGroupSpacing(altered))
|
||||
}
|
||||
|
||||
private static func addGroupSpacing(_ text: String) -> String {
|
||||
text
|
||||
.replacingOccurrences(of: "\n([A-Z].+SUBCOMMANDS:)", with: "\n\n$1", options: .regularExpression)
|
||||
.replacingOccurrences(of: "\nPLUGINS:", with: "\n\nPLUGINS:")
|
||||
}
|
||||
|
||||
func isTranslated() throws -> Bool {
|
||||
do {
|
||||
return try Sysctl.byName("sysctl.proc_translated") == 1
|
||||
} catch let posixErr as POSIXError {
|
||||
if posixErr.code == .ENOENT {
|
||||
return false
|
||||
}
|
||||
throw posixErr
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user