Add swift-experimental-destination tool

Author: MaxDesiatov

Package.swift

@@ -368,6 +368,18 @@ let package = Package(
             exclude: ["CMakeLists.txt", "README.md"]
         ),
 
+        .target(
+            /** Interacts with cross-compilation destinations */
+            name: "CrossCompilationDestinationsTool",
+            dependencies: [
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
+                "Basics",
+                "CoreCommands",
+                "SPMBuildCore",
+                "PackageModel",
+            ]
+        ),
+
         .target(
             /** Interacts with package collections */
             name: "PackageCollectionsTool",
@@ -417,6 +429,11 @@ let package = Package(
             dependencies: ["CoreCommands"],
             exclude: ["CMakeLists.txt"]
         ),
+        .executableTarget(
+            /** Interacts with cross-compilation destinations */
+            name: "swift-experimental-destination",
+            dependencies: ["Commands", "CrossCompilationDestinationsTool"]
+        ),
         .executableTarget(
             /** Runs package tests */
             name: "swift-test",
@@ -437,7 +454,13 @@ let package = Package(
         .executableTarget(
             /** Multi-tool entry point for SwiftPM. */
             name: "swift-package-manager",
-            dependencies: ["Commands", "Basics", "PackageCollectionsTool", "PackageRegistryTool"]
+            dependencies: [
+                "Basics",
+                "Commands",
+                "CrossCompilationDestinationsTool",
+                "PackageCollectionsTool",
+                "PackageRegistryTool"
+            ]
         ),
         .executableTarget(
             /** Interact with package registry */

Sources/Commands/CMakeLists.txt

@@ -7,8 +7,6 @@
 # See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 
 add_library(Commands
-  DestinationTools/DestinationCommand.swift
-  DestinationTools/ListDestinations.swift
   PackageTools/APIDiff.swift
   PackageTools/ArchiveSource.swift
   PackageTools/CompletionTool.swift

Sources/Commands/DestinationTools/ListDestinations.swift

@@ -56,8 +56,6 @@ public struct SwiftPackageTool: ParsableCommand {
             Resolve.self,
             Fetch.self,
 
-            DestinationCommand.self,
-
             ShowDependencies.self,
             ToolsVersionCommand.self,
             ComputeChecksum.self,

Sources/Commands/PackageTools/SwiftPackageTool.swift

@@ -0,0 +1,78 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2014-2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See http://swift.org/LICENSE.txt for license information
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import ArgumentParser
+import Basics
+import CoreCommands
+import SPMBuildCore
+import PackageModel
+import TSCBasic
+
+struct ListDestinations: ParsableCommand {
+    static let configuration = CommandConfiguration(
+        commandName: "list",
+        abstract:
+            """
+            Print a list of IDs of available cross-compilation destinations available on the filesystem.
+            """
+    )
+
+    @OptionGroup()
+    var locations: LocationOptions
+
+    func run() throws {
+        let fileSystem = localFileSystem
+        let observabilitySystem = ObservabilitySystem(
+            SwiftToolObservabilityHandler(outputStream: stdoutStream, logLevel: .warning)
+        )
+        let observabilityScope = observabilitySystem.topScope
+
+        guard var destinationsDirectory = try fileSystem.getSharedCrossCompilationDestinationsDirectory(
+            explicitDirectory: locations.crossCompilationDestinationsDirectory
+        ) else {
+            let expectedPath = try fileSystem.swiftPMCrossCompilationDestinationsDirectory
+            throw StringError(
+                "Couldn't find or create a directory where cross-compilation destinations are stored: \(expectedPath)"
+            )
+        }
+
+        if !fileSystem.exists(destinationsDirectory) {
+            destinationsDirectory = try fileSystem.getOrCreateSwiftPMCrossCompilationDestinationsDirectory()
+        }
+
+        // Get absolute paths to available destination bundles.
+        let destinationBundles = try fileSystem.getDirectoryContents(destinationsDirectory).filter {
+            $0.hasSuffix(BinaryTarget.Kind.artifactsArchive.fileExtension)
+        }.map {
+            destinationsDirectory.appending(components: [$0])
+        }
+
+        // Enumerate available bundles and parse manifests for each of them, then validate supplied destinations.
+        for bundlePath in destinationBundles {
+            do {
+                let destinationsBundle = try DestinationsBundle.parseAndValidate(
+                    bundlePath: bundlePath,
+                    fileSystem: fileSystem,
+                    observabilityScope: observabilityScope
+                )
+
+                destinationsBundle.artifacts.keys.forEach { print($0) }
+            } catch {
+                observabilityScope.emit(
+                    .warning(
+                        "Couldn't parse `info.json` manifest of a destination bundle at \(bundlePath): \(error)"
+                    )
+                )
+            }
+        }
+    }
+}

Sources/CrossCompilationDestinationsTool/ListDestinations.swift

@@ -11,12 +11,14 @@
 //===----------------------------------------------------------------------===//
 
 import ArgumentParser
+import Basics
 
-public struct DestinationCommand: ParsableCommand {
-    public static var configuration = CommandConfiguration(
+public struct SwiftDestinationTool: ParsableCommand {
+    public static let configuration = CommandConfiguration(
         commandName: "experimental-destination",
-        _superCommandName: "package",
+        _superCommandName: "swift",
         abstract: "Perform operations on Swift cross-compilation destinations.",
+        version: SwiftVersion.current.completeDisplayString,
         subcommands: [
             ListDestinations.self,
         ],

Sources/Commands/DestinationTools/DestinationCommand.swift renamed to Sources/CrossCompilationDestinationsTool/SwiftDestinationCommand.swift

@@ -0,0 +1,15 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See http://swift.org/LICENSE.txt for license information
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import CrossCompilationDestinationsTool
+
+SwiftDestinationTool.main()

Sources/swift-experimental-destination/main.swift

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Commands
+import CrossCompilationDestinationsTool
 import PackageCollectionsTool
 import PackageRegistryTool
 import TSCBasic
@@ -24,6 +25,8 @@ case "swift-package":
     SwiftPackageTool.main()
 case "swift-build":
     SwiftBuildTool.main()
+case "swift-destination":
+    SwiftDestinationTool.main()
 case "swift-test":
     SwiftTestTool.main()
 case "swift-run":

Sources/swift-package-manager/main.swift

@@ -426,7 +426,7 @@ def install_swiftpm(prefix, args):
     # Install the swift-package-manager tool and create symlinks to it.
     cli_tool_dest = os.path.join(prefix, "bin")
     install_binary(args, "swift-package-manager", os.path.join(cli_tool_dest, "swift-package"), destination_is_directory=False)
-    for tool in ["swift-build", "swift-test", "swift-run", "swift-package-collection", "swift-package-registry"]:
+    for tool in ["swift-build", "swift-test", "swift-run", "swift-package-collection", "swift-package-registry", "swift-experimental-destination"]:
         src = "swift-package"
         dest = os.path.join(cli_tool_dest, tool)
         note("Creating tool symlink from %s to %s" % (src, dest))