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
|
/*
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
final class TestParent: Semantic, DirectiveConvertible {
static let directiveName = "Parent"
static let introducedVersion = "1.2.3"
let originalMarkup: BlockDirective
let testChildren: [TestChild]
init?(from directive: BlockDirective, source: URL?, for bundle: DocumentationBundle, in context: DocumentationContext, problems: inout [Problem]) {
precondition(TestParent.canConvertDirective(directive))
self.originalMarkup = directive
self.testChildren = directive.children.compactMap { child -> TestChild? in
guard let childDirective = child as? BlockDirective,
childDirective.name == TestChild.directiveName else {
return nil
}
return TestChild(from: directive, source: nil, for: bundle, in: context, problems: &problems)
}
}
static func canConvertDirective(_ directive: BlockDirective) -> Bool {
return directiveName == directive.name || "AlternateParent" == directive.name
}
}
final class TestChild: Semantic, DirectiveConvertible {
static let directiveName = "Child"
static let introducedVersion = "1.2.3"
let originalMarkup: BlockDirective
init?(from directive: BlockDirective, source: URL?, for bundle: DocumentationBundle, in context: DocumentationContext, problems: inout [Problem]) {
precondition(TestChild.canConvertDirective(directive))
self.originalMarkup = directive
}
static func canConvertDirective(_ directive: BlockDirective) -> Bool {
return directiveName == directive.name || "AlternateChild" == directive.name
}
}
class HasAtLeastOneTests: XCTestCase {
func testEmpty() throws {
let source = "@Parent"
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as? BlockDirective
XCTAssertNotNil(directive)
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
do {
var problems = [Problem]()
directive.map { directive in
let (matches, remainder) = Semantic.Analyses.HasAtLeastOne<TestParent, TestChild>(severityIfNotFound: .error).analyze(directive, children: directive.children, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertTrue(matches.isEmpty)
XCTAssertTrue(remainder.elements.isEmpty)
}
XCTAssertEqual(1, problems.count)
problems.first.map { problem in
XCTAssertEqual(.error, problem.diagnostic.severity)
XCTAssertEqual("org.swift.docc.HasAtLeastOne<Parent, TestChild>", problem.diagnostic.identifier)
}
}
// Test ignoring diagnostics
do {
var problems = [Problem]()
directive.map { directive in
let (matches, remainder) = Semantic.Analyses.HasAtLeastOne<TestParent, TestChild>(severityIfNotFound: nil).analyze(directive, children: directive.children, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertTrue(matches.isEmpty)
XCTAssertTrue(remainder.elements.isEmpty)
}
XCTAssertTrue(problems.isEmpty)
}
}
func testOne() throws {
let source = """
@Parent {
@Child
}
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as? BlockDirective
var problems = [Problem]()
XCTAssertNotNil(directive)
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
directive.map { directive in
let (matches, remainder) = Semantic.Analyses.HasAtLeastOne<TestParent, TestChild>(severityIfNotFound: .error).analyze(directive, children: directive.children, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertEqual(1, matches.count)
XCTAssertTrue(remainder.elements.isEmpty)
}
XCTAssertTrue(problems.isEmpty)
}
func testMany() throws {
let source = """
@Parent {
@Child
@Child
@Child
}
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as? BlockDirective
var problems = [Problem]()
XCTAssertNotNil(directive)
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
directive.map { directive in
let (matches, remainder) = Semantic.Analyses.HasAtLeastOne<TestParent, TestChild>(severityIfNotFound: .error).analyze(directive, children: directive.children, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertEqual(3, matches.count)
XCTAssertTrue(remainder.elements.isEmpty)
}
XCTAssertTrue(problems.isEmpty)
}
func testAlternateDirectiveTitle() throws {
let source = """
@AlternateParent {
@AlternateChild
}
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let directive = document.child(at: 0) as? BlockDirective
var problems = [Problem]()
XCTAssertNotNil(directive)
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
directive.map { directive in
let (matches, remainder) = Semantic.Analyses.HasAtLeastOne<TestParent, TestChild>(severityIfNotFound: .error).analyze(directive, children: directive.children, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertEqual(1, matches.count)
XCTAssertTrue(remainder.elements.isEmpty)
}
XCTAssertTrue(problems.isEmpty)
}
}
|