Skip to content

[6.1] Binary dependencies of C/C++ modules break build planning #8225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,10 @@ extension LLBuildManifestBuilder {

case .library(.automatic), .library(.static), .plugin:
for module in product.modules {
guard let dependencyDescription = self.plan.description(
let dependencyDescription = self.plan.description(
for: module,
context: product.type == .plugin ? .host : target.destination
) else
{
throw InternalError("unknown module: \(module)")
}
)
addStaticTargetInputs(dependencyDescription)
}
case .test:
Expand Down
104 changes: 104 additions & 0 deletions Tests/BuildTests/BuildPlanTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -6738,4 +6738,108 @@ final class BuildPlanTests: XCTestCase {
)
}
}

func testProductWithBinaryArtifactDependency() async throws {
#if !os(macOS)
try XCTSkipIf(true, "Test is only supported on macOS")
#endif

let fs = InMemoryFileSystem(
emptyFiles:
"/testpackage/Sources/SwiftLib/lib.swift",
"/testpackage/Sources/CLib/include/lib.h",
"/testpackage/Sources/CLib/lib.c"
)

try fs.createDirectory("/testpackagedep/SomeArtifact.xcframework", recursive: true)
try fs.writeFileContents(
"/testpackagedep/SomeArtifact.xcframework/Info.plist",
string: """
<?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>AvailableLibraries</key>
<array>
<dict>
<key>LibraryIdentifier</key>
<string>macos</string>
<key>HeadersPath</key>
<string>Headers</string>
<key>LibraryPath</key>
<string>libSomeArtifact.a</string>
<key>SupportedArchitectures</key>
<array>
<string>arm64</string>
<string>x86_64</string>
</array>
<key>SupportedPlatform</key>
<string>macos</string>
</dict>
</array>
<key>CFBundlePackageType</key>
<string>XFWK</string>
<key>XCFrameworkFormatVersion</key>
<string>1.0</string>
</dict>
</plist>
"""
)

let observability = ObservabilitySystem.makeForTesting()
let graph = try loadModulesGraph(
fileSystem: fs,
manifests: [
Manifest.createFileSystemManifest(
displayName: "testpackagedep",
path: "/testpackagedep",
products: [
ProductDescription(name: "SomeArtifact", type: .library(.static), targets: ["SomeArtifact"]),
],
targets: [
TargetDescription(name: "SomeArtifact", path: "SomeArtifact.xcframework", type: .binary),
]
),
Manifest.createRootManifest(
displayName: "testpackage",
path: "/testpackage",
dependencies: [
.localSourceControl(path: "/testpackagedep", requirement: .upToNextMajor(from: "1.0.0")),
],
products: [
ProductDescription(name: "SwiftLib", type: .library(.static), targets: ["SwiftLib"]),
ProductDescription(name: "CLib", type: .library(.static), targets: ["CLib"]),
],
targets: [
TargetDescription(name: "SwiftLib", dependencies: ["SomeArtifact"]),
TargetDescription(name: "CLib", dependencies: ["SomeArtifact"])
]
),
],
binaryArtifacts: [
.plain("testpackagedep"): [
"SomeArtifact": .init(kind: .xcframework, originURL: nil, path: "/testpackagedep/SomeArtifact.xcframework"),
],
],
observabilityScope: observability.topScope
)
XCTAssertNoDiagnostics(observability.diagnostics)

let plan = try await mockBuildPlan(
graph: graph,
fileSystem: fs,
observabilityScope: observability.topScope
)

let llbuild = LLBuildManifestBuilder(
plan,
fileSystem: fs,
observabilityScope: observability.topScope
)
try llbuild.generateManifest(at: "/manifest.yaml")
let contents: String = try fs.readFileContents("/manifest.yaml")

XCTAssertMatch(contents, .regex(#"args: \[.*"-I","/testpackagedep/SomeArtifact.xcframework/macos/Headers".*,"/testpackage/Sources/CLib/lib.c".*]"#))
XCTAssertMatch(contents, .regex(#"args: \[.*"-module-name","SwiftLib",.*"-I","/testpackagedep/SomeArtifact.xcframework/macos/Headers".*]"#))
}
}