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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2022 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 Swift project authors
*/
import XCTest
import Markdown
@testable import SwiftDocC
class NonInclusiveLanguageCheckerTests: XCTestCase {
func testMatchTermInTitle() throws {
let source = """
# A Whitelisted title
"""
let document = Document(parsing: source)
var checker = NonInclusiveLanguageChecker(sourceFile: nil)
checker.visit(document)
XCTAssertEqual(checker.problems.count, 1)
let problem = try XCTUnwrap(checker.problems.first)
let range = try XCTUnwrap(problem.diagnostic.range)
XCTAssertEqual(range.lowerBound.line, 1)
XCTAssertEqual(range.lowerBound.column, 5)
XCTAssertEqual(range.upperBound.line, 1)
XCTAssertEqual(range.upperBound.column, 16)
}
func testMatchTermWithSpaces() throws {
let source = """
# A White listed title
# A Black listed title
# A White listed title
"""
let document = Document(parsing: source)
var checker = NonInclusiveLanguageChecker(sourceFile: nil)
checker.visit(document)
XCTAssertEqual(checker.problems.count, 3)
let problem = try XCTUnwrap(checker.problems.first)
let range = try XCTUnwrap(problem.diagnostic.range)
XCTAssertEqual(range.lowerBound.line, 1)
XCTAssertEqual(range.lowerBound.column, 5)
XCTAssertEqual(range.upperBound.line, 1)
XCTAssertEqual(range.upperBound.column, 18)
let problemTwo = try XCTUnwrap(checker.problems[1])
let rangeTwo = try XCTUnwrap(problemTwo.diagnostic.range)
XCTAssertEqual(rangeTwo.lowerBound.line, 2)
XCTAssertEqual(rangeTwo.lowerBound.column, 5)
XCTAssertEqual(rangeTwo.upperBound.line, 2)
XCTAssertEqual(rangeTwo.upperBound.column, 20)
let problemThree = try XCTUnwrap(checker.problems[2])
let rangeThree = try XCTUnwrap(problemThree.diagnostic.range)
XCTAssertEqual(rangeThree.lowerBound.line, 3)
XCTAssertEqual(rangeThree.lowerBound.column, 5)
XCTAssertEqual(rangeThree.upperBound.line, 3)
XCTAssertEqual(rangeThree.upperBound.column, 17)
}
func testMatchTermInAbstract() throws {
let source = """
# Title
The blacklist is in the abstract.
"""
let document = Document(parsing: source)
var checker = NonInclusiveLanguageChecker(sourceFile: nil)
checker.visit(document)
XCTAssertEqual(checker.problems.count, 1)
let problem = try XCTUnwrap(checker.problems.first)
let range = try XCTUnwrap(problem.diagnostic.range)
XCTAssertEqual(range.lowerBound.line, 3)
XCTAssertEqual(range.lowerBound.column, 5)
XCTAssertEqual(range.upperBound.line, 3)
XCTAssertEqual(range.upperBound.column, 14)
}
func testMatchTermInParagraph() throws {
let source = """
# Title
The abstract.
## Overview
The
master branch is the default.
"""
let document = Document(parsing: source)
var checker = NonInclusiveLanguageChecker(sourceFile: nil)
checker.visit(document)
XCTAssertEqual(checker.problems.count, 1)
let problem = try XCTUnwrap(checker.problems.first)
let range = try XCTUnwrap(problem.diagnostic.range)
XCTAssertEqual(range.lowerBound.line, 8)
XCTAssertEqual(range.lowerBound.column, 1)
XCTAssertEqual(range.upperBound.line, 8)
XCTAssertEqual(range.upperBound.column, 7)
}
func testMatchTermInList() throws {
let source = """
- Item 1 is ok
- Item 2 is blacklisted
- Item 3 is ok
"""
let document = Document(parsing: source)
var checker = NonInclusiveLanguageChecker(sourceFile: nil)
checker.visit(document)
XCTAssertEqual(checker.problems.count, 1)
let problem = try XCTUnwrap(checker.problems.first)
let range = try XCTUnwrap(problem.diagnostic.range)
XCTAssertEqual(range.lowerBound.line, 2)
XCTAssertEqual(range.lowerBound.column, 13)
XCTAssertEqual(range.upperBound.line, 2)
XCTAssertEqual(range.upperBound.column, 24)
}
func testMatchTermInInlineCode() throws {
let source = """
The name `MachineSlave` is unacceptable.
"""
let document = Document(parsing: source)
var checker = NonInclusiveLanguageChecker(sourceFile: nil)
checker.visit(document)
XCTAssertEqual(checker.problems.count, 1)
let problem = try XCTUnwrap(checker.problems.first)
let range = try XCTUnwrap(problem.diagnostic.range)
XCTAssertEqual(range.lowerBound.line, 1)
XCTAssertEqual(range.lowerBound.column, 18)
XCTAssertEqual(range.upperBound.line, 1)
XCTAssertEqual(range.upperBound.column, 23)
}
func testMatchTermInCodeBlock() throws {
let source = """
A code block:
```swift
func aBlackListedFunc() {
// ...
}
```
"""
let document = Document(parsing: source)
var checker = NonInclusiveLanguageChecker(sourceFile: nil)
checker.visit(document)
XCTAssertEqual(checker.problems.count, 1)
let problem = try XCTUnwrap(checker.problems.first)
let range = try XCTUnwrap(problem.diagnostic.range)
XCTAssertEqual(range.lowerBound.line, 5)
XCTAssertEqual(range.lowerBound.column, 7)
XCTAssertEqual(range.upperBound.line, 5)
XCTAssertEqual(range.upperBound.column, 18)
}
private let nonInclusiveContent = """
# ``SideKit``
SideKit module root symbol. And here is a ~~whitelist~~:
- item one
- item two
- item three
"""
func testDisabledByDefault() throws {
// Create a test bundle with some non-inclusive content.
let (bundleURL, _, _) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:], externalResolvers: [:], externalSymbolResolver: nil, configureBundle: { url in
try self.nonInclusiveContent.write(to: url.appendingPathComponent("documentation").appendingPathComponent("sidekit.md"), atomically: true, encoding: .utf8)
})
// Load the bundle
let (_, _, context) = try loadBundle(from: bundleURL, codeListings: [:], externalResolvers: [:], externalSymbolResolver: nil, diagnosticFilterLevel: .error, configureContext: nil)
XCTAssertEqual(context.problems.count, 0)
}
func testEnablingTheChecker() throws {
// The expectations of the checker being run, depending on the diagnostic level
// set to to the documentation context for the compilation.
let expectations: [(DiagnosticSeverity, Bool)] = [
(.hint, true),
(.information, true),
(.warning, false),
(.error, false),
]
// Create a test bundle with some non-inclusive content.
let (bundleURL, _, _) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:], externalResolvers: [:], externalSymbolResolver: nil, configureBundle: { url in
try self.nonInclusiveContent.write(to: url.appendingPathComponent("documentation").appendingPathComponent("sidekit.md"), atomically: true, encoding: .utf8)
})
for expectation in expectations {
let (severity, enabled) = expectation
// Load the bundle
let (_, _, context) = try loadBundle(from: bundleURL, codeListings: [:], externalResolvers: [:], externalSymbolResolver: nil, diagnosticFilterLevel: severity, configureContext: nil)
// Verify that checker diagnostics were emitted or not, depending on the diagnostic level set.
XCTAssertEqual(context.problems.contains(where: { $0.diagnostic.identifier == "org.swift.docc.NonInclusiveLanguage" }), enabled)
}
}
}
|
