Compare commits

..

119 Commits

  • sdk: get clang resources from swift toolchain (#274)
    ## What does this PR do?
    
    When building the SDK, derives the clang resource dir from the installed
    Swift toolchain (`swiftc -print-target-info`) instead of `clang
    -print-resource-dir`.
    
    Speculatively fixes #273.
    
    ## How was it tested?
    
    Validated that I can still build on Linux
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [ ] **0** - No AI was used to write code
    - [x] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
    
    
    <!-- This is an auto-generated comment: release notes by coderabbit.ai
    -->
    
    ## Summary by CodeRabbit
    
    * **Bug Fixes**
    * Improved detection of the host Clang resource directory by using Swift
    compiler target information, helping ensure more reliable compiler setup
    across supported environments.
    
    <!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • docs: recommend Xcode 27 and Swift 6.4 (#267)
    ## What does this PR do?
    
    Updates docs to recommend Xcode 27 + Swift 6.4
    
    ## How was it tested?
    
    Netlify deploy preview
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [x] **0** - No AI was used to write code
    - [ ] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
    
    
    <!-- This is an auto-generated comment: release notes by coderabbit.ai
    -->
    
    ## Summary by CodeRabbit
    
    - **Documentation**
      - Updated Linux installation guidance to require Swift 6.4.
      - Refreshed the example toolchain version output.
    - Updated the example Xcode archive filename to reflect the newer
    release.
    
    <!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • sdk: update darwin-tools and OAM (#270)
    ## What does this PR do?
    
    Bumps darwin-tools and OpenAppleMacros
    
    - Updates LLD to support arm64e.x1 to fix #269
    - Adds FoundationModelsMacros to fix #213
    
    ## How was it tested?
    
    - [x] Confirm that we can build with an Xcode 27 release SDK on Linux
    - [x] Confirm that FoundationModels APIs work
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [x] **0** - No AI was used to write code
    - [ ] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
    
    
    <!-- This is an auto-generated comment: release notes by coderabbit.ai
    -->
    
    ## Summary by CodeRabbit
    
    * **Bug Fixes**
    * Improved Darwin SDK tool discovery during Swift builds, including
    support for locating `dsymutil`.
    
    * **Updates**
      * Updated bundled Darwin tool dependencies.
    * Added Foundation Models macros support to the OpenAppleMacros library
    set.
    
    <!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • anisette: use XADI on macOS (#259)
    ## What does this PR do?
    
    Updates macOS build to use the fully-local XADI as the Anisette provider
    instead of Omnisette. Includes a one-time migration, logging the user
    out on macOS when they upgrade.
    
    ## How was it tested?
    
    General:
    
    - [x] Log in and confirm that there's no calls to omnisette
    - [x] `xtool dev` works
    
    Migration:
    
    - [x] Log into Apple ID using an old version of xtool
    - [x] Migrate to new xtool, run `xtool dev build -s` and confirm it
    fails due to being logged out
    - [x] Log in on new xtool, confirm that we stay logged in
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [x] **0** - No AI was used to write code
    - [ ] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
    
    
    <!-- This is an auto-generated comment: release notes by coderabbit.ai
    -->
    ## Summary by CodeRabbit
    
    * **New Features**
    * Authentication now supports tracking the anisette provider used to
    create Xcode tokens.
    * Xcode authentication tokens are automatically cleared when the
    provider changes, helping ensure users sign in again with current
    credentials.
    * Anisette provider identification is supported across macOS and Linux.
    
    * **Bug Fixes**
    * Improved authentication error messages, including clearer messaging
    for logout-related errors.
    * Prevented outdated Xcode authentication tokens from being reused after
    a provider change.
    <!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • sdk: SwiftBuild support (#229)
    ## What does this PR do?
    
    Adds support for SwiftBuild on Swift 6.4.
    
    We now point SwiftBuild to iPhoneOS.platform and rely on the real
    [SWBApplePlatform](https://github.com/swiftlang/swift-build/tree/b30ee3c00abf34857084c26bb873c3da06348134/Sources/SWBApplePlatform).
    We also do a little futzing to convince SWB to use our Darwin-compatible
    toolset (lld, librarian, resource dirs). We explicitly _don't_ pass in a
    Swift SDK because that would downgrade SWB to using one of the generic
    platform plugins instead of ApplePlatform.
    
    This also gets us a lot closer to parity with Xcode's behavior when
    building for Apple platforms; we get the same build flags and
    everything. We can probably achieve identical bundling too, if we take
    control of the PIF.
    
    One other change: since we need to pass custom env vars and such, we
    can't rely on sourcekit-lsp's built-in SwiftPM integration anymore. We
    thus create a custom BSP server that trampolines to SwiftPM's build
    server with the right flags set. This effectively makes SwiftPM an
    implementation detail, so we can start messing with the PIF.
    
    ## How was it tested?
    
    - [x] Build with Swift 6.3 on macOS
    - [x] Build with Swift 6.4 on macOS
    - [x] Build with Swift 6.3 on Linux
    - [x] Build with Swift 6.4 on Linux
    - [x] BSP/LSP file creation works
    - [x] LSP support works in VSCode
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [ ] **0** - No AI was used to write code
    - [x] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
    
    <!-- This is an auto-generated comment: release notes by coderabbit.ai
    -->
    ## Summary by CodeRabbit
    
    - **New Features**
    - Added a `dev build-server` command for Build Server Protocol
    integration.
    - Projects automatically select the appropriate Swift build system when
    supported.
    - Packaging supports output layouts for Swift Package Manager and Swift
    Build.
      - Added options to skip language-server configuration when needed.
    
    - **Documentation**
    - Updated project templates and tutorials to use `.bsp/xtool.json` for
    IDE features such as syntax highlighting and documentation lookup.
    
    - **Improvements**
    - Enhanced SDK generation and compatibility across supported toolchains
    and platforms.
    - Improved automatic language-server configuration while preserving
    existing configuration files.
    <!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • build: use automatic library type (#266)
    ## What does this PR do?
    
    Bumps xtool-core et al, switching products to automatic instead of
    forcing dynamic libraries. LGPL dependencies (LIMD, XADI) are still
    packaged as dynamic.
    
    ## How was it tested?
    
    - [x] Ran locally on macOS + Linux and confirmed `xtool dev` works
    - [x] Inspected .app bundle to make sure we have the expected dynamic
    frameworks
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [x] **0** - No AI was used to write code
    - [ ] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
    
    
    <!-- This is an auto-generated comment: release notes by coderabbit.ai
    -->
    
    ## Summary by CodeRabbit
    
    * **Chores**
    * Updated underlying package dependencies to newer minimum versions for
    improved compatibility and maintenance.
    
    <!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Bump xadi to 0.4.1 (#265)
    ## What does this PR do?
    
    Fixes a bug where installation would crash due to `plist_from_bin`
    hitting Provision's version of the function which uses D runtime
    shenanigans.
    
    ## How was it tested?
    
    Locally on macOS
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [x] **0** - No AI was used to write code
    - [ ] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
    
    
    <!-- This is an auto-generated comment: release notes by coderabbit.ai
    -->
    
    ## Summary by CodeRabbit
    
    * **Chores**
      * Updated the `xadi` package dependency to version 0.4.1.
    
    <!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • sdk: integrate OpenAppleMacros (#101)
    ## What does this PR do?
    
    Adds support for proprietary Apple macros (like SwiftUI's `@Entry` and
    `@State`) via
    [OpenAppleMacros](https://github.com/xtool-org/OpenAppleMacros).
    
    We have to re-implement these because the macros need to run on the
    _host_, and the Apple SDKs include them as macOS-only dylibs.
    
    ## How was it tested?
    
    - [x] Extensive integration tests in OpenAppleMacros that compare
    Apple's expansions against ours
    - [x] Confirmed that `@Entry`, `#Preview`, and `@State` work in Swift
    6.3 and 6.4 (State is a PW in the former, macro in the latter)
    - [x] Confirmed that OSS toolchain macros continue to work (tested
    `@Observable`, `#bundle`)
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [x] **0** - No AI was used to write code
    - [ ] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
  • tests: add integration tests (#252)
    ## What does this PR do?
    
    Adds integration tests
    
    ## How was it tested?
    
    CI
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [x] **0** - No AI was used to write code
    - [ ] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
    
    
    <!-- This is an auto-generated comment: release notes by coderabbit.ai
    -->
    
    ## Summary by CodeRabbit
    
    * **Tests**
    * Added integration smoke tests covering version checks, app creation,
    iOS build metadata, and slim SDK update behavior.
    * Added validation for locating Xcode and verifying the Swift toolchain.
    
    * **Chores**
    * Added automated integration-test execution for pushes and pull
    requests.
    * Added Docker and Compose support for running integration tests in a
    consistent environment.
    
    <!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • sdk: self-updating darwin tools (#110)
    ## What does this PR do?
    
    Allows xtool to auto-update the Darwin SDK format when there's a new
    Darwin toolset, or when we change the SDK format. Downstream this also
    allows us to auto-update when there's changes to OpenAppleMacros (#101).
    
    One callout: the disk footprint of `darwin.artifactbundle` is now ~7 GB
    instead of ~3 GB.
    
    Reason: `xtool sdk install /path/to/Xcode.[app|xip]` now performs a
    "normal" install by default, which preserves the entirety of
    `Xcode.app/Contents/Developer` — even the bits we don't currently use,
    like `AppleTVOS.platform`. This makes it so if we start using more
    components in the future, the user doesn't need to download Xcode again
    and rebuild the SDK themselves.
    
    You can still build an old-style SDK (containing just the components we
    need) using `xtool sdk install --slim` or the dedicated `xtool sdk
    build`.
    
    ## How was it tested?
    
    Tested all of the install modes. Confirmed that auto-updating works.
    Added integration tests in #252.
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [ ] **0** - No AI was used to write code
    - [x] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
    
    
    <!-- This is an auto-generated comment: release notes by coderabbit.ai
    -->
    ## Summary by CodeRabbit
    
    - **New Features**
    - Added SDK flavor reporting for slim, normal, and legacy installations.
    - Added `sdk update` support to rebuild and install SDKs from an
    installed Xcode bundle.
      - Added a `--slim` option for SDK installation.
      - SDK status now displays installation path, flavor, and version.
    - SDK setup and build operations now ensure a suitable SDK is available
    automatically.
    
    - **Bug Fixes**
    - Improved temporary SDK bundle handling, validation, replacement, and
    cross-filesystem copying.
      - Copy failures now provide detailed diagnostic information.
    <!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • anisette: use XADI Swift Package (#258)
    ## What does this PR do?
    
    The xadi repo (https://github.com/xtool-org/xadi) now vends an
    artifactbundle for xadi, so we don't need to separately build/install it
    during the xtool build. This also makes it super easy to support macOS
    later (#259).
    
    ## How was it tested?
    
    - [x] Confirmed I can sign in (including provisioning)
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [ ] **0** - No AI was used to write code
    - [x] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
  • sdk: move DarwinSDK into PackLib (#256)
    ## What does this PR do?
    
    Mechanical move of DarwinSDK from XToolSupport -> PackLib. Needed for
    https://github.com/xtool-org/xtool/pull/229.
    
    ## How was it tested?
    
    Compiled + CI
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [x] **0** - No AI was used to write code
    - [ ] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
  • gsa: fix auth again (#257)
    ## What does this PR do?
    
    Fixes HTTP 503 on GsService… again (followup from #244)
    
    Seems like GSA has stopped accepting `com.apple.dt.Xcode` in the client
    info string. Use `akd` instead.
    
    ## How was it tested?
    
    - [x] Logging in before failed
    - [x] Logging in after succeeds
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [x] **0** - No AI was used to write code
    - [ ] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
  • sdk: fix permission issue when copying clang resources (#255)
    ## What does this PR do?
    
    Fixes #254 by using `cp -R` instead of `FileManager.copyItem`. The
    latter tries to preserve the original owner of files instead of using
    the caller, which fails if you're non-root and the original files are
    root-owned.
    
    ## How was it tested?
    
    I was able to repro the original issue by installing an SDK as a
    non-root user in an xtool Docker container.
    
    Applied this patch, tried `xtool sdk install` again, and it worked.
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [ ] **0** - No AI was used to write code
    - [x] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
  • docs: update contributor guide (#250)
    ## What does this PR do?
    
    Adds more info for contributors, plus AI policy.
    
    ## How was it tested?
    
    Read the docs on GitHub
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [x] **0** - No AI was used to write code
    - [ ] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
  • http: add some debugging knobs (#249)
    ## What does this PR do?
    
    Improves support for HTTP MITM
    
    ## How was it tested?
    
    Did some MITMing on macOS + Linux via Docker, using Proxyman and
    mitmproxy. Didn't test `XTL_HTTP_PROXY` but Sol pinkie promises me that
    it's correct.
    
    ## AI tool usage
    
    How much of this PR was AI-assisted? (check one)
    
    - [ ] **0** - No AI was used to write code
    - [x] **1** - I was assisted by AI. I reviewed the finished result.
    - [ ] **2** - I set the AI going and left it to it; nobody has read the
    result - no review, or AI review only
    
    <!-- If an AI agent is filling this in: declare the level honestly, and
    open as a draft if it is #2. Do not lower the declared level to get the
    PR reviewed. -->
  • gsa: disregard keepalive (#247)
    GSA seems to, sometimes, reject HTTP requests made on a kept-alive
    connection with a 503. This was either the real root cause, or a second
    root cause, for #243. Fix this by creating a new HTTP connection for
    each GSA request.
    
    See also: https://github.com/rileytestut/AltSign/pull/52 and
    https://github.com/rileytestut/AltSign/pull/47
    
    Speculatively fixes #232
  • http: throw on unsuccessful responses (#246)
    Ref #243. `makeRequest` never inspected `response.status`, so a non-2xx
    body was
    returned as if it had succeeded. Every caller decodes that body as a
    property list
    or JSON, so Apple answering with an HTML error page surfaced as:
    
    ```
    Error: DecodingError.dataCorrupted: Data was corrupted. Debug description: The given
    data was not a valid property list.. Underlying error: ... Encountered unknown tag
    html on line 1
    ```
    
    which says nothing about what actually happened. In the case that
    prompted #243, GSA
    was returning `503 Service Temporarily Unavailable` for the `apptokens`
    operation. It
    now reads:
    
    ```
    Error: POST https://gsa.apple.com/grandslam/GsService2 failed: HTTP 503 Service
    Unavailable (text/html): <html> <head><title>503 Service Temporarily
    Unavailable</title></head> ...
    ```
    
    ### Notes
    
    - The response body is only included in the message for `text/html` and
    `text/plain`,
    i.e. gateway error pages. Bodies from the auth endpoints can carry
    account details
    (the 2FA requests use `Accept: application/x-buddyml`), and errors get
    printed
    verbatim in places such as `DevCommand.swift:164`, so those are left
    out. It also
      avoids emitting replacement characters for binary bodies.
    - The non-2xx path does not report progress, so `XADIProvider`'s
    download no longer
      prints `100%` immediately before failing.
    - Body collection moved to `collect(_:onProgress:)` so there is a single
    exit point.
      Buffer pre-sizing and progress reporting are unchanged.
    - `SDKBuilder` already does this check by hand on `send()`, so it is
    unaffected.
    
    ### Behaviour changes worth a look
    
    - `XADIProvider` writes the Apple Music APK download straight to disk; a
    failed
      download now throws instead of leaving a corrupt `applemusic.apk`.
    - The 2FA requests (`GrandSlamTrustedDeviceRequest`,
    `GrandSlamSMSAuthRequest`,
    `GrandSlamValidateRequest`) use no-op decoders, so a rejected request is
    currently
    discarded and xtool goes on to prompt for a code that was never sent —
    the symptom
      in #235. Those now fail loudly.
    
    ### Two things I left alone
    
    - `GrandSlamTwoFactorAuthenticateOperation.swift:47` catches
    `GrandSlamOperationError`
    with code `-21669` to report an incorrect verification code, but that
    error is only
    thrown by `GrandSlamOperationDecoder`, which the validate requests do
    not use, so the
    catch is unreachable. With this change a wrong code surfaces as a raw
    HTTP error
    instead. Mapping the status back to `incorrectVerificationCode` seemed
    like your call,
      since I do not know what GSA returns for a bad code.
    - If any endpoint reports errors in a decodable body under a non-2xx
    status, this guard
    would pre-empt it. I could not find one — `developerservices2` returns
    HTTP 200 with
      `resultCode`/`userString` in the body, which is untouched here.
    
    Built and linted on Linux (`swift build --product xtool`, `make lint`: 0
    violations).
    
    ---------
    
    Co-authored-by: Robetronica <noreply@Robetronica.com>
    Co-authored-by: Kabir Oberai <oberai.kabir@gmail.com>
  • gsa: update user agent to fix auth (#244)
    Fixes #243. GrandSlam seems to be rejecting clients that self-report as
    really old.
  • docs: enable copy-to-clipboard (#241)
    Ref https://github.com/swiftlang/swift-docc/pull/1273
    
    Could be a good idea to later add `nocopy` to some of the code blocks
    that aren't commands
  • Fix tmpdir reentrancy (#234)
    Previously, we would clear xtool's temporary directory on startup. This
    (practically) meant you couldn't have multiple instances running in
    parallel, because the second instance could delete the first instance's
    temp resources while the first instance still needed them. Fix this by
    having xtool instances declare locks on their temporary directories.
  • Fix clang headers (#228)
    A slightly different approach to #215.
    
    ---------
    
    Co-authored-by: sfusco <slf@stevenfusco.com>
  • Add build --sign option (#224)
    Running `xtool dev build --sign [--ipa]` will produce a codesigned
    app/ipa, without installing
  • Fix capability creation via public API (#220)
    Ref #216: the public API seems to now complain when passing in
    `capabilities`, but the field is still required when using the private
    API.
    
    Co-authored-by: sfusco <slf@stevenfusco.com>
  • fix(linux): use home cache dir to avoid tmpfs→ext4 EINVAL on SDK install (#211)
    ## Problem
    
    `xtool setup` fails on Linux Mint (and other distros) with:
    
    ```
    Error: Error Domain=NSCocoaErrorDomain Code=512 "(null)" UserInfo={
      NSUserStringVariant=["Copy"],
      NSSourceFilePathErrorKey=/tmp/sh.xtool/tmp-DarwinSDKBuild-.../darwin.artifactbundle/...,
      NSDestinationFilePath=/home/<user>/.swiftpm/swift-sdks/darwin.artifactbundle/...,
      NSUnderlyingError=Error Domain=NSPOSIXErrorDomain Code=22 "Invalid argument"
    }
    ```
    
    ## Root Cause
    
    On Linux Mint (and Ubuntu-based distros), `/tmp` is mounted as **tmpfs**
    while the home directory is on **ext4**. Foundation's
    `FileManager.copyItem` uses `sendfile(2)` internally, which returns
    `EINVAL (22)` when copying between different filesystem types.
    
    `TemporaryDirectoryRoot` defaults to
    `FileManager.default.temporaryDirectory` → `/tmp` on Linux. When `swift
    sdk install` copies the built SDK from `/tmp/sh.xtool/...` to
    `~/.swiftpm/swift-sdks/`, it crosses filesystem boundaries and fails.
    
    ## Fix
    
    On Linux, default the temp directory root to `$XDG_CACHE_HOME/xtool`
    (falling back to `~/.cache/xtool`) instead of `/tmp`. This keeps the
    build directory and install destination on the same filesystem, so the
    copy always succeeds.
    
    - `$XTL_TMPDIR` and `$TMPDIR` overrides continue to work as before
    - macOS behaviour is unchanged
    - Follows XDG Base Directory Specification
    
    ## Changes
    
    One file, `Sources/XUtils/TemporaryDirectory.swift` — 11 lines added
    inside a `#if os(Linux)` block.
    
    Fixes #181
  • Validate SDK before overwriting (#192)
    Running an invalid `sdk` subcommand like `xtool sdk list` (there's no
    `list` subcommand) is interpreted as "install the sdk at path `./list`".
    We previously unconditionally removed the existing SDK during
    installation. By switching the order so that we validate the path first,
    we avoid performing a potentially destructive action unless we have
    clear intent.
    
    See #186.
    
    Before:
    
    ```bash
    $ xtool sdk list
    Removing existing SDK... # destructive!
    Error: Could not read file or directory at path 'list'.
    ```
    
    After:
    
    ```bash
    $ xtool sdk list
    Error: Could not read file or directory at path 'list'.
      See 'xtool help sdk' for usage.
    ```
  • Bump zsign to 1.7.0 (#180)
    Includes the (speculative) fix for #14
  • Bump deployment to macOS 13, iOS 16 (#173)
    Necessary in order to pull in swift-subprocess
  • Clean up some entitlements code (#165)
    - We already do the `isFree` declarations in
    `DeveloperServiceCapability.swift`. Don't need to duplicate it on the
    entitlement types.
    - Add support for creating capabilities with raw names
  • Bump Swift version, dependencies (#166)
    Notably:
    
    - Build xtool with Swift 6.2
    - Resolve https://github.com/advisories/GHSA-xvr7-p2c6-j83w. That
    advisory shouldn't really affect us since we don't use NIO as a server
    but good hygiene anyway.
  • Enable cross import overlays (#153)
    Fixes #152
    
    We might want to figure out if there are any other flags we don't pass
    but should
  • Handle static xcframeworks not being unpacked (#156)
    SwiftPM may not unpack static xcframeworks. Handle this gracefully, if
    SwiftPM doesn't need the framework we don't either.
    
    Fixes #155.
  • Improve tmpdir management (#147)
    - We now have a single tmpdir "root" that can be recreated at launch to
    clean up old stragglers
    - The location of this tmpdir root can be controlled by `XTL_TMPDIR` or
    `TMPDIR`. In general the path is `$TMPDIR/sh.xtool`.
    
    With this change it should be possible to `export XTL_TMPDIR=/var/tmp`
    if `/tmp` doesn't have enough space, which fixes #23.
  • Update ASC spec to v4.0.0 (#142)
    No breaking changes afaik
    
    One notable change is the addition of
    `components.schemas.PagingInformation.paging.nextCursor` (which is
    possibly supposed to be the query parameter portion of `links.next`?
    could simplify the pagination code) but this doesn't seem to be returned
    by the prod ASC API right now.
  • Update PublicStaging path (#132)
    Previously this was shadowing the user's cwd path onto the device, e.g.
    if you were installing from `/home/foo/bar` it would create
    `/home/foo/bar/PublicStaging` on the device. For uniformity with other
    tools like `ideviceinstaller`, clean this up and just create
    `/PublicStaging`.
  • Add support for App Extensions (#97)
    This pull request adds support for Apple's [App
    Extensions](https://developer.apple.com/app-extensions/).
    
    Closes: #45
    
    ---------
    
    Co-authored-by: ErrorErrorError <16653389+ErrorErrorError@users.noreply.github.com>
    Co-authored-by: Kabir Oberai <oberai.kabir@gmail.com>
  • fix: resolve ASC invalid bearer token (#129)
    This pull request resolves potential clock drift between ASC and bearer
    token.
    
    Ref: https://github.com/xtool-org/xtool/pull/97#discussion_r2203584344
  • Harden mobileprovision.c to avoid UB on OOM (#122)
    # fix: hardening `mobileprovision.c` to avoid future crashes.
    
    ## Context:
    
    I found two common weakness inside `Sources/CXKit/mobileprovision.c`,
    which seems to be an important layer of `xtool`'s signing logic.
    
    ### Common weaknesses found:
    
    - CWE-476
    - CWE-119
    
    ---------
    
    Co-authored-by: Kabir Oberai <oberai.kabir@gmail.com>
  • Support unxipping Xcode betas (#115)
    Xcode betas are stored in the xip as Xcode-beta.app. Support this by
    avoiding hardcoding the `Xcode.app` path.
  • Drop the "Logging in" stage (#99)
    This was vestigial, and besides the fact that we don't actually do any
    work in this stage, we also never update the progress here so it gets
    stuck at 0%.
  • Make ALL response enums extensible (#92)
    Another bugfix for #64. Fifth… time's the charm?
  • FetchDeviceOperation: account for pagination (#91)
    - Always try to register the device and just return gracefully if it
    fails (prevents races, pagination issues)
    - Allow `SigningContext` (and therefore `AutoSigner`) to be created
    without a target device: just skip device registration.
  • DeveloperServices: support paginated requests (#89)
    Realized that we need to paginate due to #87
  • Fix duplicate App ID registration (#90)
    We pull the list of App IDs in `upsertApp` to see if we already created
    the App ID. This broke when the user had too many App IDs, since DS
    returned a paginated response and we only looked at the first page.
    
    We could paginate the whole list (as seen in #89) but that's slow.
    Instead, just filter the query to the expected App ID. This is a prefix
    search so we might still receive multiple responses, but it's much less
    likely that the user has like 10(? I'm not sure what the default/max
    pagination limit is) apps registered with the XTL-ABC.com.foo.bar prefix
    (they could have PlugIns but usually just a small number of them.)
    
    This is a tentative fix for #87.
  • Fix changeCurrentDirectory warning (#81)
    This is `discardableResult` on macOS (perhaps because it goes through
    objc bridging?) but not on Linux so we get a warning on the latter
  • Improve OpenAPI error handling (#78)
    - Make some enums non-exhaustive (closes #77)
      - Also a tentative fix for #62 and #64
    - Improve logging on deserialization failure
    
    We now use raw JS to patch the OpenAPI spec instead of openapi-overlay.
    It's a lot more flexible this way.
  • OpenAPI spec tweaks (#76)
    - Add `BundleIdPlatform.macos` (potential fix for #64)
    - Fix deprecation warnings
    - Improve overlay organization
  • Support for logging OpenAPI responses (#75)
    Allow setting `XTL_DEV_LOG` to a regex (e.g. `export
    XTL_DEV_LOG='profiles_.*'`) to log the responses of all matching
    operations
    
    Also add `BundleIdPlatform.services` as seen
    [here](https://github.com/AvdLee/appstoreconnect-swift-sdk/blob/60bbc198c8d9f9992807bfebef86f45d6173a1f1/Makefile#L9)
  • Support building for iOS simulator (#74)
    Closes #68
    
    ## On any platform
    
    You can now do
    
    ```bash
    xtool dev build --triple arm64-apple-ios-simulator [--ipa]
    ```
    
    To build a .app/.ipa that works on the simulator.
    
    ## On macOS
    
    You can do
    
    ```bash
    xtool dev --simulator
    ```
    
    To one-shot build-and-install on the booted simulator.
  • Fix macOS category build warning (#73)
    xcodebuild wants us to set a category for the Mac app
  • Update Netlify footer copy (#63)
    Netlify wants specific copy in order to be eligible for their [Open
    Source plan](https://www.netlify.com/legal/open-source-policy)
  • Improve SDK handling (#40)
    * Use swift-sdk commands instead of file ops
    
    * comment
  • Add iOS CI job (#31)
    * Add iOS CI job
    
    * dummy iOS failure
    
    * Revert "dummy iOS failure"
    
    This reverts commit 7c3ee19323.
    
    * Use xcbeautify
    
    * Pipefail
    
    * Revert "Revert "dummy iOS failure""
    
    This reverts commit 6b3608d396.
    
    * Revert "Revert "Revert "dummy iOS failure"""
    
    This reverts commit c08ff31b09.
  • Improve handling of paid developer accounts (#20)
    * getTeamIsFree -> XcodeAuthData.team().isFree
    
    * Only revoke certificates if on a free team
    
    * Update OpenAPI spec, handle AVP
    
    * Fix App ID capabilities on paid accounts
  • docs: add note about downloading Xcode.xip programmatically (#17)
    * docs: add warning to Xcode.xip
    
    * Copy tweaks
    
    * Another tweak
    
    ---------
    
    Co-authored-by: Kabir Oberai <oberai.kabir@gmail.com>
  • Fix SPI Linux build, hopefully (#21)
    * Use CMD instead of ENTRYPOINT
    
    * Point SPI to xtool-dev image
  • Add macOS .app to releases (#13)
    * Set up fastlane
    
    * Add release-macos workflow
    
    * for now
    
    * bundle install
    
    * Ruby versioning
    
    * Fix Ruby 3.4
    
    * Maybe fix CI
    
    * Maybe unlock?
    
    * Update Release workflow
    
    * on push
    
    * tweaks
    
    * don’t use frozen
    
    * Trying something a lil different
  • Package xtool as a .app on macOS (#12)
    * Package xtool as a .app on macOS
    
    * Need hardened runtime for notarization
    
    * Rename product to xtool.app
  • Refine NewCommand
    Tweak template, respect quiet flag on macOS
185 changed files with 14475 additions and 2017 deletions
+8
View File
@@ -0,0 +1,8 @@
*
!/Package.swift
!/Package.resolved
!/Sources
!/Tests
!/Linux
/Linux/packages
/Linux/staging
+37
View File
@@ -0,0 +1,37 @@
---
name: Bug report
about: Report a bug
title: ''
labels: bug
assignees: ''
---
## Description
A clear and concise description of what the bug is.
## Environment
Please provide as much of the following information as is relevant.
Host OS (macOS/Linux/WSL):
Host OS version:
<!-- macOS: Apple Logo > About this Mac -->
<!-- Linux: -->
<!-- cat /etc/*-release -->
<!-- Windows: -->
<!-- Get-WinVer; wsl -l -v -->
iOS device version:
<!-- Settings > General > About > iOS Version -->
Swift version:
<!-- swift --version -->
SDK version:
<!-- macOS: -->
<!-- xcodebuild -version; xcrun -sdk iphoneos -show-sdk-version -->
<!-- Linux/WSL: -->
<!-- swift sdk configure darwin arm64-apple-ios --show-configuration | grep -o 'iPhoneOS[0-9.]*\.sdk$' -->
+10
View File
@@ -0,0 +1,10 @@
---
name: Feature request
about: Suggest an idea
title: ''
labels: enhancement
assignees: ''
---
+17
View File
@@ -0,0 +1,17 @@
## What does this PR do?
<!-- Focus on *what* the PR does in essence. The *how* should come second, if it's relevant. -->
## How was it tested?
<!-- e.g. Ran locally on macOS and added unit tests -->
## AI tool usage
How much of this PR was AI-assisted? (check one)
- [ ] **0** - No AI was used to write code
- [ ] **1** - I was assisted by AI. I reviewed the finished result.
- [ ] **2** - I set the AI going and left it to it; nobody has read the result - no review, or AI review only
<!-- If an AI agent is filling this in: declare the level honestly, and open as a draft if it is #2. Do not lower the declared level to get the PR reviewed. -->
@@ -0,0 +1,9 @@
name: 'Configure Xcode'
description: 'Set up Xcode version'
runs:
using: composite
steps:
- name: Set up Xcode
shell: bash
run: |
sudo xcode-select -s /Applications/Xcode_26.4.app
+33 -7
View File
@@ -1,5 +1,13 @@
on:
- push
push:
branches:
- main
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
env:
XTL_CI: "1"
jobs:
build-linux:
strategy:
@@ -13,15 +21,33 @@ jobs:
runs-on: ${{ matrix.host.runner }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build
uses: actions/checkout@v6
- name: Build and test
run: |
docker compose run --build --rm xtool -c "swift build --product xtool"
docker compose run --build -e XTL_CI=1 xtool bash -c \
"swift build --product xtool && .build/debug/xtool --help && swift test"
build-macos:
runs-on: macos-15
runs-on: macos-26
steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@v6
- uses: ./.github/actions/configure-xcode
- name: Build
run: |
swift build --product xtool
swift build --product xtool && .build/debug/xtool --help
- name: Run tests
run: |
swift test
build-ios:
runs-on: macos-26
steps:
- name: Checkout
uses: actions/checkout@v6
- uses: ./.github/actions/configure-xcode
- name: Build
run: |
set -o pipefail \
&& xcodebuild build \
-skipMacroValidation -skipPackagePluginValidation \
-scheme XKit -destination generic/platform=iOS \
| xcbeautify
+18
View File
@@ -0,0 +1,18 @@
on:
push:
branches:
- main
pull_request:
concurrency:
group: integration-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
integration-test-linux:
# https://github.com/xtool-org/mac-actions-runner
runs-on: ubuntu-on-macos
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Run integration tests
run: |
./integration-tests/run.sh
-49
View File
@@ -1,49 +0,0 @@
on:
workflow_dispatch:
jobs:
build:
strategy:
fail-fast: false
matrix:
host:
- runner: ubuntu-24.04
arch: x86_64
- runner: ubuntu-24.04-arm
arch: aarch64
runs-on: ${{ matrix.host.runner }}
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build
run: |
docker compose run --build --rm xtool -c "Linux/build.sh && mv Linux/packages/xtool{,-${{ matrix.host.arch }}}.AppImage"
- name: Upload artifact
id: upload_artifact
uses: actions/upload-artifact@v4
with:
name: xtool-${{ matrix.host.arch }}
path: Linux/packages/xtool-${{ matrix.host.arch }}.AppImage
release:
needs: build
runs-on: ubuntu-24.04
permissions:
contents: write
env:
GH_TOKEN: ${{ github.token }}
steps:
- uses: actions/checkout@v4
- name: Download artifact
id: download_artifact
uses: actions/download-artifact@v4
with:
pattern: xtool-*
path: output
- name: Create and publish release
id: publish_release
run: |
TAG="${GITHUB_REF##*/}-${GITHUB_SHA:0:7}"
gh release create "$TAG" --draft --title "Draft Release"
gh release upload "$TAG" output/**/*.AppImage
+108
View File
@@ -0,0 +1,108 @@
on:
push:
tags:
- "*"
env:
XTL_CI: "1"
jobs:
build-linux:
strategy:
fail-fast: false
matrix:
host:
- runner: ubuntu-24.04
arch: x86_64
- runner: ubuntu-24.04-arm
arch: aarch64
runs-on: ${{ matrix.host.runner }}
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Build
run: |
docker compose run --build \
-e XTOOL_VERSION=${{ github.ref_name }} \
-e XTL_CI=1 \
--rm xtool Linux/build.sh
- name: Upload artifact
uses: actions/upload-artifact@v7
with:
name: xtool-${{ matrix.host.arch }}
path: |
Linux/packages/xtool-${{ matrix.host.arch }}.AppImage
Linux/packages/xtool-${{ matrix.host.arch }}.AppImage.zsync
build-mac:
runs-on: macos-26
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v6
- uses: ./.github/actions/configure-xcode
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
working-directory: macOS
bundler-cache: true
- name: Build
env:
APP_STORE_CONNECT_API_KEY_KEY_ID: ${{ secrets.APP_STORE_CONNECT_API_KEY_KEY_ID }}
APP_STORE_CONNECT_API_KEY_ISSUER_ID: ${{ secrets.APP_STORE_CONNECT_API_KEY_ISSUER_ID }}
APP_STORE_CONNECT_API_KEY_KEY: ${{ secrets.APP_STORE_CONNECT_API_KEY_KEY }}
IDENTITY_P12: ${{ secrets.IDENTITY_P12 }}
DEVELOPMENT_TEAM: ${{ secrets.DEVELOPMENT_TEAM }}
XTOOL_VERSION: ${{ github.ref_name }}
run: |
cd macOS
bundle exec fastlane package
- name: Upload artifacts
uses: actions/upload-artifact@v7
with:
name: xtool-mac
path: |
macOS/Build/Output/xtool.app.zip
macOS/Build/Output/xtool.app.dSYM.zip
release:
needs: [build-linux, build-mac]
runs-on: ubuntu-24.04
permissions:
contents: write
env:
GH_TOKEN: ${{ github.token }}
steps:
- uses: actions/checkout@v6
- name: Download artifact
uses: actions/download-artifact@v8
with:
pattern: xtool-*
path: output
- name: Create and publish release
run: |
TAG="${{ github.ref_name }}"
gh release create "$TAG" --draft --title "v$TAG"
gh release upload "$TAG" output/**/*.{AppImage,AppImage.zsync,app.zip,app.dSYM.zip}
docker:
uses: docker/github-builder/.github/workflows/build.yml@v1
permissions:
contents: read # to fetch the repository content
id-token: write # for signing attestations and cache entries with GitHub OIDC
packages: write # to push built images to GitHub Container Registry
with:
build-args: |
XTL_CI=1
output: image
push: true
platforms: linux/amd64,linux/arm64
meta-images: |
ghcr.io/xtool-org/xtool
meta-tags: |
type=semver,pattern={{version}}
secrets:
registry-auths: |
- registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
+19
View File
@@ -0,0 +1,19 @@
on:
push:
branches:
- main
pull_request:
paths:
- '.github/workflows/swiftlint.yml'
- '.swiftlint.yml'
- '**/*.swift'
jobs:
swiftlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Lint
run: |
make lint SWIFTLINT_FLAGS='--reporter=github-actions-logging' | tee swiftlint.log
# fail if there are any errors or warnings
! grep -Eq '^::(error|warning)' swiftlint.log
+1
View File
@@ -12,3 +12,4 @@ DerivedData/
.docc-build
/openapi
/.tmp
-14
View File
@@ -1,14 +0,0 @@
version: 1
builder:
configs:
- scheme: xtool
platform: macosSpm
documentation_targets:
- xtool
- scheme: xtool
platform: macosXcodebuild
# - scheme: xtool
# platform: linux
# image: # TODO: we need to use our own Docker image for this
- scheme: XKit
platform: ios
+73
View File
@@ -0,0 +1,73 @@
swiftlint_version: 0.59.1
disabled_rules:
- trailing_comma
- nesting
- fallthrough
- shorthand_operator
- todo
- large_tuple
- identifier_name
- type_name
- unneeded_override
- optional_data_string_conversion
- for_where
- blanket_disable_command
opt_in_rules:
- closure_end_indentation
- closure_spacing
- empty_count
- explicit_init
- fatal_error_message
- first_where
- implicit_return
- joined_default_parameter
- literal_expression_end_indentation
- overridden_super_call
- prohibited_super_call
- sorted_first_last
- unneeded_parentheses_in_closure_argument
- vertical_parameter_alignment_on_call
- yoda_condition
- nslocalizedstring_key
- unused_setter_value
- optional_enum_case_matching
- prefer_self_type_over_type_of_self
- contains_over_range_nil_comparison
- flatmap_over_map_reduce
- empty_collection_literal
- contains_over_first_not_nil
- contains_over_filter_count
- contains_over_filter_is_empty
- reduce_into
analyzer_rules:
- unused_import
custom_rules:
spaces_not_tabs:
name: "Spaces not Tabs"
regex: ^\t
message: "Use four spaces, not tabs"
point_zero:
name: "Point Zero"
regex: '(?<!iOS\s)(?<!macOS\s)(?<!\.)\b[\d_]+\.0\b'
match_kinds:
- number
- attribute.builtin
message: "Don't add a .0 to the end of floating point literals"
force_try: warning
force_cast: warning
function_body_length: 100
line_length: 135
file_length: 1000
type_body_length: 500
cyclomatic_complexity: 12
function_parameter_count: 7
implicit_return:
included:
- closure
included:
- Package.swift
- Sources
- Tests
- macOS/XToolMac
excluded:
- Sources/DeveloperAPI/Generated
+1
View File
@@ -0,0 +1 @@
/launch.json
+6
View File
@@ -0,0 +1,6 @@
{
"recommendations": [
"swiftlang.swift-vscode",
"vknabel.vscode-swiftlint",
]
}
+13
View File
@@ -0,0 +1,13 @@
{
"swiftlint.path": "./.tmp/swiftlint/swiftlint",
"files.watcherExclude":{
"*/.git/**": true,
"*/.build/**": true,
"*/.tmp/**": true,
},
"search.exclude": {
"*/.git/**": true,
"*/.build/**": true,
"*/.tmp/**": true,
}
}
+16
View File
@@ -0,0 +1,16 @@
# About
xtool is a cross-platform replacement for Xcode (including build system, provisioning, deployment).
The `xtool` CLI supports macOS, Linux, WSL. The lower-level XKit (provisioning and device interaction) library additionally supports iOS.
## Development
- The majority of the code is in the Swift Package. You can use `swift build` / `swift test` / etc for iteration.
- Caveat: on macOS, xtool is distributed as an app bundle (allows entitlements like Keychain). To build the Mac app, use `make mac`. You can then invoke the CLI at `./macOS/Build/xtool`.
- Make sure to run `make lint` (swiftlint) when you're done
## Conventions
- Use modern Swift 6. Strict concurrency is enabled.
- Use swift-dependencies for Dependency Injection. Passing dependencies around as arguments is an anti-pattern.
+1
View File
@@ -0,0 +1 @@
@AGENTS.md
+128
View File
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
conduct@xtool.sh.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
+18
View File
@@ -0,0 +1,18 @@
# Contributing to xtool
## Bug reports and feature requests
We welcome all bug reports and feature requests! Please create a [new issue](https://github.com/xtool-org/xtool/issues/new/choose) via GitHub.
## Code and documentation
External contributions are very welcome. Take a look at [/Documentation/Contributing/README.md](/Documentation/Contributing/README.md) for details regarding the development process.
## AI tool usage
You may use AI tools to assist your contributions. You are fully responsible
for everything you submit.
- **Understand it**: You must be able to explain every line of your code.
- **Disclose it**: Pick an AI assistance level (0/1/2) in the PR template.
- **Own it**: You are the author. If a reviewer asks "why?", you answer - not the AI. [Don't be a meat proxy.](https://dontbeameatproxy.com)
+33 -19
View File
@@ -1,7 +1,7 @@
# Note: We use 20.04 since AppImage recommends building on the
# Note: We use 22.04 since AppImage recommends building on the
# oldest configuration that you support
FROM swift:6.1-focal AS build-base
FROM swift:6.3-jammy AS build-base
RUN apt-get update \
&& DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
@@ -66,23 +66,13 @@ RUN cd libimobiledevice \
&& make install DESTDIR=/prefix
FROM build-base AS build-xadi
RUN mkdir -p /prefix/usr/lib
RUN curl -fsS https://dlang.org/install.sh | bash -s ldc
ADD https://github.com/xtool-org/xadi.git#main /xadi
RUN cd xadi \
&& /bin/bash -c 'source $(/root/dlang/install.sh ldc -a) && dub build --build=release' \
&& cp -r bin/libxadi.so /prefix/usr/lib/libxadi.so
FROM build-base
FROM build-base AS build-xtool-base
COPY --from=build-limd /prefix/usr /usr
COPY --from=build-xadi /prefix/usr /usr
WORKDIR /xtool
FROM build-xtool-base AS dev
# Docker doesn't support FUSE
ENV APPIMAGE_EXTRACT_AND_RUN=1
@@ -92,6 +82,30 @@ ENV APPIMAGE_EXTRACT_AND_RUN=1
# socat -dd TCP-LISTEN:27015,range=127.0.0.1/32,reuseaddr,fork UNIX-CLIENT:/var/run/usbmuxd
ENV USBMUXD_SOCKET_ADDRESS=host.docker.internal:27015
WORKDIR /xtool
CMD [ "/bin/bash" ]
ENTRYPOINT [ "/bin/bash" ]
FROM dev AS dev-test
ENV XTL_TEST_ENV=1
COPY --from=bats/bats:latest /opt/bats /opt/bats
COPY --from=bats/bats:latest /usr/lib/bats /usr/lib/bats
RUN ln -s /opt/bats/bin/bats /usr/local/bin/bats
FROM build-xtool-base AS build-xtool
ARG XTL_CI
ADD Package.swift Package.resolved /xtool/
RUN swift package resolve
ADD . /xtool
RUN ./Linux/build.sh
FROM swift:6.3 AS xtool
COPY --from=build-xtool /xtool/Linux/packages/xtool-*.AppImage /xtool/xtool.AppImage
RUN (cd /xtool && ./xtool.AppImage --appimage-extract) \
&& mv /xtool/squashfs-root /usr/local/xtool \
&& rm -rf /xtool \
&& ln -s /usr/local/xtool/AppRun /usr/local/bin/xtool
+20
View File
@@ -0,0 +1,20 @@
# Debugging
## Environment variables
Some environment variables that help with debugging. Use these as e.g. `XTL_FOO=1 xtool ...`
### General
- `XTL_DEBUG_ERRORS`: If xtool terminates with an error, it normally prints a user-friendly error description. Set `XTL_DEBUG_ERRORS=1` for more verbose error logging.
### Disk
- `XTL_DEBUG_TMP`: Set to `1` to log details when xtool creates/destroys temporary directories.
- `XTL_TMPDIR`: Control the location where xtool stores temporary directories. We also respect `TMPDIR` and (on Linux) `XDG_CACHE_HOME`.
### Networking
- `XTL_DEV_LOG`: Regex. When making AppStoreConnect API requests, operation IDs that match the regex will log their response status and body. Set `XTL_DEV_LOG='.*'` to match all.
- `XTL_DISABLE_TLS_VALIDATION`: Set to `1` to disable all TLS validation on HTTP requests. Useful when using an MITM proxy to inspect API requests. Use sparingly, since disabling TLS is generally unsafe.
- `XTL_HTTP_PROXY`: non-Darwin only. Set to `<host>:<port>` to point the HTTP client to a proxy. e.g. `XTL_HTTP_PROXY=localhost:8080`. On Darwin (macOS/iOS), we instead use the system proxy configuration.
+31
View File
@@ -0,0 +1,31 @@
# Contributing to xtool
## Code
When making code changes, please make sure to test them on both macOS and Linux if possible. If you can also test on Windows with WSL, that is ideal.
To build xtool for debugging, run `make` in the project directory. There are a few considerations depending on your host OS:
### macOS
On macOS, you'll firstly need to have Xcode set up.
The first time you run `make`, we'll try to detect your codesigning identity. If you have multiple, you'll see an interactive prompt to select the team you want to use. The team ID is saved to `./macOS/Support/Private-Team.xcconfig`. You can run `make team` to update it (or do so by hand).
After building, a symlink to the product will be created at `./macOS/Build/xtool`. We generate an Xcode project at `./macOS/XToolMac.xcodeproj` that you can open in order to work in Xcode.
### Linux
You need to have a few dependencies on Linux; see [Dockerfile](/Dockerfile) for specifics. It's often easiest to develop within Docker itself: see [Linux/README.md](/Linux/README.md) for details.
## Debugging
Check out [./Debugging.md](./Debugging.md) for help with debugging xtool issues during development.
## Updating Documentation
The xtool documentation at <https://xtool.sh> is built with [swift-docc](https://github.com/swiftlang/swift-docc) and resides at [Documentation/xtool.docc](/Documentation/xtool.docc). It's hosted on Netlify, the configuration for which is in [netlify.toml](/netlify.toml).
When editing the DocC bundle, you can preview it with `make docs-preview`.
Once you make a pull request with your changes, we'll also generate a [Netlify Deploy Preview](https://docs.netlify.com/site-deploys/deploy-previews/) under your pull request. You can open this preview to see how the changes will look in production.
+26
View File
@@ -0,0 +1,26 @@
#!/bin/bash
set -euo pipefail
cd "$(dirname "$0")"
rm -rf docs
if type -p xcrun &>/dev/null; then
docc="$(xcrun -f docc)"
else
docc="docc"
fi
if [[ $# == 0 ]]; then
command="convert"
elif [[ $# == 1 && ( "$1" == "preview" || "$1" == "convert" ) ]]; then
command="$1"
else
echo "Usage: $0 [convert|preview]"
exit 1
fi
"$docc" "$command" xtool.docc \
--enable-experimental-code-block-annotations \
--experimental-enable-custom-templates
+143
View File
@@ -0,0 +1,143 @@
# Create App Extensions
Add app extensions to your iOS app.
## Overview
iOS includes several [App Extension Points](https://developer.apple.com/documentation/technologyoverviews/app-extensions) to deeply integrate with system functionality: such as Widgets, Share Extensions, and Safari Extensions. With a little setup, you can create App Extensions with xtool.
This guide will show you how to add a **Widget Extension** to your app. The steps are similar for other extensions as well.
> Note: This guide assumes you already have an xtool-based application up and running. If you don't, create one first with <doc:First-app>.
## Step 1: Add a new product
Start by adding a new product declaration to your `Package.swift`.
```diff
// swift-tools-version: 6.0
import PackageDescription
let package = Package(
name: "Hello",
platforms: [.iOS(.v17)],
products: [
.library(
name: "Hello",
targets: ["Hello"]
),
+ .library(
+ name: "HelloWidget",
+ targets: ["HelloWidget"]
+ ),
],
targets: [
.target(name: "Hello"),
+ .target(name: "HelloWidget"),
]
)
```
## Step 2: Update xtool.yml
Now that we have two products, we'll need to tell xtool which one corresponds to the _application_ and which one corresponds to the _extension_.
You should already have a bare-bones `xtool.yml` file that describes metadata about your package (the bundle ID, at the bare minimum.) We'll add the new information to this file.
```diff
version: 1
bundleID: com.example.Hello
+ product: Hello
+ extensions:
+ - product: HelloWidget
+ infoPath: HelloWidget-Info.plist
```
## Step 3: Add an Info.plist
App extensions require an `Info.plist` file that tells the system what kind of extension they are, amongst other things. In the previous step, we promised xtool that this file will be located at `./HelloWidget-Info.plist` in your project. We'll now create this file.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>NSExtension</key>
<dict>
<key>NSExtensionPointIdentifier</key>
<string>com.apple.widgetkit-extension</string>
</dict>
</dict>
</plist>
```
> Note:
>
> The value `com.apple.widgetkit-extension` tells the system that this is a Widget Extension. If you're creating a different type of Extension, your `Info.plist` might look different.
>
> For a list of possible `NSExtensionPointIdentifier` values, see [Apple's documentation](https://developer.apple.com/documentation/bundleresources/information-property-list/nsextension/nsextensionpointidentifier) on the subject. You may also need other keys like `NSExtensionPrincipalClass`: refer to Apple's ~better~ legacy [documentation library](https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/AppExtensionKeys.html) for details.
>
> Finally, note that the above refers to the old paradigm of **Foundation Extensions**. Apple has started moving towards a newer framework called **ExtensionKit** for recent extension types. The main difference for extension consumers is that you replace `NSExtension -> EXAppExtensionAttributes`, and `NSExtensionPointIdentifier -> EXExtensionPointIdentifier`. xtool doesn't support ExtensionKit yet, but it's [planned](https://github.com/xtool-org/xtool/issues/138).
## Step 4: Code your widget
We can finally write the code for the widget. Create a new file at `Sources/HelloWidget/Widget.swift` with these contents:
```swift
import WidgetKit
import SwiftUI
@main struct Bundle: WidgetBundle {
var body: some Widget {
HelloWidget()
}
}
struct HelloWidget: Widget {
var body: some WidgetConfiguration {
StaticConfiguration(
kind: "HelloWidget",
provider: Provider()
) { entry in
VStack {
Text(entry.date, style: .date)
}
.containerBackground(.fill.tertiary, for: .widget)
}
.configurationDisplayName("HelloWidget")
.description("This is an example widget.")
}
struct Entry: TimelineEntry {
var date = Date()
}
struct Provider: TimelineProvider {
func placeholder(in context: Context) -> Entry {
Entry()
}
func getSnapshot(
in context: Context,
completion: @escaping (Entry) -> Void
) {
completion(Entry())
}
func getTimeline(
in context: Context,
completion: @escaping (Timeline<Entry>) -> Void
) {
completion(Timeline(
entries: [Entry()],
policy: .after(.now + 3600)
))
}
}
}
```
> Note: Blindly refreshing once an hour isn't a great strategy in practice but it makes for a short snippet. I never said this was a tutorial on writing _good_ WidgetKit code; there's plenty of other resources online if that's your goal, including Apple's own [documentation](https://developer.apple.com/documentation/widgetkit).
Finally, build and run with `xtool dev`. You should be able to locate the widget in your widget library and add it to your home screen!
@@ -21,7 +21,7 @@ You can update your app's bundle ID by editing the `bundleID` field in `xtool.ym
> Note:
>
> xtool adds a prefix to your bundle ID when signing and installing the app on a real device. For example, it may update the above bundle id to `SC-1234.com.example.Hello`. This is because, at least with free accounts (those not enrolled in the Apple Developer Program), two accounts cannot use the same bundle ID. Prefixing ensures that if you share your app with someone else, they won't run into a bundle ID conflict when installing it.
> xtool adds a prefix to your bundle ID when signing and installing the app on a real device. For example, it may update the above bundle id to `XTL-1234.com.example.Hello`. This is because, at least with free accounts (those not enrolled in the Apple Developer Program), two accounts cannot use the same bundle ID. Prefixing ensures that if you share your app with someone else, they won't run into a bundle ID conflict when installing it.
>
> With additional engineering effort, this limitation could be lifted for paid Developer Program users by leveraging wildcard provisioning profiles. If you have a concrete use case for this and/or wish to contribute, please [file an issue](https://github.com/xtool-org/xtool/issues/new).
@@ -107,3 +107,36 @@ iconPath: Resources/AppIcon.png
> Tip:
>
> Your app icon must be a png, and it should ideally have a resolution of 1024x1024px.
## Add entitlements
You may need to add special [entitlements](https://developer.apple.com/documentation/bundleresources/entitlements) to your app, for example you need the `com.apple.developer.homekit` entitlement in order to connect to HomeKit devices.
First create an `App.entitlements` file with the necessary entitlements:
```plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>com.apple.developer.homekit</key>
<true/>
</dict>
</plist>
```
Then, tell xtool about it via `xtool.yml`:
```yaml
entitlementsPath: App.entitlements
```
> Troubleshooting:
>
> There are a number of situations in which xtool may not be able to successfully apply an entitlement to your app.
>
> - Some entitlements, such as [Network Extension](https://developer.apple.com/documentation/bundleresources/entitlements/com.apple.developer.networking.networkextension), don't work with free developer accounts. You might need to enrol in one of the Apple Developer Programs to use these.
> - Other entitlements, like [User Notifications Filtering](https://developer.apple.com/documentation/bundleresources/entitlements/com.apple.developer.usernotifications.filtering), require special permission from Apple. If you do have the appropriate permission, these may or may not work with xtool.
> - Many entitlements require specific "Capabilities" to be enabled on your app in the Developer Services portal. xtool handles this for you, but we need to add code to xtool for each Entitlement-Capability mapping. If you run into a Capability that we don't handle yet, please let us know.
>
> Entitlements are a large surface area. If you find any bugs or missing functionality, please [create a GitHub Issue](https://github.com/xtool-org/xtool/issues/new/choose).
@@ -3,7 +3,7 @@ Creating package: Hello
Creating Package.swift
Creating xtool.yml
Creating .gitignore
Creating .sourcekit-lsp/config.json
Creating .bsp/xtool.json
Creating Sources/Hello/HelloApp.swift
Creating Sources/Hello/ContentView.swift
@@ -3,7 +3,7 @@ Creating package: Hello
Creating Package.swift
Creating xtool.yml
Creating .gitignore
Creating .sourcekit-lsp/config.json
Creating .bsp/xtool.json
Creating Sources/Hello/HelloApp.swift
Creating Sources/Hello/ContentView.swift
@@ -3,7 +3,7 @@ Creating package: Hello
Creating Package.swift
Creating xtool.yml
Creating .gitignore
Creating .sourcekit-lsp/config.json
Creating .bsp/xtool.json
Creating Sources/Hello/HelloApp.swift
Creating Sources/Hello/ContentView.swift
@@ -12,7 +12,7 @@ Finished generating project Hello.
Developer$
Hello$
-rw-rw-r-- 1 user user 187 .gitignore
drwxrwxr-x 2 user user 4096 .sourcekit-lsp
drwxrwxr-x 2 user user 4096 .bsp
-rw-rw-r-- 1 user user 463 Package.swift
drwxrwxr-x 3 user user 4096 Sources
-rw-rw-r-- 1 user user 39 xtool.yml
@@ -3,7 +3,7 @@ Creating package: Hello
Creating Package.swift
Creating xtool.yml
Creating .gitignore
Creating .sourcekit-lsp/config.json
Creating .bsp/xtool.json
Creating Sources/Hello/HelloApp.swift
Creating Sources/Hello/ContentView.swift
@@ -12,7 +12,7 @@ Finished generating project Hello.
Developer$ cd Hello
Hello$ ls -la
-rw-rw-r-- 1 user user 187 .gitignore
drwxrwxr-x 2 user user 4096 .sourcekit-lsp
drwxrwxr-x 2 user user 4096 .bsp
-rw-rw-r-- 1 user user 463 Package.swift
drwxrwxr-x 3 user user 4096 Sources
-rw-rw-r-- 1 user user 39 xtool.yml
@@ -3,7 +3,7 @@ Creating package: Hello
Creating Package.swift
Creating xtool.yml
Creating .gitignore
Creating .sourcekit-lsp/config.json
Creating .bsp/xtool.json
Creating Sources/Hello/HelloApp.swift
Creating Sources/Hello/ContentView.swift
@@ -12,7 +12,7 @@ Finished generating project Hello.
Developer$ cd Hello
Hello$ ls -la
-rw-rw-r-- 1 user user 187 .gitignore
drwxrwxr-x 2 user user 4096 .sourcekit-lsp
drwxrwxr-x 2 user user 4096 .bsp
-rw-rw-r-- 1 user user 463 Package.swift
drwxrwxr-x 3 user user 4096 Sources
-rw-rw-r-- 1 user user 39 xtool.yml
@@ -3,7 +3,7 @@ Creating package: Hello
Creating Package.swift
Creating xtool.yml
Creating .gitignore
Creating .sourcekit-lsp/config.json
Creating .bsp/xtool.json
Creating Sources/Hello/HelloApp.swift
Creating Sources/Hello/ContentView.swift
@@ -12,7 +12,7 @@ Finished generating project Hello.
Developer$ cd Hello
Hello$ ls -la
-rw-rw-r-- 1 user user 187 .gitignore
drwxrwxr-x 2 user user 4096 .sourcekit-lsp
drwxrwxr-x 2 user user 4096 .bsp
-rw-rw-r-- 1 user user 463 Package.swift
drwxrwxr-x 3 user user 4096 Sources
-rw-rw-r-- 1 user user 39 xtool.yml
@@ -3,7 +3,7 @@ Creating package: Hello
Creating Package.swift
Creating xtool.yml
Creating .gitignore
Creating .sourcekit-lsp/config.json
Creating .bsp/xtool.json
Creating Sources/Hello/HelloApp.swift
Creating Sources/Hello/ContentView.swift
@@ -12,7 +12,7 @@ Finished generating project Hello.
Developer$ cd Hello
Hello$ ls -la
-rw-rw-r-- 1 user user 187 .gitignore
drwxrwxr-x 2 user user 4096 .sourcekit-lsp
drwxrwxr-x 2 user user 4096 .bsp
-rw-rw-r-- 1 user user 463 Package.swift
drwxrwxr-x 3 user user 4096 Sources
-rw-rw-r-- 1 user user 39 xtool.yml
@@ -3,7 +3,7 @@ Creating package: Hello
Creating Package.swift
Creating xtool.yml
Creating .gitignore
Creating .sourcekit-lsp/config.json
Creating .bsp/xtool.json
Creating Sources/Hello/HelloApp.swift
Creating Sources/Hello/ContentView.swift
@@ -12,7 +12,7 @@ Finished generating project Hello.
Developer$ cd Hello
Hello$ ls -la
-rw-rw-r-- 1 user user 187 .gitignore
drwxrwxr-x 2 user user 4096 .sourcekit-lsp
drwxrwxr-x 2 user user 4096 .bsp
-rw-rw-r-- 1 user user 463 Package.swift
drwxrwxr-x 3 user user 4096 Sources
-rw-rw-r-- 1 user user 39 xtool.yml
@@ -21,5 +21,9 @@ Hello$ cat xtool.yml
version: 1
bundleID: com.example.Hello
Hello$ cat .sourcekit-lsp/config.json
{ "swiftPM": { "swiftSDK": "arm64-apple-ios" } }
Hello$ cat .bsp/xtool.json
{
"name": "xtool",
...
"argv": ["/usr/bin/env", "xtool", "dev", "build-server"]
}
@@ -1,6 +1,6 @@
@Tutorial(time: 30) {
@Intro(title: "Build your first iOS app on Linux") {
Once you've completed <doc:Installation-Linux>, use xtool to build and deploy an iOS app from your Linux machine.
@Intro(title: "Build your first iOS app on Linux / Windows") {
Once you've completed <doc:Installation-Linux>, use xtool to build and deploy an iOS app from your Linux/Windows machine.
}
@Section(title: "Create an xtool project") {
@@ -30,9 +30,9 @@
}
@Step {
Read `.sourcekit-lsp/config.json`.
Read `.bsp/xtool.json`.
This file tells SourceKit to build for the `arm64-apple-ios` system defined in `darwin.artifactbundle`. This is the [Swift SDK](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md) that we built during the setup process. It contains the necessary modules for building iOS apps, such as UIKit and SwiftUI, as well as tools for building and manipulating iOS binaries. Under the hood, xtool also calls `swift build` with `--swift-sdk arm64-apple-ios` for the same reason.
This file tells your IDE to ask xtool for build information (via the Build Server Protocol). It enables features like syntax highlighting and documentation lookup.
@Code(name: "Terminal", file: "template-4b.sh", previousFile: "template-4a.sh") {}
}
@@ -118,7 +118,7 @@
@Step {
Follow the instructions to configure [SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp/blob/242609dcad55824d9eb23269c0aeead187fd0faa/Documentation/Editor%20Integration.md) for your IDE.
For example, if you're using Visual Studio Code, this means you need to install the [Swift extension](https://marketplace.visualstudio.com/items?itemName=swiftlang.swift-vscode).
For example, if you're using Visual Studio Code, this means you need to install the [Swift extension](https://marketplace.visualstudio.com/items?itemName=swiftlang.swift-vscode). If you're on Windows, make sure you're [connected to the WSL remote](https://code.visualstudio.com/docs/remote/wsl).
@Image(source: "SwiftExtension", alt: "Swift extension for VSCode")
}
@@ -1,23 +1,35 @@
# Installation (Linux)
# Installation (Linux/Windows)
Set up xtool for iOS app development on Linux.
Set up xtool for iOS app development on Linux or Windows.
## Overview
This article outlines the steps to install `xtool` and begin developing iOS apps on Linux.
This article outlines the steps to install `xtool` and begin developing iOS apps on Linux (or Windows via WSL).
## Prerequisites
### WSL (for Windows users)
If you're on Windows, you can use xtool via [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) (WSL).
Once you install WSL, you'll also need to set up USB passthrough. See Microsoft's instructions on [installing USBIPD](https://learn.microsoft.com/en-us/windows/wsl/connect-usb). Make sure you're able to bind your iOS device to WSL via USB.
> Note:
>
> If you encounter `Error: AFCClient.Error.muxError`, follow the steps described in [this issue comment](https://github.com/xtool-org/xtool/issues/19#issuecomment-2898986718) from user rena2019.
>
> This relays the device connection from iTunes on Windows, instead of relying on USBIPD.
### Swift
Install the Swift 6.1 toolchain for your Linux distribution from <https://swift.org/install/linux>.
Install the Swift 6.4 toolchain for your Linux distribution from <https://swift.org/install/linux>.
After following the steps there, confirm that Swift is installed correctly:
```bash
swift --version
# should say something like:
# Swift version 6.1 (swift-6.1-RELEASE)
# Swift version 6.4 (swift-6.4-RELEASE)
```
### usbmuxd
@@ -56,7 +68,11 @@ sudo apt-get install usbmuxd
### Xcode.xip
Download **Xcode 16.3** from <https://developer.apple.com/services-account/download?path=/Developer_Tools/Xcode_16.3/Xcode_16.3.xip>. Note the path where `Xcode_16.3.xip` is saved.
Download **Xcode 27** from <https://developer.apple.com/download/all/?q=Xcode>. Note the path where `Xcode.xip` is saved.
> Note:
>
> The URL above requires authentication, so make sure to visit it in your browser rather than running `curl`. You'll be asked to log in with your Apple ID and accept the license agreement to download Xcode.
## Installation
@@ -115,7 +131,7 @@ Choice (0-1): 0
Path to Xcode.xip:
```
Enter the path (for example `~/Downloads/Xcode_16.3.xip`) and hit enter. xtool will extract the Xcode XIP to generate and install an iOS Swift SDK for you.
Enter the path (for example `~/Downloads/Xcode_27.0.xip`) and hit enter. xtool will extract the Xcode XIP to generate and install an iOS Swift SDK for you.
Confirm that it worked:
@@ -29,27 +29,19 @@ swift --version
## Installation
### 1. Build xtool
### 1. Download xtool
You currently have to build xtool from source on macOS, via Swift Package Manager.
If you have [Homebrew](https://brew.sh), you can install xtool with
```bash
git clone https://github.com/xtool-org/xtool
# Cloning into 'xtool'...
# Resolving deltas: 100% (1795/1795), done.
cd xtool
swift build -c release --product xtool
# Building for production...
# [503/503] Linking xtool
# Build of product 'xtool' complete! (67.64s)
sudo ln -s "$PWD/.build/release/xtool" /usr/local/bin/xtool
brew install xtool-org/tap/xtool
```
> Important:
Otherwise, you can download `xtool.app` from the [latest GitHub release](https://github.com/xtool-org/xtool/releases/latest). After moving it into `/Applications`, launch it and run the suggested script to add the `xtool` command to your `PATH`.
> Note:
>
> The SwiftPM build currently references relative libraries and resources. This means you can't just `mv` the built `xtool` binary, hence the usage of `ln` to symlink instead. Make sure you **don't delete the directory where you cloned xtool**.
>
> The plan is to make macOS installation easier and more self-contained in the future by shipping xtool as a `.app`, Homebrew Cask, etc. If you would like to contribute, feel free to reach out via [GitHub Issues](https://github.com/xtool-org/xtool/issues/new).
> If you install xtool manually, you'll also need to check for new GitHub releases and update it yourself. If you're interested in contributing support for auto-updates through Sparkle, pull requests are appreciated. See [issue #34 on GitHub](https://github.com/xtool-org/xtool/issues/34).
Confirm that xtool is installed correctly:

Before

Width:  |  Height:  |  Size: 286 KiB

After

Width:  |  Height:  |  Size: 286 KiB

Before

Width:  |  Height:  |  Size: 948 KiB

After

Width:  |  Height:  |  Size: 948 KiB

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

Before

Width:  |  Height:  |  Size: 5.0 MiB

After

Width:  |  Height:  |  Size: 5.0 MiB

Before

Width:  |  Height:  |  Size: 222 KiB

After

Width:  |  Height:  |  Size: 222 KiB

Before

Width:  |  Height:  |  Size: 316 KiB

After

Width:  |  Height:  |  Size: 316 KiB

Before

Width:  |  Height:  |  Size: 232 KiB

After

Width:  |  Height:  |  Size: 232 KiB

Before

Width:  |  Height:  |  Size: 142 KiB

After

Width:  |  Height:  |  Size: 142 KiB

Before

Width:  |  Height:  |  Size: 2.3 MiB

After

Width:  |  Height:  |  Size: 2.3 MiB

Before

Width:  |  Height:  |  Size: 127 KiB

After

Width:  |  Height:  |  Size: 127 KiB

+19
View File
@@ -0,0 +1,19 @@
<style>
footer {
display: flex;
justify-content: center;
padding: 0.5rem 0.8rem;
background-color: var(--color-fill-secondary);
text-align: center;
}
a, a:visited {
color: var(--color-text);
}
</style>
<footer>
<span>
&copy; xtool maintainers. This site is powered by <a href="https://www.netlify.com">Netlify</a>.
</span>
</footer>
@@ -1,4 +1,10 @@
# ``xtool``
# xtool
@Metadata {
@TechnologyRoot
@TitleHeading("Command-line Tool")
@CallToAction(url: "https://github.com/xtool-org/xtool", label: "View on GitHub")
}
Cross-platform Xcode replacement.
@@ -25,3 +31,4 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona
### Common tasks
- <doc:Control>
- <doc:Appex>
+7 -6
View File
@@ -5,9 +5,6 @@ shopt -s nullglob
cd "$(dirname "$0")"
# installer version
export LINUXDEPLOY_OUTPUT_VERSION="1.0.0"
if ! command -v fusermount &>/dev/null; then
# Docker doesn't support FUSE
export APPIMAGE_EXTRACT_AND_RUN=1
@@ -21,6 +18,7 @@ bin="$(swift build --package-path .. -c release --show-bin-path)"
strip "${bin}/xtool"
curr_git_info="$(curl -fsSL https://api.github.com/repos/linuxdeploy/linuxdeploy/git/refs/tags/continuous)"
curr_arch="$(uname -m)"
if [[ -f staging/linuxdeploy/git.json ]]; then
if ! cmp -s staging/linuxdeploy/git.json <(echo "$curr_git_info"); then
@@ -33,7 +31,7 @@ else
fi
if [[ ! -f staging/linuxdeploy/linuxdeploy.AppImage ]]; then
curl -fsSL "https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-$(arch).AppImage" \
curl -fsSL "https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-${curr_arch}.AppImage" \
-o staging/linuxdeploy/linuxdeploy.AppImage
chmod +x staging/linuxdeploy/linuxdeploy.AppImage
echo "$curr_git_info" > staging/linuxdeploy/git.json
@@ -42,14 +40,17 @@ fi
mkdir -p staging/tmp/AppDir/usr/bin
find "${bin}"/ -name '*.resources' -print0 | xargs -0 -I {} cp -a {} "${PWD}/staging/tmp/AppDir/usr/bin/"
LDAI_OUTPUT="staging/tmp/xtool.AppImage" ./staging/linuxdeploy/linuxdeploy.AppImage \
export LINUXDEPLOY_OUTPUT_VERSION="${XTOOL_VERSION:-unversioned}"
export LDAI_OUTPUT="staging/tmp/xtool-${curr_arch}.AppImage"
export LDAI_UPDATE_INFORMATION="gh-releases-zsync|xtool-org|xtool|latest|xtool-${curr_arch}.AppImage.zsync"
./staging/linuxdeploy/linuxdeploy.AppImage \
--appdir staging/tmp/AppDir \
--output appimage \
-e "${bin}/xtool" \
-d xtool.desktop \
-i xtool.png
mkdir -p packages
mv -f staging/tmp/xtool.AppImage packages/xtool.AppImage
mv -f "staging/tmp/xtool-${curr_arch}.AppImage" "./xtool-${curr_arch}.AppImage.zsync" packages/
rm -rf staging/tmp
+159 -5
View File
@@ -1,7 +1,156 @@
ifeq ($(shell uname -s),Darwin)
IS_MAC = 1
ifneq ($(VERBOSE),1)
ifeq ($(shell type -p xcbeautify &>/dev/null && echo 1),1)
XC_FORMAT = | xcbeautify
endif
endif
endif
ifeq ($(RELEASE),1)
INTERNAL_SWIFTFLAGS = -c release
INTERNAL_XCFLAGS = -configuration Release
else
INTERNAL_SWIFTFLAGS = -c debug
INTERNAL_XCFLAGS = -configuration Debug
endif
ALL_SWIFTFLAGS = $(INTERNAL_SWIFTFLAGS) $(SWIFTFLAGS)
ALL_XCFLAGS = $(INTERNAL_XCFLAGS) $(XCFLAGS)
TEAM_CONFIG = macOS/Support/Private-Team.xcconfig
.PHONY: all
# dev build for the current platform
all:
ifeq ($(IS_MAC),1)
@+$(MAKE) mac
else
@+$(MAKE) linux
endif
.PHONY: clean
# clean build artifacts
clean:
ifeq ($(IS_MAC),1)
@+$(MAKE) mac-clean
else
@+$(MAKE) linux-clean
endif
.PHONY: linux
# dev build for Linux
linux:
swift build --product xtool $(ALL_SWIFTFLAGS)
.PHONY: linux-clean
# clean build artifacts for Linux
linux-clean:
rm -rf .build
.PHONY: linux-dist
# dist build for Linux
linux-dist:
docker compose run --build --rm xtool Linux/build.sh
.PHONY: docker
docker:
docker build . -t ghcr.io/xtool-org/xtool:latest
.PHONY: mac
# dev build for macOS
mac: project
@rm -rf macOS/Build/XcodeInstall
@set -o pipefail && cd macOS && \
xcodebuild install \
-skipMacroValidation -skipPackagePluginValidation \
-scheme XToolMac -destination generic/platform=macOS \
-derivedDataPath Build/DerivedData \
DSTROOT="$$PWD"/Build/XcodeInstall INSTALL_PATH=/ \
$(ALL_XCFLAGS) $(XC_FORMAT)
@ln -fs XcodeInstall/xtool.app/Contents/Resources/bin/xtool macOS/Build/xtool
@echo "Output: ./macOS/Build/xtool"
.PHONY: mac-clean
# clean build artifacts for macOS
mac-clean:
rm -rf macOS/Build
.PHONY: mac-dist
# dist build for macOS
# requires a few secrets in the env (see .github/workflows/release.yml)
mac-dist:
@echo "bundle exec fastlane package"
@cd macOS && bundle exec fastlane package
.PHONY: reload
# update Xcode project and restart Xcode
reload:
killall Xcode || :
@+$(MAKE) project
xed macOS/XToolMac.xcodeproj
.PHONY: project
# update Xcode project
project: $(TEAM_CONFIG)
@echo "xcodegen"
@cd macOS && xcodegen
.PHONY: team
# update development team
team:
@+$(MAKE) -B $(TEAM_CONFIG)
# update development team if needed.
#
# will prompt interactively if there are multiple valid options.
# set DEVELOPMENT_TEAM=... to force a specific value.
$(TEAM_CONFIG):
ifeq ($(DEVELOPMENT_TEAM),)
@mkdir -p macOS/Support
@team=$$(./scripts/select-identity.sh); \
echo "echo \"DEVELOPMENT_TEAM = $$team\" > $@"; \
echo "DEVELOPMENT_TEAM = $$team" > $@
else
@mkdir -p macOS/Support
echo "DEVELOPMENT_TEAM = $(DEVELOPMENT_TEAM)" > $@
.PHONY: $(TEAM_CONFIG)
endif
.PHONY: docs
# build documentation
docs:
./Documentation/build.sh
.PHONY: docs-preview
# preview documentation
docs-preview:
./Documentation/build.sh preview
SWIFTLINT_VERSION = $(shell head -1 .swiftlint.yml | cut -d' ' -f2)
SWIFTLINT_BIN = .tmp/swiftlint/swiftlint-$(SWIFTLINT_VERSION)
SWIFTLINT_URL = https://github.com/realm/SwiftLint/releases/download/$(SWIFTLINT_VERSION)/$(if $(IS_MAC),portable_swiftlint,swiftlint_linux).zip
.PHONY: lint
lint: $(SWIFTLINT_BIN)
$(SWIFTLINT_BIN) $(SWIFTLINT_FLAGS)
$(SWIFTLINT_BIN):
@rm -rf .tmp/swiftlint
@mkdir -p .tmp/swiftlint
curl -fSL $(SWIFTLINT_URL) -o .tmp/swiftlint/swiftlint.zip
unzip -q .tmp/swiftlint/swiftlint.zip swiftlint -d .tmp/swiftlint
@rm -f .tmp/swiftlint/swiftlint.zip
@mv .tmp/swiftlint/swiftlint $@
@ln -s swiftlint-$(SWIFTLINT_VERSION) .tmp/swiftlint/swiftlint
SPEC_URL = https://developer.apple.com/sample-code/app-store-connect/app-store-connect-openapi-specification.zip
.PHONY: api update-api
.PHONY: api
# Regenerate the OpenAPI client code
api: openapi/openapi.json
swift run swift-openapi-generator generate \
openapi/openapi.json \
@@ -11,12 +160,17 @@ api: openapi/openapi.json
sed -i '' -e 's/[[:<:]]Client[[:>:]]/DeveloperAPIClient/g' $$file; \
done
.PHONY: update-api
# Update OpenAPI spec and regenerate the client code
update-api:
@+$(MAKE) -B api
openapi/openapi.json: openapi/base.json Sources/DeveloperAPI/openapi-overlay.yaml
npx bump-cli overlay openapi/base.json Sources/DeveloperAPI/openapi-overlay.yaml > openapi/openapi.json
openapi/openapi.json: openapi/base.json Sources/DeveloperAPI/patch.js
node Sources/DeveloperAPI/patch.js < openapi/base.json > openapi/openapi.json
openapi/base.json:
@mkdir -p openapi
curl -fsSL "$(SPEC_URL)" | bsdtar -xOf- > openapi/base.json
# piping curl|bsdtar concatenates xattrs into the JSON :thonk:
curl -fsSL "$(SPEC_URL)" -o openapi/spec.zip
bsdtar -xO -f openapi/spec.zip > openapi/base.json
rm -f openapi/spec.zip
+146 -83
View File
@@ -1,13 +1,13 @@
{
"originHash" : "6980154be7e8da0aace058cc72033471d7d9573fa77fdbf53972129e4cd1d0a2",
"originHash" : "70ed310397f7785149edfd3c75ea1be84b43c694430c1a7d8a48d1da0809d3b5",
"pins" : [
{
"identity" : "aexml",
"kind" : "remoteSourceControl",
"location" : "https://github.com/tadija/AEXML.git",
"state" : {
"revision" : "38f7d00b23ecd891e1ee656fa6aeebd6ba04ecc3",
"version" : "4.6.1"
"revision" : "db806756c989760b35108146381535aec231092b",
"version" : "4.7.0"
}
},
{
@@ -15,8 +15,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/swift-server/async-http-client.git",
"state" : {
"revision" : "333f51104b75d1a5b94cb3b99e4c58a3b442c9f7",
"version" : "1.25.2"
"revision" : "3a5b74a58782c3b4c1f0bc75e9b67b10c2494e8f",
"version" : "1.33.1"
}
},
{
@@ -24,8 +24,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/attaswift/BigInt",
"state" : {
"revision" : "114343a705df4725dfe7ab8a2a326b8883cfd79c",
"version" : "5.5.1"
"revision" : "e07e00fa1fd435143a2dcf8b7eec9a7710b2fdfe",
"version" : "5.7.0"
}
},
{
@@ -33,8 +33,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/combine-schedulers",
"state" : {
"revision" : "5928286acce13def418ec36d05a001a9641086f2",
"version" : "1.0.3"
"revision" : "dcccb979a2183b8df3334237e3dc1ae2b4116a86",
"version" : "1.2.0"
}
},
{
@@ -51,8 +51,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/mattpolzin/OpenAPIKit",
"state" : {
"revision" : "da7d3a5ddff0dd8e5e9fdb5585d186d645bcc21b",
"version" : "3.5.0"
"revision" : "57b6318128e3f901c93f4fbf98d1c1464ec168d3",
"version" : "6.2.0"
}
},
{
@@ -69,8 +69,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/onevcat/Rainbow.git",
"state" : {
"revision" : "0c627a4f8a39ef37eadec1ceec02e4a7f55561ac",
"version" : "4.1.0"
"revision" : "cdf146ae671b2624917648b61c908d1244b98ca1",
"version" : "4.2.1"
}
},
{
@@ -96,8 +96,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-argument-parser",
"state" : {
"revision" : "41982a3656a71c768319979febd796c6fd111d5c",
"version" : "1.5.0"
"revision" : "626b5b7b2f45e1b0b1c6f4a309296d1d21d7311b",
"version" : "1.7.1"
}
},
{
@@ -105,8 +105,17 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-asn1.git",
"state" : {
"revision" : "a54383ada6cecde007d374f58f864e29370ba5c3",
"version" : "1.3.2"
"revision" : "eb50cbd14606a9161cbc5d452f18797c90ef0bab",
"version" : "1.7.0"
}
},
{
"identity" : "swift-async-algorithms",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-async-algorithms.git",
"state" : {
"revision" : "9d349bcc328ac3c31ce40e746b5882742a0d1272",
"version" : "1.1.3"
}
},
{
@@ -114,8 +123,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-atomics.git",
"state" : {
"revision" : "cd142fd2f64be2100422d658e7411e39489da985",
"version" : "1.2.0"
"revision" : "b601256eab081c0f92f059e12818ac1d4f178ff7",
"version" : "1.3.0"
}
},
{
@@ -123,8 +132,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-certificates",
"state" : {
"revision" : "999fd70c7803da89f3904d635a6815a2a7cd7585",
"version" : "1.10.0"
"revision" : "bde8ca32a096825dfce37467137c903418c1893d",
"version" : "1.19.1"
}
},
{
@@ -139,10 +148,10 @@
{
"identity" : "swift-collections",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-collections.git",
"location" : "https://github.com/apple/swift-collections",
"state" : {
"revision" : "671108c96644956dddcd89dd59c203dcdb36cec7",
"version" : "1.1.4"
"revision" : "fea17c02d767f46b23070fdfdacc28a03a39232a",
"version" : "1.5.1"
}
},
{
@@ -150,8 +159,17 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-concurrency-extras",
"state" : {
"revision" : "82a4ae7170d98d8538ec77238b7eb8e7199ef2e8",
"version" : "1.3.1"
"revision" : "5a3825302b1a0d744183200915a47b508c828e6f",
"version" : "1.3.2"
}
},
{
"identity" : "swift-configuration",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-configuration.git",
"state" : {
"revision" : "be76c4ad929eb6c4bcaf3351799f2adf9e6848a9",
"version" : "1.2.0"
}
},
{
@@ -159,8 +177,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-crypto",
"state" : {
"revision" : "e8d6eba1fef23ae5b359c46b03f7d94be2f41fed",
"version" : "3.12.3"
"revision" : "1b6b2e274e85105bfa155183145a1dcfd63331f1",
"version" : "4.5.0"
}
},
{
@@ -168,17 +186,26 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-dependencies",
"state" : {
"revision" : "4c90d6b2b9bf0911af87b103bb40f41771891596",
"version" : "1.9.2"
"revision" : "706feb7858a7f6c242879d137b8ee30926aa5b26",
"version" : "1.12.0"
}
},
{
"identity" : "swift-distributed-tracing",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-distributed-tracing.git",
"state" : {
"revision" : "dc4030184203ffafbb2ec614352487235d747fe0",
"version" : "1.4.1"
}
},
{
"identity" : "swift-docc-plugin",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-docc-plugin",
"location" : "https://github.com/swiftlang/swift-docc-plugin",
"state" : {
"revision" : "85e4bb4e1cd62cec64a4b8e769dcefdf0c5b9d64",
"version" : "1.4.3"
"revision" : "647c708be89f834fa6a6d4945442793a77ddf5b6",
"version" : "1.5.0"
}
},
{
@@ -195,8 +222,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-http-structured-headers.git",
"state" : {
"revision" : "f280fc7676b9940ff2c6598642751ea333c6544f",
"version" : "1.2.2"
"revision" : "933538faa42c432d385f02e07df0ace7c5ecfc47",
"version" : "1.7.0"
}
},
{
@@ -204,8 +231,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-http-types",
"state" : {
"revision" : "a0a57e949a8903563aba4615869310c0ebf14c03",
"version" : "1.4.0"
"revision" : "45eb0224913ea070ec4fba17291b9e7ecf4749ca",
"version" : "1.5.1"
}
},
{
@@ -213,8 +240,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-log.git",
"state" : {
"revision" : "3d8596ed08bd13520157f0355e35caed215ffbfa",
"version" : "1.6.3"
"revision" : "5073617dac96330a486245e4c0179cb0a6fd2256",
"version" : "1.12.0"
}
},
{
@@ -222,8 +249,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-nio",
"state" : {
"revision" : "0f54d58bb5db9e064f332e8524150de379d1e51c",
"version" : "2.82.1"
"revision" : "f71c8d2a5e74a2c6d11a0fbe324774b5d6084237",
"version" : "2.99.0"
}
},
{
@@ -231,8 +258,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-nio-extras.git",
"state" : {
"revision" : "f1f6f772198bee35d99dd145f1513d8581a54f2c",
"version" : "1.26.0"
"revision" : "5a48717e29f62cb8326d6d42e46b562ca93847a6",
"version" : "1.34.0"
}
},
{
@@ -240,8 +267,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-nio-http2.git",
"state" : {
"revision" : "4281466512f63d1bd530e33f4aa6993ee7864be0",
"version" : "1.36.0"
"revision" : "81cc18264f92cd307ff98430f89372711d4f6fe9",
"version" : "1.43.0"
}
},
{
@@ -249,8 +276,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-nio-ssl.git",
"state" : {
"revision" : "6df102a39c8da5fdc2eae29a0f63546d660866fc",
"version" : "2.30.0"
"revision" : "3f337058ccd7243c4cac7911477d8ad4c598d4da",
"version" : "2.37.0"
}
},
{
@@ -258,8 +285,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-nio-transport-services.git",
"state" : {
"revision" : "cd1e89816d345d2523b11c55654570acd5cd4c56",
"version" : "1.24.0"
"revision" : "67787bb645a5e67d2edcdfbe48a216cc549222d5",
"version" : "1.28.0"
}
},
{
@@ -267,8 +294,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-numerics.git",
"state" : {
"revision" : "e0ec0f5f3af6f3e4d5e7a19d2af26b481acb6ba8",
"version" : "1.0.3"
"revision" : "0c0290ff6b24942dadb83a929ffaaa1481df04a2",
"version" : "1.1.1"
}
},
{
@@ -276,8 +303,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/swift-server/swift-openapi-async-http-client",
"state" : {
"revision" : "915aeff168625b0f88a5810ee7ab8e9c00af671b",
"version" : "1.1.0"
"revision" : "3681f659d9417652b8119f0adbdf57c04b6cb292",
"version" : "1.5.0"
}
},
{
@@ -285,8 +312,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-openapi-generator",
"state" : {
"revision" : "02cab48b66b4b412013827c2938adaf0eb67dc8d",
"version" : "1.7.2"
"revision" : "5dd0da1c7da7bac8f0c458a02a76f69031137a80",
"version" : "1.12.1"
}
},
{
@@ -294,8 +321,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-openapi-runtime",
"state" : {
"revision" : "8f33cc5dfe81169fb167da73584b9c72c3e8bc23",
"version" : "1.8.2"
"revision" : "f039fa6d6338aab5164f3d1be16281524c9a8f89",
"version" : "1.11.0"
}
},
{
@@ -303,8 +330,35 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-openapi-urlsession",
"state" : {
"revision" : "6fac6f7c428d5feea2639b5f5c8b06ddfb79434b",
"version" : "1.1.0"
"revision" : "576a65b4ffb8c12ddad4950dc21eea2ef071bec2",
"version" : "1.3.0"
}
},
{
"identity" : "swift-service-context",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-service-context.git",
"state" : {
"revision" : "d0997351b0c7779017f88e7a93bc30a1878d7f29",
"version" : "1.3.0"
}
},
{
"identity" : "swift-service-lifecycle",
"kind" : "remoteSourceControl",
"location" : "https://github.com/swift-server/swift-service-lifecycle",
"state" : {
"revision" : "9829955b385e5bb88128b73f1b8389e9b9c3191a",
"version" : "2.11.0"
}
},
{
"identity" : "swift-subprocess",
"kind" : "remoteSourceControl",
"location" : "https://github.com/swiftlang/swift-subprocess",
"state" : {
"revision" : "11633673a41f509f8945f23c96c7acd4adafd679",
"version" : "0.5.0"
}
},
{
@@ -312,8 +366,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/swiftlang/swift-syntax",
"state" : {
"revision" : "f99ae8aa18f0cf0d53481901f88a0991dc3bd4a2",
"version" : "601.0.1"
"revision" : "9de99a78f099e59caf2b2beec65a4c45d54b2081",
"version" : "603.0.1"
}
},
{
@@ -321,8 +375,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-system",
"state" : {
"revision" : "a34201439c74b53f0fd71ef11741af7e7caf01e1",
"version" : "1.4.2"
"revision" : "7c6ad0fc39d0763e0b699210e4124afd5041c5df",
"version" : "1.6.4"
}
},
{
@@ -339,8 +393,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/SwiftyMobileDevice",
"state" : {
"revision" : "5ee5f680d065519dd6ac56c96435a7db0d599ade",
"version" : "1.4.0"
"revision" : "1f6e4cc614a31953bda5d1092a747cfdea90916f",
"version" : "1.7.0"
}
},
{
@@ -348,8 +402,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/saagarjha/unxip",
"state" : {
"revision" : "d6f0009109f7502f8f5b3f23dcd5b43cf5b29b32",
"version" : "3.1.0"
"revision" : "6c3990517fcc4c1db6952fccf4c562fb14097601",
"version" : "3.3.0"
}
},
{
@@ -357,8 +411,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/mxcl/Version",
"state" : {
"revision" : "303a0f916772545e1e8667d3104f83be708a723c",
"version" : "2.1.0"
"revision" : "3043fcd2a50375db76d89ff206a612471833d1c2",
"version" : "2.2.1"
}
},
{
@@ -366,8 +420,17 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/vapor/websocket-kit.git",
"state" : {
"revision" : "014ccd52891b8c098d7e1033d5e72ed76fef7a86",
"version" : "2.16.0"
"revision" : "90bbbdab3ede12c803cfbe91646f291c092517a3",
"version" : "2.16.2"
}
},
{
"identity" : "xadi",
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/xadi",
"state" : {
"revision" : "2aad968e4806b8571f6f2bed22ecec00b0322f95",
"version" : "0.4.1"
}
},
{
@@ -375,8 +438,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/yonaskolb/XcodeGen",
"state" : {
"revision" : "7193eb447a6f60061f069e07bc1efd32d73c0e19",
"version" : "2.43.0"
"revision" : "8d3d3476a69ae3e5d68e1adccc701c410c05eb36",
"version" : "2.45.4"
}
},
{
@@ -384,8 +447,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/tuist/XcodeProj.git",
"state" : {
"revision" : "dc3b87a4e69f9cd06c6cb16199f5d0472e57ef6b",
"version" : "8.24.3"
"revision" : "01bb77000bc8c23a09ea2058f4954612f03cb705",
"version" : "9.10.1"
}
},
{
@@ -393,8 +456,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/xctest-dynamic-overlay",
"state" : {
"revision" : "39de59b2d47f7ef3ca88a039dff3084688fe27f4",
"version" : "1.5.2"
"revision" : "dfd70507def84cb5fb821278448a262c6ff2bbad",
"version" : "1.9.0"
}
},
{
@@ -402,8 +465,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/xtool-core",
"state" : {
"revision" : "63c644eef014f7faff53daaebe8bad37c31fbbe5",
"version" : "1.3.0"
"revision" : "f867f9c2aea16ac78ca14d0d2f948b47db0732b4",
"version" : "1.5.0"
}
},
{
@@ -411,8 +474,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/jpsim/Yams",
"state" : {
"revision" : "b4b8042411dc7bbb696300a34a4bf3ba1b7ad19b",
"version" : "5.3.1"
"revision" : "3d6871d5b4a5cd519adf233fbb576e0a2af71c17",
"version" : "5.4.0"
}
},
{
@@ -420,8 +483,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/zsign",
"state" : {
"revision" : "e9853fd3be36ea1a61fa9d4b7f71f4b4d8244369",
"version" : "1.4.0"
"revision" : "19aab76b3f1388966a3ed4fc11b357f95aafc70b",
"version" : "1.8.0"
}
}
],
+68 -32
View File
@@ -1,16 +1,37 @@
// swift-tools-version:6.0
// swift-tools-version:6.2
import PackageDescription
let xtoolVersion: String? = {
if let explicitVersion = Context.environment["XTOOL_VERSION"] {
return explicitVersion
} else if let info = Context.gitInformation {
let gitCommit = info.currentCommit
let gitTag = info.currentTag
let gitRef = gitTag ?? "commit \(gitCommit)"
return "\(gitRef)\(info.hasUncommittedChanges ? " (dirty)" : "")"
} else {
return nil
}
}()
let cSettings: [CSetting] = [
.define("_GNU_SOURCE", .when(platforms: [.linux])),
]
let swiftSettings: [SwiftSetting] = {
var settings: [SwiftSetting] = []
if Context.environment["XTL_CI"] == "1" {
settings.append(.treatAllWarnings(as: .error))
}
return settings
}()
let package = Package(
name: "xtool",
platforms: [
.iOS(.v15),
.macOS(.v12),
.iOS(.v16),
.macOS(.v13),
],
products: [
.library(
@@ -27,20 +48,23 @@ let package = Package(
),
],
dependencies: [
.package(url: "https://github.com/xtool-org/xtool-core", .upToNextMinor(from: "1.3.0")),
.package(url: "https://github.com/xtool-org/SwiftyMobileDevice", .upToNextMinor(from: "1.4.0")),
.package(url: "https://github.com/xtool-org/zsign", .upToNextMinor(from: "1.4.0")),
.package(url: "https://github.com/xtool-org/xtool-core", .upToNextMinor(from: "1.5.0")),
.package(url: "https://github.com/xtool-org/SwiftyMobileDevice", .upToNextMinor(from: "1.7.0")),
.package(url: "https://github.com/xtool-org/zsign", .upToNextMinor(from: "1.8.0")),
.package(url: "https://github.com/xtool-org/xadi", .upToNextMinor(from: "0.4.1")),
.package(url: "https://github.com/apple/swift-system", from: "1.4.0"),
.package(url: "https://github.com/apple/swift-http-types", from: "1.3.1"),
.package(url: "https://github.com/apple/swift-certificates", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-crypto", from: "3.9.1"),
.package(url: "https://github.com/apple/swift-crypto", from: "4.5.0"),
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0"),
.package(url: "https://github.com/apple/swift-openapi-generator", from: "1.6.0"),
.package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-openapi-urlsession", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-nio", from: "2.77.0"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.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"),
@@ -52,33 +76,51 @@ let package = Package(
.package(url: "https://github.com/attaswift/BigInt", from: "5.5.0"),
.package(url: "https://github.com/mxcl/Version", from: "2.1.0"),
.package(url: "https://github.com/jpsim/Yams", from: "5.1.3"),
.package(url: "https://github.com/saagarjha/unxip", from: "3.1.0"),
.package(url: "https://github.com/saagarjha/unxip", from: "3.2.0"),
// TODO: just depend on tuist/XcodeProj instead
.package(url: "https://github.com/yonaskolb/XcodeGen", from: "2.43.0"),
.package(url: "https://github.com/yonaskolb/XcodeGen", from: "2.45.4"),
],
targets: [
.systemLibrary(name: "XADI"),
.target(
name: "CXKit",
dependencies: [
.product(name: "OpenSSL", package: "xtool-core")
],
cSettings: cSettings
cSettings: cSettings + (
xtoolVersion
.map { [.define("XTOOL_VERSION", to: "\"\($0)\"")] }
?? []
)
),
.target(
name: "DeveloperAPI",
dependencies: [
.product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
],
exclude: ["openapi-generator-config.yaml", "openapi-overlay.yaml"]
exclude: ["openapi-generator-config.yaml", "patch.js"],
swiftSettings: swiftSettings,
),
// common utilities shared across xtool targets
.target(
name: "XUtils",
dependencies: [
.product(name: "SystemPackage", package: "swift-system"),
.product(
name: "Subprocess",
package: "swift-subprocess",
condition: .when(platforms: [.linux, .macOS])
),
],
swiftSettings: swiftSettings,
),
.target(
name: "XKit",
dependencies: [
"DeveloperAPI",
"CXKit",
.byName(name: "XADI", condition: .when(platforms: [.linux])),
"XUtils",
.product(name: "XADI", package: "xadi", condition: .when(platforms: [.linux, .macOS])),
.product(name: "ConcurrencyExtras", package: "swift-concurrency-extras"),
.product(name: "Dependencies", package: "swift-dependencies"),
.product(name: "SwiftyMobileDevice", package: "SwiftyMobileDevice"),
@@ -109,27 +151,16 @@ let package = Package(
condition: .when(platforms: [.linux])
),
],
cSettings: cSettings
cSettings: cSettings,
swiftSettings: swiftSettings,
),
.testTarget(
name: "XToolTests",
dependencies: [
"XToolSupport",
]
),
.testTarget(
name: "XKitTests",
dependencies: [
"XKit",
.product(name: "SuperutilsTestSupport", package: "xtool-core")
"XToolSupport",
],
exclude: [
"config/config-template.json",
],
resources: [
.copy("config/config.json"),
.copy("config/test.app"),
]
swiftSettings: swiftSettings,
),
.target(
name: "XToolSupport",
@@ -143,14 +174,18 @@ let package = Package(
.product(name: "Version", package: "Version"),
.product(name: "libunxip", package: "unxip"),
],
cSettings: cSettings
cSettings: cSettings,
swiftSettings: swiftSettings,
),
.target(
name: "PackLib",
dependencies: [
"XUtils",
.product(name: "Superutils", package: "xtool-core"),
.product(name: "Yams", package: "Yams"),
.product(name: "XcodeGenKit", package: "XcodeGen", condition: .when(platforms: [.macOS])),
]
],
swiftSettings: swiftSettings,
),
.executableTarget(
name: "xtool",
@@ -159,7 +194,8 @@ let package = Package(
"XKit",
"XToolSupport",
],
cSettings: cSettings
cSettings: cSettings,
swiftSettings: swiftSettings,
),
]
)
+5 -5
View File
@@ -1,6 +1,6 @@
# xtool
Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux and macOS.
Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, and macOS.
## Overview
@@ -15,15 +15,15 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona
## Getting Started
1. Follow the guide to install `xtool`
- [Installation (Linux)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-linux)
- [Installation (macOS)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-macos)
2. Create and run your first xtool-powered app by following the [tutorial](https://swiftpackageindex.com/xtool-org/xtool/tutorials/xtool/first-app)!
- [Installation (Linux/Windows)](https://xtool.sh/documentation/xtooldocs/installation-linux)
- [Installation (macOS)](https://xtool.sh/documentation/xtooldocs/installation-macos)
2. Create and run your first xtool-powered app by following the [tutorial](https://xtool.sh/tutorials/xtooldocs/first-app)!
## Examples
### Screenshot
![A screenshot of xtool being invoked from VSCode](Sources/xtool/Documentation.docc/Resources/Cover.png)
![A screenshot of xtool being invoked from VSCode](Documentation/xtool.docc/Resources/Cover.png)
### Command line interface
+5
View File
@@ -0,0 +1,5 @@
# Security Policy
## Reporting a Vulnerability
To report a vulnerability, please use GitHub's ["Report a Vulnerability"](https://github.com/xtool-org/xtool/security/advisories/new) tab. We'll be in touch regarding next steps.
+1
View File
@@ -0,0 +1 @@
const char * _Nonnull xtl_version(void);
+8
View File
@@ -18,6 +18,8 @@ struct mobileprovision {
static mobileprovision_t mobileprovision_create(PKCS7 *raw) {
mobileprovision_t profile = malloc(sizeof(struct mobileprovision));
if (!profile) return NULL;
profile->raw = raw;
return profile;
}
@@ -41,6 +43,12 @@ void *mobileprovision_copy_data(mobileprovision_t profile, size_t *len) {
if (data_len < 0) return NULL;
*len = data_len;
void *ret = malloc(data_len);
if (!ret) {
OPENSSL_free(data);
return NULL;
}
memcpy(ret, data, data_len);
OPENSSL_free(data);
return ret;
+9
View File
@@ -0,0 +1,9 @@
#include "version.h"
const char *xtl_version(void) {
#ifdef XTOOL_VERSION
return XTOOL_VERSION;
#else
return "unversioned";
#endif
}
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
-22
View File
@@ -1,22 +0,0 @@
overlay: 1.0.0
info:
title: Overlay for App Store Connect API
version: 1.0.0
actions:
- target: '$.components.schemas.BundleIdCapabilityCreateRequest.properties.data.properties.relationships'
update:
properties:
capability:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum: [capabilities]
id:
"$ref": "#/components/schemas/CapabilityType"
required: [id, type]
required: [data]
required: [capability]
+109
View File
@@ -0,0 +1,109 @@
#!/usr/bin/env node
import fs from 'fs';
function update(schema, value) {
for (const key in value) {
const val = value[key];
if (val === null) {
delete schema[key];
} else if (Array.isArray(val)) {
schema[key] = (schema[key] ?? []).concat(val);
} else if (typeof val === 'object') {
if (schema[key] === undefined) {
schema[key] = {};
}
update(schema[key], val);
} else {
schema[key] = val;
}
}
}
// in-place update
function replace(schema, value) {
Object.keys(schema).forEach(k => delete schema[k]);
Object.assign(schema, value);
}
function clone(schema) {
return JSON.parse(JSON.stringify(schema));
}
function makeOpen(enumSchema) {
replace(enumSchema, {
anyOf: [
clone(enumSchema),
{ type: 'string' },
]
});
}
function openAll(schema, path = []) {
if (Array.isArray(schema)) {
schema.forEach((s, i) => openAll(s, [...path, i]))
} else if (typeof schema === 'object' && schema !== null) {
const keys = new Set(Object.keys(schema))
if (keys.size === 2
&& keys.has('type')
&& keys.has('enum')
&& schema.type === 'string'
&& Array.isArray(schema.enum)) {
// several polymorphic schemas have a field literally named 'type', that always has a single case.
// skip that instance, but make all other enums open.
if (!(path[path.length - 1] === 'type' && schema.enum.length === 1)) {
makeOpen(schema);
}
} else {
for (const key in schema) {
openAll(schema[key], [...path, key]);
}
}
}
}
function patch(schema) {
const schemas = schema.components.schemas;
// this field is required iff using the private Xcode API
update(schemas.BundleIdCapabilityCreateRequest.properties.data.properties.relationships, {
properties: {
capability: {
type: 'object',
properties: {
data: {
type: 'object',
properties: {
type: {
type: 'string',
enum: ['capabilities'],
},
id: { $ref: '#/components/schemas/CapabilityType' },
},
required: ['id', 'type'],
},
},
required: ['data'],
}
},
})
// we don't use this but it triggers a deprecation warning. see:
// https://github.com/apple/swift-openapi-generator/issues/715
schemas.App.properties.relationships.properties.inAppPurchases.deprecated = false;
// openapi-generator expects response enums to be exhaustive. Apple's ASC OpenAPI spec
// misses some cases that they do, actually, return. So we make all bona fide enums in
// schema.components.schemas open. We don't do this on the schema.paths side because
// most (all?) of the enums in there are on the request side rather than the response.
// https://swiftpackageindex.com/apple/swift-openapi-generator/1.7.2/documentation/swift-openapi-generator/useful-openapi-patterns#Open-enums-and-oneOfs
openAll(schemas);
return schema;
}
const text = fs.readFileSync(process.stdin.fd, 'utf8');
const json = JSON.parse(text);
const patched = patch(json);
const patchedText = JSON.stringify(patched);
console.log(patchedText);
+146 -42
View File
@@ -1,65 +1,126 @@
import Foundation
import Subprocess
import XUtils
import Superutils
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")
public let packagePath: String
public var packagePath: String
public let configuration: BuildConfiguration
public let triple: String
public let sdkOptions: [String]
public let options: [String]
public let buildSystem: BuildSystem
public let customOptions: [String]
public var sdkOptions: [String]
public var sdkEnvironment: [Environment.Key: String?]
private var configOptions: [String] {
return [
"--configuration", configuration.rawValue,
"--build-system", buildSystem.pmName,
"--package-path", packagePath,
]
}
private var resolvedBaseOptions: [String] {
configOptions + sdkOptions + customOptions
}
public init(
configuration: BuildConfiguration,
triple: String,
buildSystem: BuildSystem? = nil,
packagePath: String = ".",
options: [String] = []
) async throws {
self.packagePath = packagePath
self.configuration = configuration
self.options = options
self.customOptions = options
self.triple = triple
self.buildSystem = if let buildSystem { buildSystem } else { try await .default() }
// TODO: allow customizing?
self.triple = "arm64-apple-ios"
self.sdkEnvironment = [
// xcrun passes an SDKROOT that messes with our sdk configuration
"SDKROOT": nil,
]
// on macOS we don't explicitly install a Swift SDK but
// SwiftPM vends "implicit" Darwin SDKs as of Swift 6.1,
// i.e. we can pass `--swift-sdk arm64-apple-ios` and it
// just works. See:
// https://github.com/swiftlang/swift-package-manager/pull/6828
self.sdkOptions = ["--swift-sdk", triple]
switch self.buildSystem {
case .swiftPM:
// on macOS we don't explicitly install a Swift SDK but
// SwiftPM vends "implicit" Darwin SDKs as of Swift 6.1,
// i.e. we can pass `--swift-sdk arm64-apple-ios` and it
// just works. See:
// https://github.com/swiftlang/swift-package-manager/pull/6828
self.sdkOptions = ["--swift-sdk", triple]
case .swiftBuild:
self.sdkOptions = ["--triple", triple]
#if !os(macOS)
let darwinSDK = try DarwinSDK.current()
.orThrow(StringError("No Darwin SDK configured. Please run `xtool setup`."))
self.sdkOptions += [
"--toolset", "\(darwinSDK.bundle.path)/toolset-swb.json",
]
self.sdkEnvironment.merge([
"XCODE_EXTRA_PLATFORM_FOLDERS": "\(darwinSDK.bundle.path)/Developer/Platforms",
// SWB looks for dsymutil in the PATH. Other stuff (lld, libtool) is handled by toolset-swb.json.
"PATH": "\(darwinSDK.bundle.path)/toolset/bin:\(ProcessInfo.processInfo.environment["PATH"] ?? "")",
]) { $1 }
#endif
}
}
#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"]))
private static let _swiftURL = Task {
try await FilePath(xcrun(["-f", "swift"]))
}
public static func swiftURL() async throws -> FilePath {
try await _swiftURL.value
}
private static let _swiftcURL = Task {
try await FilePath(xcrun(["-f", "swiftc"]))
}
public static func swiftcURL() async throws -> FilePath {
try await _swiftcURL.value
}
#else
public static func swiftURL() async throws -> FilePath {
try await FilePath(ToolRegistry.locate("swift")).orThrow(StringError("Got bad path for swift executable"))
}
public static func swiftcURL() async throws -> FilePath {
try await FilePath(ToolRegistry.locate("swiftc")).orThrow(StringError("Got bad path for swiftc executable"))
}
#endif
public func withPackagePath(_ path: String) -> Self {
var copy = self
copy.packagePath = path
return copy
}
public func swiftPMInvocation(
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,28 +128,71 @@ public struct BuildSettings: Sendable {
// to add SDKROOT=.../MacOSX.sdk to our invocations. We avoid this by
// 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
// through a parent process (e.g. `swift run xtool`).
executable = .path(try await Self.swiftURL())
#else
process.executableURL = try await ToolRegistry.locate("swift")
executable = .name("swift")
#endif
baseArguments = [tool]
}
let extraArguments: [String] = [
"--package-path", packagePathOverride ?? packagePath,
"--configuration", configuration.rawValue,
]
return Configuration(
executable,
arguments: .init(baseArguments + resolvedBaseOptions + arguments),
environment: .inherit.updating(sdkEnvironment),
platformOptions: .withGracefulShutDown,
)
}
var env = ProcessInfo.processInfo.environment
env.removeValue(forKey: "SDKROOT")
process.environment = env
process.arguments = baseArguments + extraArguments + sdkOptions + options + arguments
return process
// loosely based on
// https://github.com/swiftlang/sourcekit-lsp/blob/c55899a/Sources/BuildServerIntegration/ExternalBuildServerAdapter.swift#L92
private var baseBuildServerArguments: [String] {
return [
"experimental-build-server",
"--disable-automatic-resolution",
"--scratch-path", ".build/index-build",
// this requires Swift 6.4 but we need 6.4 on Linux anyway, for the platform toolset fixes
"--experimental-skip-acquiring-lock",
]
}
public var buildServerArguments: [String] {
["package"] + baseBuildServerArguments + resolvedBaseOptions
}
public func buildServerInvocation() async throws -> Subprocess.Configuration {
try await swiftPMInvocation(forTool: "package", arguments: baseBuildServerArguments)
}
}
public enum BuildConfiguration: String, CaseIterable, Sendable {
case debug
case release
var swiftBuildValue: String {
switch self {
case .debug: "Debug"
case .release: "Release"
}
}
}
public enum BuildSystem: Sendable {
case swiftPM
case swiftBuild
public static func `default`() async throws -> Self {
if try await SwiftVersion.current.supportsSwiftBuild {
return .swiftBuild
} else {
return .swiftPM
}
}
var pmName: String {
switch self {
case .swiftPM: "native"
case .swiftBuild: "swiftbuild"
}
}
}
+132
View File
@@ -0,0 +1,132 @@
import Foundation
import XUtils
import Subprocess
import Superutils
public struct DarwinSDK {
package struct TemporaryBundle: ~Copyable {
package let url: URL
fileprivate init(url: URL) {
self.url = url
}
package consuming func install() async throws {
guard DarwinSDK(bundle: url) != nil else {
throw StringError("Invalid Darwin SDK at '\(url.path)'")
}
try await DarwinSDK.addHostClangResourceDir(to: url)
let destination = url.deletingLastPathComponent()
.appendingPathComponent("darwin.artifactbundle", isDirectory: true)
try FileManager.default.moveItem(at: url, to: destination)
}
deinit {
try? FileManager.default.removeItem(at: url)
}
}
public enum Flavor {
// can't be updated in place
case slim
// can be updated in place, includes a whole copy of Xcode.app
case normal
// from before the slim/normal split existed (version "develop")
case legacy
}
public let bundle: URL
public let version: String
public let flavor: Flavor
static func swiftPMDirectory(
environment: [String: String] = ProcessInfo.processInfo.environment,
homeDirectory: URL = FileManager.default.homeDirectoryForCurrentUser
) throws -> URL {
if let configurationDirectory = environment["XDG_CONFIG_HOME"] {
guard (configurationDirectory as NSString).isAbsolutePath else {
throw StringError("XDG_CONFIG_HOME must be an absolute path: '\(configurationDirectory)'")
}
return URL(fileURLWithPath: configurationDirectory, isDirectory: true)
.appendingPathComponent("swiftpm", isDirectory: true)
} else {
return homeDirectory.appendingPathComponent(".swiftpm", isDirectory: true)
}
}
private static func swiftSDKsDirectory(
environment: [String: String] = ProcessInfo.processInfo.environment,
homeDirectory: URL = FileManager.default.homeDirectoryForCurrentUser
) throws -> URL {
try swiftPMDirectory(environment: environment, homeDirectory: homeDirectory)
.appendingPathComponent("swift-sdks", isDirectory: true)
}
public init?(bundle: URL) {
self.bundle = bundle
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 ["darwin.xtoolsdk", "darwin.artifactbundle", "darwin.artifactbundle.tmp"].contains(bundle.lastPathComponent) {
self.version = "develop"
} else {
return nil
}
if version == "develop" {
self.flavor = .legacy
} else if bundle.appendingPathComponent("Xcode.app").dirExists {
self.flavor = .normal
} else {
self.flavor = .slim
}
}
package static func prepareTemporaryBundle(
environment: [String: String] = ProcessInfo.processInfo.environment,
homeDirectory: URL = FileManager.default.homeDirectoryForCurrentUser
) throws -> TemporaryBundle {
let sdksDirectory = try swiftSDKsDirectory(environment: environment, homeDirectory: homeDirectory)
try FileManager.default.createDirectory(at: sdksDirectory, withIntermediateDirectories: true)
let bundle = sdksDirectory.appendingPathComponent("darwin.artifactbundle.tmp", isDirectory: true)
if FileManager.default.fileExists(atPath: bundle.path) {
try FileManager.default.removeItem(at: bundle)
}
return TemporaryBundle(url: bundle)
}
private static func addHostClangResourceDir(to sdk: URL) async throws {
struct SwiftTargetInfo: Decodable {
struct Paths: Decodable {
let runtimeResourcePath: String
}
let paths: Paths
}
let process = try await Subprocess.run(
.path(try await BuildSettings.swiftcURL()),
arguments: ["-print-target-info"],
output: .data(limit: .max)
).checkSuccess()
let targetInfo = try JSONDecoder().decode(
SwiftTargetInfo.self,
from: process.standardOutput
)
let hostClangResources = URL(filePath: targetInfo.paths.runtimeResourcePath).appending(path: "clang")
let hostInclude = hostClangResources.appending(path: "include")
let sdkInclude = sdk.appending(path: "Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/clang/include")
try await FileManager.default.copyItem(at: hostInclude, to: sdkInclude, preserveOwner: false)
}
public static func current() throws -> DarwinSDK? {
let bundle = try swiftSDKsDirectory().appendingPathComponent("darwin.artifactbundle", isDirectory: true)
guard bundle.dirExists else { return nil }
return DarwinSDK(bundle: bundle)
}
public func remove() throws {
try FileManager.default.removeItem(at: bundle)
}
}
-56
View File
@@ -1,56 +0,0 @@
import Foundation
package struct TemporaryDirectory: ~Copyable {
private var shouldDelete = true
package let url: URL
package init(name: String) throws {
self.url = FileManager.default.temporaryDirectory.appendingPathComponent(name, isDirectory: true)
_delete()
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
}
private func _delete() {
try? FileManager.default.removeItem(at: url)
}
package consuming func persist() -> URL {
shouldDelete = false
return url
}
package consuming func persist(at location: URL) throws {
try FileManager.default.moveItem(at: url, to: location)
// we do this after moving, so that if the move fails we clean up
shouldDelete = false
}
deinit {
if shouldDelete { _delete() }
}
}
extension Data {
// AsyncBytes is Darwin-only :/
package init(reading fileHandle: FileHandle) async throws {
#if canImport(Darwin)
self = try await fileHandle.bytes.reduce(into: Data()) { $0.append($1) }
#else
self = try fileHandle.readToEnd() ?? Data()
#endif
}
package init(reading file: URL) async throws {
#if canImport(Darwin)
self = try await file.resourceBytes.reduce(into: Data()) { $0.append($1) }
#else
try self.init(contentsOf: file)
#endif
}
}
package func stderrPrint(_ message: String, terminator: String = "\n") {
try? FileHandle.standardError.write(contentsOf: Data("\(message)\(terminator)".utf8))
}
+24
View File
@@ -1,5 +1,6 @@
import Foundation
import Yams
import XUtils
public struct PackSchemaBase: Codable, Sendable {
public enum Version: Int, Codable, Sendable {
@@ -14,11 +15,29 @@ public struct PackSchemaBase: Codable, Sendable {
public var product: String?
public var infoPath: String?
public var entitlementsPath: String?
public var iconPath: String?
public var resources: [String]?
public var extensions: [Extension]?
/// Skip auto-creating the LSP support file if it's missing.
public var skipLSP: Bool?
public struct Extension: Codable, Sendable {
public var product: String
public var bundleID: String?
public var infoPath: String
public var resources: [String]?
public var entitlementsPath: String?
}
}
@dynamicMemberLookup
public struct PackSchema: Sendable {
public typealias Extension = PackSchemaBase.Extension
public enum IDSpecifier: Sendable {
case orgID(String)
case bundleID(String)
@@ -58,6 +77,7 @@ public struct PackSchema: Sendable {
}
}
// swiftlint:disable:next force_try
public static let `default` = try! PackSchema(validating: .init(
version: .v1,
orgID: "com.example"
@@ -68,4 +88,8 @@ public struct PackSchema: Sendable {
let base = try YAMLDecoder().decode(PackSchemaBase.self, from: data)
try self.init(validating: base)
}
public subscript<Subject>(dynamicMember keyPath: KeyPath<PackSchemaBase, Subject>) -> Subject {
self.base[keyPath: keyPath]
}
}
+175 -93
View File
@@ -1,4 +1,6 @@
import Foundation
import XUtils
import Subprocess
public struct Packer: Sendable {
public let buildSettings: BuildSettings
@@ -20,60 +22,116 @@ public struct Packer: Sendable {
// swift-tools-version: 6.0
import PackageDescription
let package = Package(
name: "\(plan.product)-Builder",
name: "\(plan.app.product)-Builder",
platforms: [
.iOS("\(plan.deploymentTarget)"),
.iOS("\(plan.app.deploymentTarget)"),
],
dependencies: [
.package(name: "RootPackage", path: "../.."),
],
targets: [
.executableTarget(
name: "\(plan.product)-App",
dependencies: [
.product(name: "\(plan.product)", package: "RootPackage"),
]
),
\(
plan.allProducts.map {
"""
.executableTarget(
name: "\($0.targetName)",
dependencies: [
.product(name: "\($0.product)", package: "RootPackage"),
],
linkerSettings: \($0.linkerSettings)
)
"""
}
.joined(separator: ",\n")
)
]
)\n
"""
try Data(contents.utf8).write(to: packageSwift)
let sources = packageDir.appendingPathComponent("Sources")
try? FileManager.default.createDirectory(at: sources, withIntermediateDirectories: true)
try Data().write(to: sources.appendingPathComponent("stub.c"))
let builder = try await buildSettings.swiftPMInvocation(
forTool: "build",
arguments: [
"--package-path", packageDir.path,
"--scratch-path", ".build",
"--product", "\(plan.product)-App",
// resolving can cause SwiftPM to overwrite the root package deps
// with just the deps needed for the builder package (which is to
// say, any "dev dependencies" of the root package may be removed.)
// fortunately we've already resolved the root package by this point
// in order to dump the plan, so we can skip resolution here to skirt
// the issue.
"--disable-automatic-resolution",
"-Xlinker", "-rpath", "-Xlinker", "@executable_path/Frameworks",
]
for product in plan.allProducts {
let sources: URL = packageDir.appendingPathComponent("Sources/\(product.targetName)", isDirectory: true)
try FileManager.default.createDirectory(at: sources, withIntermediateDirectories: true)
try Data().write(to: sources.appendingPathComponent("stub.c", isDirectory: false))
}
let buildConfig = try await buildSettings
.withPackagePath(packageDir.path)
.swiftPMInvocation(
forTool: "build",
arguments: [
"--scratch-path", ".build",
// resolving can cause SwiftPM to overwrite the root package deps
// with just the deps needed for the builder package (which is to
// say, any "dev dependencies" of the root package may be removed.)
// fortunately we've already resolved the root package by this point
// in order to dump the plan, so we can skip resolution here to skirt
// the issue.
"--disable-automatic-resolution",
],
)
try await Subprocess.run(
buildConfig,
output: .currentStandardOutput,
error: .currentStandardError,
)
builder.standardOutput = FileHandle.standardError
try await builder.runUntilExit()
.checkSuccess()
}
public func pack() async throws -> URL {
try await build()
let output = try TemporaryDirectory(name: "\(plan.product).app")
let binDir = URL(
fileURLWithPath: ".build/\(buildSettings.triple)/\(buildSettings.configuration.rawValue)",
isDirectory: true
)
let output = try TemporaryDirectory(name: "\(plan.app.product).app")
let outputURL = output.url
let binPath: String
switch buildSettings.buildSystem {
case .swiftPM:
binPath = "\(buildSettings.triple)/\(buildSettings.configuration.rawValue)"
case .swiftBuild:
let platformName = buildSettings.triple.contains("simulator") ? "iphonesimulator" : "iphoneos"
binPath = "out/Products/\(buildSettings.configuration.swiftBuildValue)-\(platformName)"
}
let binDir = URL(
fileURLWithPath: ".build/\(binPath)",
isDirectory: true
)
try await withThrowingTaskGroup(of: Void.self) { group in
for product in plan.allProducts {
try pack(
product: product,
binDir: binDir,
outputURL: product.directory(inApp: outputURL),
&group
)
}
while !group.isEmpty {
do {
try await group.next()
} catch is CancellationError {
// continue
} catch {
group.cancelAll()
throw error
}
}
}
let dest = URL(fileURLWithPath: "xtool").appendingPathComponent(outputURL.lastPathComponent)
try? FileManager.default.removeItem(at: dest)
try output.persist(at: dest)
return dest
}
@Sendable private func pack(
product: Plan.Product,
binDir: URL,
outputURL: URL,
_ group: inout ThrowingTaskGroup<Void, Error>
) throws {
@Sendable func packFileToRoot(srcName: String) async throws {
let srcURL = URL(fileURLWithPath: srcName)
let destURL = outputURL.appendingPathComponent(srcURL.lastPathComponent)
@@ -91,69 +149,93 @@ public struct Packer: Sendable {
try Task.checkCancellation()
}
try await withThrowingTaskGroup(of: Void.self) { group in
for command in plan.resources {
group.addTask {
switch command {
case .bundle(let package, let target):
try await packFile(srcName: "\(package)_\(target).bundle")
case .binaryTarget(let name):
let src = URL(fileURLWithPath: "\(name).framework/\(name)", relativeTo: binDir)
let magic = Data("!<arch>\n".utf8)
let thinMagic = Data("!<thin>\n".utf8)
let bytes = try FileHandle(forReadingFrom: src).read(upToCount: magic.count)
// if the magic matches one of these it's a static archive; don't embed it.
// https://github.com/apple/llvm-project/blob/e716ff14c46490d2da6b240806c04e2beef01f40/llvm/include/llvm/Object/Archive.h#L33
if bytes != magic && bytes != thinMagic {
try await packFile(srcName: "\(name).framework", dstName: "Frameworks/\(name).framework", sign: true)
}
case .library(let name):
try await packFile(srcName: "lib\(name).dylib", dstName: "Frameworks/lib\(name).dylib", sign: true)
case .root(let source):
try await packFileToRoot(srcName: source)
// Ensure output directory is available
try? FileManager.default.createDirectory(at: outputURL, withIntermediateDirectories: true)
for command in product.resources {
group.addTask {
switch command {
case .bundle(let package, let target):
try await packFile(srcName: "\(package)_\(target).bundle")
case .binaryTarget(let name):
let src = URL(fileURLWithPath: "\(name).framework/\(name)", relativeTo: binDir)
let magic = Data("!<arch>\n".utf8)
let thinMagic = Data("!<thin>\n".utf8)
guard let bytes = try? FileHandle(forReadingFrom: src).read(upToCount: magic.count) else {
// if we can't find the binary, it might be a static framework that SwiftPM
// did not copy into the .build directory. we don't need to pack it anyway.
break
}
}
}
if let iconPath = plan.iconPath {
group.addTask {
try await packFileToRoot(srcName: iconPath)
}
}
group.addTask {
try await packFile(srcName: "\(plan.product)-App", dstName: plan.product)
}
group.addTask {
var info = plan.infoPlist
if let iconPath = plan.iconPath {
let iconName = URL(fileURLWithPath: iconPath).deletingPathExtension().lastPathComponent
info["CFBundleIconFile"] = iconName
}
let infoPath = outputURL.appendingPathComponent("Info.plist")
let encodedPlist = try PropertyListSerialization.data(
fromPropertyList: info,
format: .xml,
options: 0
)
try encodedPlist.write(to: infoPath)
}
while !group.isEmpty {
do {
try await group.next()
} catch is CancellationError {
// continue
} catch {
group.cancelAll()
throw error
// if the magic matches one of these it's a static archive; don't embed it.
// https://github.com/apple/llvm-project/blob/e716ff14c46490d2da6b240806c04e2beef01f40/llvm/include/llvm/Object/Archive.h#L33
// swiftlint:disable:previous line_length
if bytes != magic && bytes != thinMagic {
try await packFile(srcName: "\(name).framework", dstName: "Frameworks/\(name).framework", sign: true)
}
case .library(let name):
try await packFile(srcName: "lib\(name).dylib", dstName: "Frameworks/lib\(name).dylib", sign: true)
case .root(let source):
try await packFileToRoot(srcName: source)
}
}
}
if let iconPath = product.iconPath {
group.addTask {
try await packFileToRoot(srcName: iconPath)
}
}
group.addTask {
try await packFile(srcName: product.targetName, dstName: product.product)
}
group.addTask {
var info = product.infoPlist
let dest = URL(fileURLWithPath: "xtool")
.appendingPathComponent(output.url.lastPathComponent)
try? FileManager.default.removeItem(at: dest)
try output.persist(at: dest)
return dest
if product.type == .application {
info["UIRequiredDeviceCapabilities"] = ["arm64"]
info["LSRequiresIPhoneOS"] = true
info["CFBundleSupportedPlatforms"] = ["iPhoneOS"]
}
if let iconPath = product.iconPath {
let iconName = URL(fileURLWithPath: iconPath).deletingPathExtension().lastPathComponent
info["CFBundleIconFile"] = iconName
}
let infoPath = outputURL.appendingPathComponent("Info.plist")
let encodedPlist = try PropertyListSerialization.data(
fromPropertyList: info,
format: .xml,
options: 0
)
try encodedPlist.write(to: infoPath)
}
}
}
extension Plan.Product {
fileprivate var linkerSettings: String {
switch self.type {
case .application: """
[
.unsafeFlags([
"-Xlinker", "-rpath", "-Xlinker", "@executable_path/Frameworks",
]),
]
"""
case .appExtension: """
[
// Link to Foundation framework which implements the _NSExtensionMain entrypoint
.linkedFramework("Foundation"),
.unsafeFlags([
// Set the entry point to Foundation`_NSExtensionMain
"-Xlinker", "-e", "-Xlinker", "_NSExtensionMain",
// Include frameworks that the host app may use
"-Xlinker", "-rpath", "-Xlinker", "@executable_path/../../Frameworks",
// ...as well as our own
"-Xlinker", "-rpath", "-Xlinker", "@executable_path/Frameworks",
]),
]
"""
}
}
}
+211 -64
View File
@@ -1,4 +1,6 @@
import Foundation
import XUtils
import Subprocess
public struct Planner: Sendable {
public var buildSettings: BuildSettings
@@ -18,14 +20,12 @@ public struct Planner: Sendable {
return decoder
}()
public func createPlan() async throws -> Plan {
// TODO: cache plan using (Package.swift+Package.resolved) as the key?
// anything older than this requires bundling the stdlib which
// is doable but probably not worth the effort
private static let minSupportedIOSVersion = "13.0"
let dependencyData = try await _dumpAction(
arguments: ["show-dependencies", "--format", "json"],
path: buildSettings.packagePath
)
let dependencyRoot = try Self.decoder.decode(PackageDependency.self, from: dependencyData)
private func buildGraph() async throws -> PackageGraph {
let dependencyRoot = try await dumpDependencies()
let packages = try await withThrowingTaskGroup(
of: (PackageDependency, PackageDump).self,
@@ -64,18 +64,74 @@ public struct Planner: Sendable {
}
let rootPackage = packages[dependencyRoot.identity]!
let deploymentTarget = rootPackage.platforms?.first { $0.name == "ios" }?.version ?? "13.0"
let libraries = rootPackage.products?.filter { $0.type == .autoLibrary } ?? []
return PackageGraph(
root: rootPackage,
packages: packages,
packagesByProductName: packagesByProductName
)
}
let library = try selectLibrary(
from: libraries,
matching: schema.base.product
public func createPlan() async throws -> Plan {
// TODO: cache plan using (Package.swift+Package.resolved) as the key?
let graph = try await buildGraph()
let app = try await product(
from: graph,
matching: schema.product,
type: .application,
plist: schema.infoPath,
idSpecifier: schema.idSpecifier,
iconPath: schema.iconPath,
rootResources: schema.resources,
entitlementsPath: schema.entitlementsPath
)
var resources: [Resource] = []
let extensionProducts: [Plan.Product]
if let extensions = schema.extensions, !extensions.isEmpty {
extensionProducts = try await withThrowingTaskGroup(of: Plan.Product.self) { group in
for ext in extensions {
group.addTask {
try await product(
from: graph,
matching: ext.product,
type: .appExtension,
plist: ext.infoPath,
idSpecifier: ext.bundleID.flatMap(PackSchema.IDSpecifier.bundleID) ?? .orgID(app.bundleID),
iconPath: nil,
rootResources: ext.resources,
entitlementsPath: ext.entitlementsPath
)
}
}
return try await group.reduce(into: []) { $0.append($1) }
}
} else {
extensionProducts = []
}
return Plan(app: app, extensions: extensionProducts)
}
// swiftlint:disable cyclomatic_complexity function_parameter_count
private func product(
from graph: PackageGraph,
matching name: String?,
type: Plan.ProductType,
plist: String?,
idSpecifier: PackSchema.IDSpecifier,
iconPath: String?,
rootResources: [String]?,
entitlementsPath: String?
) async throws -> Plan.Product {
let library = try selectLibrary(
from: graph.root.products?.filter { $0.type == .autoLibrary } ?? [],
matching: name
)
var resources: [Plan.Resource] = []
var visited: Set<String> = []
var targets = library.targets.map { (rootPackage, $0) }
var targets = library.targets.map { (graph.root, $0) }
while let (targetPackage, targetName) = targets.popLast() {
guard let target = targetPackage.targets?.first(where: { $0.name == targetName }) else {
throw StringError("Could not find target '\(targetName)' in package '\(targetPackage.name)'")
@@ -91,15 +147,7 @@ public struct Planner: Sendable {
targets.append((targetPackage, targetName))
}
for productName in (target.productDependencies ?? []) {
guard let packageID = packagesByProductName[productName] else {
throw StringError("Could not find package containing product '\(productName)'")
}
guard let package = packages[packageID] else {
throw StringError("Could not find package by id '\(packageID)'")
}
guard let product = package.products?.first(where: { $0.name == productName }) else {
throw StringError("Could not find product '\(productName)' in package '\(packageID)'")
}
let (package, product) = try graph.product(name: productName)
if product.type == .dynamicLibrary {
resources.append(.library(name: productName))
}
@@ -107,37 +155,44 @@ public struct Planner: Sendable {
}
}
if let rootResources = schema.base.resources {
if let rootResources {
resources += rootResources.map { .root(source: $0) }
}
let bundleID = schema.idSpecifier.formBundleID(product: library.name)
let bundleID = idSpecifier.formBundleID(product: library.name)
let deploymentTarget = graph.root.platforms?.first { $0.name == "ios" }?.version
?? Self.minSupportedIOSVersion
var infoPlist: [String: Sendable] = [
"CFBundleInfoDictionaryVersion": "6.0",
"UIRequiredDeviceCapabilities": ["arm64"],
"LSRequiresIPhoneOS": true,
"CFBundleSupportedPlatforms": ["iPhoneOS"],
"CFBundlePackageType": "APPL",
"UIDeviceFamily": [1, 2],
"CFBundleDevelopmentRegion": "en",
"UISupportedInterfaceOrientations": ["UIInterfaceOrientationPortrait"],
"UISupportedInterfaceOrientations~ipad": [
"UIInterfaceOrientationPortrait",
"UIInterfaceOrientationPortraitUpsideDown",
"UIInterfaceOrientationLandscapeLeft",
"UIInterfaceOrientationLandscapeRight"
],
"UILaunchScreen": [:] as [String: Sendable],
"CFBundleVersion": "1",
"CFBundleShortVersionString": "1.0.0",
"MinimumOSVersion": deploymentTarget,
"CFBundleIdentifier": bundleID,
"CFBundleName": "\(library.name)",
"CFBundleExecutable": "\(library.name)",
"CFBundleName": library.name,
"CFBundleExecutable": library.name,
"CFBundleDisplayName": library.name,
"CFBundlePackageType": type.fourCharCode,
]
if let plist = self.schema.base.infoPath {
switch type {
case .application:
infoPlist["UIDeviceFamily"] = [1, 2]
infoPlist["UISupportedInterfaceOrientations"] = ["UIInterfaceOrientationPortrait"]
infoPlist["UISupportedInterfaceOrientations~ipad"] = [
"UIInterfaceOrientationPortrait",
"UIInterfaceOrientationPortraitUpsideDown",
"UIInterfaceOrientationLandscapeLeft",
"UIInterfaceOrientationLandscapeRight",
]
infoPlist["UILaunchScreen"] = [:] as [String: Sendable]
case .appExtension:
// Should set default parameters?
infoPlist["NSExtension"] = [:] as [String: Sendable]
}
if let plist {
let data = try await Data(reading: URL(fileURLWithPath: plist))
let info = try PropertyListSerialization.propertyList(from: data, format: nil)
if let info = info as? [String: Sendable] {
@@ -147,33 +202,59 @@ public struct Planner: Sendable {
}
}
return Plan(
return Plan.Product(
type: type,
product: library.name,
deploymentTarget: deploymentTarget,
bundleID: bundleID,
infoPlist: infoPlist,
resources: resources,
iconPath: self.schema.base.iconPath
iconPath: iconPath,
entitlementsPath: entitlementsPath
)
}
private func dumpDependencies() async throws -> PackageDependency {
let tempDir = try TemporaryDirectory(name: "xtool-dump")
let tempFileURL = tempDir.url.appendingPathComponent("dump.json")
// SwiftPM sometimes prints extraneous data to stdout, so ask
// it to write the JSON to a temp file instead. See:
// https://github.com/xtool-org/xtool/pull/97#discussion_r2203618825
_ = try await _dumpAction(
arguments: ["-q", "show-dependencies", "--format", "json", "-o", tempFileURL.path],
path: buildSettings.packagePath
)
return try Self.decoder.decode(
PackageDependency.self,
from: Data(contentsOf: tempFileURL)
)
}
private func dumpPackage(at path: String) async throws -> PackageDump {
let data = try await _dumpAction(arguments: ["describe", "--type", "json"], path: path)
let data = try await _dumpAction(arguments: ["-q", "describe", "--type", "json"], path: path)
try Task.checkCancellation()
return try Self.decoder.decode(PackageDump.self, from: data)
// As in dumpDependencies, we may end up with extraneous data, but `describe`
// doesn't have a `-o` flag for a clean workaround. Resort to a heuristic,
// looking for the opening brace.
let fromBrace = data.drop(while: { $0 != Character("{").asciiValue })
return try Self.decoder.decode(PackageDump.self, from: fromBrace)
}
private func _dumpAction(arguments: [String], path: String) async throws -> Data {
let dump = try await buildSettings.swiftPMInvocation(
let dumpConfig = try await buildSettings.withPackagePath(path).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(
@@ -211,19 +292,66 @@ public struct Planner: Sendable {
}
public struct Plan: Sendable {
public var product: String
public var deploymentTarget: String
public var bundleID: String
public var infoPlist: [String: any Sendable]
public var resources: [Resource]
public var iconPath: String?
}
public var app: Product
public var extensions: [Product]
public enum Resource: Codable, Sendable {
case bundle(package: String, target: String)
case binaryTarget(name: String)
case library(name: String)
case root(source: String)
public var allProducts: [Product] {
[app] + extensions
}
public enum Resource: Codable, Sendable, Hashable {
case bundle(package: String, target: String)
case binaryTarget(name: String)
case library(name: String)
case root(source: String)
}
public struct Product: Sendable {
public var type: ProductType
public var product: String
public var deploymentTarget: String
public var bundleID: String
public var infoPlist: [String: any Sendable]
public var resources: [Resource]
public var iconPath: String?
public var entitlementsPath: String?
public var targetName: String {
"\(self.product)-\(self.type.targetSuffix)"
}
public func directory(inApp baseDir: URL) -> URL {
switch type {
case .application:
baseDir
.appendingPathComponent(".", isDirectory: true)
case .appExtension:
baseDir
.appendingPathComponent("PlugIns", isDirectory: true)
.appendingPathComponent(product, isDirectory: true)
.appendingPathExtension("appex")
}
}
}
public enum ProductType: Sendable {
case application
case appExtension
fileprivate var targetSuffix: String {
switch self {
case .application: "App"
case .appExtension: "Extension"
}
}
fileprivate var fourCharCode: String {
switch self {
case .application: "APPL"
case .appExtension: "XPC!"
}
}
}
}
private struct PackageDependency: Decodable {
@@ -299,3 +427,22 @@ private struct PackageDump: Decodable {
let targets: [Target]?
let platforms: [Platform]?
}
private struct PackageGraph {
let root: PackageDump
let packages: [String: PackageDump]
let packagesByProductName: [String: String]
func product(name productName: String) throws -> (PackageDump, PackageDump.Product) {
guard let packageID = packagesByProductName[productName] else {
throw StringError("Could not find package containing product '\(productName)'")
}
guard let package = packages[packageID] else {
throw StringError("Could not find package by id '\(packageID)'")
}
guard let product = package.products?.first(where: { $0.name == productName }) else {
throw StringError("Could not find product '\(productName)' in package '\(packageID)'")
}
return (package, product)
}
}
-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
}
}
+50
View File
@@ -0,0 +1,50 @@
import Subprocess
import Version
import XUtils
public struct SwiftVersion: Sendable {
public var version: Version
public var supportsSwiftBuild: Bool {
version >= Version(6, 4, 0)
}
}
extension SwiftVersion {
private static let cached = Task<Self, Error> {
let outputString: String?
do {
outputString = try await Subprocess.run(
.path(try await BuildSettings.swiftURL()),
arguments: ["--version"],
output: .string(limit: .max)
)
.checkSuccess()
.standardOutput
} catch {
throw StringError("Failed to obtain Swift version")
}
var output = outputString?[...] ?? ""
if output.hasPrefix("Apple ") {
output = output.dropFirst("Apple ".count)
}
guard output.hasPrefix("Swift version ") else {
throw StringError("Could not parse Swift version: '\(output)'")
}
output = output.dropFirst("Swift version ".count)
guard let space = output.firstIndex(of: " ") else {
throw StringError("Could not parse Swift version: '\(output)'")
}
output = output[..<space]
guard let version = Version(tolerant: output) else {
throw StringError("Could not parse Swift version: '\(output)'")
}
return SwiftVersion(version: version)
}
public static var current: Self {
get async throws {
try await cached.value
}
}
}
+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 {
+77 -58
View File
@@ -13,62 +13,93 @@ public struct XcodePacker {
self.plan = plan
}
// swiftlint:disable:next function_body_length
public func createProject() async throws -> URL {
let targetName = "\(plan.product)-App"
let xtoolDir: Path = "xtool"
let projectDir: Path = xtoolDir + ".xtool-tmp"
try? xtoolDir.delete()
try projectDir.mkpath()
let infoPath = projectDir + "Info.plist"
var plist = plan.infoPlist
let families = (plist.removeValue(forKey: "UIDeviceFamily") as? [Int]) ?? [1, 2]
plist["CFBundleExecutable"] = targetName
plist["CFBundleName"] = targetName
plist["CFBundleDisplayName"] = plan.product
let encodedPlist = try PropertyListSerialization.data(fromPropertyList: plist, format: .xml, options: 0)
try infoPath.write(encodedPlist)
let emptyFile = projectDir + "empty.c"
try emptyFile.write(Data("// leave this file empty".utf8))
let fromProjectToRoot = try Path(".").relativePath(from: projectDir)
guard let deploymentTarget = Version(tolerant: plan.deploymentTarget) else {
throw StringError("Could not parse deployment target '\(plan.deploymentTarget)'")
guard let deploymentTarget = Version(tolerant: plan.app.deploymentTarget) else {
throw StringError("Could not parse deployment target '\(plan.app.deploymentTarget)'")
}
let emptyText = Data("""
// leave this file empty
""".utf8)
let targets = try plan.allProducts.map { product in
let productDir = projectDir + product.product
try productDir.mkpath()
let emptyFile = productDir + "empty.c"
try emptyFile.write(emptyText)
let infoPath = productDir + "Info.plist"
var plist = product.infoPlist
let families = (plist.removeValue(forKey: "UIDeviceFamily") as? [Int]) ?? [1, 2]
plist["CFBundleExecutable"] = product.targetName
plist["CFBundleName"] = product.targetName
plist["CFBundleDisplayName"] = product.product
let encodedPlist = try PropertyListSerialization.data(fromPropertyList: plist, format: .xml, options: 0)
try infoPath.write(encodedPlist)
var buildSettings: [String: BuildSetting] = [
"PRODUCT_BUNDLE_IDENTIFIER": .string(product.bundleID),
"TARGETED_DEVICE_FAMILY": .string(families.map { "\($0)" }.joined(separator: ",")),
]
if product.type == .appExtension {
buildSettings["APPLICATION_EXTENSION_API_ONLY"] = true
}
if let entitlementsPath = product.entitlementsPath {
buildSettings["CODE_SIGN_ENTITLEMENTS"] = .string((fromProjectToRoot + Path(entitlementsPath)).string)
}
let additionalDependencies: [Dependency] = if product.type == .application {
plan.extensions.map {
Dependency(
type: .target,
reference: $0.targetName
)
}
} else {
[]
}
return Target(
name: product.targetName,
type: product.type == .application ? .application : .appExtension,
platform: .iOS,
deploymentTarget: deploymentTarget,
settings: Settings(buildSettings: buildSettings),
sources: [
TargetSource(
path: try emptyFile.relativePath(from: projectDir).string,
buildPhase: .sources
),
],
dependencies: [
Dependency(
type: .package(products: [product.product]),
reference: "RootPackage"
),
] + additionalDependencies,
info: Plist(
path: try infoPath.relativePath(from: projectDir).string,
attributes: [:]
)
)
}
let project = Project(
name: plan.product,
targets: [
Target(
name: targetName,
type: .application,
platform: .iOS,
deploymentTarget: deploymentTarget,
settings: Settings(buildSettings: [
"PRODUCT_BUNDLE_IDENTIFIER": plan.bundleID,
"TARGETED_DEVICE_FAMILY": families.map { "\($0)" }.joined(separator: ","),
]),
sources: [
TargetSource(path: (fromProjectToRoot + emptyFile).string),
],
dependencies: [
Dependency(
type: .package(products: [plan.product]),
reference: "RootPackage"
),
],
info: Plist(
path: (fromProjectToRoot + infoPath).string,
attributes: [:]
)
)
],
name: plan.app.targetName,
targets: targets,
packages: [
"RootPackage": .local(
path: fromProjectToRoot.string,
@@ -85,8 +116,8 @@ public struct XcodePacker {
// TODO: Handle plan.iconPath
let generator = ProjectGenerator(project: project)
let xcodeproj = projectDir + "\(plan.product).xcodeproj"
let xcworkspace = xtoolDir + "\(plan.product).xcworkspace"
let xcodeproj = projectDir + "\(plan.app.product).xcodeproj"
let xcworkspace = xtoolDir + "\(plan.app.product).xcworkspace"
do {
let current = Path.current
Path.current = xcodeproj.parent()
@@ -99,18 +130,6 @@ public struct XcodePacker {
xcodeProject.pbxproj.delete(object: packageRef)
}
if let emptyFileRef = xcodeProject.pbxproj.fileReferences.first(where: { $0.path == "empty.c" }),
let existingGroup = xcodeProject.pbxproj.groups.first(where: {
$0.children.contains { $0.uuid == emptyFileRef.uuid }
}),
let existingGroupGroup = xcodeProject.pbxproj.groups.first(where: {
$0.children.contains { $0.uuid == existingGroup.uuid }
}) {
existingGroupGroup.children.removeAll(where: { $0.uuid == existingGroup.uuid })
existingGroupGroup.children.insert(emptyFileRef, at: 0)
xcodeProject.pbxproj.delete(object: existingGroup)
}
try xcodeProject.write(path: Path(xcodeproj.lastComponent))
}
-4
View File
@@ -1,4 +0,0 @@
module XADI [extern_c] {
header "xadi.h"
link "xadi"
}
-13
View File
@@ -1,13 +0,0 @@
#include <stdint.h>
void xadi_Load(const char *path);
int32_t xadi_SetAndroidID(const char *identifier, uint32_t length);
int32_t xadi_SetProvisioningPath(const char *path);
int32_t xadi_ProvisioningErase(uint64_t dsId);
int32_t xadi_Synchronize(uint64_t dsId, const void *serverIntermediateMetadata, uint32_t serverIntermediateMetadataLength, void **machineIdentifier, uint32_t *machineIdentifierLength, void **synchronizationResumeMetadata, uint32_t *synchronizationResumeMetadataLength);
int32_t xadi_ProvisioningDestroy(uint32_t session);
int32_t xadi_ProvisioningEnd(uint32_t session, const void *persistentTokenMetadata, uint32_t persistentTokenMetadataLength, const void *trustKey, uint32_t trustKeyLength);
int32_t xadi_ProvisioningStart(uint64_t dsId, const void *serverProvisioningIntermediateMetadata, uint32_t serverProvisioningIntermediateMetadataLength, void **clientProvisioningIntermediateMetadata, uint32_t *clientProvisioningIntermediateMetadataLength, uint32_t *session);
int32_t xadi_GetLoginCode(uint64_t dsId);
int32_t xadi_Dispose(void *ptr);
int32_t xadi_OTPRequest(uint64_t dsId, void **machineIdentifier, uint32_t *machineIdentifierLength, void **oneTimePassword, uint32_t *oneTimePasswordLength);
@@ -13,7 +13,6 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
public enum Error: LocalizedError {
case invalidApp(URL)
case teamNotFound(DeveloperServicesTeam.ID)
public var errorDescription: String? {
switch self {
@@ -25,16 +24,6 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
), $0
)
}
case .teamNotFound(let id):
return id.rawValue.withCString {
String.localizedStringWithFormat(
NSLocalizedString(
"add_app_operation.error.team_not_found",
value: "A team with the ID '%s' could not be found. Please select another team.",
comment: ""
), $0
)
}
}
}
}
@@ -52,14 +41,22 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
private func upsertApp(
bundleID: String,
entitlements: Entitlements,
isFreeTeam: Bool,
appIDs: [String: Components.Schemas.BundleId]
isFreeTeam: Bool
) async throws -> Components.Schemas.BundleId {
let newBundleID = ProvisioningIdentifiers.identifier(fromSanitized: bundleID, context: self.context)
let existing = try await context.developerAPIClient
.bundleIdsGetCollection(query: .init(
filter_lbrack_identifier_rbrack_: [bundleID]
))
.ok.body.json.data
// filter[identifier] is a prefix filter so we need to manually upgrade to equality
.first(where: { $0.attributes?.identifier == newBundleID })
let appID: Components.Schemas.BundleId
if let existing = appIDs[bundleID] {
if let existing {
appID = existing
} else {
let newBundleID = ProvisioningIdentifiers.identifier(fromSanitized: bundleID, context: self.context)
let name = ProvisioningIdentifiers.appName(fromSanitized: bundleID)
let createResponse = try await context.developerAPIClient.bundleIdsCreateInstance(
body: .json(
@@ -68,7 +65,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
_type: .bundleIds,
attributes: .init(
name: name,
platform: .ios,
platform: .init(.ios),
identifier: newBundleID
)
)
@@ -115,9 +112,13 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
.ok
}
} else {
_ = try await context.developerAPIClient
.bundleIdCapabilitiesDeleteInstance(path: .init(id: cap.id))
.noContent
// DeveloperServices doesn't allow deleting these capabilities
let requiredCapabilities: Set<Components.Schemas.CapabilityType.Value1Payload> = [.inAppPurchase]
if let capType = cap.attributes?.capabilityType?.value1, !requiredCapabilities.contains(capType) {
_ = try await context.developerAPIClient
.bundleIdCapabilitiesDeleteInstance(path: .init(id: cap.id))
.noContent
}
}
}
for (typ, settings) in wantedCapabilities {
@@ -136,8 +137,8 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
id: appID.id
)
),
// not public but required when using ds2 API
capability: .init(
// not public but required iff using ds2 API
capability: context.auth.isPublicAPI ? nil : .init(
data: .init(
_type: .capabilities,
id: typ
@@ -157,8 +158,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
/// that the app has).
private func addApp(
_ app: URL,
isFreeTeam: Bool,
appIDs: [String: Components.Schemas.BundleId]
isFreeTeam: Bool
) async throws -> ProvisioningInfo {
let infoURL = app.appendingPathComponent("Info.plist")
guard let data = try? Data(contentsOf: infoURL),
@@ -172,7 +172,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
var entitlements: Entitlements
// if the executable doesn't already have entitlements, that's
// okay. We don't have to throw an error.
if let entitlementsData = try? await context.signerImpl.analyze(executable: executableURL),
if let entitlementsData = try? await context.signer.analyze(executable: executableURL),
let decodedEntitlements = try? PropertyListDecoder().decode(Entitlements.self, from: entitlementsData) {
entitlements = decodedEntitlements
@@ -186,7 +186,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
entitlements = try Entitlements(entitlements: [])
}
let appID = try await upsertApp(bundleID: bundleID, entitlements: entitlements, isFreeTeam: isFreeTeam, appIDs: appIDs)
let appID = try await upsertApp(bundleID: bundleID, entitlements: entitlements, isFreeTeam: isFreeTeam)
let newBundleID = appID.attributes!.identifier!
let teamID = try signingInfo.certificate.teamID()
@@ -232,42 +232,17 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
)
}
private func getTeamIsFree() async throws -> Bool {
switch context.auth {
case .appStoreConnect:
return false
case .xcode(let authData):
let client = DeveloperServicesClient(authData: authData)
let request = DeveloperServicesListTeamsRequest()
let teams = try await client.send(request)
guard let team = teams.first(where: { $0.id == authData.teamID })
else { throw Error.teamNotFound(authData.teamID) }
return team.isFree
}
}
// keyed by sanitized bundle ID
private func getCurrentAppIDs() async throws -> [String: Components.Schemas.BundleId] {
let bundleIDs = try await context.developerAPIClient.bundleIdsGetCollection().ok.body.json.data
let keyedIDs = bundleIDs
.compactMap { id -> (String, Components.Schemas.BundleId)? in
guard let bundleID = id.attributes?.identifier else { return nil }
return (ProvisioningIdentifiers.sanitize(identifier: bundleID), id)
}
return Dictionary(keyedIDs, uniquingKeysWith: { $1 })
}
/// Registers the app + its extensions, returning the profile and entitlements of each
public func perform() async throws -> [URL: ProvisioningInfo] {
var apps: [URL] = [root]
let plugins = root.appendingPathComponent("PlugIns")
if plugins.dirExists {
for pluginsDir in ["PlugIns", "Extensions"] {
let plugins = root.appendingPathComponent(pluginsDir)
guard plugins.dirExists else { continue }
apps += plugins.implicitContents.filter { $0.pathExtension.lowercased() == "appex" }
}
async let isFreeTeamTask = getTeamIsFree()
async let appIDsTask = getCurrentAppIDs()
let (isFreeTeam, appIDs) = try await (isFreeTeamTask, appIDsTask)
let isFreeTeam = try await context.auth.team()?.isFree == true
return try await withThrowingTaskGroup(
of: (URL, ProvisioningInfo).self,
@@ -275,7 +250,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
) { group in
for app in apps {
group.addTask {
let info = try await addApp(app, isFreeTeam: isFreeTeam, appIDs: appIDs)
let info = try await addApp(app, isFreeTeam: isFreeTeam)
return (app, info)
}
}
@@ -15,11 +15,21 @@ public struct DeveloperServicesCapability: Sendable, Hashable {
public var settings: [Components.Schemas.CapabilitySetting]?
public init(
_ capabilityType: Components.Schemas.CapabilityType,
_ capabilityType: Components.Schemas.CapabilityType.Value1Payload,
isFree: Bool,
settings: [Components.Schemas.CapabilitySetting]? = nil
) {
self.capabilityType = capabilityType
self.capabilityType = .init(capabilityType)
self.isFree = isFree
self.settings = settings
}
public init(
rawName: String,
isFree: Bool,
settings: [Components.Schemas.CapabilitySetting]? = nil
) {
self.capabilityType = .init(value2: rawName)
self.isFree = isFree
self.settings = settings
}
@@ -39,7 +49,7 @@ extension Entitlement {
extension DataProtectionEntitlement: EntitlementWithCapability {
var capability: DeveloperServicesCapability {
let option: Components.Schemas.CapabilityOption.KeyPayload = switch self {
let option: Components.Schemas.CapabilityOption.KeyPayload.Value1Payload = switch self {
case .complete: .completeProtection
case .unlessOpen: .protectedUnlessOpen
case .untilFirstAuth: .protectedUntilFirstUserAuth
@@ -49,8 +59,8 @@ extension DataProtectionEntitlement: EntitlementWithCapability {
isFree: true,
settings: [
.init(
key: .dataProtectionPermissionLevel,
options: [.init(key: option)]
key: .init(.dataProtectionPermissionLevel),
options: [.init(key: .init(option))]
)
]
)
@@ -128,3 +138,9 @@ extension WirelessAccessoryEntitlement: EntitlementWithCapability {
DeveloperServicesCapability(.wirelessAccessoryConfiguration, isFree: true)
}
}
extension WiFiAwareEntitlement: EntitlementWithCapability {
var capability: DeveloperServicesCapability {
DeveloperServicesCapability(rawName: "WIFI_AWARE", isFree: false)
}
}
@@ -54,7 +54,7 @@ public struct DeveloperServicesFetchCertificateOperation: DeveloperServicesOpera
_type: .certificates,
attributes: .init(
csrContent: csr.pemString,
certificateType: .development
certificateType: .init(.development)
)
)))
)
@@ -72,19 +72,21 @@ public struct DeveloperServicesFetchCertificateOperation: DeveloperServicesOpera
_ certificates: [DeveloperServicesCertificate],
requireConfirmation: Bool
) async throws -> SigningInfo {
if !certificates.isEmpty, requireConfirmation {
guard await confirmRevocation(certificates)
else { throw CancellationError() }
}
try await withThrowingTaskGroup(of: Void.self) { group in
for certificate in certificates {
group.addTask {
_ = try await context.developerAPIClient
.certificatesDeleteInstance(path: .init(id: certificate.id))
.noContent
}
if try await context.auth.team()?.isFree == true {
if !certificates.isEmpty, requireConfirmation {
guard await confirmRevocation(certificates)
else { throw CancellationError() }
}
try await withThrowingTaskGroup(of: Void.self) { group in
for certificate in certificates {
group.addTask {
_ = try await context.developerAPIClient
.certificatesDeleteInstance(path: .init(id: certificate.id))
.noContent
}
}
try await group.waitForAll()
}
try await group.waitForAll()
}
let signingInfo = try await createCertificate()
signingInfoManager[self.context.auth.identityID] = signingInfo
@@ -39,7 +39,7 @@ public struct DeveloperServicesProvisioningOperation: DeveloperServicesOperation
public func perform() async throws -> Response {
progress(0/3)
_ = try await DeveloperServicesFetchDeviceOperation(context: context).perform()
try await DeveloperServicesAddDeviceOperation(context: context).perform()
progress(1/3)
let signingInfo = try await DeveloperServicesFetchCertificateOperation(
@@ -0,0 +1,59 @@
import Foundation
private actor DeveloperServicesTeamFetcher {
static let shared = DeveloperServicesTeamFetcher()
private var cache: [DeveloperServicesTeam.ID: Task<DeveloperServicesTeam, Error>] = [:]
private init() {}
func teams(forXcodeLogin auth: XcodeAuthData) async throws -> DeveloperServicesTeam {
let teamID = auth.teamID
if let cached = cache[teamID] {
return try await cached.value
}
let task = Task {
let client = DeveloperServicesClient(authData: auth)
let teams = try await client.send(DeveloperServicesListTeamsRequest())
guard let team = teams.first(where: { $0.id == teamID })
else { throw Errors.teamNotFound(teamID) }
return team
}
cache[auth.teamID] = task
return try await task.value
}
enum Errors: LocalizedError {
case teamNotFound(DeveloperServicesTeam.ID)
public var errorDescription: String? {
switch self {
case .teamNotFound(let id):
return id.rawValue.withCString {
String.localizedStringWithFormat(
NSLocalizedString(
"add_app_operation.error.team_not_found",
value: "A team with the ID '%s' could not be found. Please select another team.",
comment: ""
), $0
)
}
}
}
}
}
extension XcodeAuthData {
public func team() async throws -> DeveloperServicesTeam {
try await DeveloperServicesTeamFetcher.shared.teams(forXcodeLogin: self)
}
}
extension DeveloperAPIAuthData {
public func team() async throws -> DeveloperServicesTeam? {
switch self {
case .appStoreConnect: nil
case .xcode(let auth): try await auth.team()
}
}
}
@@ -0,0 +1,36 @@
import Foundation
import DeveloperAPI
public struct DeveloperServicesAddDeviceOperation: DeveloperServicesOperation {
public let context: SigningContext
public init(context: SigningContext) {
self.context = context
}
public func perform() async throws {
guard let targetDevice = context.targetDevice else { return }
// try to register the device
let response = try await context.developerAPIClient.devicesCreateInstance(
body: .json(.init(data: .init(
_type: .devices,
attributes: .init(
name: targetDevice.name,
platform: .init(.ios),
udid: targetDevice.udid
)
)))
)
// we get a 409 CONFLICT if the device was already registered.
// handle this by returning gracefully.
if (try? response.conflict) != nil {
return
}
// otherwise, we should get a 201 CREATED to indicate that the device
// was added. any other case is unexpected, and this will throw.
_ = try response.created
}
}
@@ -1,39 +0,0 @@
//
// DeveloperServicesFetchDeviceOperation.swift
// XKit
//
// Created by Kabir Oberai on 13/10/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import Foundation
import DeveloperAPI
public struct DeveloperServicesFetchDeviceOperation: DeveloperServicesOperation {
public let context: SigningContext
public init(context: SigningContext) {
self.context = context
}
public func perform() async throws -> Components.Schemas.Device {
let devices = try await context.developerAPIClient.devicesGetCollection().ok.body.json.data
if let device = devices.first(where: { $0.attributes?.udid == self.context.udid }) {
return device
}
let response = try await context.developerAPIClient.devicesCreateInstance(
body: .json(.init(data: .init(
_type: .devices,
attributes: .init(
name: self.context.deviceName,
platform: .ios,
udid: self.context.udid
)
)))
)
return try response.created.body.json.data
}
}
@@ -15,13 +15,14 @@ public struct ASCKey: Sendable {
actor ASCJWTGenerator {
// the duration for which we generate JWTs.
// ASC allows a maximum of 20 minutes.
private static let ttl: TimeInterval = 60 * 20
// ASC allows a maximum of 20 minutes. We use
// 15 minutes to account for clock drift.
private static let ttl: TimeInterval = 60 * 15
// the minimum remaining ttl for us to consider reusing a previous key.
// that is, we reuse the last JWT if it has at least [threshold] seconds
// left before it expires.
private static let tolerance: TimeInterval = 60
private static let tolerance: TimeInterval = 60 * 2
private static let encoder: JSONEncoder = {
let encoder = JSONEncoder()
@@ -0,0 +1,78 @@
import DeveloperAPI
/// An `AsyncSequence` that unfolds a paginated DeveloperAPI request.
///
/// Some Developer API GET requests are paginated. Each response contains
/// a `links.next` field that points to the next page. This API allows you to
/// consume all pages as an `AsyncSequence`. For example, you can
/// enumerate all devices with
///
/// ```swift
/// let pages = DeveloperAPIPages {
/// try await client.devicesGetCollection().ok.body.json
/// } next: {
/// $0.links.next
/// }
/// for try await page in pages {
/// print(page.data)
/// }
/// ```
public struct DeveloperAPIPages<Page>: AsyncSequence {
// inspired by PagedRequest from
// https://github.com/AvdLee/appstoreconnect-swift-sdk
public var request: @Sendable () async throws -> Page
public var getNext: @Sendable (Page) -> String?
public init(
request: @escaping @Sendable () async throws -> Page,
next getNext: @escaping @Sendable (Page) -> String?
) {
self.request = request
self.getNext = getNext
}
public func makeAsyncIterator() -> AsyncIterator {
AsyncIterator(request: request, getNext: getNext)
}
public struct AsyncIterator: AsyncIteratorProtocol {
fileprivate enum State {
case initial
case hasNext(String)
case end
}
fileprivate let request: @Sendable () async throws -> Page
fileprivate let getNext: @Sendable (Page) -> String?
fileprivate var state: State = .initial
public mutating func next() async throws -> Page? {
guard !Task.isCancelled else { return nil }
let cursor: String?
switch state {
case .initial:
cursor = nil
case .hasNext(let next):
cursor = next
case .end:
return nil
}
let page = try await DeveloperAPIClient.withNextLink(cursor) {
try await request()
}
if let next = getNext(page), next != cursor {
state = .hasNext(next)
} else {
state = .end
}
return page
}
}
}
@@ -6,21 +6,58 @@ import OpenAPIURLSession
import Dependencies
extension DeveloperAPIClient {
@TaskLocal fileprivate static var cursor: [URLQueryItem] = []
public init(
auth: DeveloperAPIAuthData
) {
@Dependency(\.httpClient) var httpClient
self.init(
// swiftlint:disable:next force_try
serverURL: try! Servers.Server1.url(),
configuration: .init(
dateTranscoder: .iso8601WithFractionalSeconds
),
transport: httpClient.asOpenAPITransport,
middlewares: [
auth.middleware
auth.middleware,
LoggingMiddleware(),
]
)
}
/// Perform a paginated request, starting at the page given by `link`.
///
/// `link` should be a URL that contains a `cursor` query parameter. The
/// cursor will be applied to any requests made inside the closure.
public static func withNextLink<T>(
_ link: String?,
isolation: isolated (any Actor)? = #isolation,
perform action: () async throws -> T
) async throws -> T {
let cursor: [URLQueryItem]
if let link {
guard let components = URLComponents(string: link),
let newOffset = components.queryItems?.first(where: { $0.name == "cursor" }),
let newLimit = components.queryItems?.first(where: { $0.name == "limit" })
else { throw Errors.badNextLink(link) }
// the next value will contain a cursor (offset) *and* a limit even if we didn't
// provide a limit in our initial request. we need to include the limit in subsequent
// requests, otherwise the cursor isn't respected.
cursor = [newOffset, newLimit]
} else {
cursor = []
}
return try await $cursor.withValue(cursor) {
try await action()
}
}
public enum Errors: Error {
case badNextLink(String)
}
}
public enum DeveloperAPIAuthData: Sendable {
@@ -36,6 +73,13 @@ public enum DeveloperAPIAuthData: Sendable {
}
}
public var isPublicAPI: Bool {
switch self {
case .appStoreConnect: true
case .xcode: false
}
}
// A unique ID tied to this token
public var identityID: String {
switch self {
@@ -96,12 +140,10 @@ public struct DeveloperAPIXcodeAuthMiddleware: ClientMiddleware {
// Xcode-specific
request.headerFields[.userAgent] = "Xcode"
request.headerFields[.init(DeviceInfo.xcodeVersionKey)!] = "16.2 (16C5031c)"
request.headerFields[.init(DeviceInfo.xcodeVersionKey)!] = DeviceInfo.xcodeVersion
// MobileMe identity
request.headerFields[.init(DeviceInfo.clientInfoKey)!] = """
<VirtualMac2,1> <macOS;15.1.1;24B91> <com.apple.AuthKit/1 (com.apple.dt.Xcode/23505)>
""" // deviceInfo.clientInfo.clientString
request.headerFields[.init(DeviceInfo.clientInfoKey)!] = deviceInfo.clientInfo.clientString
request.headerFields[.init(DeviceInfo.deviceIDKey)!] = deviceInfo.deviceID
// GrandSlam authentication
@@ -125,9 +167,13 @@ public struct DeveloperAPIXcodeAuthMiddleware: ClientMiddleware {
let path = request.path ?? "/"
var components = URLComponents(string: path) ?? .init()
components.queryItems = (components.queryItems ?? []) + [
var items = components.queryItems ?? []
items.upsertQueryItems(DeveloperAPIClient.cursor + [
URLQueryItem(name: "teamId", value: authData.teamID.rawValue)
]
])
components.queryItems = items
let query = components.percentEncodedQuery ?? ""
components.query = nil
@@ -213,9 +259,28 @@ public struct DeveloperAPIASCAuthMiddleware: ClientMiddleware {
_ baseURL: URL
) async throws -> (HTTPResponse, HTTPBody?)
) async throws -> (HTTPResponse, HTTPBody?) {
let jwt = try await generator.generate()
var request = request
let jwt = try await generator.generate()
request.headerFields[.authorization] = "Bearer \(jwt)"
let cursor = DeveloperAPIClient.cursor
if !cursor.isEmpty {
var components = URLComponents(string: request.path ?? "") ?? .init()
var items = components.queryItems ?? []
items.upsertQueryItems(cursor)
components.queryItems = items
request.path = components.string
}
return try await next(request, body, baseURL)
}
}
extension [URLQueryItem] {
fileprivate mutating func upsertQueryItems(_ items: [URLQueryItem]) {
let newNames = Set(items.map(\.name))
removeAll { newNames.contains($0.name) }
append(contentsOf: items)
}
}
@@ -0,0 +1,39 @@
import Foundation
import OpenAPIRuntime
import HTTPTypes
struct LoggingMiddleware: ClientMiddleware {
static let regex: NSRegularExpression? = {
guard let pat = ProcessInfo.processInfo.environment["XTL_DEV_LOG"] else { return nil }
return try? NSRegularExpression(pattern: pat)
}()
func intercept(
_ request: HTTPRequest,
body: HTTPBody?,
baseURL: URL,
operationID: String,
next: (HTTPRequest, HTTPBody?, URL) async throws -> (HTTPResponse, HTTPBody?)
) async throws -> (HTTPResponse, HTTPBody?) {
var (response, body) = try await next(request, body, baseURL)
guard Self.regex?.firstMatch(
in: operationID,
range: NSRange(operationID.startIndex..., in: operationID)
) != nil
else { return (response, body) }
print("\n\(operationID) response status -> \(response.status)")
if let unwrapped = body {
let data = try await Data(collecting: unwrapped, upTo: .max)
// body may only be consumable once, replace it with the collected data
body = .init(data)
let text = String(decoding: data, as: UTF8.self)
print("\(operationID) response body -> \(text)")
}
return (response, body)
}
}
@@ -0,0 +1,31 @@
import DeveloperAPI
// syntactic sugar to make it nicer to work with `anyOf:` types
public protocol OpenAPIExtensibleEnum {
associatedtype Value1Payload: RawRepresentable<String>, Codable, Hashable, Sendable, CaseIterable
var value1: Value1Payload? { get set }
var value2: String? { get set }
init(value1: Value1Payload?, value2: String?)
}
extension OpenAPIExtensibleEnum {
public var rawValue: String {
value2!
}
public init(_ value: Value1Payload) {
self.init(value1: value, value2: nil)
}
}
extension Components.Schemas.BundleIdPlatform: OpenAPIExtensibleEnum {}
extension Components.Schemas.CapabilityOption.KeyPayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.CapabilitySetting.KeyPayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.CapabilityType: OpenAPIExtensibleEnum {}
extension Components.Schemas.CertificateType: OpenAPIExtensibleEnum {}
extension Components.Schemas.Device.AttributesPayload.DeviceClassPayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.Device.AttributesPayload.StatusPayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.Profile.AttributesPayload.ProfileStatePayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.Profile.AttributesPayload.ProfileTypePayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.ProfileCreateRequest.DataPayload.AttributesPayload.ProfileTypePayload: OpenAPIExtensibleEnum {}
@@ -71,6 +71,7 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
let allDevices = try await context.developerAPIClient.devicesGetCollection()
.ok.body.json.data
.filter { $0.attributes?.deviceClass?.value1?.supportsIOSApps == true }
let response = try await context.developerAPIClient.profilesCreateInstance(
body: .json(
@@ -78,8 +79,8 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
data: .init(
_type: .profiles,
attributes: .init(
name: "SC profile \(bundleID.id)",
profileType: .iosAppDevelopment
name: "XTL profile \(bundleID.id)",
profileType: .init(.iosAppDevelopment)
),
relationships: .init(
bundleId: .init(
@@ -106,3 +107,12 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
}
}
extension Components.Schemas.Device.AttributesPayload.DeviceClassPayload.Value1Payload {
fileprivate var supportsIOSApps: Bool {
switch self {
case .ipad, .iphone, .ipod: true
default: false
}
}
}
@@ -9,7 +9,7 @@
import Foundation
public struct DeveloperServicesTeam: Decodable, Sendable {
public struct ID: RawRepresentable, Decodable, Sendable {
public struct ID: RawRepresentable, Decodable, Sendable, Hashable {
public let rawValue: String
public init(rawValue: String) { self.rawValue = rawValue }
}

Some files were not shown because too many files have changed in this diff Show More