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
|
/*
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 XCTest
@testable import SwiftDocC
class SourceRepositoryTests: XCTestCase {
func testFormatReturnsNilIfSourceFilePrefixDoesNotMatchCheckout() {
XCTAssertNil(
SourceRepository(
checkoutPath: "/path/to/checkout",
sourceServiceBaseURL: URL(string: "https://example.com/source")!,
formatLineNumber: { _ in "" }
).format(sourceFileURL: URL(string: "file:///not/path/to/checkout/file")!),
"""
format(sourceFileURL:lineNumber:) unexpectedly returned non-nil result for source file that isn't in \
source repository's local checkout folder.
"""
)
}
func testFormatReturnsURLIfSourceFilePrefixMatchesCheckout() {
XCTAssertEqual(
SourceRepository(
checkoutPath: "/path/to/checkout",
sourceServiceBaseURL: URL(string: "https://example.com/source")!,
formatLineNumber: { _ in "" }
).format(sourceFileURL: URL(string: "file:///path/to/checkout/file")!),
URL(string: "https://example.com/source/file")!
)
}
func testFormatReturnsURLWithLineNumber() {
XCTAssertEqual(
SourceRepository(
checkoutPath: "/path/to/checkout",
sourceServiceBaseURL: URL(string: "https://example.com/source")!,
formatLineNumber: { lineNumber in "line-\(lineNumber)" }
).format(sourceFileURL: URL(string: "file:///path/to/checkout/file")!, lineNumber: 5),
URL(string: "https://example.com/source/file#line-5")!
)
}
func testGitHubFormatting() {
XCTAssertEqual(
SourceRepository
.github(
checkoutPath: "/path/to/checkout",
sourceServiceBaseURL: URL(string: "https://example.com/source")!
)
.format(sourceFileURL: URL(string: "file:///path/to/checkout/file")!, lineNumber: 5),
URL(string: "https://example.com/source/file#L5")!
)
}
func testGitLabFormatting() {
XCTAssertEqual(
SourceRepository
.gitlab(
checkoutPath: "/path/to/checkout",
sourceServiceBaseURL: URL(string: "https://example.com/source")!
)
.format(sourceFileURL: URL(string: "file:///path/to/checkout/file")!, lineNumber: 5),
URL(string: "https://example.com/source/file#L5")!
)
}
func testBitBucketFormatting() {
XCTAssertEqual(
SourceRepository
.bitbucket(
checkoutPath: "/path/to/checkout",
sourceServiceBaseURL: URL(string: "https://example.com/source")!
)
.format(sourceFileURL: URL(string: "file:///path/to/checkout/file")!, lineNumber: 5),
URL(string: "https://example.com/source/file#lines-5")!
)
}
func testLocalFileSystemFormatting() {
XCTAssertEqual(
SourceRepository.localFilesystem()
.format(sourceFileURL: URL(string: "file:///path/to/file")!, lineNumber: 5),
URL(string: "doc-source-file:///path/to/file#L5")!
)
}
}
|
