-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathSwiftSyntaxPackageParserTests.swift
More file actions
246 lines (206 loc) · 10.3 KB
/
SwiftSyntaxPackageParserTests.swift
File metadata and controls
246 lines (206 loc) · 10.3 KB
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
import Foundation
import Testing
@testable import SwiftDependencyAuditLib
@Suite("SwiftSyntaxPackageParser Tests")
struct SwiftSyntaxPackageParserTests {
@Test("Parse basic Package.swift with line numbers")
func testBasicPackageParsingWithLineNumbers() async throws {
let packageContent = """
// swift-tools-version: 6.1
import PackageDescription
let package = Package(
name: "TestPackage",
products: [
.library(name: "TestLibrary", targets: ["TestTarget"]),
.executable(name: "TestExec", targets: ["TestExec"])
],
dependencies: [
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.0.0")
],
targets: [
.target(
name: "TestTarget",
dependencies: [
.product(name: "ArgumentParser", package: "swift-argument-parser"),
"SomeOtherTarget"
]
),
.executableTarget(
name: "TestExec",
dependencies: ["TestTarget"]
),
.testTarget(
name: "TestTargetTests",
dependencies: ["TestTarget"]
)
]
)
"""
let parser = SwiftSyntaxPackageParser()
let packageInfo = try await parser.parseContent(packageContent, packageDirectory: "/tmp")
// Verify basic parsing
#expect(packageInfo.name == "TestPackage")
#expect(packageInfo.targets.count == 3)
#expect(packageInfo.products.count == 2)
#expect(packageInfo.externalDependencies.count == 1)
// Verify target details
let testTarget = packageInfo.targets.first { $0.name == "TestTarget" }
#expect(testTarget != nil)
#expect(testTarget?.type == .library)
#expect(testTarget?.dependencies.count == 2)
// Verify dependency line numbers are captured
let argumentParserDep = testTarget?.dependencyInfo.first { $0.name == "ArgumentParser" }
#expect(argumentParserDep != nil)
#expect(argumentParserDep?.lineNumber != nil)
if let lineNumber = argumentParserDep?.lineNumber {
#expect(lineNumber > 0)
}
let otherTargetDep = testTarget?.dependencyInfo.first { $0.name == "SomeOtherTarget" }
#expect(otherTargetDep != nil)
#expect(otherTargetDep?.lineNumber != nil)
if let lineNumber = otherTargetDep?.lineNumber {
#expect(lineNumber > 0)
}
// Verify products
let library = packageInfo.products.first { $0.name == "TestLibrary" }
#expect(library?.type == .library)
#expect(library?.targets == ["TestTarget"])
let executable = packageInfo.products.first { $0.name == "TestExec" }
#expect(executable?.type == .executable)
#expect(executable?.targets == ["TestExec"])
// Verify external dependencies
let externalDep = packageInfo.externalDependencies.first
#expect(externalDep?.packageName == "swift-argument-parser")
#expect(externalDep?.url == "https://github.com/apple/swift-argument-parser.git")
}
@Test("Parse package with dependency constants")
func testDependencyConstants() async throws {
let packageContent = """
// swift-tools-version: 6.1
import PackageDescription
let ArgumentParser = Target.Dependency.product(name: "ArgumentParser", package: "swift-argument-parser")
let package = Package(
name: "TestPackage",
dependencies: [
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.0.0")
],
targets: [
.target(
name: "TestTarget",
dependencies: [
ArgumentParser
]
)
]
)
"""
let parser = SwiftSyntaxPackageParser()
let packageInfo = try await parser.parseContent(packageContent, packageDirectory: "/tmp")
#expect(packageInfo.name == "TestPackage")
#expect(packageInfo.targets.count == 1)
let target = packageInfo.targets.first!
#expect(target.name == "TestTarget")
#expect(target.dependencies.count == 1)
#expect(target.dependencies.first == "ArgumentParser")
// Verify the constant was resolved correctly
let dep = target.dependencyInfo.first!
#expect(dep.name == "ArgumentParser")
#expect(dep.type.isProduct)
#expect(dep.lineNumber != nil)
}
@Test("SwiftSyntax parser handles conditional dependencies correctly - Fixes regex parser bug")
func testConditionalDependenciesFix() async throws {
let testBundle = Bundle.module
let fixtureURL = testBundle.url(
forResource: "ConditionalBugPackage", withExtension: "swift", subdirectory: "Fixtures")!
let packageContent = try String(contentsOf: fixtureURL)
// Test SwiftSyntax parser
let syntaxParser = SwiftSyntaxPackageParser()
let syntaxResult = try await syntaxParser.parseContent(packageContent, packageDirectory: "/tmp")
// Test regex parser (should demonstrate the bug)
let regexParser = PackageParser()
let regexResult = try await regexParser.parseContent(packageContent, packageDirectory: "/tmp")
#expect(syntaxResult.name == "ConditionalBugPackage")
#expect(syntaxResult.targets.count == 1)
let syntaxTarget = syntaxResult.targets.first!
let regexTarget = regexResult.targets.first!
// SwiftSyntax should correctly parse ALL dependencies including conditional ones
#expect(syntaxTarget.dependencies.count == 3, "SwiftSyntax should find all 3 dependencies")
#expect(syntaxTarget.dependencies.contains("MyModuleTV"))
#expect(syntaxTarget.dependencies.contains("RxSwift"))
#expect(syntaxTarget.dependencies.contains("AnotherProduct"))
// Demonstrate the regex parser bug (this shows why SwiftSyntax migration is valuable)
#expect(
regexTarget.dependencies.count == 1,
"Regex parser bug: only finds 1 dependency due to conditional parsing issue")
print("SwiftSyntax parser found \(syntaxTarget.dependencies.count) dependencies: \(syntaxTarget.dependencies)")
print("Regex parser found \(regexTarget.dependencies.count) dependencies: \(regexTarget.dependencies)")
}
@Test("SwiftSyntax parser does not treat Target.Dependency.target as a target declaration")
func testTargetDependencyDoesNotCreateTarget() async throws {
let testBundle = Bundle.module
let fixtureURL = testBundle.url(
forResource: "TargetDependencyTargetsArray", withExtension: "swift",
subdirectory: "Fixtures/Regression")!
let packageContent = try String(contentsOf: fixtureURL)
let parser = SwiftSyntaxPackageParser()
let packageInfo = try await parser.parseContent(packageContent, packageDirectory: "/tmp")
#expect(packageInfo.targets.count == 3)
#expect(packageInfo.targets.map(\.name).sorted() == ["Core", "Shared", "SharedUI"])
let coreTarget = packageInfo.targets.first { $0.name == "Core" }
#expect(coreTarget?.dependencies.count == 2)
#expect(coreTarget?.dependencies.contains("Shared") == true)
#expect(coreTarget?.dependencies.contains("SharedUI") == true)
}
@Test("SwiftSyntax parser ignores dependency targets inside nested unlabeled arrays")
func testNestedArrayDependencyDoesNotCreateTarget() async throws {
let testBundle = Bundle.module
let fixtureURL = testBundle.url(
forResource: "TargetDependencyNestedArray", withExtension: "swift",
subdirectory: "Fixtures/Regression")!
let packageContent = try String(contentsOf: fixtureURL)
let parser = SwiftSyntaxPackageParser()
let packageInfo = try await parser.parseContent(packageContent, packageDirectory: "/tmp")
#expect(packageInfo.targets.count == 3)
#expect(packageInfo.targets.map(\.name).sorted() == ["App", "Core", "Shared"])
}
@Test("Compare line number accuracy with regex parser")
func testLineNumberAccuracy() async throws {
let testBundle = Bundle.module
let fixtureURL = testBundle.url(
forResource: "BasicPackage", withExtension: "swift", subdirectory: "Fixtures")!
let packageContent = try String(contentsOf: fixtureURL)
// Parse with both parsers
let syntaxParser = SwiftSyntaxPackageParser()
let regexParser = PackageParser()
let syntaxResult = try await syntaxParser.parseContent(packageContent, packageDirectory: "/tmp")
let regexResult = try await regexParser.parseContent(packageContent, packageDirectory: "/tmp")
// Compare basic structure
#expect(syntaxResult.name == regexResult.name)
#expect(syntaxResult.targets.count == regexResult.targets.count)
// Compare specific dependency line numbers where available
for syntaxTarget in syntaxResult.targets {
if let regexTarget = regexResult.targets.first(where: { $0.name == syntaxTarget.name }) {
for syntaxDep in syntaxTarget.dependencyInfo {
if let regexDep = regexTarget.dependencyInfo.first(where: { $0.name == syntaxDep.name }) {
// Both should have line numbers, and they should be close (within 2 lines tolerance)
if let syntaxLine = syntaxDep.lineNumber, let regexLine = regexDep.lineNumber {
#expect(
abs(syntaxLine - regexLine) <= 2,
"Line numbers should be close: SwiftSyntax=\(syntaxLine), Regex=\(regexLine)")
}
}
}
}
}
}
}
// Helper extension for dependency type checking
extension DependencyInfo.DependencyType {
var isProduct: Bool {
switch self {
case .product: return true
case .target: return false
}
}
}