Compare commits

...

5 Commits

25 changed files with 420 additions and 612 deletions
+6 -3
View File
@@ -20,10 +20,10 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Build
- name: Build and test
run: |
docker compose run --build --rm xtool bash -c \
"swift build --product xtool && .build/debug/xtool --help"
docker compose run --build xtool bash -c \
"swift build --product xtool && .build/debug/xtool --help && swift test"
build-macos:
runs-on: macos-26
steps:
@@ -33,6 +33,9 @@ jobs:
- name: Build
run: |
swift build --product xtool && .build/debug/xtool --help
- name: Run tests
run: |
swift test
build-ios:
runs-on: macos-26
steps:
+10
View File
@@ -1,3 +1,13 @@
{
"swiftlint.path": "./.tmp/swiftlint/swiftlint",
"files.watcherExclude":{
"*/.git/**": true,
"*/.build/**": true,
"*/.tmp/**": true,
},
"search.exclude": {
"*/.git/**": true,
"*/.build/**": true,
"*/.tmp/**": true,
}
}
+10 -1
View File
@@ -1,5 +1,5 @@
{
"originHash" : "eb2a57fb4e4c2c83ff1f1fa55631db81988fc6e2e576a05a3cc5c8ed69432c3a",
"originHash" : "80db0cddb0e78cf6a4c79f94537cdfebd8004679161532fbae8a57ee9d1d8cd1",
"pins" : [
{
"identity" : "aexml",
@@ -352,6 +352,15 @@
"version" : "2.11.0"
}
},
{
"identity" : "swift-subprocess",
"kind" : "remoteSourceControl",
"location" : "https://github.com/swiftlang/swift-subprocess",
"state" : {
"revision" : "11633673a41f509f8945f23c96c7acd4adafd679",
"version" : "0.5.0"
}
},
{
"identity" : "swift-syntax",
"kind" : "remoteSourceControl",
+12 -15
View File
@@ -55,6 +55,7 @@ let package = Package(
.package(url: "https://github.com/apple/swift-nio", from: "2.77.0"),
.package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"),
.package(url: "https://github.com/swiftlang/swift-subprocess", .upToNextMinor(from: "0.5.0")),
.package(url: "https://github.com/swift-server/async-http-client.git", from: "1.23.0"),
.package(url: "https://github.com/swift-server/swift-openapi-async-http-client", from: "1.0.0"),
@@ -92,7 +93,17 @@ let package = Package(
exclude: ["openapi-generator-config.yaml", "patch.js"]
),
// common utilities shared across xtool targets
.target(name: "XUtils"),
.target(
name: "XUtils",
dependencies: [
.product(name: "SystemPackage", package: "swift-system"),
.product(
name: "Subprocess",
package: "swift-subprocess",
condition: .when(platforms: [.linux, .macOS])
),
]
),
.target(
name: "XKit",
dependencies: [
@@ -138,20 +149,6 @@ let package = Package(
"XToolSupport",
]
),
.testTarget(
name: "XKitTests",
dependencies: [
"XKit",
.product(name: "SuperutilsTestSupport", package: "xtool-core")
],
exclude: [
"config/config-template.json",
],
resources: [
.copy("config/config.json"),
.copy("config/test.app"),
]
),
.target(
name: "XToolSupport",
dependencies: [
+27 -21
View File
@@ -1,9 +1,11 @@
import Foundation
import Subprocess
import XUtils
public struct BuildSettings: Sendable {
private static let customBinDir =
// this is the same option used by SwiftPM itself for dev builds
ProcessInfo.processInfo.environment["SWIFTPM_CUSTOM_BIN_DIR"].map { URL(fileURLWithPath: $0) }
ProcessInfo.processInfo.environment["SWIFTPM_CUSTOM_BIN_DIR"].map { FilePath($0) }
private static let envURL = URL(fileURLWithPath: "/usr/bin/env")
@@ -34,18 +36,16 @@ public struct BuildSettings: Sendable {
#if os(macOS)
private static func xcrun(_ arguments: [String]) async throws -> String {
let xcrun = Process()
let pipe = Pipe()
xcrun.executableURL = URL(fileURLWithPath: "/usr/bin/xcrun")
xcrun.arguments = arguments
xcrun.standardOutput = pipe
try await xcrun.runUntilExit()
return String(decoding: pipe.fileHandleForReading.readDataToEndOfFile(), as: UTF8.self)
.trimmingCharacters(in: .whitespacesAndNewlines)
let result = try await Subprocess.run(
.path("/usr/bin/xcrun"),
arguments: .init(arguments),
output: .string(limit: .max)
).checkSuccess()
return result.standardOutput?.trimmingCharacters(in: .whitespacesAndNewlines) ?? ""
}
private static let swiftURL = Task {
try await URL(fileURLWithPath: xcrun(["-f", "swift"]))
try await FilePath(xcrun(["-f", "swift"]))
}
#endif
@@ -53,12 +53,11 @@ public struct BuildSettings: Sendable {
forTool tool: String,
arguments: [String],
packagePathOverride: String? = nil
) async throws -> Process {
let process = Process()
) async throws -> Subprocess.Configuration {
let executable: Executable
let baseArguments: [String]
if let customBinDir = Self.customBinDir {
process.executableURL = customBinDir.appendingPathComponent("swift-\(tool)")
executable = .path(customBinDir.appending("swift-\(tool)"))
baseArguments = []
} else {
#if os(macOS)
@@ -67,9 +66,9 @@ public struct BuildSettings: Sendable {
// 1) invoking the real swift executable (located with `xcrun -f`) and
// 2) explicitly removing SDKROOT from the env, as it may be inherited
// through the `swift run pack` invocation.
process.executableURL = try await Self.swiftURL.value
executable = .path(try await Self.swiftURL.value)
#else
process.executableURL = try await ToolRegistry.locate("swift")
executable = .name("swift")
#endif
baseArguments = [tool]
}
@@ -79,11 +78,18 @@ public struct BuildSettings: Sendable {
"--configuration", configuration.rawValue,
]
var env = ProcessInfo.processInfo.environment
env.removeValue(forKey: "SDKROOT")
process.environment = env
process.arguments = baseArguments + extraArguments + sdkOptions + options + arguments
return process
var rawEnv = ProcessInfo.processInfo.environment
rawEnv.removeValue(forKey: "SDKROOT")
let env = Dictionary(uniqueKeysWithValues: rawEnv.map {
(Environment.Key(rawValue: $0)!, $1)
})
return Configuration(
executable,
arguments: .init(baseArguments + extraArguments + sdkOptions + options + arguments),
environment: .custom(env),
platformOptions: .withGracefulShutDown,
)
}
}
+8 -3
View File
@@ -1,5 +1,6 @@
import Foundation
import XUtils
import Subprocess
public struct Packer: Sendable {
public let buildSettings: BuildSettings
@@ -54,7 +55,7 @@ public struct Packer: Sendable {
try Data().write(to: sources.appendingPathComponent("stub.c", isDirectory: false))
}
let builder = try await buildSettings.swiftPMInvocation(
let buildConfig = try await buildSettings.swiftPMInvocation(
forTool: "build",
arguments: [
"--package-path", packageDir.path,
@@ -68,8 +69,12 @@ public struct Packer: Sendable {
"--disable-automatic-resolution",
]
)
builder.standardOutput = FileHandle.standardError
try await builder.runUntilExit()
try await Subprocess.run(
buildConfig,
output: .currentStandardError,
error: .currentStandardError,
)
.checkSuccess()
}
public func pack() async throws -> URL {
+9 -6
View File
@@ -1,5 +1,6 @@
import Foundation
import XUtils
import Subprocess
public struct Planner: Sendable {
public var buildSettings: BuildSettings
@@ -243,16 +244,18 @@ public struct Planner: Sendable {
}
private func _dumpAction(arguments: [String], path: String) async throws -> Data {
let dump = try await buildSettings.swiftPMInvocation(
let dumpConfig = try await buildSettings.swiftPMInvocation(
forTool: "package",
arguments: arguments,
packagePathOverride: path
)
let pipe = Pipe()
dump.standardOutput = pipe
async let task = Data(reading: pipe.fileHandleForReading)
try await dump.runUntilExit()
return try await task
return try await Subprocess.run(
dumpConfig,
output: .data(limit: .max),
error: .currentStandardError,
)
.checkSuccess()
.standardOutput
}
private func selectLibrary(
-63
View File
@@ -1,63 +0,0 @@
import Foundation
extension Process {
/// Launches the process and suspends until the receiver is finished.
///
/// - Parameter onCancel: The action to take if the current
/// task is cancelled.
public func runUntilExit(onCancel: TaskCancelAction = .interrupt) async throws {
try Task.checkCancellation()
let (terminationStream, terminationContinuation) = AsyncStream<Never>.makeStream()
terminationHandler = { _ in
terminationContinuation.finish()
}
do {
try run()
} catch {
terminationContinuation.finish()
throw error
}
await withTaskCancellationHandler {
for await _ in terminationStream {}
} onCancel: {
switch onCancel {
case .interrupt:
interrupt()
case .terminate:
terminate()
case .ignore:
break
}
}
try Task.checkCancellation()
switch terminationReason {
case .exit where terminationStatus == 0:
break
case .exit:
throw Failure.exit(terminationStatus)
case .uncaughtSignal:
throw Failure.uncaughtSignal(terminationStatus)
@unknown default:
break
}
}
public enum Failure: Error {
case exit(CInt)
case uncaughtSignal(CInt)
}
public enum TaskCancelAction: Sendable {
/// Sends `SIGINT` to the process.
case interrupt
/// Sends `SIGTERM` to the process.
case terminate
/// Don't participate in cooperative cancellation.
case ignore
}
}
+5 -19
View File
@@ -1,4 +1,5 @@
import Foundation
import Subprocess
package enum ToolRegistry {
package enum Errors: Error, CustomStringConvertible {
@@ -16,11 +17,6 @@ package enum ToolRegistry {
/// Obtain the full path to a tool in the user's `PATH`.
///
/// This effectively invokes `/bin/sh -c "command -v '$tool'"`.
///
/// - Warning: Make sure you trust/sanitize the `tool` parameter. If it
/// contains a single quote, it can be used in a shell escape.
///
/// - Throws: `Errors.toolNotFound` if the tool could not be located.
package static func locate(_ tool: String) async throws -> URL {
try await cache.locate(tool: tool)
@@ -30,20 +26,10 @@ package enum ToolRegistry {
private var cache: [String: Task<URL, Error>] = [:]
private func _locate(tool: String) async throws -> URL {
let pipe = Pipe()
let proc = Process()
proc.executableURL = URL(fileURLWithPath: "/bin/sh")
proc.arguments = ["-c", "command -v '\(tool)'"]
proc.standardOutput = pipe
async let bytes = pipe.fileHandleForReading.readToEnd()
do {
try await proc.runUntilExit()
} catch is Process.Failure {
throw Errors.toolNotFound(tool)
}
let path = String(decoding: try await bytes ?? Data(), as: UTF8.self)
.trimmingCharacters(in: .whitespacesAndNewlines)
return URL(fileURLWithPath: path)
guard let path = try? await Executable.name(tool).resolveExecutablePath(in: .inherit),
let url = URL(filePath: path)
else { throw Errors.toolNotFound(tool) }
return url
}
func locate(tool: String) async throws -> URL {
@@ -3,6 +3,7 @@
import Foundation
import XADI
import Dependencies
import Subprocess
public actor XADIProvider: RawADIProvider {
@MainActor private static var loadTask: Task<Void, Error>?
@@ -45,17 +46,17 @@ public actor XADIProvider: RawADIProvider {
let archDir = "lib/\(arch)"
// TODO: Use ZIPFoundation
let proc = Process()
proc.executableURL = URL(filePath: "/usr/bin/env")
proc.arguments = [
"unzip", "-q",
applemusic.path(),
"\(archDir)/libCoreADI.so",
"\(archDir)/libstoreservicescore.so",
"-d", tmp.path()
]
try proc.run()
proc.waitUntilExit()
try await Subprocess.run(
.name("unzip"),
arguments: [
"-q",
applemusic.path,
"\(archDir)/libCoreADI.so",
"\(archDir)/libstoreservicescore.so",
"-d", tmp.path
],
output: .discarded
).checkSuccess()
try FileManager.default.moveItem(
at: tmp.appending(path: archDir),
to: libDir
+1 -1
View File
@@ -1,6 +1,6 @@
import Foundation
import XKit
import SystemPackage
import XUtils
import NIOPosix
import NIOCore
+8 -4
View File
@@ -282,6 +282,8 @@ struct DevCommand: AsyncParsableCommand {
extension BuildConfiguration: ExpressibleByArgument {}
#if os(macOS)
import Subprocess
struct SimInstallOperation {
var path: URL
@@ -289,10 +291,12 @@ struct SimInstallOperation {
var simulator = "booted"
func run() async throws {
let process = Process()
process.executableURL = URL(fileURLWithPath: "/usr/bin/xcrun")
process.arguments = ["simctl", "install", simulator, path.path]
try await process.runUntilExit()
try await Subprocess.run(
.path("/usr/bin/xcrun"),
arguments: ["simctl", "install", simulator, path.path],
output: .discarded
)
.checkSuccess()
print("Installed to simulator")
}
}
@@ -2,6 +2,8 @@ import Foundation
import XKit
import Dependencies
import PackLib
import Subprocess
import XUtils
extension ZIPCompressor: DependencyKey {
// TODO: Use `powershell Compress-Archive` and `powershell Expand-Archive` on Windows
@@ -12,20 +14,23 @@ extension ZIPCompressor: DependencyKey {
let dest = dir.deletingLastPathComponent().appendingPathComponent("app.ipa")
let zip = Process()
zip.executableURL = try await ToolRegistry.locate("zip")
zip.currentDirectoryURL = dir.deletingLastPathComponent()
zip.arguments = ["-yqru0", dest.path, dir.lastPathComponent]
try await zip.runUntilExit()
try await Subprocess.run(
.name("zip"),
arguments: ["-yqru0", dest.path, dir.lastPathComponent],
workingDirectory: FilePath(dir.deletingLastPathComponent()),
output: .discarded,
).checkSuccess()
return dest
},
decompress: { ipa, directory, progress in
progress(nil)
let unzip = Process()
unzip.executableURL = try await ToolRegistry.locate("unzip")
unzip.arguments = ["-q", ipa.path, "-d", directory.path]
try await unzip.runUntilExit()
try await Subprocess.run(
.name("unzip"),
arguments: ["-q", ipa.path, "-d", directory.path],
output: .discarded,
).checkSuccess()
}
)
}
+30 -29
View File
@@ -1,9 +1,9 @@
import Foundation
import Dependencies
import SystemPackage
import libunxip
import Subprocess
import XKit // HTTPClient, stdoutSafe
import PackLib // ToolRegistry
import XUtils // System.File{Path,Descriptor}
struct SDKBuilder {
enum Arch: String {
@@ -53,17 +53,13 @@ struct SDKBuilder {
}
let input: Input
let outputPath: String
let output: URL
let arch: Arch
@discardableResult
func buildSDK() async throws -> String {
func buildSDK() async throws {
// TODO: store relevant info for staleness check
let sdkVersion = "develop"
let output = URL(fileURLWithPath: outputPath, isDirectory: true)
.appendingPathComponent("darwin.artifactbundle")
try? FileManager.default.removeItem(at: output)
try FileManager.default.createDirectory(
at: output,
@@ -171,8 +167,6 @@ struct SDKBuilder {
try Data("\(sdkVersion)\n".utf8)
.write(to: output.appendingPathComponent("darwin-sdk-version.txt"))
return output.path
}
private func installToolset(in output: URL) async throws {
@@ -186,14 +180,6 @@ struct SDKBuilder {
withIntermediateDirectories: false
)
let pipe = Pipe()
let untar = Process()
untar.currentDirectoryURL = toolsetDir
untar.executableURL = try await ToolRegistry.locate("tar")
untar.arguments = ["xzf", "-"]
untar.standardInput = pipe.fileHandleForReading
async let tarExit: Void = untar.runUntilExit()
@Dependency(\.httpClient) var httpClient
let url = URL(string: """
https://github.com/xtool-org/darwin-tools-linux-llvm/releases/download/\
@@ -205,25 +191,36 @@ struct SDKBuilder {
case .known(let known): known
case .unknown: nil
}
let writer = pipe.fileHandleForWriting
var written: Int64 = 0
do {
defer { try? writer.close() }
defer { print() }
try await Subprocess.run(
.name("tar"),
arguments: ["xzf", "-"],
workingDirectory: FilePath(toolsetDir),
input: .inputWriter,
output: .discarded,
error: .discarded,
) { execution in
var totalWritten: Int64 = 0
for try await chunk in body {
try writer.write(contentsOf: chunk)
written += Int64(chunk.count)
if let length {
let progress = Int(Double(written) / Double(length) * 100)
var remaining = chunk
while !remaining.isEmpty {
let written = try await execution.standardInputWriter.write(Array(remaining))
remaining = remaining.dropFirst(written)
totalWritten += Int64(written)
guard let length else { continue }
let progress = Int(Double(totalWritten) / Double(length) * 100)
print("\r[Downloading toolset] \(progress)%", terminator: "")
fflush(stdoutSafe)
}
}
try await execution.standardInputWriter.finish()
}
print()
try await tarExit
.checkSuccess()
}
// swiftlint:disable:next cyclomatic_complexity
// swiftlint:disable:next cyclomatic_complexity function_body_length
private func installDeveloper(in output: URL) async throws -> URL {
let dev = output.appendingPathComponent("Developer")
@@ -353,6 +350,10 @@ struct SDKBuilder {
)
}
try FileManager.default.removeItem(
at: dev.appending(path: "Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/clang/include")
)
return dev
}
+66 -43
View File
@@ -5,6 +5,7 @@ import ArgumentParser
import Dependencies
import PackLib
import XUtils
import Subprocess
struct SDKCommand: AsyncParsableCommand {
static let configuration = CommandConfiguration(
@@ -47,9 +48,10 @@ struct DevSDKBuildCommand: AsyncParsableCommand {
func run() async throws {
let builderArch = try arch.sdkBuilderArch
let input = try SDKBuilder.Input(path: path)
let builder = SDKBuilder(input: input, outputPath: outputDir, arch: builderArch)
let sdkPath = try await builder.buildSDK()
print("Built SDK at \(sdkPath)")
let output = URL(fileURLWithPath: outputDir, isDirectory: true).appending(path: "darwin.xtoolsdk")
let builder = SDKBuilder(input: input, output: output, arch: builderArch)
try await builder.buildSDK()
print("Built SDK at \(output.path). You can install it with `xtool sdk install`.")
}
}
@@ -83,8 +85,8 @@ struct DevSDKInstallCommand: AsyncParsableCommand {
)
@Argument(
help: "Path to Xcode.xip or Xcode.app",
completion: .file(extensions: ["xip", "app"])
help: "Path to Xcode.xip, Xcode.app, or darwin.xtoolsdk",
completion: .file(extensions: ["xip", "app", "xtoolsdk"])
)
var path: String
@@ -132,7 +134,7 @@ struct DarwinSDK {
if let version = try? Data(contentsOf: bundle.appendingPathComponent("darwin-sdk-version.txt")) {
self.version = String(decoding: version, as: UTF8.self)
.trimmingCharacters(in: .whitespacesAndNewlines)
} else if bundle.lastPathComponent == "darwin.artifactbundle" {
} else if ["darwin.xtoolsdk", "darwin.artifactbundle"].contains(bundle.lastPathComponent) {
self.version = "unknown"
} else {
return nil
@@ -148,26 +150,42 @@ struct DarwinSDK {
let url = URL(fileURLWithPath: path)
guard DarwinSDK(bundle: url) != nil else { throw Console.Error("Invalid Darwin SDK at '\(path)'")}
let process = Process()
process.executableURL = try await ToolRegistry.locate("swift")
process.arguments = ["sdk", "install", url.path]
try await process.runUntilExit()
try await addHostClangResourceDir(to: url)
try await Subprocess.run(
.name("swift"),
arguments: ["sdk", "install", url.path],
output: .discarded
)
.checkSuccess()
}
private static func addHostClangResourceDir(to sdk: URL) async throws {
let clangURL = try await ToolRegistry.locate("clang")
let process = try await Subprocess.run(
.path(FilePath(clangURL.path)),
arguments: ["-print-resource-dir"],
output: .string(limit: .max)
).checkSuccess()
let output = process.standardOutput ?? ""
let hostClangResources = URL(filePath: output.trimmingCharacters(in: .whitespacesAndNewlines))
let hostInclude = hostClangResources.appending(path: "include")
let sdkInclude = sdk.appending(path: "Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/clang/include")
try FileManager.default.copyItem(at: hostInclude, to: sdkInclude)
}
static func current() async throws -> DarwinSDK? {
let output = Pipe()
let process = Process()
process.executableURL = try await ToolRegistry.locate("swift")
process.arguments = ["sdk", "configure", "darwin", "arm64-apple-ios", "--show-configuration"]
process.standardOutput = output
process.standardError = FileHandle.nullDevice
async let outputData = Data(reading: output.fileHandleForReading)
let outputString: String
do {
try await process.runUntilExit()
} catch Process.Failure.exit {
outputString = try await Subprocess.run(
.name("swift"),
arguments: ["sdk", "configure", "darwin", "arm64-apple-ios", "--show-configuration"],
output: .string(limit: .max)
)
.checkSuccess()
.standardOutput
?? ""
} catch SubprocessFailure.exited {
return nil
}
@@ -175,7 +193,6 @@ struct DarwinSDK {
// swiftResourcesPath: /home/user/.swiftpm/swift-sdks/darwin.artifactbundle/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift
// swiftlint:disable:previous line_length
let resourcesPathPrefix = "swiftResourcesPath: "
let outputString = String(decoding: try await outputData, as: UTF8.self)
guard let resourcesPath = outputString
.split(separator: "\n")
@@ -203,21 +220,19 @@ struct DarwinSDK {
private enum SwiftVersion {}
extension SwiftVersion {
static func current() async throws -> Version {
let outPipe = Pipe()
let errPipe = Pipe()
let swift = Process()
swift.executableURL = try await ToolRegistry.locate("swift")
swift.arguments = ["--version"]
swift.standardOutput = outPipe
swift.standardError = errPipe
async let outputTask = outPipe.fileHandleForReading.readToEnd()
let outputString: String?
do {
try await swift.runUntilExit()
} catch is Process.Failure {
outputString = try await Subprocess.run(
.name("swift"),
arguments: ["--version"],
output: .string(limit: .max)
)
.checkSuccess()
.standardOutput
} catch {
throw Console.Error("Failed to obtain Swift version")
}
let outputData = try await outputTask
var output = String(decoding: outputData ?? Data(), as: UTF8.self)[...]
var output = outputString?[...] ?? ""
if output.hasPrefix("Apple ") {
output = output.dropFirst("Apple ".count)
}
@@ -243,20 +258,28 @@ struct InstallSDKOperation {
#if os(macOS)
print("Skipping SDK install; the iOS SDK ships with Xcode on macOS")
#else
// validate input before removing existing SDK
let input = try SDKBuilder.Input(path: path)
let arch = try ArchSelection.auto.sdkBuilderArch
let tempDir = try TemporaryDirectory(name: "DarwinSDKBuild")
let sdkPath = tempDir.url.appending(path: "darwin.artifactbundle")
if path.hasSuffix(".xtoolsdk") {
print("Installing prebuilt SDK...")
try FileManager.default.copyItem(at: URL(filePath: path), to: sdkPath)
} else {
// validate input before removing existing SDK
let input = try SDKBuilder.Input(path: path)
let arch = try ArchSelection.auto.sdkBuilderArch
let builder = SDKBuilder(input: input, output: sdkPath, arch: arch)
try await builder.buildSDK()
}
if let sdk = try await DarwinSDK.current() {
print("Removing existing SDK...")
try sdk.remove()
}
let tempDir = try TemporaryDirectory(name: "DarwinSDKBuild")
let builder = SDKBuilder(input: input, outputPath: tempDir.url.path, arch: arch)
let sdkPath = try await builder.buildSDK()
try await DarwinSDK.install(from: sdkPath)
try await DarwinSDK.install(from: sdkPath.path)
// don't destroy tempDir before this point
withExtendedLifetime(tempDir) {}
+57
View File
@@ -0,0 +1,57 @@
#if canImport(Subprocess)
import Subprocess
import Foundation
extension ExecutionResult {
@discardableResult
public func checkSuccess() throws(SubprocessFailure) -> Self {
try terminationStatus.checkSuccess()
return self
}
}
extension TerminationStatus {
fileprivate func checkSuccess() throws(SubprocessFailure) {
if let failure { throw failure }
}
private var failure: SubprocessFailure? {
if isSuccess { return nil }
switch self {
case .exited(let code): return .exited(code)
case .signaled(let code): return .signaled(code)
}
}
}
public enum SubprocessFailure: Error {
case exited(TerminationStatus.Code)
case signaled(TerminationStatus.Code)
}
extension PlatformOptions {
public static var withGracefulShutDown: Self {
.init().withGracefulShutDown
}
public var withGracefulShutDown: Self {
var copy = self
copy.teardownSequence = [
.gracefulShutDown(
allowedDurationToNextStep: .milliseconds(500)
)
]
return copy
}
}
extension Environment {
public static func currentMap() -> [Environment.Key: String] {
Dictionary(
uniqueKeysWithValues: ProcessInfo.processInfo.environment.map {
(Environment.Key(rawValue: $0)!, $1)
}
)
}
}
#endif
+53
View File
@@ -0,0 +1,53 @@
import Foundation
#if canImport(System)
import System
public typealias FilePath = System.FilePath
public typealias FileDescriptor = System.FileDescriptor
public typealias Errno = System.Errno
#else
import SystemPackage
public typealias FilePath = SystemPackage.FilePath
public typealias FileDescriptor = SystemPackage.FileDescriptor
public typealias Errno = SystemPackage.Errno
extension URL {
public init?(filePath: FilePath) {
self.init(filePath: filePath.string)
}
}
extension FilePath {
public init?(_ url: URL) {
guard url.isFileURL else { return nil }
self.init(url.path)
}
}
#endif
extension FileDescriptor {
enum LockMode {
case shared
case exclusive
fileprivate var raw: CInt {
switch self {
case .shared: LOCK_SH
case .exclusive: LOCK_EX
}
}
}
func tryLock(mode: LockMode) throws -> Bool {
if flock(rawValue, mode.raw | LOCK_NB) == 0 {
return true
}
let err = errno
if err == EWOULDBLOCK {
return false
}
throw Errno(rawValue: err)
}
}
+92 -14
View File
@@ -4,6 +4,7 @@ package struct TemporaryDirectory: ~Copyable {
private static let debugTmp = ProcessInfo.processInfo.environment["XTL_DEBUG_TMP"] != nil
private var shouldDelete: Bool
private let base: URL
package let url: URL
/// Prepares a fresh tmpdir root.
@@ -19,15 +20,19 @@ package struct TemporaryDirectory: ~Copyable {
/// To save the contents, move them elsewhere with ``persist(at:)``.
package init(name: String) throws {
do {
let basename = name.replacingOccurrences(of: ".", with: "_")
self.url = try TemporaryDirectoryRoot.shared.url
let basename = name
.replacingOccurrences(of: ".", with: "_")
.replacingOccurrences(of: "/", with: "_")
.prefix(32)
self.base = try TemporaryDirectoryRoot.shared.url
// ensures uniqueness
.appendingPathComponent("tmp-\(basename)-\(UUID().uuidString)")
.appendingPathComponent(name, isDirectory: true)
.appendingPathComponent("dir-\(basename)-\(UUID().uuidString)")
self.url = base.appendingPathComponent(name, isDirectory: true)
self.shouldDelete = true
} catch {
// non-copyable types can't be partially initialized so we need a stub value
self.url = URL(fileURLWithPath: "")
self.base = URL(fileURLWithPath: "")
self.url = base
self.shouldDelete = false
throw error
}
@@ -40,11 +45,12 @@ package struct TemporaryDirectory: ~Copyable {
private func _delete() {
guard !Self.debugTmp else { return }
try? FileManager.default.removeItem(at: url)
try? FileManager.default.removeItem(at: base)
}
package consuming func persist(at location: URL) throws {
try FileManager.default.moveItem(at: url, to: location)
_delete()
// we do this after moving, so that if the move fails we clean up
shouldDelete = false
}
@@ -83,23 +89,95 @@ private struct TemporaryDirectoryRoot {
url = FileManager.default.temporaryDirectory.appendingPathComponent("sh.xtool")
#endif
}
try? FileManager.default.removeItem(at: url)
do {
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
} catch {
self._url = .failure(Errors.tmpdirCreationFailed(url, error))
return
Self.pruneOrphans(in: url)
self._url = Result {
let childDir = try Self.claimDirectory(in: url)
try FileManager.default.createDirectory(at: childDir, withIntermediateDirectories: true)
return childDir
}
.mapError { $0 as? Errors ?? .tmpdirCreationFailed(url, $0) }
}
private static func claimDirectory(in url: URL) throws -> URL {
// create a lockfile + tmpdir. while we hold the lock, other instaces of
// xtool will not delete the directory during their prune step.
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
let pid = ProcessInfo.processInfo.processIdentifier
for i in 0..<10 {
let random = "pid-\(pid)-\(i == 0 ? "0" : UUID().uuidString)"
let lockFile = url.appending(path: "\(random).lock")
#if os(macOS)
let fd = try FileDescriptor.open(
FilePath(lockFile.path),
.writeOnly,
options: [.create, .exclusiveLock],
permissions: [.ownerReadWrite, .groupRead, .otherRead],
)
#else
let fd = try FileDescriptor.open(
FilePath(lockFile.path),
.writeOnly,
options: [.create],
permissions: [.ownerReadWrite, .groupRead, .otherRead],
)
guard try fd.tryLock(mode: .exclusive) else {
// someone else raced us and claimed the right to prune between when we created the file and
// when we tried to lock it
continue
}
#endif
// leak the file descriptor so that the lock is held until the process exits
return url.appending(path: random)
}
throw Errors.tmpdirClaimFailed(url)
}
private static func pruneOrphans(in url: URL) {
guard let children = try? FileManager.default.contentsOfDirectory(at: url, includingPropertiesForKeys: nil)
else { return }
for lock in children {
do {
let basename = lock.lastPathComponent
if basename.hasPrefix("tmp-") {
// legacy tmpdir, remove it
try? FileManager.default.removeItem(at: lock)
continue
}
guard basename.hasPrefix("pid-") && basename.hasSuffix(".lock") else { continue }
let lockFD = try FileDescriptor.open(FilePath(lock.path), .readWrite)
defer { try? lockFD.close() }
if try lockFD.tryLock(mode: .exclusive) {
// we must remove the directory first. if we instead removed the lock first,
// we could be killed after the lock was removed but before the dir was
// removed and therefore leave it hanging around.
do {
try FileManager.default.removeItem(at: lock.deletingPathExtension())
} catch CocoaError.fileNoSuchFile {
// pass
}
try FileManager.default.removeItem(at: lock)
}
} catch {
// continue
}
}
self._url = .success(url)
}
enum Errors: Error, CustomStringConvertible {
case tmpdirCreationFailed(URL, Error)
case tmpdirClaimFailed(URL)
var description: String {
switch self {
case let .tmpdirCreationFailed(url, error):
"Could not create temporary directory at '\(url.path)': \(error)"
"Could not create temporary directory in '\(url.path)': \(error)"
case let .tmpdirClaimFailed(url):
"Could not claim temporary directory in '\(url.path)'"
}
}
}
@@ -1,71 +0,0 @@
//
// XKitDeveloperServicesTests.swift
// XKitTests
//
// Created by Kabir Oberai on 30/10/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import XCTest
import SuperutilsTestSupport
import XKit
// swiftlint:disable force_try
class XKitDeveloperServicesTests: XCTestCase {
var storage: KeyValueStorage!
var client: DeveloperServicesClient!
override func setUp() {
super.setUp()
_ = addMockSigner
storage = MemoryKeyValueStorage()
client = try! .test(storage: storage)
}
override func tearDown() {
super.tearDown()
client = nil
}
// integration test for provisioning
@MainActor func testProvisioningIntegration() async throws {
let listTeams = DeveloperServicesListTeamsRequest()
let teams = try await client.send(listTeams)
let team = teams.first { $0.status == "active" && $0.memberships.contains { $0.platform == .iOS } }!
let source = try XCTUnwrap(Bundle.module.url(forResource: "test", withExtension: "app"))
let context = try XCTTry(SigningContext(
udid: Config.current.udid,
deviceName: SigningContext.hostName,
teamID: team.id,
client: client,
signingInfoManager: MemoryBackedSigningInfoManager()
))
let response = try await DeveloperServicesProvisioningOperation(
context: context,
app: source,
confirmRevocation: { _ in true },
progress: { _ in }
).perform()
print(response)
}
func testListTeams() async throws {
let listTeams = DeveloperServicesListTeamsRequest()
let teams = try await client.send(listTeams)
XCTAssertFalse(teams.isEmpty, "No teams found")
let team = try XCTUnwrap(
teams.first { $0.id.rawValue == Config.current.preferredTeam },
"Could not find preferred team"
)
XCTAssertEqual(team.status, "active", "Expected team status active. Got: \(team.status)")
XCTAssert(team.memberships.contains { $0.platform == .iOS }, "Team does not have iOS membership")
}
}
@@ -1,67 +0,0 @@
//
// XKitGrandSlamTests.swift
// XKitTests
//
// Created by Kabir Oberai on 10/04/20.
// Copyright © 2020 Kabir Oberai. All rights reserved.
//
// swiftlint:disable force_try
import XCTest
import SuperutilsTestSupport
@testable import XKit
final class TwoFactorAuthenticator: TwoFactorAuthDelegate {
func fetchCode() async -> String? {
print("Code: ", terminator: "")
return readLine() ?? ""
}
}
class XKitGrandSlamTests: XCTestCase {
var authenticator: TwoFactorAuthenticator!
var storage: KeyValueStorage!
var client: GrandSlamClient!
override func setUp() {
super.setUp()
_ = addMockSigner
storage = MemoryKeyValueStorage()
client = try! .test(storage: storage)
authenticator = TwoFactorAuthenticator()
}
override func tearDown() {
super.tearDown()
client = nil
authenticator = nil
}
func testAuthentication() async throws {
let loginData = try await GrandSlamAuthenticateOperation(
client: client,
username: Config.current.appleID.username,
password: Config.current.appleID.password,
twoFactorDelegate: authenticator
).authenticate()
XCTAssertFalse(loginData.adsid.isEmpty)
XCTAssertFalse(loginData.cookie.isEmpty)
XCTAssertFalse(loginData.identityToken.isEmpty)
XCTAssertFalse(loginData.idmsToken.isEmpty)
XCTAssertFalse(loginData.sk.isEmpty)
let now = Date() // *before* the actual request is made
let tokens = try await GrandSlamFetchAppTokensOperation(
client: client,
apps: [.xcode],
loginData: loginData
).perform()
let token = try XCTUnwrap(tokens[.xcode], "Xcode token absent from response")
XCTAssertGreaterThanOrEqual(token.expiry, now)
XCTAssertFalse(token.value.isEmpty)
}
}
@@ -1,90 +0,0 @@
//
// XKitSigningTests.swift
// XKitTests
//
// Created by Kabir Oberai on 06/11/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
// TODO: Test using mock signer
#if false
import XCTest
import SuperutilsTestSupport
import XKit
class XKitSigningTests: XCTestCase {
var client: DeveloperServicesClient!
var signerImpl: SignerImpl!
var app: URL!
// swiftlint:disable force_try
override func setUp() {
super.setUp()
_ = addMockSigner
client = .test()
signerImpl = try! SignerImpl.first()
let source = try! XCTUnwrap(Bundle.module.url(forResource: "test", withExtension: "app"))
let tmp = FileManager.default.temporaryDirectory
app = tmp.appendingPathComponent(source.lastPathComponent)
if FileManager.default.fileExists(atPath: app.path) {
try! FileManager.default.removeItem(at: app)
}
try! FileManager.default.copyItem(at: source, to: app)
}
override func tearDown() {
super.tearDown()
client = nil
signerImpl = nil
try! FileManager.default.removeItem(at: app)
app = nil
}
// swiftlint:enable force_try
// integration test for signing
@MainActor func testSigningIntegration() throws {
let listTeams = DeveloperServicesListTeamsRequest()
let teams = try XCTTry(client.sendTest(listTeams))
let team = teams.first { $0.status == "active" && $0.memberships.contains { $0.platform == .iOS } }!
let context = try XCTTry(SigningContext(
udid: Config.current.udid,
deviceName: SigningContext.hostName,
teamID: team.id,
client: client,
signingInfoManager: MemoryBackedSigningInfoManager(),
signerImpl: signerImpl
))
let signer = Signer(context: context)
let signingWaiter = ResultWaiter<()>(description: "Failed to sign app")
signer.sign(app: app, status: { _ in }, progress: { _ in }, completion: signingWaiter.completion)
try XCTTry(signingWaiter.wait(timeout: 10000))
// TODO: Ensure entitlements are correct in new app, also codesign -vvvv
}
func testAnalyze() throws {
let infoURL = app.appendingPathComponent("Info.plist")
let info = try XCTUnwrap(NSDictionary(contentsOf: infoURL))
let execName = try XCTUnwrap(info[kCFBundleExecutableKey as String] as? String)
let exec = app.appendingPathComponent(execName)
let ents = try XCTUnwrap(signerImpl.analyze(executable: exec))
let entsPlist = try XCTTry(PropertyListDecoder().decode(Entitlements.self, from: ents))
XCTAssertFalse(try XCTTry(entsPlist.entitlements().isEmpty))
}
func testSign() throws {
let signingWaiter = ResultWaiter<()>(description: "Failed to sign app")
// TODO: Get cert, key, ents from fixtures
}
}
#endif
-32
View File
@@ -1,32 +0,0 @@
//
// Config.swift
// XKitTests
//
// Created by Kabir Oberai on 05/11/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import Foundation
import XKit
struct Config: Decodable {
struct AppleID: Decodable {
let username: String
let password: String
/// for non-login tests, just provide a token already
let token: DeveloperServicesLoginToken
}
let appleID: AppleID
let deviceInfo: DeviceInfo
let preferredTeam: String
let udid: String
static let current: Config = {
let url = Bundle.module.url(forResource: "config", withExtension: "json")!
// swiftlint:disable:next force_try
let data = try! Data(contentsOf: url)
// swiftlint:disable:next force_try
return try! JSONDecoder().decode(Config.self, from: data)
}()
}
@@ -1,62 +0,0 @@
//
// DeveloperServicesTestClient.swift
// XKitTests
//
// Created by Kabir Oberai on 06/11/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import Foundation
import XCTest
@testable import XKit
#if false
extension TCPAnisetteDataProvider {
static func test() -> TCPAnisetteDataProvider {
TCPAnisetteDataProvider(localPort: 4321)
}
}
extension NetcatAnisetteDataProvider {
static func test() -> NetcatAnisetteDataProvider {
NetcatAnisetteDataProvider(localPort: 4322, deviceInfo: Config.current.deviceInfo)
}
}
#endif
extension ADIDataProvider {
static func test(storage: KeyValueStorage) throws -> ADIDataProvider {
try adiProvider(deviceInfo: Config.current.deviceInfo, storage: storage)
}
}
extension GrandSlamClient {
static func test(storage: KeyValueStorage) throws -> GrandSlamClient {
try GrandSlamClient(
deviceInfo: Config.current.deviceInfo,
anisetteProvider: ADIDataProvider.test(storage: storage)
)
}
}
extension DeveloperServicesClient {
static func test(storage: KeyValueStorage) throws -> DeveloperServicesClient {
try DeveloperServicesClient(
loginToken: Config.current.appleID.token,
deviceInfo: Config.current.deviceInfo,
anisetteProvider: ADIDataProvider.test(storage: storage)
)
}
}
@@ -1,16 +0,0 @@
import Foundation
import SignerSupport
let addMockSigner: () = {
add_signer(
"MockSigner",
{ _, _, _, _, _, _, _, _, _, exception in
exception.initialize(to: strdup("Mock signer not implemented"))
return 1
},
{ _, _, exception in
exception.initialize(to: strdup("Mock analyzer not implemented"))
return nil
}
)
}()
@@ -1,32 +0,0 @@
{
"appleID": {
"username": "",
"password": "",
"token": {
"adsid": "",
"token": "",
"expiry": 0
}
},
"deviceInfo": {
"clientInfo": {
"macOSBuild": "",
"darwinVersion": "",
"macOSVersion": "",
"akdVersion": "",
"cfNetworkVersion": "",
"authKitVersion": "",
"modelID": "",
},
"xcodeInfo": {
"version": "",
"build": ""
},
"deviceID": "",
"mlbSerialNumber": "",
"romAddress": "",
"serialNumber": ""
},
"preferredTeam": "",
"udid": "",
}