File: TutorialReferenceTests.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (68 lines) | stat: -rw-r--r-- 2,911 bytes parent folder | download
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
/*
 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 TutorialReferenceTests: XCTestCase {
    func testEmpty() throws {
        let source = """
@TutorialReference
"""
        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 tutorialReference = TutorialReference(from: directive, source: nil, for: bundle, in: context, problems: &problems)
        XCTAssertNil(tutorialReference)
        XCTAssertEqual(1, problems.count)
        problems.first.map { problem in
            XCTAssertEqual("org.swift.docc.HasArgument.tutorial", problem.diagnostic.identifier)
            XCTAssertEqual(.warning, problem.diagnostic.severity)
        }
    }
    
    func testValid() throws {
        let tutorialLink = "doc:MyTutorial"
        let source = """
@TutorialReference(tutorial: "\(tutorialLink)")
"""
        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 tutorialReference = TutorialReference(from: directive, source: nil, for: bundle, in: context, problems: &problems)
        XCTAssertNotNil(tutorialReference)
        tutorialReference.map { tutorialReference in
            guard case let .unresolved(unresolved) = tutorialReference.topic else {
                fatalError()
            }
            XCTAssertEqual(ValidatedURL(parsingExact: tutorialLink), unresolved.topicURL)
        }
        XCTAssertTrue(problems.isEmpty)
    }
    
    func testMissingPath() throws {
        let tutorialLink = "doc:"
        let source = """
        @TutorialReference(tutorial: "\(tutorialLink)")
        """
        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 tutorialReference = TutorialReference(from: directive, source: nil, for: bundle, in: context, problems: &problems)
        XCTAssertNil(tutorialReference)
        XCTAssertEqual(problems.count, 1)
        let problem = try XCTUnwrap(problems.first)
        XCTAssertEqual("org.swift.docc.HasArgument.tutorial.ConversionFailed", problem.diagnostic.identifier)
    }
}