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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 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 Foundation
import XCTest
@testable import SwiftDocC
import Markdown
class SnippetTests: XCTestCase {
func testNoPath() throws {
let (bundle, context) = try testBundleAndContext(named: "Snippets")
let source = """
@Snippet()
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as! BlockDirective
var problems = [Problem]()
XCTAssertNil(Snippet(from: directive, source: nil, for: bundle, in: context, problems: &problems))
XCTAssertEqual(1, problems.count)
XCTAssertEqual(.warning, problems[0].diagnostic.severity)
XCTAssertEqual("org.swift.docc.HasArgument.path", problems[0].diagnostic.identifier)
}
func testHasInnerContent() throws {
let (bundle, context) = try testBundleAndContext(named: "Snippets")
let source = """
@Snippet(path: "path/to/snippet") {
This content shouldn't be here.
}
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as! BlockDirective
var problems = [Problem]()
XCTAssertNotNil(Snippet(from: directive, source: nil, for: bundle, in: context, problems: &problems))
XCTAssertEqual(1, problems.count)
XCTAssertEqual(.warning, problems[0].diagnostic.severity)
XCTAssertEqual("org.swift.docc.Snippet.NoInnerContentAllowed", problems[0].diagnostic.identifier)
}
func testLinkResolves() throws {
let (bundle, context) = try testBundleAndContext(named: "Snippets")
let source = """
@Snippet(path: "Test/Snippets/MySnippet")
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as! BlockDirective
var problems = [Problem]()
let snippet = try XCTUnwrap(Snippet(from: directive, source: nil, for: bundle, in: context, problems: &problems))
XCTAssertEqual("Test/Snippets/MySnippet", snippet.path)
XCTAssertNotNil(snippet)
XCTAssertTrue(problems.isEmpty)
}
func testUnresolvedSnippetPathDiagnostic() throws {
let (bundle, context) = try testBundleAndContext(named: "Snippets")
let source = """
@Snippet(path: "Test/Snippets/DoesntExist")
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
var resolver = MarkupReferenceResolver(context: context, bundle: bundle, rootReference: context.rootModules[0])
_ = resolver.visit(document)
XCTAssertEqual(1, resolver.problems.count)
resolver.problems.first.map {
XCTAssertEqual("org.swift.docc.unresolvedTopicReference", $0.diagnostic.identifier)
}
}
func testSliceResolves() throws {
let (bundle, context) = try testBundleAndContext(named: "Snippets")
let source = """
@Snippet(path: "Test/Snippets/MySnippet", slice: "foo")
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as! BlockDirective
var problems = [Problem]()
let snippet = try XCTUnwrap(Snippet(from: directive, source: nil, for: bundle, in: context, problems: &problems))
XCTAssertEqual("Test/Snippets/MySnippet", snippet.path)
XCTAssertEqual("foo", snippet.slice)
XCTAssertNotNil(snippet)
XCTAssertTrue(problems.isEmpty)
}
}
|
