Allow omitting the target triple for `swift sdk configure` #8856

marcprux · 2025-06-21T02:20:58Z

You can now run swift sdk configure --sdk-root-path /some/sdk/root sdk-id without needing to specify the target triple

Motivation:

The Android SDK (swiftlang/swift#80788 (comment)) needs to have its sdkRootPath configured to point to an external NDK sysroot. But it contains many different target triples, like armv7-unknown-linux-androideabi33 and x86_64-unknown-linux-android29, all of which need to be configured to point to the same sysroot. Following on to #8687 and swiftlang/swift-evolution#2888, this PR enables running a single command to configure the entire SDK, like so:

swift run swift-sdk configure --sdk-root-path ~/Library/Android/sdk/ndk/27.0.12077973/toolchains/llvm/prebuilt/darwin-x86_64/sysroot swift-6.1-RELEASE-android-24-0.1

This will result in configurations being created for each of the target triples for the SDK ID.

% swift run swift-sdk configure --sdk-root-path ~/Library/Android/sdk/ndk/27.0.12077973/toolchains/llvm/prebuilt/darwin-x86_64/sysroot swift-6.1-RELEASE-android-24-0.1
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android25` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi33` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android26` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi35` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android31` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi29` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android32` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android34` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android27` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi25` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi26` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi24` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android33` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android35` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android29` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android32` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android25` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android24` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi30` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android26` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android33` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi32` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android35` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android34` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android31` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android28` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android27` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android24` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android30` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi28` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `x86_64-unknown-linux-android28` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi27` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android30` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi34` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `armv7-unknown-linux-androideabi31` were successfully updated: sdkRootPath.
info: These properties of Swift SDK `swift-6.1-RELEASE-android-24-0.1` for target triple `aarch64-unknown-linux-android29` were successfully updated: sdkRootPath.

% ls ~/Library/org.swift.swiftpm/swift-sdks/configuration/
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android24.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android25.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android26.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android27.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android28.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android29.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android30.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android31.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android32.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android33.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android34.json
swift-6.1-RELEASE-android-24-0.1_aarch64-unknown-linux-android35.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi24.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi25.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi26.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi27.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi28.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi29.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi30.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi31.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi32.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi33.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi34.json
swift-6.1-RELEASE-android-24-0.1_armv7-unknown-linux-androideabi35.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android24.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android25.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android26.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android27.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android28.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android29.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android30.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android31.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android32.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android33.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android34.json
swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android35.json

% cat ~/Library/org.swift.swiftpm/swift-sdks/configuration/swift-6.1-RELEASE-android-24-0.1_x86_64-unknown-linux-android31.json
{
  "sdkRootPath" : "/Users/marc/Library/Android/sdk/ndk/27.0.12077973/toolchains/llvm/prebuilt/darwin-x86_64/sysroot",
  "swiftResourcesPath" : "/Users/marc/Library/org.swift.swiftpm/swift-sdks/swift-6.1-RELEASE-android-24-0.1.artifactbundle/swift-6.1-release-android-24-sdk/android-27c-sysroot/usr/lib/swift",
  "swiftStaticResourcesPath" : "/Users/marc/Library/org.swift.swiftpm/swift-sdks/swift-6.1-RELEASE-android-24-0.1.artifactbundle/swift-6.1-release-android-24-sdk/android-27c-sysroot/usr/lib/swift_static-x86_64",
  "toolsetPaths" : [
    "/Users/marc/Library/org.swift.swiftpm/swift-sdks/swift-6.1-RELEASE-android-24-0.1.artifactbundle/swift-6.1-release-android-24-sdk/swift-toolset.json"
  ]
}

In addition, this fixes #8584, where swift sdk configure with a specified target triple didn't work at all, and instead would configure some random target triple for the specified SDK.

Modifications:

Make the targetTriple flag for ConfigureSwiftSDK optional and, when nil, apply the command to all triples included in the specified SDK.

Result:

Fixes #8584 and enables configuring multiple target triples with a single swift sdk configure command.

marcprux · 2025-06-21T02:21:55Z

CC @finagolfin, @etcwilde, @MaxDesiatov

finagolfin · 2025-06-21T08:04:38Z

Seems good, I think the reviewers will ask for a test though. Running it through self-hosted CI to make sure the patch didn't break anything.

finagolfin · 2025-06-21T08:04:51Z

@swift-ci test self hosted

marcprux · 2025-06-22T20:03:21Z

I think the reviewers will ask for a test

There's no existing test support for the sdk configure command. I could probably implement something, but it would be a fairly major refactor, since much of the ConfigureSwiftSDK.run() logic would need to be relocated to somewhere more testable, like SwiftSDKConfigurationStore.

I'd be willing to undertake it if the reviewers want/need it.

MaxDesiatov · 2025-06-23T13:29:43Z

I think the reviewers will ask for a test

There's no existing test support for the sdk configure command. I could probably implement something, but it would be a fairly major refactor, since much of the ConfigureSwiftSDK.run() logic would need to be relocated to somewhere more testable, like SwiftSDKConfigurationStore.

I'd be willing to undertake it if the reviewers want/need it.

Yes please!

marcprux · 2025-06-23T15:41:36Z

OK, I'll work on implementing test support.

Are there any other common use cases for swift sdk configure, either existing or envisioned? I'd like to make sure my tests cover as many plausible scenarios as possible, and not just the Android SDK sysroot setup.

MaxDesiatov · 2025-06-23T15:44:23Z

OK, I'll work on implementing test support.

Are there any other common use cases for swift sdk configure, either existing or envisioned? I'd like to make sure my tests cover as many plausible scenarios as possible, and not just the Android SDK sysroot setup.

Not at the moment, I've designed it almost exclusively to support out-of-tree sysroots like NDK 😅

marcprux · 2025-06-24T02:52:22Z

I've added a SwiftSDKBundleTests.testConfigureSDKRootPath test, which is supported by moving the SDK configuration logic from the ConfigureSwiftSDK command to the SwiftSDKConfigurationStore. In doing so, I also centralized the config properties by making SwiftSDK.PathsConfiguration generic, so String and AbsolutePath variants will share the same structure; should new configuration properties ever need to be added in the future, it will be simpler to have them in this one place.

Lastly, I cleaned up some of the logic for the PathsConfiguration initializers which can accept an optional swiftSDKDirectory base directory and condensed it by eliminating the branch on nil to instead use the AbsolutePath initializer extension that accepts an optional relativeTo argument (which I had to relocate there anyway).

finagolfin · 2025-06-24T09:11:35Z

@swift-ci test self hosted

MaxDesiatov

Thanks! Other than formatting nits (see CONTRIBUTING.md "Creating PRs" section, p. 7) and unnecessary use of public, I think that new and existing functions and types deserve more doc comments while we're at it.

Sources/PackageModel/SwiftSDKs/SwiftSDK.swift

Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift

Sources/SwiftSDKCommand/ConfigureSwiftSDK.swift

Tests/PackageModelTests/SwiftSDKBundleTests.swift

Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift

Sources/PackageModel/SwiftSDKs/SwiftSDK.swift

Co-authored-by: Max Desiatov <[email protected]>

Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift

Co-authored-by: Max Desiatov <[email protected]>

…docs

Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift

Tests/PackageModelTests/SwiftSDKBundleTests.swift

Co-authored-by: Max Desiatov <[email protected]>

MaxDesiatov

Thanks!

MaxDesiatov · 2025-06-24T15:02:30Z

@swift-ci test

MaxDesiatov · 2025-06-24T15:04:03Z

@swift-ci test windows

MaxDesiatov · 2025-06-24T16:05:41Z

@swift-ci test windows

marcprux · 2025-06-27T14:34:57Z

@swift-ci test windows

I see that the Windows CI failed, but the link returns 404. Maybe the log expired? Can you run it again and I can take a look?

MaxDesiatov · 2025-06-27T14:36:20Z

@swift-ci test self hosted windows

marcprux · 2025-06-27T17:02:06Z

Windows error was:

11:51:14  C:\source\swiftpm\Tests\PackageModelTests\SwiftSDKBundleTests.swift:635: error: SwiftSDKBundleTests.testConfigureSDKRootPath : XCTAssertEqual failed: ("Optional("/some/sdk/root/path")") is not equal to ("Optional("\\some\\sdk\\root\\path")") -

I fixed it in b155f05. Can I get another CI run?

finagolfin · 2025-06-27T17:29:36Z

@swift-ci test self hosted windows

marcprux · 2025-07-01T19:41:07Z

CI passed. Is there anything else preventing this PR from getting merged?

MaxDesiatov · 2025-07-01T20:40:01Z

It needs a review from someone on the SwiftPM team.

MaxDesiatov · 2025-07-01T20:47:40Z

@swift-ci test

MaxDesiatov · 2025-07-01T20:47:52Z

@swift-ci test windows

Allow omitting the target triple for swift sdk configure

72fb717

marcprux requested review from jakepetroules, dschaefer2, shawnhyam, bripeticca, plemarquand, owenv, bkhouri, cmcgee1024 and daveyc123 as code owners June 21, 2025 02:21

MaxDesiatov added cross-compilation needs tests This change needs test coverage command-line interface labels Jun 23, 2025

marcprux marked this pull request as draft June 23, 2025 15:41

Move SDK configuration to SwiftSDKConfigurationStore and add tests

4fdc6fe

marcprux marked this pull request as ready for review June 24, 2025 02:53

MaxDesiatov reviewed Jun 24, 2025

View reviewed changes

MaxDesiatov added needs documentation and removed needs tests This change needs test coverage labels Jun 24, 2025

MaxDesiatov changed the title ~~Allow omitting the target triple for swift sdk configure~~ Allow omitting the target triple for swift sdk configure Jun 24, 2025

finagolfin mentioned this pull request Jun 24, 2025

Update sdkRootPath to be optional in swift-sdk.json swiftlang/swift-evolution#2888

Open

marcprux and others added 9 commits June 24, 2025 08:30

Make swiftSDKs(for:) private

018e73d

Update Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift

1524b41

Co-authored-by: Max Desiatov <[email protected]>

Update Sources/PackageModel/SwiftSDKs/SwiftSDK.swift

6d090cd

Co-authored-by: Max Desiatov <[email protected]>

Update Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift

94f0e72

Co-authored-by: Max Desiatov <[email protected]>

Update Tests/PackageModelTests/SwiftSDKBundleTests.swift

7323ea6

Co-authored-by: Max Desiatov <[email protected]>

Update Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift

d7ce846

Co-authored-by: Max Desiatov <[email protected]>

Update Sources/PackageModel/SwiftSDKs/SwiftSDK.swift

bbc9e15

Co-authored-by: Max Desiatov <[email protected]>

Update format of if statement

bb6a0d8

Make SwiftSDK.merge function internal and fix line-length formatting

bf6ea45

MaxDesiatov reviewed Jun 24, 2025

View reviewed changes

Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift Outdated Show resolved Hide resolved

marcprux and others added 3 commits June 24, 2025 10:25

Update Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift

6735809

Co-authored-by: Max Desiatov <[email protected]>

Add comments for PathsConfiguration

dec4007

Make SwiftSDKConfigurationStore.configure package accessible and add …

62596eb

…docs

MaxDesiatov reviewed Jun 24, 2025

View reviewed changes

Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift Outdated Show resolved Hide resolved

MaxDesiatov reviewed Jun 24, 2025

View reviewed changes

Tests/PackageModelTests/SwiftSDKBundleTests.swift Outdated Show resolved Hide resolved

marcprux and others added 2 commits June 24, 2025 10:45

Update Sources/PackageModel/SwiftSDKs/SwiftSDKConfigurationStore.swift

8271ac3

Co-authored-by: Max Desiatov <[email protected]>

Fix line lengths in test case

b8bc8d8

MaxDesiatov approved these changes Jun 24, 2025

View reviewed changes

Fix windows path for sdkRootPath test case

b155f05

Allow omitting the target triple for swift sdk configure #8856

Are you sure you want to change the base?

Allow omitting the target triple for swift sdk configure #8856

Uh oh!

Conversation

marcprux commented Jun 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation:

Modifications:

Result:

Uh oh!

marcprux commented Jun 21, 2025

Uh oh!

finagolfin commented Jun 21, 2025

Uh oh!

finagolfin commented Jun 21, 2025

Uh oh!

marcprux commented Jun 22, 2025

Uh oh!

MaxDesiatov commented Jun 23, 2025

Uh oh!

marcprux commented Jun 23, 2025

Uh oh!

MaxDesiatov commented Jun 23, 2025

Uh oh!

marcprux commented Jun 24, 2025

Uh oh!

finagolfin commented Jun 24, 2025

Uh oh!

MaxDesiatov left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MaxDesiatov left a comment

Choose a reason for hiding this comment

Uh oh!

MaxDesiatov commented Jun 24, 2025

Uh oh!

MaxDesiatov commented Jun 24, 2025

Uh oh!

MaxDesiatov commented Jun 24, 2025

Uh oh!

marcprux commented Jun 27, 2025

Uh oh!

MaxDesiatov commented Jun 27, 2025

Uh oh!

marcprux commented Jun 27, 2025

Uh oh!

finagolfin commented Jun 27, 2025

Uh oh!

marcprux commented Jul 1, 2025

Uh oh!

MaxDesiatov commented Jul 1, 2025

Uh oh!

MaxDesiatov commented Jul 1, 2025

Uh oh!

MaxDesiatov commented Jul 1, 2025

Uh oh!

Uh oh!

Allow omitting the target triple for `swift sdk configure` #8856

Allow omitting the target triple for `swift sdk configure` #8856

marcprux commented Jun 21, 2025 •

edited

Loading

MaxDesiatov left a comment •

edited

Loading