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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 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
@testable import SwiftDocC
import Markdown
class MissingAbstractTests: XCTestCase, CheckerTest {
func gatherProblems(for document: Document) -> [Problem] {
var checker = MissingAbstract(sourceFile: nil)
checker.visit(document)
return checker.problems
}
func testDocumentHasAbstract() {
let source = """
# Title
This is an abstract.
"""
let document = Document(parsing: source, options: [])
let problems = gatherProblems(for: document)
XCTAssertTrue(problems.isEmpty)
}
func testDocumentHasNoContentAfterTitle() {
let document = Document(parsing: "# Title", options: [])
let problems = gatherProblems(for: document)
XCTAssertEqual(problems.count, 0)
}
func testDocumentIsEmpty() {
let document = Document(parsing: "", options: [])
let problems = gatherProblems(for: document)
XCTAssertEqual(problems.count, 0)
}
func testDocumentHasListAfterTitle() {
let source = """
# Title
- Foo
- Bar
"""
let document = Document(parsing: source, options: [])
let problems = gatherProblems(for: document)
XCTAssertEqual(problems.count, 1)
let problem = problems[0]
let title = document.child(at: 0)! as! Heading
XCTAssertEqual(problem.diagnostic.identifier, "org.swift.docc.DocumentHasNoAbstract")
XCTAssertEqual(problem.diagnostic.range, title.range)
XCTAssertEqual(problem.diagnostic.severity, .information)
}
func testDocumentHasTitleAfterTitle() {
let source = """
# Title
# Title
"""
let document = Document(parsing: source, options: [])
let problems = gatherProblems(for: document)
XCTAssertEqual(problems.count, 1)
let problem = problems[0]
let title = document.child(at: 0)! as! Heading
XCTAssertEqual(problem.diagnostic.identifier, "org.swift.docc.DocumentHasNoAbstract")
XCTAssertEqual(problem.diagnostic.range, title.range)
}
func testNoTitle() {
let document = Document(parsing: "- List item", options: [])
let problems = gatherProblems(for: document)
XCTAssertEqual(problems.count, 1)
let problem = problems[0]
let zeroLocation = SourceLocation(line: 1, column: 1, source: nil)
let endOfElementLocation = SourceLocation(line: 1, column: 12, source: nil)
XCTAssertEqual(problem.diagnostic.range, zeroLocation..<endOfElementLocation)
XCTAssertEqual(problem.diagnostic.identifier, "org.swift.docc.DocumentHasNoAbstract")
}
}
|
