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
|
/*
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 Foundation
import XCTest
@testable import SwiftDocC
import Markdown
class DocumentationExtensionTests: XCTestCase {
func testEmpty() throws {
let source = "@DocumentationExtension"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let options = DocumentationExtension(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(options)
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(1, problems.count)
XCTAssertEqual("org.swift.docc.HasArgument.mergeBehavior", problems.first?.diagnostic.identifier)
}
func testAppendArgumentValue() throws {
let source = "@DocumentationExtension(mergeBehavior: append)"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let options = DocumentationExtension(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(options)
XCTAssertEqual(problems.count, 1)
XCTAssertEqual("org.swift.docc.DocumentationExtension.NoConfiguration", problems.first?.diagnostic.identifier)
XCTAssertEqual(options?.behavior, .append)
}
func testOverrideArgumentValue() throws {
let source = "@DocumentationExtension(mergeBehavior: override)"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let options = DocumentationExtension(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(options)
XCTAssertTrue(problems.isEmpty)
XCTAssertEqual(options?.behavior, .override)
}
func testUnknownArgumentValue() throws {
let source = "@DocumentationExtension(mergeBehavior: somethingUnknown )"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let options = DocumentationExtension(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(options)
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(1, problems.count)
XCTAssertEqual("org.swift.docc.HasArgument.mergeBehavior.ConversionFailed", problems.first?.diagnostic.identifier)
}
func testExtraArguments() throws {
let source = "@DocumentationExtension(mergeBehavior: override, argument: value)"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let options = DocumentationExtension(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(options, "Even if there are warnings we can create an options value")
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(1, problems.count)
XCTAssertEqual("org.swift.docc.UnknownArgument", problems.first?.diagnostic.identifier)
}
func testExtraDirective() throws {
let source = """
@DocumentationExtension(mergeBehavior: override) {
@Image
}
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let options = DocumentationExtension(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(options, "Even if there are warnings we can create a DocumentationExtension value")
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(2, problems.count)
XCTAssertEqual("org.swift.docc.HasOnlyKnownDirectives", problems.first?.diagnostic.identifier)
XCTAssertEqual("org.swift.docc.DocumentationExtension.NoInnerContentAllowed", problems.last?.diagnostic.identifier)
}
func testExtraContent() throws {
let source = """
@DocumentationExtension(mergeBehavior: override) {
Some text
}
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let options = DocumentationExtension(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(options, "Even if there are warnings we can create a DocumentationExtension value")
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(1, problems.count)
XCTAssertEqual("org.swift.docc.DocumentationExtension.NoInnerContentAllowed", problems.first?.diagnostic.identifier)
}
func testIncorrectArgumentLabel() throws {
let source = """
@DocumentationExtension(merge: override)
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0)! as! BlockDirective
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems = [Problem]()
let options = DocumentationExtension(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(options)
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(2, problems.count)
let expectedIds = [
"org.swift.docc.UnknownArgument",
"org.swift.docc.HasArgument.mergeBehavior",
]
let problemIds = problems.map(\.diagnostic.identifier)
for id in expectedIds {
XCTAssertTrue(problemIds.contains(id))
}
}
}
|
