File: SwiftSDKCommandTests.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (264 lines) | stat: -rw-r--r-- 11,999 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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2024 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
import Commands
import SPMTestSupport
import XCTest

import class Basics.AsyncProcess

private let sdkCommandDeprecationWarning = """
    warning: `swift experimental-sdk` command is deprecated and will be removed in a future version of SwiftPM. Use \
    `swift sdk` instead.

    """


final class SwiftSDKCommandTests: CommandsTestCase {
    func testUsage() async throws {
        for command in [SwiftPM.sdk, SwiftPM.experimentalSDK] {
            let stdout = try await command.execute(["-help"]).stdout
            XCTAssert(stdout.contains("USAGE: swift sdk <subcommand>") || stdout.contains("USAGE: swift sdk [<subcommand>]"), "got stdout:\n" + stdout)
        }
    }

    func testVersion() async throws {
        for command in [SwiftPM.sdk, SwiftPM.experimentalSDK] {
            let stdout = try await command.execute(["--version"]).stdout
            XCTAssert(stdout.contains("Swift Package Manager"), "got stdout:\n" + stdout)
        }
    }

    func testInstallSubcommand() async throws {
        for command in [SwiftPM.sdk, SwiftPM.experimentalSDK] {
            try await fixture(name: "SwiftSDKs") { fixturePath in
                for bundle in ["test-sdk.artifactbundle.tar.gz", "test-sdk.artifactbundle.zip"] {
                    var (stdout, stderr) = try await command.execute(
                        [
                            "install",
                            "--swift-sdks-path", fixturePath.pathString,
                            fixturePath.appending(bundle).pathString
                        ]
                    )

                    if command == .experimentalSDK {
                        XCTAssertMatch(stderr, .contains(sdkCommandDeprecationWarning))
                        XCTAssertNoMatch(stdout, .contains(sdkCommandDeprecationWarning))
                    }

                    // We only expect tool's output on the stdout stream.
                    XCTAssertMatch(
                        stdout,
                        .contains("\(bundle)` successfully installed as test-sdk.artifactbundle.")
                    )

                    (stdout, stderr) = try await command.execute(
                        ["list", "--swift-sdks-path", fixturePath.pathString])

                    if command == .experimentalSDK {
                        XCTAssertMatch(stderr, .contains(sdkCommandDeprecationWarning))
                        XCTAssertNoMatch(stdout, .contains(sdkCommandDeprecationWarning))
                    }

                    // We only expect tool's output on the stdout stream.
                    XCTAssertMatch(stdout, .contains("test-artifact"))

                    await XCTAssertAsyncThrowsError(try await command.execute(
                        [
                            "install",
                            "--swift-sdks-path", fixturePath.pathString,
                            fixturePath.appending(bundle).pathString
                        ]
                    )) { error in
                        guard case SwiftPMError.executionFailure(_, _, let stderr) = error else {
                            XCTFail()
                            return
                        }

                        XCTAssertTrue(
                            stderr.contains(
                                "Error: Swift SDK bundle with name `test-sdk.artifactbundle` is already installed. Can't install a new bundle with the same name."
                            ),
                            "got stderr: \(stderr)"
                        )
                    }

                    if command == .experimentalSDK {
                        XCTAssertMatch(stderr, .contains(sdkCommandDeprecationWarning))
                    }

                    (stdout, stderr) = try await command.execute(
                        ["remove", "--swift-sdks-path", fixturePath.pathString, "test-artifact"])

                    if command == .experimentalSDK {
                        XCTAssertMatch(stderr, .contains(sdkCommandDeprecationWarning))
                        XCTAssertNoMatch(stdout, .contains(sdkCommandDeprecationWarning))
                    }

                    // We only expect tool's output on the stdout stream.
                    XCTAssertMatch(stdout, .contains("test-sdk.artifactbundle` was successfully removed from the file system."))

                    (stdout, stderr) = try await command.execute(
                        ["list", "--swift-sdks-path", fixturePath.pathString])

                    if command == .experimentalSDK {
                        XCTAssertMatch(stderr, .contains(sdkCommandDeprecationWarning))
                        XCTAssertNoMatch(stdout, .contains(sdkCommandDeprecationWarning))
                    }

                    // We only expect tool's output on the stdout stream.
                    XCTAssertNoMatch(stdout, .contains("test-artifact"))
                }
            }
        }
    }

    func testConfigureSubcommand() async throws {
        let deprecationWarning = """
            warning: `swift sdk configuration` command is deprecated and will be removed in a future version of \
            SwiftPM. Use `swift sdk configure` instead.

            """

        for command in [SwiftPM.sdk, SwiftPM.experimentalSDK] {
            try await fixture(name: "SwiftSDKs") { fixturePath in
                let bundle = "test-sdk.artifactbundle.zip"

                var (stdout, stderr) = try await command.execute([
                    "install",
                    "--swift-sdks-path", fixturePath.pathString,
                    fixturePath.appending(bundle).pathString
                ])

                // We only expect tool's output on the stdout stream.
                XCTAssertMatch(
                    stdout,
                    .contains("\(bundle)` successfully installed as test-sdk.artifactbundle.")
                )

                let deprecatedShowSubcommand = ["configuration", "show"]

                for showSubcommand in [deprecatedShowSubcommand, ["configure", "--show-configuration"]] {
                    let invocation = showSubcommand + [
                        "--swift-sdks-path", fixturePath.pathString,
                        "test-artifact",
                        "aarch64-unknown-linux-gnu",
                    ]
                    (stdout, stderr) = try await command.execute(invocation)

                    if command == .experimentalSDK {
                        XCTAssertMatch(stderr, .contains(sdkCommandDeprecationWarning))
                    }

                    if showSubcommand == deprecatedShowSubcommand {
                        XCTAssertMatch(stderr, .contains(deprecationWarning))
                    }

                    let sdkSubpath = "test-sdk.artifactbundle/sdk/sdk"

                    XCTAssertEqual(stdout,
                        """
                        sdkRootPath: \(fixturePath.pathString)/\(sdkSubpath)
                        swiftResourcesPath: not set
                        swiftStaticResourcesPath: not set
                        includeSearchPaths: not set
                        librarySearchPaths: not set
                        toolsetPaths: not set

                        """,
                        invocation.joined(separator: " ")
                    )

                    let deprecatedSetSubcommand = ["configuration", "set"]
                    let deprecatedResetSubcommand = ["configuration", "reset"]
                    for setSubcommand in [deprecatedSetSubcommand, ["configure"]] {
                        for resetSubcommand in [deprecatedResetSubcommand, ["configure", "--reset"]] {
                            var invocation = setSubcommand + [
                                "--swift-resources-path", fixturePath.appending("foo").pathString,
                                "--swift-sdks-path", fixturePath.pathString,
                                "test-artifact",
                                "aarch64-unknown-linux-gnu",
                            ]
                            (stdout, stderr) = try await command.execute(invocation)

                            XCTAssertEqual(stdout, """
                                info: These properties of Swift SDK `test-artifact` for target triple `aarch64-unknown-linux-gnu` \
                                were successfully updated: swiftResourcesPath.

                                """,
                                invocation.joined(separator: " ")
                            )

                            if command == .experimentalSDK {
                                XCTAssertMatch(stderr, .contains(sdkCommandDeprecationWarning))
                            }

                            if setSubcommand == deprecatedSetSubcommand {
                                XCTAssertMatch(stderr, .contains(deprecationWarning))
                            }

                            invocation = showSubcommand + [
                                "--swift-sdks-path", fixturePath.pathString,
                                "test-artifact",
                                "aarch64-unknown-linux-gnu",
                            ]
                            (stdout, stderr) = try await command.execute(invocation)

                            XCTAssertEqual(stdout,
                                """
                                sdkRootPath: \(fixturePath.pathString)/\(sdkSubpath)
                                swiftResourcesPath: \(fixturePath.pathString)/foo
                                swiftStaticResourcesPath: not set
                                includeSearchPaths: not set
                                librarySearchPaths: not set
                                toolsetPaths: not set

                                """,
                                invocation.joined(separator: " ")
                            )

                            invocation = resetSubcommand + [
                                "--swift-sdks-path", fixturePath.pathString,
                                "test-artifact",
                                "aarch64-unknown-linux-gnu",
                            ]
                            (stdout, stderr) = try await command.execute(invocation)

                            if command == .experimentalSDK {
                                XCTAssertMatch(stderr, .contains(sdkCommandDeprecationWarning))
                            }

                            if resetSubcommand == deprecatedResetSubcommand {
                                XCTAssertMatch(stderr, .contains(deprecationWarning))
                            }

                            XCTAssertEqual(stdout,
                                """
                                info: All configuration properties of Swift SDK `test-artifact` for target triple `aarch64-unknown-linux-gnu` were successfully reset.

                                """,
                                invocation.joined(separator: " ")
                            )
                        }
                    }
                }

                (stdout, stderr) = try await command.execute(
                    ["remove", "--swift-sdks-path", fixturePath.pathString, "test-artifact"])

                // We only expect tool's output on the stdout stream.
                XCTAssertMatch(stdout, .contains("test-sdk.artifactbundle` was successfully removed from the file system."))
            }
        }
    }
}