File: ArchitectureMappingTests.swift

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (175 lines) | stat: -rw-r--r-- 7,442 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2022-2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import Logging
@testable import SwiftSDKGenerator
import XCTest

final class ArchitectureMappingTests: XCTestCase {
  /// Swift on macOS, Swift on Linux and Debian packages all use
  /// different names for the x86 and Arm architectures:
  ///
  ///                     |  x86_64    arm64
  ///    ------------------------------------
  ///    Swift macOS      |  x86_64    arm64
  ///    Swift Linux      |  x86_64  aarch64
  ///    Debian packages  |   amd64    arm64
  ///
  /// The right names must be used in the right places, such as
  /// in download URLs and paths within the SDK bundle.   These
  /// tests check several paths and URLs for each combination
  /// of host and target architecture.
  ///
  /// At present macOS is the only supported build environment
  /// and Linux is the only supported target environment.

  public func verifySDKSpec(
    bundleVersion: String,
    hostTriple: Triple,
    targetTriple: Triple,

    artifactID: String, // Base name of the generated bundle
    hostLLVMDownloadURL: String, // URL of the host LLVM package
    targetSwiftDownloadURL: String, // URL of the target Swift SDK

    artifactBundlePathSuffix: String, // Path to the generated bundle
    sdkDirPathSuffix: String // Path of the SDK within the bundle
  ) async throws {
    let recipe = try LinuxRecipe(
      targetTriple: targetTriple,
      hostTriple: hostTriple,
      linuxDistribution: .ubuntu(.jammy),
      swiftVersion: "5.8-RELEASE",
      swiftBranch: nil,
      lldVersion: "16.0.4",
      withDocker: false,
      fromContainerImage: nil,
      hostSwiftPackagePath: nil,
      targetSwiftPackagePath: nil
    )
    // LocalSwiftSDKGenerator constructs URLs and paths which depend on architectures
    let sdk = try await SwiftSDKGenerator(
      bundleVersion: bundleVersion,

      // Linux is currently the only supported runtime environment
      targetTriple: targetTriple,
      artifactID: recipe.defaultArtifactID,
      // Remaining fields are placeholders which are the same for all
      // combinations of build and runtime architecture
      isIncremental: false,
      isVerbose: false,
      logger: Logger(label: "org.swift.swift-sdk-generator")
    )

    let sdkArtifactID = await sdk.artifactID
    XCTAssertEqual(sdkArtifactID, artifactID, "Unexpected artifactID")

    // Verify download URLs
    let artifacts = try await DownloadableArtifacts(
      hostTriple: hostTriple,
      targetTriple: sdk.targetTriple,
      recipe.versionsConfiguration,
      sdk.pathsConfiguration
    )

    // The build-time Swift SDK is a multiarch package and so is always the same
    XCTAssertEqual(
      artifacts.hostSwift.remoteURL.absoluteString,
      "https://download.swift.org/swift-5.8-release/xcode/swift-5.8-RELEASE/swift-5.8-RELEASE-osx.pkg",
      "Unexpected build-time Swift SDK URL"
    )

    // LLVM provides ld.lld
    XCTAssertEqual(
      artifacts.hostLLVM.remoteURL.absoluteString,
      hostLLVMDownloadURL,
      "Unexpected llvmDownloadURL"
    )

    // The Swift runtime must match the target architecture
    XCTAssertEqual(
      artifacts.targetSwift.remoteURL.absoluteString,
      targetSwiftDownloadURL,
      "Unexpected runtimeSwiftDownloadURL"
    )

    // Verify paths within the bundle
    let paths = await sdk.pathsConfiguration

    // The bundle path is not critical - it uses Swift's name
    // for the target architecture
    XCTAssertEqual(
      paths.artifactBundlePath.string,
      paths.sourceRoot.string + artifactBundlePathSuffix,
      "Unexpected artifactBundlePathSuffix"
    )

    // The SDK path must use Swift's name for the architecture
    XCTAssertEqual(
      recipe.sdkDirPath(paths: paths).string,
      paths.artifactBundlePath.string + sdkDirPathSuffix,
      "Unexpected sdkDirPathSuffix"
    )
  }

  func testX86ToX86SDKGenerator() async throws {
    try await self.verifySDKSpec(
      bundleVersion: "0.0.1",
      hostTriple: Triple("x86_64-apple-macosx13"),
      targetTriple: Triple("x86_64-unknown-linux-gnu"),
      artifactID: "5.8-RELEASE_ubuntu_jammy_x86_64",
      hostLLVMDownloadURL: "https://github.com/llvm/llvm-project/releases/download/llvmorg-16.0.4/clang+llvm-16.0.4-x86_64-apple-darwin22.0.tar.xz",
      targetSwiftDownloadURL: "https://download.swift.org/swift-5.8-release/ubuntu2204/swift-5.8-RELEASE/swift-5.8-RELEASE-ubuntu22.04.tar.gz",
      artifactBundlePathSuffix: "/Bundles/5.8-RELEASE_ubuntu_jammy_x86_64.artifactbundle",
      sdkDirPathSuffix: "/5.8-RELEASE_ubuntu_jammy_x86_64/x86_64-unknown-linux-gnu/ubuntu-jammy.sdk"
    )
  }

  func testX86ToArmSDKGenerator() async throws {
    try await self.verifySDKSpec(
      bundleVersion: "0.0.1",
      hostTriple: Triple("x86_64-apple-macosx13"),
      targetTriple: Triple("aarch64-unknown-linux-gnu"),
      artifactID: "5.8-RELEASE_ubuntu_jammy_aarch64",
      hostLLVMDownloadURL: "https://github.com/llvm/llvm-project/releases/download/llvmorg-16.0.4/clang+llvm-16.0.4-x86_64-apple-darwin22.0.tar.xz",
      targetSwiftDownloadURL: "https://download.swift.org/swift-5.8-release/ubuntu2204-aarch64/swift-5.8-RELEASE/swift-5.8-RELEASE-ubuntu22.04-aarch64.tar.gz",
      artifactBundlePathSuffix: "/Bundles/5.8-RELEASE_ubuntu_jammy_aarch64.artifactbundle",
      sdkDirPathSuffix: "/5.8-RELEASE_ubuntu_jammy_aarch64/aarch64-unknown-linux-gnu/ubuntu-jammy.sdk"
    )
  }

  func testArmToArmSDKGenerator() async throws {
    try await self.verifySDKSpec(
      bundleVersion: "0.0.1",
      hostTriple: Triple("arm64-apple-macosx13"),
      targetTriple: Triple("aarch64-unknown-linux-gnu"),
      artifactID: "5.8-RELEASE_ubuntu_jammy_aarch64",
      hostLLVMDownloadURL: "https://github.com/llvm/llvm-project/releases/download/llvmorg-16.0.4/clang+llvm-16.0.4-arm64-apple-darwin22.0.tar.xz",
      targetSwiftDownloadURL: "https://download.swift.org/swift-5.8-release/ubuntu2204-aarch64/swift-5.8-RELEASE/swift-5.8-RELEASE-ubuntu22.04-aarch64.tar.gz",
      artifactBundlePathSuffix: "/Bundles/5.8-RELEASE_ubuntu_jammy_aarch64.artifactbundle",
      sdkDirPathSuffix: "/5.8-RELEASE_ubuntu_jammy_aarch64/aarch64-unknown-linux-gnu/ubuntu-jammy.sdk"
    )
  }

  func testArmToX86SDKGenerator() async throws {
    try await self.verifySDKSpec(
      bundleVersion: "0.0.1",
      hostTriple: Triple("arm64-apple-macosx13"),
      targetTriple: Triple("x86_64-unknown-linux-gnu"),
      artifactID: "5.8-RELEASE_ubuntu_jammy_x86_64",
      hostLLVMDownloadURL: "https://github.com/llvm/llvm-project/releases/download/llvmorg-16.0.4/clang+llvm-16.0.4-arm64-apple-darwin22.0.tar.xz",
      targetSwiftDownloadURL: "https://download.swift.org/swift-5.8-release/ubuntu2204/swift-5.8-RELEASE/swift-5.8-RELEASE-ubuntu22.04.tar.gz",
      artifactBundlePathSuffix: "/Bundles/5.8-RELEASE_ubuntu_jammy_x86_64.artifactbundle",
      sdkDirPathSuffix: "/5.8-RELEASE_ubuntu_jammy_x86_64/x86_64-unknown-linux-gnu/ubuntu-jammy.sdk"
    )
  }
}