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
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
///
/// This file tests `Workspace.rewriteToolsVersionSpecification(toDefaultManifestIn:specifying:fileSystem:)`.
///
import Basics
import PackageModel
@testable import Workspace
import Testing
/// Test cases for `rewriteToolsVersionSpecification(toDefaultManifestIn:specifying:fileSystem:)`
fileprivate struct ToolsVersionSpecificationRewriterTests {
struct NonVersionSpecificManifestTestData: Identifiable {
let id: String
let content: String
let version: ToolsVersion
let expected: String
}
@Test(
arguments:[
NonVersionSpecificManifestTestData(
id: "Empty file.",
content: "",
version: ToolsVersion(version: "4.1.2"),
expected: "// swift-tools-version:4.1.2\n"
),
NonVersionSpecificManifestTestData(
id: "File with just a new line.",
content: "\n",
version: ToolsVersion(version: "4.1.2"),
expected: "// swift-tools-version:4.1.2\n\n"
),
NonVersionSpecificManifestTestData(
id: "File with some contents.",
content: "let package = ... \n",
version: ToolsVersion(version: "4.1.2"),
expected: "// swift-tools-version:4.1.2\nlet package = ... \n"
),
NonVersionSpecificManifestTestData(
id: "File already having a valid version specifier.",
content: """
// swift-tools-version:3.1.2
...
""",
version: ToolsVersion(version: "4.1.2"),
expected: "// swift-tools-version:4.1.2\n..."
),
NonVersionSpecificManifestTestData(
id: "File already having a valid version specifier.",
content: """
// swift-tools-version:3.1.2
...
""",
version: ToolsVersion(version: "2.1.0"),
expected: "// swift-tools-version:2.1\n..."
),
NonVersionSpecificManifestTestData(
id: "Contents with invalid tools version specification (ignoring the validity of the version specifier).",
content: """
// swift-tool-version:3.1.2
...
""",
version: ToolsVersion(version: "4.1.2"),
expected: "// swift-tools-version:4.1.2\n// swift-tool-version:3.1.2\n..."
),
NonVersionSpecificManifestTestData(
id: "Contents with invalid version specifier.",
content: """
// swift-tools-version:3.1.2
...
""",
version: ToolsVersion(version: "4.1.2"),
expected: "// swift-tools-version:4.1.2\n..."
),
NonVersionSpecificManifestTestData(
id: "Contents with invalid version specifier and some meta data.",
content: """
// swift-tools-version:3.1.2
...
""",
version: ToolsVersion(version: "4.1.2"),
expected: "// swift-tools-version:4.1.2\n..."
),
NonVersionSpecificManifestTestData(
id: "Try to write a version with prerelease and build meta data.",
content: "let package = ... \n",
version: ToolsVersion(version: "4.1.2-alpha.beta+sha.1234"),
expected: "// swift-tools-version:4.1.2\nlet package = ... \n"
)
]
)
func nonVersionSpecificManifests(_ data: NonVersionSpecificManifestTestData) throws {
let content = data.content
let version = data.version
let expected = data.expected
let inMemoryFileSystem = InMemoryFileSystem()
let manifestFilePath = AbsolutePath("/pkg/Package.swift")
try inMemoryFileSystem.createDirectory(manifestFilePath.parentDirectory, recursive: true)
try inMemoryFileSystem.writeFileContents(manifestFilePath, string: content)
try ToolsVersionSpecificationWriter.rewriteSpecification(
manifestDirectory: manifestFilePath.parentDirectory,
toolsVersion: version,
fileSystem: inMemoryFileSystem
)
// resultHandler(try inMemoryFileSystem.readFileContents(manifestFilePath))
let actual = try #require(try inMemoryFileSystem.readFileContents(manifestFilePath))
#expect(actual.validDescription == expected, "Actual is not expected")
}
@Test
func manifestAccessFailures() throws {
let toolsVersion = ToolsVersion.v5_3
let inMemoryFileSystem = InMemoryFileSystem()
let manifestFilePath = AbsolutePath("/pkg/Package.swift/Package.swift")
try inMemoryFileSystem.createDirectory(manifestFilePath.parentDirectory, recursive: true) // /pkg/Package.swift/
// Test `ManifestAccessError.Kind.isADirectory`
#expect{
try ToolsVersionSpecificationWriter.rewriteSpecification(
manifestDirectory: manifestFilePath.parentDirectory.parentDirectory, // /pkg/
toolsVersion: toolsVersion,
fileSystem: inMemoryFileSystem
)
} throws: { error in
let error = try #require(
error as? ToolsVersionSpecificationWriter.ManifestAccessError,
"a ManifestAccessError should've been thrown"
)
let isExpectedKind = (error.kind == .isADirectory)
let isExpectedDescription = (error.description == "no accessible Swift Package Manager manifest file found at '\(manifestFilePath.parentDirectory)'; the path is a directory; a file is expected")
return isExpectedKind && isExpectedDescription
}
// Test `ManifestAccessError.Kind.noSuchFileOrDirectory`
#expect {
try ToolsVersionSpecificationWriter.rewriteSpecification(
manifestDirectory: manifestFilePath.parentDirectory, // /pkg/Package.swift/
toolsVersion: toolsVersion,
fileSystem: inMemoryFileSystem
)
} throws: { error in
let error = try #require(
error as? ToolsVersionSpecificationWriter.ManifestAccessError,
"a ManifestAccessError should've been thrown"
)
let isExpectedKind = (error.kind == .noSuchFileOrDirectory)
let isExpectedDescription = (error.description == "no accessible Swift Package Manager manifest file found at '\(manifestFilePath)'; a component of the path does not exist, or the path is an empty string")
return isExpectedKind && isExpectedDescription
}
}
// Private functions are not run in tests.
@Test
func versionSpecificManifests() throws {
}
@Test
func zeroedPatchVersion() {
#expect(ToolsVersion(version: "4.2.1").zeroedPatch.description == "4.2.0")
#expect(ToolsVersion(version: "4.2.0").zeroedPatch.description == "4.2.0")
#expect(ToolsVersion(version: "6.0.129").zeroedPatch.description == "6.0.0")
}
}
|
