Skip to content

Support module aliasing for PIF gen with xcode build system in SwiftPM #4196

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.

Sign up for GitHub

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 1 commit into from
Mar 4, 2022
Merged

Support module aliasing for PIF gen with xcode build system in SwiftPM #4196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions Sources/XCBuildSupport/PIF.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,6 +963,7 @@ public enum PIF {
case SPECIALIZATION_SDK_OPTIONS
case SUPPORTED_PLATFORMS
case SWIFT_ACTIVE_COMPILATION_CONDITIONS
case SWIFT_MODULE_ALIASES
}

public enum Platform: String, CaseIterable, Codable {
Expand Down
3 changes: 3 additions & 0 deletions Sources/XCBuildSupport/PIFBuilder.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,9 @@ final class PackagePIFProjectBuilder: PIFProjectBuilder {
// Disable code coverage linker flags since we're producing .o files. Otherwise, we will run into duplicated
// symbols when there are more than one targets that produce .o as their product.
settings[.CLANG_COVERAGE_MAPPING_LINKER_ARGS] = "NO"
if let aliases = target.moduleAliases {
settings[.SWIFT_MODULE_ALIASES] = aliases.map{ $0.key + "=" + $0.value }
}

// Create a set of build settings that will be imparted to any target that depends on this one.
var impartedSettings = PIF.BuildSettings()
Expand Down
3 changes: 3 additions & 0 deletions Sources/Xcodeproj/XcodeProjectModel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,7 @@ public struct Xcode {
public var SWIFT_ACTIVE_COMPILATION_CONDITIONS: [String]?
public var SWIFT_FORCE_STATIC_LINK_STDLIB: String?
public var SWIFT_FORCE_DYNAMIC_LINK_STDLIB: String?
public var SWIFT_MODULE_ALIASES: [String: String]?
public var SWIFT_OPTIMIZATION_LEVEL: String?
public var SWIFT_VERSION: String?
public var TARGET_NAME: String?
Expand Down Expand Up @@ -440,6 +441,7 @@ public struct Xcode {
SWIFT_ACTIVE_COMPILATION_CONDITIONS: [String]? = nil,
SWIFT_FORCE_STATIC_LINK_STDLIB: String? = nil,
SWIFT_FORCE_DYNAMIC_LINK_STDLIB: String? = nil,
SWIFT_MODULE_ALIASES: [String: String]? = nil,
SWIFT_OPTIMIZATION_LEVEL: String? = nil,
SWIFT_VERSION: String? = nil,
TARGET_NAME: String? = nil,
Expand Down Expand Up @@ -488,6 +490,7 @@ public struct Xcode {
self.SWIFT_ACTIVE_COMPILATION_CONDITIONS = SWIFT_ACTIVE_COMPILATION_CONDITIONS
self.SWIFT_FORCE_STATIC_LINK_STDLIB = SWIFT_FORCE_STATIC_LINK_STDLIB
self.SWIFT_FORCE_DYNAMIC_LINK_STDLIB = SWIFT_FORCE_DYNAMIC_LINK_STDLIB
self.SWIFT_MODULE_ALIASES = SWIFT_MODULE_ALIASES
self.SWIFT_OPTIMIZATION_LEVEL = SWIFT_OPTIMIZATION_LEVEL
self.SWIFT_VERSION = SWIFT_VERSION
self.TARGET_NAME = TARGET_NAME
Expand Down
227 changes: 227 additions & 0 deletions Tests/XCBuildSupportTests/PIFBuilderTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1460,6 +1460,233 @@ class PIFBuilderTests: XCTestCase {
}
}

func testPIFGenWithModuleAliases() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif
let fs = InMemoryFileSystem(emptyFiles:
"/App/Sources/App/main.swift",
"/App/Sources/Logging/lib.swift",
"/App/Sources/Utils/lib.swift",
"/Bar/Sources/Lib/lib.swift",
"/Bar/Sources/Logging/lib.swift"
)

let observability = ObservabilitySystem.makeForTesting()
let graph = try loadPackageGraph(
fs: fs,
manifests: [
Manifest.createRootManifest(
name: "App",
path: .init("/App"),
dependencies: [
.localSourceControl(path: .init("/Bar"), requirement: .branch("main")),
],
targets: [
.init(name: "App", dependencies: ["Logging", "Utils"], type: .executable),
.init(name: "Logging", dependencies: []),
.init(name: "Utils", dependencies: [
.product(name: "BarLib", package: "Bar", moduleAliases: ["Logging": "BarLogging"]),
]),
]),
Manifest.createLocalSourceControlManifest(
name: "Bar",
path: .init("/Bar"),
products: [
.init(name: "BarLib", type: .library(.dynamic), targets: ["Lib"]),
],
targets: [
.init(name: "Lib", dependencies: ["Logging"]),
.init(name: "Logging", dependencies: []),
]),
],
observabilityScope: observability.topScope
)

var pif: PIF.TopLevelObject!
try! withCustomEnv(["PKG_CONFIG_PATH": inputsDir.pathString]) {
let builder = PIFBuilder(
graph: graph,
parameters: .mock(),
fileSystem: localFileSystem,
observabilityScope: observability.topScope
)
pif = try builder.construct()
}

XCTAssertNoDiagnostics(observability.diagnostics)

PIFTester(pif) { workspace in
workspace.checkProject("PACKAGE:/App") { project in
project.checkTarget("PACKAGE-PRODUCT:App") { target in
XCTAssertEqual(target.name, "App_1DA2DD44_PackageProduct")
XCTAssertEqual(target.productType, .executable)
XCTAssertEqual(target.productName, "App")
XCTAssertEqual(target.dependencies, [
"PACKAGE-TARGET:Utils",
"PACKAGE-TARGET:Logging",
"PACKAGE-PRODUCT:BarLib",
])
XCTAssertEqual(target.frameworks, [
"PACKAGE-TARGET:Utils",
"PACKAGE-TARGET:Logging",
"PACKAGE-PRODUCT:BarLib",
])

target.checkBuildConfiguration("Debug") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-PRODUCT:App::BUILDCONFIG_Debug")
XCTAssertEqual(configuration.name, "Debug")
configuration.checkBuildSettings { settings in
XCTAssertNil(settings[.SWIFT_MODULE_ALIASES])
}
}

target.checkBuildConfiguration("Release") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-PRODUCT:App::BUILDCONFIG_Release")
XCTAssertEqual(configuration.name, "Release")
configuration.checkBuildSettings { settings in
XCTAssertNil(settings[.SWIFT_MODULE_ALIASES])
}
}
}

project.checkTarget("PACKAGE-TARGET:Utils") { target in
XCTAssertEqual(target.name, "Utils")
XCTAssertEqual(target.productType, .objectFile)
XCTAssertEqual(target.productName, "Utils.o")
XCTAssertEqual(target.dependencies, [
"PACKAGE-PRODUCT:BarLib",
])

target.checkBuildConfiguration("Debug") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-TARGET:Utils::BUILDCONFIG_Debug")
XCTAssertEqual(configuration.name, "Debug")
configuration.checkBuildSettings { settings in
XCTAssertNil(settings[.SWIFT_MODULE_ALIASES])
}
}

target.checkBuildConfiguration("Release") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-TARGET:Utils::BUILDCONFIG_Release")
XCTAssertEqual(configuration.name, "Release")
configuration.checkBuildSettings { settings in
XCTAssertNil(settings[.SWIFT_MODULE_ALIASES])
}
}

}
project.checkTarget("PACKAGE-TARGET:Logging") { target in
XCTAssertEqual(target.name, "Logging")
XCTAssertEqual(target.productType, .objectFile)
XCTAssertEqual(target.productName, "Logging.o")
XCTAssertEqual(target.dependencies, [])

target.checkBuildConfiguration("Debug") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-TARGET:Logging::BUILDCONFIG_Debug")
XCTAssertEqual(configuration.name, "Debug")
configuration.checkBuildSettings { settings in
XCTAssertNil(settings[.SWIFT_MODULE_ALIASES])
}
}

target.checkBuildConfiguration("Release") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-TARGET:Logging::BUILDCONFIG_Release")
XCTAssertEqual(configuration.name, "Release")
configuration.checkBuildSettings { settings in
XCTAssertNil(settings[.SWIFT_MODULE_ALIASES])
}
}
}
}

workspace.checkProject("PACKAGE:/Bar") { project in
project.checkTarget("PACKAGE-PRODUCT:BarLib") { target in
XCTAssertEqual(target.name, "BarLib_175D063FAE17B2_PackageProduct")
XCTAssertEqual(target.productType, .framework)
XCTAssertEqual(target.productName, "BarLib.framework")
XCTAssertEqual(target.dependencies, ["PACKAGE-TARGET:BarLogging", "PACKAGE-TARGET:Lib"])
XCTAssertEqual(target.frameworks, ["PACKAGE-TARGET:BarLogging", "PACKAGE-TARGET:Lib"])

target.checkBuildConfiguration("Debug") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-PRODUCT:BarLib::BUILDCONFIG_Debug")
XCTAssertEqual(configuration.name, "Debug")
configuration.checkBuildSettings { settings in
XCTAssertNil(settings[.SWIFT_MODULE_ALIASES])
XCTAssertEqual(settings[.PRODUCT_MODULE_NAME], "BarLib")
XCTAssertEqual(settings[.PRODUCT_NAME], "BarLib")
XCTAssertEqual(settings[.TARGET_NAME], "BarLib")
}
}

target.checkBuildConfiguration("Release") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-PRODUCT:BarLib::BUILDCONFIG_Release")
XCTAssertEqual(configuration.name, "Release")
configuration.checkBuildSettings { settings in
XCTAssertNil(settings[.SWIFT_MODULE_ALIASES])
XCTAssertEqual(settings[.PRODUCT_MODULE_NAME], "BarLib")
XCTAssertEqual(settings[.PRODUCT_NAME], "BarLib")
XCTAssertEqual(settings[.TARGET_NAME], "BarLib")
}
}
}
project.checkTarget("PACKAGE-TARGET:BarLogging") { target in
XCTAssertEqual(target.name, "BarLogging")
XCTAssertEqual(target.productType, .objectFile)
XCTAssertEqual(target.productName, "BarLogging.o")
XCTAssertEqual(target.dependencies, [])
XCTAssertEqual(target.frameworks, [])

target.checkBuildConfiguration("Debug") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-TARGET:BarLogging::BUILDCONFIG_Debug")
XCTAssertEqual(configuration.name, "Debug")
configuration.checkBuildSettings { settings in
XCTAssertEqual(settings[.SWIFT_MODULE_ALIASES], ["Logging=BarLogging"])
XCTAssertEqual(settings[.PRODUCT_NAME], "BarLogging.o")
XCTAssertEqual(settings[.TARGET_NAME], "BarLogging")
}
}

target.checkBuildConfiguration("Release") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-TARGET:BarLogging::BUILDCONFIG_Release")
XCTAssertEqual(configuration.name, "Release")
configuration.checkBuildSettings { settings in
XCTAssertEqual(settings[.SWIFT_MODULE_ALIASES], ["Logging=BarLogging"])
XCTAssertEqual(settings[.PRODUCT_NAME], "BarLogging.o")
XCTAssertEqual(settings[.TARGET_NAME], "BarLogging")
}
}
}
project.checkTarget("PACKAGE-TARGET:Lib") { target in
XCTAssertEqual(target.name, "Lib")
XCTAssertEqual(target.productType, .objectFile)
XCTAssertEqual(target.productName, "Lib.o")
XCTAssertEqual(target.dependencies, ["PACKAGE-TARGET:BarLogging"])
XCTAssertEqual(target.frameworks, [])

target.checkBuildConfiguration("Debug") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-TARGET:Lib::BUILDCONFIG_Debug")
XCTAssertEqual(configuration.name, "Debug")
configuration.checkBuildSettings { settings in
XCTAssertEqual(settings[.SWIFT_MODULE_ALIASES], ["Logging=BarLogging"])
XCTAssertEqual(settings[.PRODUCT_NAME], "Lib.o")
XCTAssertEqual(settings[.TARGET_NAME], "Lib")
}
}

target.checkBuildConfiguration("Release") { configuration in
XCTAssertEqual(configuration.guid, "PACKAGE-TARGET:Lib::BUILDCONFIG_Release")
XCTAssertEqual(configuration.name, "Release")
configuration.checkBuildSettings { settings in
XCTAssertEqual(settings[.SWIFT_MODULE_ALIASES], ["Logging=BarLogging"])
XCTAssertEqual(settings[.PRODUCT_NAME], "Lib.o")
XCTAssertEqual(settings[.TARGET_NAME], "Lib")
}
}
}
}
}
}

func testLibraryTargetsAsDylib() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
Expand Down