Skip to content

Commit e040b7b

Browse files
franklinschfranklinsch
committed
Rename makeRequestHead(path:headers:)
Renames the 'path' parameter to 'uri' since that's what it's representing.
1 parent ba9d711 commit e040b7b

File tree

5 files changed

+24
-24
lines changed

5 files changed

+24
-24
lines changed

‎Tests/SwiftDocCUtilitiesTests/PreviewServer/PreviewHTTPHandlerTests.swift

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ class PreviewHTTPHandlerTests: XCTestCase {
4343

4444
// Request a page
4545
do {
46-
let request = makeRequestHead(path: "/tutorials")
46+
let request = makeRequestHead(uri: "/tutorials")
4747
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)))
4848
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)))
4949

@@ -53,7 +53,7 @@ class PreviewHTTPHandlerTests: XCTestCase {
5353

5454
// Request an asset
5555
do {
56-
let request = makeRequestHead(path: "/css/test.css")
56+
let request = makeRequestHead(uri: "/css/test.css")
5757
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)))
5858
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)))
5959

@@ -63,7 +63,7 @@ class PreviewHTTPHandlerTests: XCTestCase {
6363

6464
// Not found error
6565
do {
66-
let request = makeRequestHead(path: "/css/notfound.css")
66+
let request = makeRequestHead(uri: "/css/notfound.css")
6767
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)))
6868
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)))
6969

@@ -73,7 +73,7 @@ class PreviewHTTPHandlerTests: XCTestCase {
7373

7474
// Passed credentials when none required
7575
do {
76-
let request = makeRequestHead(path: "/tutorials", headers: [("Authorization", "Basic \("USER:PASS".data(using: .utf8)!.base64EncodedString())")])
76+
let request = makeRequestHead(uri: "/tutorials", headers: [("Authorization", "Basic \("USER:PASS".data(using: .utf8)!.base64EncodedString())")])
7777
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)))
7878
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)))
7979

@@ -109,7 +109,7 @@ class PreviewHTTPHandlerTests: XCTestCase {
109109

110110
// Request page without credentials
111111
do {
112-
let request = makeRequestHead(path: "/tutorials")
112+
let request = makeRequestHead(uri: "/tutorials")
113113
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)))
114114
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)))
115115

@@ -119,7 +119,7 @@ class PreviewHTTPHandlerTests: XCTestCase {
119119

120120
// Request asset without credentials, e.g. verify we authorize before serving content
121121
do {
122-
let request = makeRequestHead(path: "/css/test.css")
122+
let request = makeRequestHead(uri: "/css/test.css")
123123
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)))
124124
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)))
125125

@@ -129,7 +129,7 @@ class PreviewHTTPHandlerTests: XCTestCase {
129129

130130
// Request error without credentials, e.g. verify we authorize before error handler
131131
do {
132-
let request = makeRequestHead(path: "/css/notfound.css")
132+
let request = makeRequestHead(uri: "/css/notfound.css")
133133
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)))
134134
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)))
135135

@@ -139,7 +139,7 @@ class PreviewHTTPHandlerTests: XCTestCase {
139139

140140
// Request with valid credentials
141141
do {
142-
let request = makeRequestHead(path: "/tutorials", headers: [("Authorization", "Basic \("user:pass".data(using: .utf8)!.base64EncodedString())")])
142+
let request = makeRequestHead(uri: "/tutorials", headers: [("Authorization", "Basic \("user:pass".data(using: .utf8)!.base64EncodedString())")])
143143
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)))
144144
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)))
145145

@@ -149,7 +149,7 @@ class PreviewHTTPHandlerTests: XCTestCase {
149149

150150
// Request error with valid credentials
151151
do {
152-
let request = makeRequestHead(path: "/css/notfound.css", headers: [("Authorization", "Basic \("user:pass".data(using: .utf8)!.base64EncodedString())")])
152+
let request = makeRequestHead(uri: "/css/notfound.css", headers: [("Authorization", "Basic \("user:pass".data(using: .utf8)!.base64EncodedString())")])
153153
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)))
154154
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)))
155155

@@ -159,7 +159,7 @@ class PreviewHTTPHandlerTests: XCTestCase {
159159

160160
// Request with invalid credentials
161161
do {
162-
let request = makeRequestHead(path: "/tutorials", headers: [("Authorization", "Basic \("USER:PASS".data(using: .utf8)!.base64EncodedString())")])
162+
let request = makeRequestHead(uri: "/tutorials", headers: [("Authorization", "Basic \("USER:PASS".data(using: .utf8)!.base64EncodedString())")])
163163
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.head(request)))
164164
XCTAssertNoThrow(try channel.writeInbound(HTTPServerRequestPart.end(nil)))
165165

‎Tests/SwiftDocCUtilitiesTests/PreviewServer/RequestHandler/DefaultRequestHandlerTests.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class DefaultRequestHandlerTests: XCTestCase {
2525
])
2626

2727
// Default handler should be invoked for any non-asset path
28-
let request = makeRequestHead(path: "/random-path")
28+
let request = makeRequestHead(uri: "/random-path")
2929
let factory = DefaultRequestHandler(rootURL: tempFolderURL)
3030
let response = try responseWithPipeline(request: request, handler: factory)
3131

@@ -48,7 +48,7 @@ class DefaultRequestHandlerTests: XCTestCase {
4848
])
4949

5050
// Default handler should handle even paths that do exist on disc
51-
let request = makeRequestHead(path: "/existing.html")
51+
let request = makeRequestHead(uri: "/existing.html")
5252
let factory = DefaultRequestHandler(rootURL: tempFolderURL)
5353
let response = try responseWithPipeline(request: request, handler: factory)
5454

‎Tests/SwiftDocCUtilitiesTests/PreviewServer/RequestHandler/ErrorRequestHandlerTests.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import NIOHTTP1
1818

1919
class ErrorRequestHandlerTests: XCTestCase {
2020
func testErrorHandlerDefault() throws {
21-
let request = makeRequestHead(path: "/random-path")
21+
let request = makeRequestHead(uri: "/random-path")
2222
let factory = ErrorRequestHandler()
2323
let response = try responseWithPipeline(request: request, handler: factory)
2424

@@ -27,7 +27,7 @@ class ErrorRequestHandlerTests: XCTestCase {
2727
}
2828

2929
func testErrorHandlerStatus() throws {
30-
let request = makeRequestHead(path: "/random-path")
30+
let request = makeRequestHead(uri: "/random-path")
3131
let factory = ErrorRequestHandler(error: RequestError(status: .notFound))
3232
let response = try responseWithPipeline(request: request, handler: factory)
3333

@@ -36,7 +36,7 @@ class ErrorRequestHandlerTests: XCTestCase {
3636
}
3737

3838
func testErrorHandlerCustomHeader() throws {
39-
let request = makeRequestHead(path: "/random-path")
39+
let request = makeRequestHead(uri: "/random-path")
4040
let factory = ErrorRequestHandler(error: RequestError(status: .notFound), headers: [("Name", "Value")])
4141
let response = try responseWithPipeline(request: request, handler: factory)
4242

@@ -46,7 +46,7 @@ class ErrorRequestHandlerTests: XCTestCase {
4646
}
4747

4848
func testErrorHandlerCustomHeaderCustomMessage() throws {
49-
let request = makeRequestHead(path: "/random-path")
49+
let request = makeRequestHead(uri: "/random-path")
5050
let factory = ErrorRequestHandler(error: RequestError(status: .notFound, message: "Message!"))
5151
let response = try responseWithPipeline(request: request, handler: factory)
5252

‎Tests/SwiftDocCUtilitiesTests/PreviewServer/RequestHandler/FileRequestHandlerTests.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class FileRequestHandlerTests: XCTestCase {
2121
let fileIO = NonBlockingFileIO(threadPool: NIOThreadPool(numberOfThreads: 2))
2222

2323
private func verifyAsset(root: URL, path: String, body: String, type: String, file: StaticString = #file, line: UInt = #line) throws {
24-
let request = makeRequestHead(path: path)
24+
let request = makeRequestHead(uri: path)
2525
let factory = FileRequestHandler(rootURL: root, fileIO: fileIO)
2626
let response = try responseWithPipeline(request: request, handler: factory)
2727

@@ -95,7 +95,7 @@ class FileRequestHandlerTests: XCTestCase {
9595
func testFileHandlerAssetsMissing() throws {
9696
let tempFolderURL = try createTempFolder(content: [])
9797

98-
let request = makeRequestHead(path: "/css/b00011100.css")
98+
let request = makeRequestHead(uri: "/css/b00011100.css")
9999
let factory = FileRequestHandler(rootURL: tempFolderURL, fileIO: fileIO)
100100
let response = try responseWithPipeline(request: request, handler: factory)
101101

@@ -109,7 +109,7 @@ class FileRequestHandlerTests: XCTestCase {
109109
])
110110
])
111111

112-
let request = makeRequestHead(path: "/videos/video.mov", headers: [("Range", "bytes=0-1")])
112+
let request = makeRequestHead(uri: "/videos/video.mov", headers: [("Range", "bytes=0-1")])
113113
let factory = FileRequestHandler(rootURL: tempFolderURL, fileIO: fileIO)
114114
let response = try responseWithPipeline(request: request, handler: factory)
115115

@@ -128,7 +128,7 @@ class FileRequestHandlerTests: XCTestCase {
128128
])
129129
])
130130

131-
let request = makeRequestHead(path: "/videos/../video.mov", headers: [("Range", "bytes=0-1")])
131+
let request = makeRequestHead(uri: "/videos/../video.mov", headers: [("Range", "bytes=0-1")])
132132
let factory = FileRequestHandler(rootURL: tempFolderURL, fileIO: fileIO)
133133
let response = try responseWithPipeline(request: request, handler: factory)
134134

@@ -143,7 +143,7 @@ class FileRequestHandlerTests: XCTestCase {
143143
])
144144
])
145145

146-
let request = makeRequestHead(path: "/videos/. ? ? ? ./video.mov", headers: [("Range", "bytes=0-1")])
146+
let request = makeRequestHead(uri: "/videos/. ? ? ? ./video.mov", headers: [("Range", "bytes=0-1")])
147147
let factory = FileRequestHandler(rootURL: tempFolderURL, fileIO: fileIO)
148148
let response = try responseWithPipeline(request: request, handler: factory)
149149

‎Tests/SwiftDocCUtilitiesTests/PreviewServer/ServerTestUtils.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ import NIOHTTP1
1414
import XCTest
1515
@testable import SwiftDocCUtilities
1616

17-
/// Makes a request head part with the given path and headers.
18-
func makeRequestHead(path: String, headers: [(String, String)]? = nil) -> HTTPRequestHead {
19-
var head = HTTPRequestHead(version: .init(major: 1, minor: 1), method: .GET, uri: path)
17+
/// Makes a request head part with the given URI and headers.
18+
func makeRequestHead(uri: String, headers: [(String, String)]? = nil) -> HTTPRequestHead {
19+
var head = HTTPRequestHead(version: .init(major: 1, minor: 1), method: .GET, uri: uri)
2020
if let headers = headers {
2121
for header in headers {
2222
head.headers.add(name: header.0, value: header.1)

0 commit comments

Comments
 (0)