Enable contrived test plugin test case (#8756)

This test case did not work until
swiftlang/swift-build#541 was merged.

Enable more plugin dependency testing.

Allow more than one custom task per target in the PIF Builder.

Author: cmcgee1024

Sources/SwiftBuildSupport/PIFBuilder.swift

@@ -257,7 +257,7 @@ public final class PIFBuilder {
             var packagesAndProjects: [(ResolvedPackage, ProjectModel.Project)] = []
 
             for package in sortedPackages {
-                var buildToolPluginResultsByTargetName: [String: PackagePIFBuilder.BuildToolPluginInvocationResult] = [:]
+                var buildToolPluginResultsByTargetName: [String: [PackagePIFBuilder.BuildToolPluginInvocationResult]] = [:]
 
                 for module in package.modules {
                     // Apply each build tool plugin used by the target in order,
@@ -388,7 +388,11 @@ public final class PIFBuilder {
 
                         // Add a BuildToolPluginInvocationResult to the mapping.
                         buildToolPluginResults.append(result2)
-                        buildToolPluginResultsByTargetName[module.name] = result2
+                        if var existingResults = buildToolPluginResultsByTargetName[module.name] {
+                            existingResults.append(result2)
+                        } else {
+                            buildToolPluginResultsByTargetName[module.name] = [result2]
+                        }
                     }
                 }
 

Sources/SwiftBuildSupport/PackagePIFBuilder.swift

@@ -159,7 +159,7 @@ public final class PackagePIFBuilder {
     }
 
     /// Records the results of applying build tool plugins to modules in the package.
-    let buildToolPluginResultsByTargetName: [String: PackagePIFBuilder.BuildToolPluginInvocationResult]
+    let buildToolPluginResultsByTargetName: [String: [PackagePIFBuilder.BuildToolPluginInvocationResult]]
 
     /// Whether to create dynamic libraries for dynamic products.
     ///
@@ -192,7 +192,7 @@ public final class PackagePIFBuilder {
         resolvedPackage: ResolvedPackage,
         packageManifest: PackageModel.Manifest,
         delegate: PackagePIFBuilder.BuildDelegate,
-        buildToolPluginResultsByTargetName: [String: BuildToolPluginInvocationResult],
+        buildToolPluginResultsByTargetName: [String: [BuildToolPluginInvocationResult]],
         createDylibForDynamicProducts: Bool = false,
         packageDisplayVersion: String?,
         fileSystem: FileSystem,
@@ -209,6 +209,28 @@ public final class PackagePIFBuilder {
         self.observabilityScope = observabilityScope
     }
 
+    public init(
+        modulesGraph: ModulesGraph,
+        resolvedPackage: ResolvedPackage,
+        packageManifest: PackageModel.Manifest,
+        delegate: PackagePIFBuilder.BuildDelegate,
+        buildToolPluginResultsByTargetName: [String: BuildToolPluginInvocationResult],
+        createDylibForDynamicProducts: Bool = false,
+        packageDisplayVersion: String?,
+        fileSystem: FileSystem,
+        observabilityScope: ObservabilityScope
+    ) {
+        self.package = resolvedPackage
+        self.packageManifest = packageManifest
+        self.modulesGraph = modulesGraph
+        self.delegate = delegate
+        self.buildToolPluginResultsByTargetName = buildToolPluginResultsByTargetName.mapValues { [$0] }
+        self.createDylibForDynamicProducts = createDylibForDynamicProducts
+        self.packageDisplayVersion = packageDisplayVersion
+        self.fileSystem = fileSystem
+        self.observabilityScope = observabilityScope
+    }
+
     /// Build an empty PIF project.
     public func buildEmptyPIF() {
         self._pifProject = PackagePIFBuilder.buildEmptyPIF(package: self.package.underlying)

Sources/SwiftBuildSupport/PackagePIFProjectBuilder.swift

@@ -380,28 +380,36 @@ struct PackagePIFProjectBuilder {
         targetKeyPath: WritableKeyPath<ProjectModel.Project, ProjectModel.Target>,
         addBuildToolPluginCommands: Bool
     ) -> (sourceFilePaths: [AbsolutePath], resourceFilePaths: [String]) {
-        guard let pluginResult = pifBuilder.buildToolPluginResultsByTargetName[module.name] else {
+        guard let pluginResults = pifBuilder.buildToolPluginResultsByTargetName[module.name] else {
             // We found no results for the target.
             return (sourceFilePaths: [], resourceFilePaths: [])
         }
 
-        // Process the results of applying any build tool plugins on the target.
-        // If we've been asked to add build tool commands for the result, we do so now.
-        if addBuildToolPluginCommands {
-            for command in pluginResult.buildCommands {
-                self.addBuildToolCommand(command, to: targetKeyPath)
+        var sourceFilePaths: [AbsolutePath] = []
+        var resourceFilePaths: [AbsolutePath] = []
+
+        for pluginResult in pluginResults {
+            // Process the results of applying any build tool plugins on the target.
+            // If we've been asked to add build tool commands for the result, we do so now.
+            if addBuildToolPluginCommands {
+                for command in pluginResult.buildCommands {
+                    self.addBuildToolCommand(command, to: targetKeyPath)
+                }
             }
-        }
 
-        // Process all the paths of derived output paths using the same rules as for source.
-        let result = self.process(
-            pluginGeneratedFilePaths: pluginResult.allDerivedOutputPaths,
-            forModule: module,
-            toolsVersion: self.package.manifest.toolsVersion
-        )
+            // Process all the paths of derived output paths using the same rules as for source.
+            let result = self.process(
+                pluginGeneratedFilePaths: pluginResult.allDerivedOutputPaths,
+                forModule: module,
+                toolsVersion: self.package.manifest.toolsVersion
+            )
+
+            sourceFilePaths.append(contentsOf: result.sourceFilePaths)
+            resourceFilePaths.append(contentsOf: result.resourceFilePaths.map(\.path))
+        }
         return (
-            sourceFilePaths: result.sourceFilePaths,
-            resourceFilePaths: result.resourceFilePaths.map(\.path.pathString)
+            sourceFilePaths: sourceFilePaths,
+            resourceFilePaths: resourceFilePaths.map(\.pathString)
         )
     }
 
@@ -414,17 +422,19 @@ struct PackagePIFProjectBuilder {
         sourceFilePaths: [AbsolutePath],
         resourceFilePaths: [String]
     ) {
-        guard let pluginResult = pifBuilder.buildToolPluginResultsByTargetName[module.name] else {
+        guard let pluginResults = pifBuilder.buildToolPluginResultsByTargetName[module.name] else {
             return
         }
 
-        for command in pluginResult.buildCommands {
-            let producesResources = Set(command.outputPaths).intersection(resourceFilePaths).hasContent
+        for pluginResult in pluginResults {
+            for command in pluginResult.buildCommands {
+                let producesResources = Set(command.outputPaths).intersection(resourceFilePaths).hasContent
 
-            if producesResources {
-                self.addBuildToolCommand(command, to: resourceBundleTargetKeyPath)
-            } else {
-                self.addBuildToolCommand(command, to: sourceModuleTargetKeyPath)
+                if producesResources {
+                    self.addBuildToolCommand(command, to: resourceBundleTargetKeyPath)
+                } else {
+                    self.addBuildToolCommand(command, to: sourceModuleTargetKeyPath)
+                }
             }
         }
     }

Tests/FunctionalTests/PluginTests.swift

@@ -204,15 +204,12 @@ final class PluginTests: XCTestCase {
             XCTAssert(stdout.contains("Build of product 'MyLocalTool' complete!"), "stdout:\n\(stdout)")
         }
 
-/*
-FIXME: Determine the cause of the compile error.
 #if os(macOS) // See https://github.com/swiftlang/swift-package-manager/issues/8416 for errors running build tools on Linux
         try await fixture(name: "Miscellaneous/Plugins") { fixturePath in
             let (stdout, _) = try await executeSwiftBuild(fixturePath.appending("ContrivedTestPlugin"), configuration: .Debug, extraArgs: ["--build-system", "swiftbuild", "--product", "MyLocalTool", "--disable-sandbox"])
             XCTAssert(stdout.contains("Build complete!"), "stdout:\n\(stdout)")
         }
 #endif
-*/
     }
 
     func testPluginScriptSandbox() async throws {
@@ -1335,5 +1332,12 @@ FIXME: Determine the cause of the compile error.
             let (stdout, _) = try await executeSwiftBuild(fixturePath)
             XCTAssert(stdout.contains("Build complete!"), "stdout:\n\(stdout)")
         }
+
+#if os(macOS) // See https://github.com/swiftlang/swift-package-manager/issues/8416 for errors running build tools on Linux
+        try await fixture(name: "Miscellaneous/Plugins/DependentPlugins") { fixturePath in
+            let (stdout, _) = try await executeSwiftBuild(fixturePath, extraArgs: ["--build-system", "swiftbuild"])
+            XCTAssert(stdout.contains("Build complete!"), "stdout:\n\(stdout)")
+        }
+#endif
     }
 }