Merge pull request #204 from artemcm/ExplicitFrameworkBuilds

[Explicit Module Builds] Add `isFramework` flag to the dependency graph and swift module info.

Author: artemcm

Sources/SwiftDriver/Explicit Module Builds/ExplicitModuleBuildHandler.swift

@@ -342,11 +342,15 @@ public typealias ExternalDependencyArtifactMap =
     let dependencyInfo = try dependencyGraph.moduleInfo(of: dependencyId)
 
     let swiftModulePath: TypedVirtualPath
+    let isFramework: Bool
     if case .swift(let details) = dependencyInfo.details,
        let compiledModulePath = details.explicitCompiledModulePath {
       // If an already-compiled module is available, use it.
       swiftModulePath = .init(file: try VirtualPath(path: compiledModulePath),
                               type: .swiftModule)
+      // Since this module has already been built, it is no longer relevant
+      // whether it is a framework or not.
+      isFramework = false
     } else {
       // Generate a build job for the dependency module, if not already generated
       if swiftModuleBuildCache[dependencyId] == nil {
@@ -355,13 +359,15 @@ public typealias ExternalDependencyArtifactMap =
       }
       swiftModulePath = .init(file: try VirtualPath(path: dependencyInfo.modulePath),
                               type: .swiftModule)
+      isFramework = try dependencyGraph.swiftModuleDetails(of: dependencyId).isFramework
     }
 
     // Collect the required information about this module
     // TODO: add .swiftdoc and .swiftsourceinfo for this module.
     swiftDependencyArtifacts.append(
       SwiftModuleArtifactInfo(name: dependencyId.moduleName,
-                              modulePath: swiftModulePath.file.description))
+                              modulePath: swiftModulePath.file.description,
+                              isFramework: isFramework))
 
     // Process all transitive dependencies as direct
     try addModuleDependencies(moduleId: dependencyId, pcmArgs: pcmArgs,

Sources/SwiftDriver/Explicit Module Builds/InterModuleDependencyGraph.swift

@@ -97,6 +97,9 @@ public struct SwiftModuleDetails: Codable {
   /// arguments to the generic PCM build arguments reported from the dependency
   /// graph.
   @_spi(Testing) public var extraPcmArgs: [String]?
+
+  /// A flag to indicate whether or not this module is a framework.
+  @_spi(Testing) public var isFramework: Bool
 }
 
 /// Details specific to Swift external modules.

Sources/SwiftDriver/Explicit Module Builds/ModuleArtifacts.swift

@@ -25,12 +25,16 @@ public struct SwiftModuleArtifactInfo: Codable {
   public let docPath: String?
   /// The path for the module's .swiftsourceinfo file
   public let sourceInfoPath: String?
+  /// A flag to indicate whether this module is a framework
+  public let isFramework: Bool
 
-  init(name: String, modulePath: String, docPath: String? = nil, sourceInfoPath: String? = nil) {
+  init(name: String, modulePath: String, docPath: String? = nil,
+       sourceInfoPath: String? = nil, isFramework: Bool = false) {
     self.moduleName = name
     self.modulePath = modulePath
     self.docPath = docPath
     self.sourceInfoPath = sourceInfoPath
+    self.isFramework = isFramework
   }
 }
 

Sources/SwiftDriver/Explicit Module Builds/PlaceholderDependencyResolution.swift

@@ -167,5 +167,6 @@ private extension SwiftModuleDetails {
     self.bridgingSourceFiles = nil
     self.commandLine = nil
     self.extraPcmArgs = extraPcmArgs
+    self.isFramework = false
   }
 }

Tests/SwiftDriverTests/ExplicitModuleBuildTests.swift

@@ -90,6 +90,7 @@ private func checkExplicitModuleBuildJobDependencies(job: Job,
         let dependencyArtifacts =
           dependencyInfoList.first(where:{ $0.moduleName == dependencyId.moduleName })
         XCTAssertEqual(dependencyArtifacts!.modulePath, swiftDetails.explicitCompiledModulePath ?? dependencyInfo.modulePath)
+        XCTAssertEqual(dependencyArtifacts!.isFramework, swiftDetails.isFramework)
       case .clang(let clangDependencyDetails):
         let clangDependencyModulePathString =
           try ExplicitModuleBuildHandler.targetEncodedClangModuleFilePath(
@@ -391,13 +392,15 @@ final class ExplicitModuleBuildTests: XCTestCase {
         "moduleName": "A",
         "modulePath": "A.swiftmodule",
         "docPath": "A.swiftdoc",
-        "sourceInfoPath": "A.swiftsourceinfo"
+        "sourceInfoPath": "A.swiftsourceinfo",
+        "isFramework": true
       },
       {
         "moduleName": "B",
         "modulePath": "B.swiftmodule",
         "docPath": "B.swiftdoc",
-        "sourceInfoPath": "B.swiftsourceinfo"
+        "sourceInfoPath": "B.swiftsourceinfo",
+        "isFramework": false
       }
     ]
     """
@@ -408,9 +411,11 @@ final class ExplicitModuleBuildTests: XCTestCase {
     XCTAssertEqual(moduleMap[0].modulePath, "A.swiftmodule")
     XCTAssertEqual(moduleMap[0].docPath, "A.swiftdoc")
     XCTAssertEqual(moduleMap[0].sourceInfoPath, "A.swiftsourceinfo")
+    XCTAssertEqual(moduleMap[0].isFramework, true)
     XCTAssertEqual(moduleMap[1].moduleName, "B")
     XCTAssertEqual(moduleMap[1].modulePath, "B.swiftmodule")
     XCTAssertEqual(moduleMap[1].docPath, "B.swiftdoc")
     XCTAssertEqual(moduleMap[1].sourceInfoPath, "B.swiftsourceinfo")
+    XCTAssertEqual(moduleMap[1].isFramework, false)
   }
 }