Add tests, refine Destination and DestinationInfoV2

Author: MaxDesiatov

Sources/Commands/SwiftTool.swift

@@ -842,13 +842,13 @@ public class SwiftTool {
         }
         // Apply any manual overrides.
         if let triple = self.options.build.customCompileTriple {
-            destination.target = triple
+            destination.destinationTriple = triple
         }
         if let binDir = self.options.build.customCompileToolchain {
             destination.binDir = binDir.appending(components: "usr", "bin")
         }
         if let sdk = self.options.build.customCompileSDK {
-            destination.sdk = sdk
+            destination.sdkDir = sdk
         }
         destination.archs = options.build.archs
 

Sources/PackageModel/Destination.swift

@@ -49,13 +49,22 @@ public struct Destination: Encodable, Equatable {
     ///  - abi = eabi, gnu, android, macho, elf, etc.
     ///
     /// for more information see //https://clang.llvm.org/docs/CrossCompilation.html
-    public var target: Triple?
+    public var destinationTriple: Triple?
+
+    /// Triple describing hosts that can compile for this destination.
+    let hostTriple: Triple?
 
     /// The architectures to build for. We build for host architecture if this is empty.
     public var archs: [String] = []
 
+    /// The root SDK directory used to compile for the destination.
+    @available(*, deprecated, message: "use `sdkDir` instead")
+    public var sdk: AbsolutePath? {
+        sdkDir
+    }
+
     /// The SDK used to compile for the destination.
-    public var sdk: AbsolutePath?
+    public var sdkDir: AbsolutePath?
 
     /// The binDir in the containing the compilers/linker to be used for the compilation.
     public var binDir: AbsolutePath
@@ -82,7 +91,7 @@ public struct Destination: Encodable, Equatable {
     public let extraFlags: BuildFlags
 
     /// Creates a compilation destination with the specified properties.
-    @available(*, deprecated, message: "use `init(target:sdk:binDir:extraFlags)` instead")
+    @available(*, deprecated, message: "use `init(destinationTriple:sdk:binDir:extraFlags)` instead")
     public init(
         target: Triple? = nil,
         sdk: AbsolutePath?,
@@ -91,8 +100,9 @@ public struct Destination: Encodable, Equatable {
         extraSwiftCFlags: [String] = [],
         extraCPPFlags: [String]
     ) {
-        self.target = target
-        self.sdk = sdk
+        self.hostTriple = nil
+        self.destinationTriple = target
+        self.sdkDir = sdk
         self.binDir = binDir
         self.extraFlags = BuildFlags(
             cCompilerFlags: extraCCFlags,
@@ -103,13 +113,15 @@ public struct Destination: Encodable, Equatable {
 
     /// Creates a compilation destination with the specified properties.
     public init(
-        target: Triple? = nil,
-        sdk: AbsolutePath?,
+        hostTriple: Triple? = nil,
+        destinationTriple: Triple? = nil,
+        sdkDir: AbsolutePath?,
         binDir: AbsolutePath,
         extraFlags: BuildFlags = BuildFlags()
     ) {
-        self.target = target
-        self.sdk = sdk
+        self.hostTriple = hostTriple
+        self.destinationTriple = destinationTriple
+        self.sdkDir = sdkDir
         self.binDir = binDir
         self.extraFlags = extraFlags
     }
@@ -181,8 +193,7 @@ public struct Destination: Encodable, Equatable {
 #endif
 
         return Destination(
-            target: nil,
-            sdk: sdkPath,
+            sdkDir: sdkPath,
             binDir: binDir,
             extraFlags: BuildFlags(cCompilerFlags: extraCCFlags, swiftCompilerFlags: extraSwiftCFlags)
         )
@@ -222,8 +233,8 @@ public struct Destination: Encodable, Equatable {
                 .parentDirectory // usr
                 .appending(components: "share", "wasi-sysroot")
             return Destination(
-                target: triple,
-                sdk: wasiSysroot,
+                destinationTriple: triple,
+                sdkDir: wasiSysroot,
                 binDir: host.binDir
             )
         }
@@ -232,7 +243,7 @@ public struct Destination: Encodable, Equatable {
 }
 
 extension Destination {
-    /// Load a Destination description from a JSON representation from disk.
+    /// Load a ``Destination`` description from a JSON representation from disk.
     public init(fromFile path: AbsolutePath, fileSystem: FileSystem) throws {
         let decoder = JSONDecoder.makeWithDefaults()
         let version = try decoder.decode(path: path, fileSystem: fileSystem, as: VersionInfo.self)
@@ -242,8 +253,8 @@ extension Destination {
         case 1:
             let destination = try decoder.decode(path: path, fileSystem: fileSystem, as: DestinationInfoV1.self)
             try self.init(
-                target: destination.target.map{ try Triple($0) },
-                sdk: destination.sdk,
+                destinationTriple: destination.target.map{ try Triple($0) },
+                sdkDir: destination.sdk,
                 binDir: destination.binDir,
                 extraFlags: .init(
                     cCompilerFlags: destination.extraCCFlags,
@@ -256,8 +267,9 @@ extension Destination {
             let destinationDirectory = path.parentDirectory
 
             try self.init(
-                target: Triple(destination.destinationTriple),
-                sdk: AbsolutePath(validating: destination.sdkDir, relativeTo: destinationDirectory),
+                hostTriple: Triple(destination.hostTriple),
+                destinationTriple: Triple(destination.destinationTriple),
+                sdkDir: AbsolutePath(validating: destination.sdkDir, relativeTo: destinationDirectory),
                 binDir: AbsolutePath(validating: destination.toolchainBinDir, relativeTo: destinationDirectory),
                 extraFlags: .init(
                     cCompilerFlags: destination.extraCCFlags,

Sources/PackageModel/Manifest.swift

@@ -180,14 +180,14 @@ public final class Manifest {
         }
 
         var requiredDependencies: Set<PackageIdentity> = []
-        for target in self.targetsRequired(for: products) {
-            for targetDependency in target.dependencies {
+        for destinationTriple in self.targetsRequired(for: products) {
+            for targetDependency in destinationTriple.dependencies {
                 if let dependency = self.packageDependency(referencedBy: targetDependency) {
                     requiredDependencies.insert(dependency.identity)
                 }
             }
 
-            target.pluginUsages?.forEach {
+            destinationTriple.pluginUsages?.forEach {
                 if let dependency = self.packageDependency(referencedBy: $0) {
                     requiredDependencies.insert(dependency.identity)
                 }

Sources/PackageModel/UserToolchain.swift

@@ -258,7 +258,7 @@ public final class UserToolchain: Toolchain {
     }
 
     internal static func deriveSwiftCFlags(triple: Triple, destination: Destination, environment: EnvironmentVariables) throws -> [String] {
-        guard let sdk = destination.sdk else {
+        guard let sdkDir = destination.sdkDir else {
             if triple.isWindows() {
                 // Windows uses a variable named SDKROOT to determine the root of
                 // the SDK.  This is not the same value as the SDKROOT parameter
@@ -336,7 +336,7 @@ public final class UserToolchain: Toolchain {
         }
 
         return (triple.isDarwin() || triple.isAndroid() || triple.isWASI() || triple.isWindows()
-                ? ["-sdk", sdk.pathString]
+                ? ["-sdk", sdkDir.pathString]
                 : [])
         + destination.extraFlags.swiftCompilerFlags
     }
@@ -373,7 +373,7 @@ public final class UserToolchain: Toolchain {
         self.archs = destination.archs
 
         // Use the triple from destination or compute the host triple using swiftc.
-        var triple = destination.target ?? Triple.getHostTriple(usingSwiftCompiler: swiftCompilers.compile)
+        var triple = destination.destinationTriple ?? Triple.getHostTriple(usingSwiftCompiler: swiftCompilers.compile)
 
         self.librarianPath = try UserToolchain.determineLibrarian(triple: triple, binDir: binDir, useXcrun: useXcrun, environment: environment, searchPaths: envSearchPaths)
 
@@ -389,9 +389,9 @@ public final class UserToolchain: Toolchain {
 
         self.extraFlags.swiftCompilerFlags = try Self.deriveSwiftCFlags(triple: triple, destination: destination, environment: environment)
 
-        if let sdk = destination.sdk {
+        if let sdkDir = destination.sdkDir {
             self.extraFlags.cCompilerFlags = [
-                triple.isDarwin() ? "-isysroot" : "--sysroot", sdk.pathString
+                triple.isDarwin() ? "-isysroot" : "--sysroot", sdkDir.pathString
             ] + destination.extraFlags.cCompilerFlags
 
             self.extraFlags.cxxCompilerFlags = destination.extraFlags.cxxCompilerFlags
@@ -444,7 +444,7 @@ public final class UserToolchain: Toolchain {
             swiftCompilerFlags: self.extraFlags.swiftCompilerFlags,
             swiftCompilerEnvironment: environment,
             swiftPMLibrariesLocation: swiftPMLibrariesLocation,
-            sdkRootPath: self.destination.sdk,
+            sdkRootPath: self.destination.sdkDir,
             xctestPath: xctestPath
         )
     }
@@ -521,12 +521,12 @@ public final class UserToolchain: Toolchain {
                 return try AbsolutePath(validating: path)
             }
         } else if triple.isWindows() {
-            let sdkroot: AbsolutePath
+            let sdkRoot: AbsolutePath
 
-            if let sdk = destination.sdk {
-                sdkroot = sdk
-            } else if let SDKROOT = environment["SDKROOT"], let sdk = try? AbsolutePath(validating: SDKROOT) {
-                sdkroot = sdk
+            if let sdkDir = destination.sdkDir {
+                sdkRoot = sdkDir
+            } else if let SDKROOT = environment["SDKROOT"], let sdkDir = try? AbsolutePath(validating: SDKROOT) {
+                sdkRoot = sdkDir
             } else {
                 return .none
             }
@@ -537,7 +537,7 @@ public final class UserToolchain: Toolchain {
             // Library/Developer/Platforms/[PLATFORM].platform/Developer/SDKs/[PLATFORM].sdk/...
             //
             // SDKROOT points to [PLATFORM].sdk
-            let platform = sdkroot.parentDirectory.parentDirectory.parentDirectory
+            let platform = sdkRoot.parentDirectory.parentDirectory.parentDirectory
 
             if let info = WindowsPlatformInfo(reading: platform.appending(component: "Info.plist"),
                                               diagnostics: nil, filesystem: localFileSystem) {

Tests/BuildTests/BuildPlanTests.swift

@@ -3372,7 +3372,7 @@ final class BuildPlanTests: XCTestCase {
         XCTAssertNoDiagnostics(observability.diagnostics)
 
         let userDestination = Destination(
-            sdk: AbsolutePath(path: "/fake/sdk"),
+            sdkDir: AbsolutePath(path: "/fake/sdk"),
             binDir: try UserToolchain.default.destination.binDir,
             extraFlags: BuildFlags(
                 cCompilerFlags: ["-I/fake/sdk/sysroot", "-clang-flag-from-json"],
@@ -3400,7 +3400,7 @@ final class BuildPlanTests: XCTestCase {
       #else
         args += ["--sysroot"]
       #endif
-        args += ["\(userDestination.sdk!)", "-I/fake/sdk/sysroot", "-clang-flag-from-json", .anySequence, "-clang-command-line-flag"]
+        args += ["\(userDestination.sdkDir!)", "-I/fake/sdk/sysroot", "-clang-flag-from-json", .anySequence, "-clang-command-line-flag"]
         XCTAssertMatch(try lib.basicArguments(isCXX: false), args)
 
         let exe = try result.target(for: "exe").swiftTarget().compileArguments()

Tests/PackageModelTests/DestinationTests.swift

@@ -0,0 +1,62 @@
+//===----------------------------------------------------------------------===//
+//
+// 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 Basics
+@testable import PackageModel
+import TSCBasic
+import TSCUtility
+import XCTest
+
+private let bundleRootPath = try! AbsolutePath(validating: "/tmp/cross-toolchain")
+private let toolchainBinDir = bundleRootPath.appending(.init("swift.xctoolchain/usr/bin"))
+private let sdkRootDir = bundleRootPath.appending(.init("ubuntu-jammy.sdk"))
+private let destinationTriple = "x86_64-unknown-linux-gnu"
+private let extraFlags = BuildFlags(
+    cCompilerFlags: ["-fintegrated-as"],
+    cxxCompilerFlags: ["-fno-exceptions"],
+    swiftCompilerFlags: ["-enable-experimental-cxx-interop", "-use-ld=lld"],
+    linkerFlags: ["-R/usr/lib/swift/linux/"]
+)
+
+private let destinationV1JSON =
+    #"""
+    {
+        "version": 1,
+        "sdk": "\#(sdkRootDir)",
+        "toolchain-bin-dir": "\#(toolchainBinDir)",
+        "target": "\#(destinationTriple)",
+        "extra-cc-flags": \#(extraFlags.cCompilerFlags),
+        "extra-swiftc-flags": \#(extraFlags.swiftCompilerFlags),
+        "extra-cpp-flags": \#(extraFlags.cxxCompilerFlags)
+    }
+    """#
+
+class DestinationTests: XCTestCase {
+    func testDestinationCodable() throws {
+        let fs = InMemoryFileSystem(files: ["/sdk/destination.json": ByteString(encodingAsUTF8: destinationV1JSON)])
+
+        let destinationV1 = try Destination(fromFile: AbsolutePath(validating: "/sdk/destination.json"), fileSystem: fs)
+
+        var flagsWithoutLinkerFlags = extraFlags
+        flagsWithoutLinkerFlags.linkerFlags = []
+
+        XCTAssertEqual(
+            destinationV1,
+            Destination(
+                destinationTriple: try Triple(destinationTriple),
+                sdkDir: sdkRootDir,
+                binDir: toolchainBinDir,
+                extraFlags: flagsWithoutLinkerFlags
+            )
+        )
+    }
+}

Tests/PackageModelTests/PackageModelTests.swift

@@ -56,19 +56,19 @@ class PackageModelTests: XCTestCase {
     }
 
     func testAndroidCompilerFlags() throws {
-        let target = try Triple("x86_64-unknown-linux-android")
-        let sdk = AbsolutePath(path: "/some/path/to/an/SDK.sdk")
+        let triple = try Triple("x86_64-unknown-linux-android")
+        let sdkDir = AbsolutePath(path: "/some/path/to/an/SDK.sdk")
         let toolchainPath = AbsolutePath(path: "/some/path/to/a/toolchain.xctoolchain")
 
         let destination = Destination(
-            target: target,
-            sdk: sdk,
+            destinationTriple: triple,
+            sdkDir: sdkDir,
             binDir: toolchainPath.appending(components: "usr", "bin")
         )
 
-        XCTAssertEqual(try UserToolchain.deriveSwiftCFlags(triple: target, destination: destination, environment: .process()), [
+        XCTAssertEqual(try UserToolchain.deriveSwiftCFlags(triple: triple, destination: destination, environment: .process()), [
             // Needed when cross‐compiling for Android. 2020‐03‐01
-            "-sdk", sdk.pathString,
+            "-sdk", sdkDir.pathString,
         ])
     }
 }