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
151
152
153
154
155
156
157
158
159
160
161
|
/*
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 SwiftDocCUtilities
@testable import SwiftDocC
import SwiftDocCTestUtilities
import ArgumentParser
class ConvertSubcommandSourceRepositoryTests: XCTestCase {
private let testBundleURL = Bundle.module.url(
forResource: "TestBundle",
withExtension: "docc",
subdirectory: "Test Bundles"
)!
private let testTemplateURL = Bundle.module.url(
forResource: "Test Template",
withExtension: nil,
subdirectory: "Test Resources"
)!
func testSourceRepositoryAllArgumentsSpecified() throws {
for sourceService in ["github", "gitlab", "bitbucket"] {
try assertSourceRepositoryArguments(
checkoutPath: "checkout path",
sourceService: sourceService,
sourceServiceBaseURL: "https://example.com/path/to/base"
) { action in
XCTAssertEqual(action.sourceRepository?.checkoutPath, "checkout path")
XCTAssertEqual(action.sourceRepository?.sourceServiceBaseURL.absoluteString, "https://example.com/path/to/base")
}
}
}
func testDoesNotSetSourceRepositoryIfBothCheckoutPathAndsourceServiceBaseURLArgumentsAreMissing() throws {
try assertSourceRepositoryArguments(
checkoutPath: nil,
sourceService: nil,
sourceServiceBaseURL: nil
) { action in
XCTAssertNil(action.sourceRepository)
}
}
func testThrowsValidationErrorWhenSourceServiceIsSpecifiedButNotSourceServiceBaseURL() throws {
XCTAssertThrowsError(
try assertSourceRepositoryArguments(
checkoutPath: nil,
sourceService: nil,
sourceServiceBaseURL: "https://example.com/path/to/base"
)
) { error in
XCTAssertEqual(
(error as? ValidationError)?.message,
"""
Missing argument '--source-service', which is required when using '--source-service-base-url' \
and '--checkout-path'.
"""
)
}
}
func testThrowsValidationErrorWhenSourceServiceBaseURLIsSpecifiedButNotSourceService() throws {
XCTAssertThrowsError(
try assertSourceRepositoryArguments(
checkoutPath: nil,
sourceService: "github",
sourceServiceBaseURL: nil
)
) { error in
XCTAssertEqual(
(error as? ValidationError)?.message,
"""
Missing argument '--source-service-base-url', which is required when using '--source-service' \
and '--checkout-path'.
"""
)
}
}
func testThrowsValidationErrorWhenSourceServiceBaseURLIsInvalid() throws {
XCTAssertThrowsError(
try assertSourceRepositoryArguments(
checkoutPath: "checkout path",
sourceService: "github",
sourceServiceBaseURL: "not a valid URL"
)
) { error in
XCTAssertEqual(
(error as? ValidationError)?.message,
"Invalid URL 'not a valid URL' for '--source-service-base-url' argument."
)
}
}
func testThrowsValidationErrorWhenCheckoutPathIsNotSpecified() throws {
XCTAssertThrowsError(
try assertSourceRepositoryArguments(
checkoutPath: nil,
sourceService: "github",
sourceServiceBaseURL: "example.com/path/to/base"
)
) { error in
XCTAssertEqual(
(error as? ValidationError)?.message,
"""
Missing argument '--checkout-path', which is required when using '--source-service' \
and '--source-service-base-url'.
"""
)
}
}
func testThrowsValidationErrorWhenSourceServiceIsInvalid() throws {
XCTAssertThrowsError(
try assertSourceRepositoryArguments(
checkoutPath: "checkout path",
sourceService: "not a supported source service",
sourceServiceBaseURL: "https://example.com/foo"
)
) { error in
XCTAssertEqual(
(error as? ValidationError)?.message,
"Unsupported source service 'not a supported source service'. Use 'github', 'gitlab', or 'bitbucket'."
)
}
}
private func assertSourceRepositoryArguments(
checkoutPath: String?,
sourceService: String?,
sourceServiceBaseURL: String?,
assertion: ((ConvertAction) throws -> Void)? = nil
) throws {
SetEnvironmentVariable(TemplateOption.environmentVariableKey, testTemplateURL.path)
var arguments: [String] = [testBundleURL.path]
if let checkoutPath {
arguments.append(contentsOf: ["--checkout-path", checkoutPath])
}
if let sourceService {
arguments.append(contentsOf: ["--source-service", sourceService])
}
if let sourceServiceBaseURL {
arguments.append(contentsOf: ["--source-service-base-url", sourceServiceBaseURL])
}
let convertOptions = try Docc.Convert.parse(arguments)
let result = try ConvertAction(fromConvertCommand: convertOptions)
try assertion?(result)
}
}
|
