Files
container/Sources/APIServer/Kernel/KernelHarness.swift
T
Kathryn Baldauf d6b2243c75 Add force option to kernel set and add tests for kernel setting (#579)
## Type of Change
- [x] New feature  

## Description
Add option to force kernel setting and tests for CLI `kernel set`.
Related to https://github.com/apple/container/pull/575.

## Motivation and Context
This PR adds additional tests to ensure that we can set kernels from
local files, remote tar files, and local tar files. A new option `force`
is added to the `kernel set` subcommand which will overwrite an existing
kernel with the same name if one exists to make testing easier. The
tests ensure that a container can be started with the newly set kernel
and resets to the default recommended kernel when complete.

## Testing
- [x] Tested locally
- [x] Added/updated tests

Signed-off-by: Kathryn Baldauf <k_baldauf@apple.com>
2025-09-05 11:51:07 -07:00

96 lines
3.8 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 ContainerClient
import ContainerXPC
import Containerization
import ContainerizationError
import Foundation
import Logging
struct KernelHarness {
private let log: Logging.Logger
private let service: KernelService
init(service: KernelService, log: Logging.Logger) {
self.log = log
self.service = service
}
public func install(_ message: XPCMessage) async throws -> XPCMessage {
let kernelFilePath = try message.kernelFilePath()
let platform = try message.platform()
let force = try message.kernelForce()
guard let kernelTarUrl = try message.kernelTarURL() else {
// We have been given a path to a kernel binary on disk
guard let kernelFile = URL(string: kernelFilePath) else {
throw ContainerizationError(.invalidArgument, message: "Invalid kernel file path: \(kernelFilePath)")
}
try await self.service.installKernel(kernelFile: kernelFile, platform: platform, force: force)
return message.reply()
}
let progressUpdateService = ProgressUpdateService(message: message)
try await self.service.installKernelFrom(
tar: kernelTarUrl, kernelFilePath: kernelFilePath, platform: platform, progressUpdate: progressUpdateService?.handler, force: force)
return message.reply()
}
public func getDefaultKernel(_ message: XPCMessage) async throws -> XPCMessage {
guard let platformData = message.dataNoCopy(key: .systemPlatform) else {
throw ContainerizationError(.invalidArgument, message: "Missing SystemPlatform")
}
let platform = try JSONDecoder().decode(SystemPlatform.self, from: platformData)
let kernel = try await self.service.getDefaultKernel(platform: platform)
let reply = message.reply()
let data = try JSONEncoder().encode(kernel)
reply.set(key: .kernel, value: data)
return reply
}
}
extension XPCMessage {
fileprivate func platform() throws -> SystemPlatform {
guard let platformData = self.dataNoCopy(key: .systemPlatform) else {
throw ContainerizationError(.invalidArgument, message: "Missing SystemPlatform in XPC Message")
}
let platform = try JSONDecoder().decode(SystemPlatform.self, from: platformData)
return platform
}
fileprivate func kernelFilePath() throws -> String {
guard let kernelFilePath = self.string(key: .kernelFilePath) else {
throw ContainerizationError(.invalidArgument, message: "Missing kernel file path in XPC Message")
}
return kernelFilePath
}
fileprivate func kernelTarURL() throws -> URL? {
guard let kernelTarURLString = self.string(key: .kernelTarURL) else {
return nil
}
guard let k = URL(string: kernelTarURLString) else {
throw ContainerizationError(.invalidArgument, message: "Cannot parse URL from \(kernelTarURLString)")
}
return k
}
fileprivate func kernelForce() throws -> Bool {
self.bool(key: .kernelForce)
}
}