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
|
/*
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 DisplayNameTests: XCTestCase {
func testEmpty() throws {
let source = "@DisplayName"
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 displayName = DisplayName(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNil(displayName)
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(1, problems.count)
XCTAssertEqual("org.swift.docc.HasArgument.unlabeled", problems.first?.diagnostic.identifier)
}
func testUnlabeledArgumentValue() throws {
let source = "@DisplayName(\"Custom Symbol Name\")"
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 displayName = DisplayName(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(displayName)
XCTAssertTrue(problems.isEmpty)
XCTAssertEqual(displayName?.style, .conceptual)
}
func testConceptualStyleArgumentValue() throws {
let source = "@DisplayName(\"Custom Symbol Name\", style: conceptual)"
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 displayName = DisplayName(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(displayName)
XCTAssertTrue(problems.isEmpty)
XCTAssertEqual(displayName?.style, .conceptual)
}
func testSymbolStyleArgumentValue() throws {
let source = "@DisplayName(\"Custom Symbol Name\", style: symbol)"
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 displayName = DisplayName(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(displayName)
XCTAssertTrue(problems.isEmpty)
XCTAssertEqual(displayName?.style, .symbol)
}
func testUnknownStyleArgumentValue() throws {
let source = "@DisplayName(\"Custom Symbol Name\", style: 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 displayName = DisplayName(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(displayName)
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(1, problems.count)
XCTAssertEqual("org.swift.docc.HasArgument.style.ConversionFailed", problems.first?.diagnostic.identifier)
}
func testExtraArguments() throws {
let source = "@DisplayName(\"Custom Symbol Name\", 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 displayName = DisplayName(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(displayName, "Even if there are warnings we can create a displayName value")
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(1, problems.count)
XCTAssertEqual("org.swift.docc.UnknownArgument", problems.first?.diagnostic.identifier)
}
func testExtraDirective() throws {
let source = """
@DisplayName(\"Custom Symbol Name\") {
@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 displayName = DisplayName(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(displayName, "Even if there are warnings we can create a DisplayName value")
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(2, problems.count)
XCTAssertEqual("org.swift.docc.HasOnlyKnownDirectives", problems.first?.diagnostic.identifier)
XCTAssertEqual("org.swift.docc.DisplayName.NoInnerContentAllowed", problems.last?.diagnostic.identifier)
}
func testExtraContent() throws {
let source = """
@DisplayName(\"Custom Symbol Name\") {
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 displayName = DisplayName(from: directive, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertNotNil(displayName, "Even if there are warnings we can create a DisplayName value")
XCTAssertFalse(problems.containsErrors)
XCTAssertEqual(1, problems.count)
XCTAssertEqual("org.swift.docc.DisplayName.NoInnerContentAllowed", problems.first?.diagnostic.identifier)
XCTAssertNotNil(problems.first?.possibleSolutions.first)
}
}
|