Compare commits

...

4 Commits

14 changed files with 223 additions and 425 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,
}
}
+6 -15
View File
@@ -92,7 +92,12 @@ 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"),
]
),
.target(
name: "XKit",
dependencies: [
@@ -138,20 +143,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: [
+7 -9
View File
@@ -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 {
@@ -223,7 +217,7 @@ struct SDKBuilder {
try await tarExit
}
// 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 +347,10 @@ struct SDKBuilder {
)
}
try FileManager.default.removeItem(
at: dev.appending(path: "Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/clang/include")
)
return dev
}
+49 -14
View File
@@ -47,9 +47,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 +84,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 +133,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,12 +149,38 @@ struct DarwinSDK {
let url = URL(fileURLWithPath: path)
guard DarwinSDK(bundle: url) != nil else { throw Console.Error("Invalid Darwin SDK at '\(path)'")}
try await addHostClangResourceDir(to: url)
let process = Process()
process.executableURL = try await ToolRegistry.locate("swift")
process.arguments = ["sdk", "install", url.path]
try await process.runUntilExit()
}
private static func addHostClangResourceDir(to sdk: URL) async throws {
let outPipe = Pipe()
let clang = Process()
clang.executableURL = try await ToolRegistry.locate("clang")
clang.arguments = ["-print-resource-dir"]
clang.standardOutput = outPipe
clang.standardError = FileHandle.standardError
async let outputData = Data(reading: outPipe.fileHandleForReading)
do {
try await clang.runUntilExit()
} catch is Process.Failure {
throw Console.Error("Failed to query host clang -print-resource-dir")
}
let path = String(decoding: try await outputData, as: UTF8.self)
.trimmingCharacters(in: .whitespacesAndNewlines)
guard !path.isEmpty else {
throw Console.Error("Host clang returned an empty resource directory")
}
let hostClangResources = URL(fileURLWithPath: path, isDirectory: true)
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()
@@ -243,20 +270,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) {}
+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": "",
}