Adjust to SE-0303: Package plugins default to a "Plugins" directory next to "Sources" and "Tests"

Author: abertelrud

Fixtures/Miscellaneous/Plugins/ContrivedTestPlugin/Sources/MySourceGenBuildToolPlugin/plugin.swift renamed to Fixtures/Miscellaneous/Plugins/ContrivedTestPlugin/Plugins/MySourceGenBuildToolPlugin/plugin.swift

@@ -83,7 +83,7 @@ extension ModuleError: CustomStringConvertible {
             let packages = packages.joined(separator: "', '")
             return "multiple targets named '\(name)' in: '\(packages)'"
         case .moduleNotFound(let target, let type):
-            let folderName = type == .test ? "Tests" : "Sources"
+            let folderName = (type == .test) ? "Tests" : (type == .plugin) ? "Plugins" : "Sources"
             return "Source files for target \(target) should be located under '\(folderName)/\(target)', or a custom sources path can be set with the 'path' property in Package.swift"
         case .artifactNotFound(let target):
             return "artifact not found for target '\(target)'"
@@ -535,9 +535,12 @@ public final class PackageBuilder {
 
     /// Predefined test directories, in order of preference.
     public static let predefinedTestDirectories = ["Tests", "Sources", "Source", "src", "srcs"]
+    
+    /// Predefined plugin directories, in order of preference.
+    public static let predefinedPluginDirectories = ["Plugins"]
 
-    /// Finds the predefined directories for regular and test targets.
-    private func findPredefinedTargetDirectory() -> (targetDir: String, testTargetDir: String) {
+    /// Finds the predefined directories for regular targets, test targets, and plugin targets.
+    private func findPredefinedTargetDirectory() -> (targetDir: String, testTargetDir: String, pluginTargetDir: String) {
         let targetDir = PackageBuilder.predefinedSourceDirectories.first(where: {
             fileSystem.isDirectory(packagePath.appending(component: $0))
         }) ?? PackageBuilder.predefinedSourceDirectories[0]
@@ -546,7 +549,11 @@ public final class PackageBuilder {
             fileSystem.isDirectory(packagePath.appending(component: $0))
         }) ?? PackageBuilder.predefinedTestDirectories[0]
 
-        return (targetDir, testTargetDir)
+        let pluginTargetDir = PackageBuilder.predefinedPluginDirectories.first(where: {
+            fileSystem.isDirectory(packagePath.appending(component: $0))
+        }) ?? PackageBuilder.predefinedPluginDirectories[0]
+
+        return (targetDir, testTargetDir, pluginTargetDir)
     }
 
     struct PredefinedTargetDirectory {
@@ -566,6 +573,7 @@ public final class PackageBuilder {
 
         let predefinedTargetDirectory = PredefinedTargetDirectory(fs: fileSystem, path: packagePath.appending(component: predefinedDirs.targetDir))
         let predefinedTestTargetDirectory = PredefinedTargetDirectory(fs: fileSystem, path: packagePath.appending(component: predefinedDirs.testTargetDir))
+        let predefinedPluginTargetDirectory = PredefinedTargetDirectory(fs: fileSystem, path: packagePath.appending(component: predefinedDirs.pluginTargetDir))
 
         /// Returns the path of the given target.
         func findPath(for target: TargetDescription) throws -> AbsolutePath {
@@ -598,7 +606,15 @@ public final class PackageBuilder {
             }
 
             // Check if target is present in the predefined directory.
-            let predefinedDir = target.isTest ? predefinedTestTargetDirectory : predefinedTargetDirectory
+            let predefinedDir: PredefinedTargetDirectory
+            switch target.type {
+            case .test:
+                predefinedDir = predefinedTestTargetDirectory
+            case .plugin:
+                predefinedDir = predefinedPluginTargetDirectory
+            default:
+                predefinedDir = predefinedTargetDirectory
+            }
             let path = predefinedDir.path.appending(component: target.name)
 
             // Return the path if the predefined directory contains it.

Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Sources/MySourceGenBuildToolPlugin/plugin.swift renamed to Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Plugins/MySourceGenBuildToolPlugin/plugin.swift

@@ -2164,7 +2164,7 @@ class PackageBuilderTests: XCTestCase {
 
     func testExtensionTargetsAreGuardededByFeatureFlag() throws {
         let fs = InMemoryFileSystem(emptyFiles:
-            "/Foo/Sources/MyPlugin/plugin.swift",
+            "/Foo/Plugins/MyPlugin/plugin.swift",
             "/Foo/Sources/MyLibrary/library.swift"
         )
 

Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MySourceGenBuildToolPlugin/plugin.swift renamed to Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Plugins/MySourceGenBuildToolPlugin/plugin.swift

@@ -23,10 +23,10 @@ class PluginInvocationTests: XCTestCase {
     func testBasics() throws {
         // Construct a canned file system and package graph with a single package and a library that uses a plugin that uses a tool.
         let fileSystem = InMemoryFileSystem(emptyFiles:
+            "/Foo/Plugins/FooPlugin/source.swift",
+            "/Foo/Sources/FooTool/source.swift",
             "/Foo/Sources/Foo/source.swift",
-            "/Foo/Sources/Foo/SomeFile.abc",
-            "/Foo/Sources/FooExt/source.swift",
-            "/Foo/Sources/FooTool/source.swift"
+            "/Foo/Sources/Foo/SomeFile.abc"
         )
         let diagnostics = DiagnosticsEngine()
         let graph = try loadPackageGraph(fs: fileSystem, diagnostics: diagnostics,
@@ -46,11 +46,11 @@ class PluginInvocationTests: XCTestCase {
                     targets: [
                         TargetDescription(
                             name: "Foo",
-                            dependencies: ["FooExt"],
-                            type: .regular
+                            type: .regular,
+                            pluginUsages: [.plugin(name: "FooPlugin", package: nil)]
                         ),
                         TargetDescription(
-                            name: "FooExt",
+                            name: "FooPlugin",
                             dependencies: ["FooTool"],
                             type: .plugin,
                             pluginCapability: .buildTool
@@ -70,11 +70,11 @@ class PluginInvocationTests: XCTestCase {
         XCTAssertNoDiagnostics(diagnostics)
         PackageGraphTester(graph) { graph in
             graph.check(packages: "Foo")
-            graph.check(targets: "Foo", "FooExt", "FooTool")
+            graph.check(targets: "Foo", "FooPlugin", "FooTool")
             graph.checkTarget("Foo") { target in
-                target.check(dependencies: "FooExt")
+                target.check(dependencies: "FooPlugin")
             }
-            graph.checkTarget("FooExt") { target in
+            graph.checkTarget("FooPlugin") { target in
                 target.check(type: .plugin)
                 target.check(dependencies: "FooTool")
             }
@@ -97,7 +97,7 @@ class PluginInvocationTests: XCTestCase {
                 fileSystem: FileSystem
             ) throws -> (outputJSON: Data, stdoutText: Data) {
                 // Check that we were given the right sources.
-                XCTAssertEqual(sources.root, AbsolutePath("/Foo/Sources/FooExt"))
+                XCTAssertEqual(sources.root, AbsolutePath("/Foo/Plugins/FooPlugin"))
                 XCTAssertEqual(sources.relativePaths, [RelativePath("source.swift")])
 
                 // Deserialize and check the input.