Merge pull request #649 from xymus/emit-module-verify-5.5

[5.5] Verify module interfaces generated from emit-module jobs

Author: xymus

Sources/SwiftDriver/Jobs/Planning.swift

@@ -139,7 +139,7 @@ extension Driver {
 
     try addPrecompileModuleDependenciesJobs(addJob: addJobBeforeCompiles)
     try addPrecompileBridgingHeaderJob(addJob: addJobBeforeCompiles)
-    try addEmitModuleJob(addJob: addJobBeforeCompiles)
+    try addEmitModuleJob(addJobBeforeCompiles: addJobBeforeCompiles, addJobAfterCompiles: addJobAfterCompiles)
     let linkerInputs = try addJobsFeedingLinker(
       addJobBeforeCompiles: addJobBeforeCompiles,
       addCompileJobGroup: addCompileJobGroup,
@@ -175,9 +175,11 @@ extension Driver {
     )
   }
 
-  private mutating func addEmitModuleJob(addJob: (Job) -> Void) throws {
+  private mutating func addEmitModuleJob(addJobBeforeCompiles: (Job) -> Void, addJobAfterCompiles: (Job) -> Void) throws {
     if shouldCreateEmitModuleJob {
-      addJob( try emitModuleJob() )
+      let emitModuleJob = try emitModuleJob()
+      addJobBeforeCompiles(emitModuleJob)
+      try addVerifyJobs(emitModuleJob: emitModuleJob, addJob: addJobAfterCompiles)
     }
   }
 
@@ -213,9 +215,11 @@ extension Driver {
       }
     }
 
-    try addSingleCompileJobs(addJob: addJobBeforeCompiles,
+    if let compileJob = try addSingleCompileJobs(addJob: addJobBeforeCompiles,
                              addJobOutputs: addJobOutputs,
-                             emitModuleTrace: loadedModuleTracePath != nil)
+                             emitModuleTrace: loadedModuleTracePath != nil) {
+      try addVerifyJobs(emitModuleJob: compileJob, addJob: addJobAfterCompiles)
+    }
 
     try addJobsForPrimaryInputs(
       addCompileJobGroup: addCompileJobGroup,
@@ -231,7 +235,7 @@ extension Driver {
         moduleInputs: moduleInputs,
         moduleInputsFromJobOutputs: moduleInputsFromJobOutputs) {
       addJobAfterCompiles(mergeJob)
-      try addVerifyJobs(mergeJob: mergeJob, addJob: addJobAfterCompiles)
+      try addVerifyJobs(emitModuleJob: mergeJob, addJob: addJobAfterCompiles)
       try addWrapJobOrMergeOutputs(
         mergeJob: mergeJob,
         debugInfo: debugInfo,
@@ -241,13 +245,15 @@ extension Driver {
     return linkerInputs
   }
 
+  /// When in single compile, add one compile job and possiblity multiple backend jobs.
+  /// Return the compile job if one was created.
   private mutating func addSingleCompileJobs(
     addJob: (Job) -> Void,
     addJobOutputs: ([TypedVirtualPath]) -> Void,
     emitModuleTrace: Bool
-  ) throws {
+  ) throws -> Job? {
     guard case .singleCompile = compilerMode
-    else { return }
+    else { return nil }
 
     if parsedOptions.hasArgument(.embedBitcode),
        inputFiles.allSatisfy({ $0.type.isPartOfSwiftCompilation }) {
@@ -262,6 +268,7 @@ extension Driver {
           : nil
       }
       backendJobs.forEach(addJob)
+      return compile
     } else {
       // We can skip the compile jobs if all we want is a module when it's
       // built separately.
@@ -270,6 +277,7 @@ extension Driver {
                                    addJobOutputs: addJobOutputs,
                                    emitModuleTrace: emitModuleTrace)
       addJob(compile)
+      return compile
     }
   }
 
@@ -387,7 +395,7 @@ extension Driver {
     return try mergeModuleJob(inputs: moduleInputs, inputsFromOutputs: moduleInputsFromJobOutputs)
   }
 
-  private mutating func addVerifyJobs(mergeJob: Job, addJob: (Job) -> Void )
+  private mutating func addVerifyJobs(emitModuleJob: Job, addJob: (Job) -> Void )
   throws {
     guard
        parsedOptions.hasArgument(.enableLibraryEvolution),
@@ -405,7 +413,7 @@ extension Driver {
 
       let outputType: FileType =
         forPrivate ? .privateSwiftInterface : .swiftInterface
-      let mergeInterfaceOutputs = mergeJob.outputs.filter { $0.type == outputType }
+      let mergeInterfaceOutputs = emitModuleJob.outputs.filter { $0.type == outputType }
       assert(mergeInterfaceOutputs.count == 1,
              "Merge module job should only have one swiftinterface output")
       let job = try verifyModuleInterfaceJob(interfaceInput: mergeInterfaceOutputs[0])

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -3592,13 +3592,56 @@ final class SwiftDriverTests: XCTestCase {
       XCTAssertTrue(verifyJob.outputs.isEmpty)
       XCTAssertTrue(verifyJob.commandLine.contains(.path(mergeInterfaceOutputs[0].file)))
     }
+
     // No Evolution
     do {
       var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module", "-module-name",
                                      "foo", "-emit-module-interface", "-verify-emitted-module-interface"])
       let plannedJobs = try driver.planBuild()
       XCTAssertEqual(plannedJobs.count, 2)
     }
+
+    // Emit-module separately
+    do {
+      var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module", "-module-name",
+                                     "foo", "-emit-module-interface",
+                                     "-verify-emitted-module-interface",
+                                     "-enable-library-evolution",
+                                     "-experimental-emit-module-separately"])
+      let plannedJobs = try driver.planBuild()
+      XCTAssertEqual(plannedJobs.count, 2)
+      let emitJob = plannedJobs[0]
+      let verifyJob = plannedJobs[1]
+      XCTAssertEqual(emitJob.kind, .emitModule)
+      let emitInterfaceOutput = emitJob.outputs.filter { $0.type == .swiftInterface }
+      XCTAssertTrue(emitInterfaceOutput.count == 1,
+                    "Emit module job should only have one swiftinterface output")
+      XCTAssertEqual(verifyJob.kind, .verifyModuleInterface)
+      XCTAssertTrue(verifyJob.inputs.count == 1)
+      XCTAssertTrue(verifyJob.inputs[0] == emitInterfaceOutput[0])
+      XCTAssertTrue(verifyJob.commandLine.contains(.path(emitInterfaceOutput[0].file)))
+    }
+
+    // Whole-module
+    do {
+      var driver = try Driver(args: ["swiftc", "foo.swift", "-emit-module", "-module-name",
+                                     "foo", "-emit-module-interface",
+                                     "-verify-emitted-module-interface",
+                                     "-enable-library-evolution",
+                                     "-whole-module-optimization"])
+      let plannedJobs = try driver.planBuild()
+      XCTAssertEqual(plannedJobs.count, 2)
+      let emitJob = plannedJobs[0]
+      let verifyJob = plannedJobs[1]
+      XCTAssertEqual(emitJob.kind, .compile)
+      let emitInterfaceOutput = emitJob.outputs.filter { $0.type == .swiftInterface }
+      XCTAssertTrue(emitInterfaceOutput.count == 1,
+                    "Emit module job should only have one swiftinterface output")
+      XCTAssertEqual(verifyJob.kind, .verifyModuleInterface)
+      XCTAssertTrue(verifyJob.inputs.count == 1)
+      XCTAssertTrue(verifyJob.inputs[0] == emitInterfaceOutput[0])
+      XCTAssertTrue(verifyJob.commandLine.contains(.path(emitInterfaceOutput[0].file)))
+    }
   }
 
   func testPCHGeneration() throws {