Don't include test products in the product_memberships key of the describe command. Also fix a problem where not all products were included. (#3139)

Author: abertelrud

Sources/Commands/Describe.swift

@@ -62,15 +62,19 @@ fileprivate struct DescribedPackage: Encodable {
         self.dependencies = package.manifest.dependencies.map { DescribedPackageDependency(from: $0) }
         self.defaultLocalization = package.manifest.defaultLocalization
         self.platforms = package.manifest.platforms.map { DescribedPlatformRestriction(from: $0) }
-        self.products = package.products.map {
+        // SwiftPM considers tests to be products, which is not how things are presented in the manifest.
+        let nonTestProducts = package.products.filter{ $0.type != .test }
+        self.products = nonTestProducts.map {
             DescribedProduct(from: $0, in: package)
         }
         // Create a mapping from the targets to the products to which they contribute directly.  This excludes any
         // contributions that occur through `.product()` dependencies, but since those targets are still part of a
         // product of the package, the set of targets that contribute to products still accurately represents the
         // set of targets reachable from external clients.
-        let targetProductPairs = package.products.flatMap{ p in transitiveClosure(p.targets, successors: {
-            $0.dependencies.compactMap{ $0.target } }).map{ t in (t, p) }
+        let targetProductPairs = nonTestProducts.flatMap{ p in
+            transitiveClosure(p.targets, successors: {
+                $0.dependencies.compactMap{ $0.target }
+            }).union(p.targets).map{ t in (t, p) }
         }
         let targetsToProducts = Dictionary(targetProductPairs.map{ ($0.0, [$0.1]) }, uniquingKeysWith: { $0 + $1 })
         self.targets = package.targets.map {

Tests/CommandsTests/PackageToolTests.swift

@@ -193,6 +193,21 @@ final class PackageToolTests: XCTestCase {
     }
 
     func testDescribe() throws {
+        
+        fixture(name: "Miscellaneous/ExeTest") { prefix in
+            // Generate the JSON description.
+            let jsonResult = try SwiftPMProduct.SwiftPackage.executeProcess(["describe", "--type=json"], packagePath: prefix)
+            let jsonOutput = try jsonResult.utf8Output()
+            let json = try JSON(bytes: ByteString(encodingAsUTF8: jsonOutput))
+
+            // Check that tests don't appear in the product memberships.
+            XCTAssertEqual(json["name"]?.string, "ExeTest")
+            let jsonTarget0 = try XCTUnwrap(json["targets"]?.array?[0])
+            XCTAssertNil(jsonTarget0["product_memberships"])
+            let jsonTarget1 = try XCTUnwrap(json["targets"]?.array?[1])
+            XCTAssertEqual(jsonTarget1["product_memberships"]?.array?[0].stringValue, "Exe")
+        }
+
         fixture(name: "CFamilyTargets/SwiftCMixed") { prefix in
             // Generate the JSON description.
             let jsonResult = try SwiftPMProduct.SwiftPackage.executeProcess(["describe", "--type=json"], packagePath: prefix)
@@ -214,11 +229,13 @@ final class PackageToolTests: XCTestCase {
             XCTAssertEqual(jsonTarget1["c99name"]?.stringValue, "SeaExec")
             XCTAssertEqual(jsonTarget1["type"]?.stringValue, "executable")
             XCTAssertEqual(jsonTarget1["module_type"]?.stringValue, "SwiftTarget")
+            XCTAssertEqual(jsonTarget1["product_memberships"]?.array?[0].stringValue, "SeaExec")
             let jsonTarget2 = try XCTUnwrap(json["targets"]?.array?[2])
             XCTAssertEqual(jsonTarget2["name"]?.stringValue, "CExec")
             XCTAssertEqual(jsonTarget2["c99name"]?.stringValue, "CExec")
             XCTAssertEqual(jsonTarget2["type"]?.stringValue, "executable")
             XCTAssertEqual(jsonTarget2["module_type"]?.stringValue, "ClangTarget")
+            XCTAssertEqual(jsonTarget2["product_memberships"]?.array?[0].stringValue, "CExec")
 
             // Generate the text description.
             let textResult = try SwiftPMProduct.SwiftPackage.executeProcess(["describe", "--type=text"], packagePath: prefix)