Support Target Grouping (#6356)

Support Target Grouping
- Allow opting out of package boundary
- Default set to package boundary

Resolves rdar://107454728

Author: elsh

Fixtures/Miscellaneous/TargetGrouping/libPkg/Package.swift

@@ -0,0 +1,19 @@
+// swift-tools-version:999.0
+import PackageDescription
+
+let package = Package(
+    name: "libPkg",
+    products: [
+        .executable(name: "ExampleApp", targets: ["ExampleApp"]),
+        .library(name: "MainLib", targets: ["MainLib"]),
+    ],
+    targets: [
+        .executableTarget(name: "ExampleApp", group: .excluded, dependencies: ["MainLib"]),
+        .target(name: "MainLib", group: .package, dependencies: ["Core"]),
+        .target(name: "Core", dependencies: ["DataManager"]),
+        .target(name: "DataManager", group: .package, dependencies: ["DataModel"]),
+        .target(name: "DataModel"),
+        .testTarget(name: "MainLibTests", group: .package, dependencies: ["MainLib"]),
+        .testTarget(name: "BlackBoxTests", group: .excluded, dependencies: ["MainLib"])
+    ]
+)

Fixtures/Miscellaneous/TargetGrouping/libPkg/Sources/Core/Core.swift

@@ -0,0 +1,11 @@
+import DataManager
+
+public struct PublicCore {
+    public let publicVar: Int
+    public init(publicVar: Int) {
+        self.publicVar = publicVar
+    }
+    public func publicCoreFunc() {
+        managePublicFunc()
+    }
+}

Fixtures/Miscellaneous/TargetGrouping/libPkg/Sources/DataManager/File.swift

@@ -0,0 +1,5 @@
+import DataModel
+
+public func managePublicFunc() -> PublicData? {
+    return nil
+}

Fixtures/Miscellaneous/TargetGrouping/libPkg/Sources/DataModel/File.swift

@@ -0,0 +1 @@
+public class PublicData {}

Fixtures/Miscellaneous/TargetGrouping/libPkg/Sources/ExampleApp/main.swift

@@ -0,0 +1,3 @@
+import MainLib
+
+publicFunc()

Fixtures/Miscellaneous/TargetGrouping/libPkg/Sources/MainLib/Lib.swift

@@ -0,0 +1,6 @@
+import Core
+
+public func publicFunc() -> Int {
+    print("public decl")
+    return PublicCore(publicVar: 10).publicVar
+}

Fixtures/Miscellaneous/TargetGrouping/libPkg/Tests/BlackBoxTests/BlackBoxTests.swift

@@ -0,0 +1,9 @@
+import MainLib
+import XCTest
+
+class BlackBoxTests: XCTestCase {
+    func testBlackBox() {
+        let x = publicFunc()
+        XCTAssertTrue(x > 0)
+    }
+}

Fixtures/Miscellaneous/TargetGrouping/libPkg/Tests/MainLibTests/MainLibTests.swift

@@ -0,0 +1,9 @@
+import MainLib
+import XCTest
+
+class TestMainLib: XCTestCase {
+    func testMainLib() {
+        let x = publicFunc()
+        XCTAssertTrue(x > 0)
+    }
+}

Sources/Build/BuildDescription/SwiftTargetBuildDescription.swift

@@ -385,12 +385,19 @@ public final class SwiftTargetBuildDescription {
         try self.fileSystem.writeIfChanged(path: path, bytes: stream.bytes)
     }
 
-    private func packageNameArgumentIfSupported(with pkg: ResolvedPackage) -> [String] {
+    private func packageNameArgumentIfSupported(with pkg: ResolvedPackage, group: Target.Group) -> [String] {
+        let flag = "-package-name"
         if pkg.manifest.usePackageNameFlag,
-           driverSupport.checkToolchainDriverFlags(flags: ["package-name"], toolchain:  self.buildParameters.toolchain, fileSystem: self.fileSystem) {
-              return ["-package-name", pkg.identity.description.spm_mangledToC99ExtendedIdentifier()]
-          }
-          return []
+           driverSupport.checkToolchainDriverFlags(flags: [flag], toolchain:  self.buildParameters.toolchain, fileSystem: self.fileSystem) {
+            switch group {
+            case .package:
+                let pkgID = pkg.identity.description.spm_mangledToC99ExtendedIdentifier()
+                return [flag, pkgID]
+            case .excluded:
+                return []
+            }
+        }
+        return []
     }
 
     private func macroArguments() throws -> [String] {
@@ -513,7 +520,7 @@ public final class SwiftTargetBuildDescription {
             }
         }
 
-        args += self.packageNameArgumentIfSupported(with: self.package)
+        args += self.packageNameArgumentIfSupported(with: self.package, group: self.target.group)
         args += try self.macroArguments()
 
         return args
@@ -527,7 +534,7 @@ public final class SwiftTargetBuildDescription {
 
         result.append("-module-name")
         result.append(self.target.c99name)
-        result.append(contentsOf: packageNameArgumentIfSupported(with: self.package))
+        result.append(contentsOf: packageNameArgumentIfSupported(with: self.package, group: self.target.group))
         if !scanInvocation {
             result.append("-emit-dependencies")
 
@@ -573,7 +580,7 @@ public final class SwiftTargetBuildDescription {
         result.append("-emit-module")
         result.append("-emit-module-path")
         result.append(self.moduleOutputPath.pathString)
-        result.append(contentsOf: packageNameArgumentIfSupported(with: self.package))
+        result.append(contentsOf: packageNameArgumentIfSupported(with: self.package, group: self.target.group))
         result += self.buildParameters.toolchain.extraFlags.swiftCompilerFlags
 
         result.append("-Xfrontend")
@@ -619,7 +626,7 @@ public final class SwiftTargetBuildDescription {
 
         result.append("-module-name")
         result.append(self.target.c99name)
-        result.append(contentsOf: packageNameArgumentIfSupported(with: self.package))
+        result.append(contentsOf: packageNameArgumentIfSupported(with: self.package, group: self.target.group))
         result.append("-incremental")
         result.append("-emit-dependencies")
 

Sources/Build/BuildPlan.swift

@@ -282,6 +282,7 @@ public class BuildPlan: SPMBuildCore.BuildPlan {
 
                 let discoveryTarget = SwiftTarget(
                     name: discoveryTargetName,
+                    group: .package, // test target is allowed access to package decls by default
                     dependencies: testProduct.underlyingProduct.targets.map { .target($0, conditions: []) },
                     testDiscoverySrc: Sources(paths: discoveryPaths, root: discoveryDerivedDir)
                 )
@@ -313,6 +314,7 @@ public class BuildPlan: SPMBuildCore.BuildPlan {
 
                 let entryPointTarget = SwiftTarget(
                     name: testProduct.name,
+                    group: .package, // test target is allowed access to package decls by default
                     type: .library,
                     dependencies: testProduct.underlyingProduct.targets.map { .target($0, conditions: []) } + [.target(discoveryTarget, conditions: [])],
                     testEntryPointSources: entryPointSources
@@ -342,6 +344,7 @@ public class BuildPlan: SPMBuildCore.BuildPlan {
                         // Allow using the explicitly-specified test entry point target, but still perform test discovery and thus declare a dependency on the discovery targets.
                         let entryPointTarget = SwiftTarget(
                             name: entryPointResolvedTarget.underlyingTarget.name,
+                            group: entryPointResolvedTarget.group,
                             dependencies: entryPointResolvedTarget.underlyingTarget.dependencies + [.target(discoveryTargets.target, conditions: [])],
                             testEntryPointSources: entryPointResolvedTarget.underlyingTarget.sources
                         )
@@ -1000,12 +1003,14 @@ private extension PackageModel.SwiftTarget {
     /// Initialize a SwiftTarget representing a test entry point.
     convenience init(
         name: String,
+        group: Group,
         type: PackageModel.Target.Kind? = nil,
         dependencies: [PackageModel.Target.Dependency],
         testEntryPointSources sources: Sources
     ) {
         self.init(
             name: name,
+            group: group,
             type: type ?? .executable,
             path: .root,
             sources: sources,