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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org 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 XCTest
import FoundationMacros
import SwiftSyntax
import SwiftSyntaxMacros
import SwiftParser
import SwiftDiagnostics
import SwiftOperators
import SwiftSyntaxMacroExpansion
#if FOUNDATION_FRAMEWORK
let foundationModuleName = "Foundation"
#else
let foundationModuleName = "FoundationEssentials"
#endif
struct DiagnosticTest : ExpressibleByStringLiteral, Hashable, CustomStringConvertible {
struct FixItTest : Hashable {
let message: String
let result: String
init(_ message: String, result: String) {
self.message = message
self.result = result
}
func matches(_ fixIt: FixIt) -> Bool {
fixIt.message.message == message && fixIt.changes.first?._result == result
}
}
let message: String
let fixIts: [FixItTest]
var description: String { message }
var mappedToExpression: Self {
DiagnosticTest(
message._replacing("Predicate", with: "Expression")._replacing("predicate", with: "expression"),
fixIts: fixIts.map {
FixItTest($0.message, result: $0.result._replacing("#Predicate", with: "#Expression"))
}
)
}
init(stringLiteral value: StringLiteralType) {
message = value
fixIts = []
}
init(_ message: String, fixIts: [FixItTest] = []) {
self.message = message
self.fixIts = fixIts
}
func matches(_ diagnostic: Diagnostic) -> Bool {
func hasProducedFixIt(_ fixIt: FixItTest) -> Bool {
diagnostic.fixIts.contains { produced in
fixIt.matches(produced)
}
}
func hasExpectedFixIt(_ fixIt: FixIt) -> Bool {
fixIts.contains { expected in
expected.matches(fixIt)
}
}
return diagnostic.debugDescription == message &&
diagnostic.fixIts.allSatisfy(hasExpectedFixIt) &&
fixIts.allSatisfy(hasProducedFixIt)
}
}
extension FixIt.Change {
fileprivate var _result: String {
switch self {
case let .replace(_, newNode):
return newNode.description
default:
return "<trivia change>"
}
}
}
extension Diagnostic {
fileprivate var _assertionDescription: String {
if fixIts.isEmpty {
return debugDescription
} else {
var result = "Message: \(debugDescription)\nFix-Its:\n"
for fixIt in fixIts {
result += "\t\(fixIt.message.message)\n\t\(fixIt.changes.first!._result.replacingOccurrences(of: "\n", with: "\n\t"))"
}
return result
}
}
}
extension DiagnosticTest {
fileprivate var _assertionDescription: String {
if fixIts.isEmpty {
return message
} else {
var result = "Message: \(message)\nFix-Its:\n"
for fixIt in fixIts {
result += "\t\(fixIt.message)\n\t\(fixIt.result.replacingOccurrences(of: "\n", with: "\n\t"))"
}
return result
}
}
}
func AssertMacroExpansion(macros: [String : Macro.Type], testModuleName: String = "TestModule", testFileName: String = "test.swift", _ source: String, _ result: String = "", diagnostics: Set<DiagnosticTest> = [], file: StaticString = #filePath, line: UInt = #line) {
let context = BasicMacroExpansionContext()
let origSourceFile = Parser.parse(source: source)
let expandedSourceFile: Syntax
do {
expandedSourceFile = try OperatorTable.standardOperators.foldAll(origSourceFile).expand(macros: macros, in: context)
} catch {
XCTFail("Operator folding on input source failed with error \(error)")
return
}
let expansionResult = expandedSourceFile.description
if !context.diagnostics.contains(where: { $0.diagMessage.severity == .error }) {
XCTAssertEqual(expansionResult, result, file: file, line: line)
}
for diagnostic in context.diagnostics {
if !diagnostics.contains(where: { $0.matches(diagnostic) }) {
XCTFail("Produced extra diagnostic:\n\(diagnostic._assertionDescription)", file: file, line: line)
}
}
for diagnostic in diagnostics {
if !context.diagnostics.contains(where: { diagnostic.matches($0) }) {
XCTFail("Failed to produce diagnostic:\n\(diagnostic._assertionDescription)", file: file, line: line)
}
}
}
func AssertPredicateExpansion(_ source: String, _ result: String = "", diagnostics: Set<DiagnosticTest> = [], file: StaticString = #filePath, line: UInt = #line) {
AssertMacroExpansion(
macros: ["Predicate": PredicateMacro.self],
source,
result,
diagnostics: diagnostics,
file: file,
line: line
)
AssertMacroExpansion(
macros: ["Expression" : FoundationMacros.ExpressionMacro.self],
source._replacing("#Predicate", with: "#Expression"),
result._replacing(".Predicate", with: ".Expression"),
diagnostics: Set(diagnostics.map(\.mappedToExpression)),
file: file,
line: line
)
}
extension String {
func _replacing(_ text: String, with other: String) -> Self {
if #available(macOS 13.0, *) {
// Use the stdlib API if available
self.replacing(text, with: other)
} else {
// Use the Foundation API on older OSes
self.replacingOccurrences(of: text, with: other, options: [.literal])
}
}
}
|
