Remove hardcoded ports in tests (#3071)

* Start removing hardcoded ports from tests * Handle tests that have port set to 0 * Remove tests that default to port 8080
vapor · Sep 22, 2023 · 8f230c6 · 8f230c6
1 parent b70d504
commit 8f230c6
Show file tree

Hide file tree

Showing 10 changed files with 137 additions and 70 deletions.
diff --git a/Sources/XCTVapor/XCTApplication.swift b/Sources/XCTVapor/XCTApplication.swift
@@ -13,6 +13,7 @@ extension Application: XCTApplicationTester {
 extension Application {
     public enum Method {
         case inMemory
+        // TODO: Default to Port 0 in the next major release
         public static var running: Method {
             return .running(hostname:"localhost", port: 8080)
         }
@@ -51,7 +52,19 @@ extension Application {
             defer { try! client.syncShutdown() }
             var path = request.url.path
             path = path.hasPrefix("/") ? path : "/\(path)"
-            var url = "http://\(self.hostname):\(self.port)\(path)"
+
+            let actualPort: Int
+
+            if self.port == 0 {
+                guard let portAllocated = app.http.server.shared.localAddress?.port else {
+                    throw Abort(.internalServerError, reason: "Failed to get port from local address")
+                }
+                actualPort = portAllocated
+            } else {
+                actualPort = self.port
+            }
+
+            var url = "http://\(self.hostname):\(actualPort)\(path)"
             if let query = request.url.query {
                 url += "?\(query)"
             }

diff --git a/Tests/AsyncTests/AsyncClientTests.swift b/Tests/AsyncTests/AsyncClientTests.swift
@@ -68,10 +68,15 @@ final class AsyncClientTests: XCTestCase {
             $0.redirect(to: "foo")
         }
 
-        try app.server.start(address: .hostname("localhost", port: 8080))
+        try app.server.start(address: .hostname("localhost", port: 0))
         defer { app.server.shutdown() }
+
+        guard let port = app.http.server.shared.localAddress?.port else {
+            XCTFail("Failed to get port for app")
+            return
+        }
 
-        let res = try await app.client.get("http://localhost:8080/redirect")
+        let res = try await app.client.get("http://localhost:\(port)/redirect")
 
         XCTAssertEqual(res.status, .seeOther)
     }
@@ -86,13 +91,18 @@ final class AsyncClientTests: XCTestCase {
             $0.redirect(to: "foo")
         }
 
-        try app.server.start(address: .hostname("localhost", port: 8080))
+        try app.server.start(address: .hostname("localhost", port: 0))
         defer { app.server.shutdown() }
+
+        guard let port = app.http.server.shared.localAddress?.port else {
+            XCTFail("Failed to get port for app")
+            return
+        }
 
-        _ = try await app.client.get("http://localhost:8080/redirect")
+        _ = try await app.client.get("http://localhost:\(port)/redirect")
 
         app.http.client.configuration.redirectConfiguration = .follow(max: 1, allowCycles: false)
-        let res = try await app.client.get("http://localhost:8080/redirect")
+        let res = try await app.client.get("http://localhost:\(port)/redirect")
         XCTAssertEqual(res.status, .seeOther)
     }
 

diff --git a/Tests/AsyncTests/AsyncRouteTests.swift b/Tests/AsyncTests/AsyncRouteTests.swift
@@ -75,7 +75,7 @@ final class AsyncRouteTests: XCTestCase {
             [testMarkerHeaderKey: testMarkerHeaderValue]
         }, onUpgrade: { _, _ in })
 
-        try app.testable(method: .running).test(.GET, "customshouldupgrade", beforeRequest: { req in
+        try app.testable(method: .running(port: 0)).test(.GET, "customshouldupgrade", beforeRequest: { req in
             req.headers.replaceOrAdd(name: HTTPHeaders.Name.secWebSocketVersion, value: "13")
             req.headers.replaceOrAdd(name: HTTPHeaders.Name.secWebSocketKey, value: "zyFJtLIpI2ASsmMHJ4Cf0A==")
             req.headers.replaceOrAdd(name: .connection, value: "Upgrade")

diff --git a/Tests/AsyncTests/AsyncWebSocketTests.swift b/Tests/AsyncTests/AsyncWebSocketTests.swift
@@ -50,7 +50,7 @@ final class AsyncWebSocketTests: XCTestCase {
         let app = Application(.testing)
         defer { app.shutdown() }
 
-        app.http.server.configuration.port = 8085
+        app.http.server.configuration.port = 0
 
         app.webSocket("bar") { req, ws in
             ws.close(promise: nil)
@@ -59,10 +59,17 @@ final class AsyncWebSocketTests: XCTestCase {
         app.environment.arguments = ["serve"]
 
         try app.start()
+
+        XCTAssertNotNil(app.http.server.shared.localAddress)
+        guard let localAddress = app.http.server.shared.localAddress,
+              let port = localAddress.port else {
+            XCTFail("couldn't get ip/port from \(app.http.server.shared.localAddress.debugDescription)")
+            return
+        }
 
         do {
             try await WebSocket.connect(
-                to: "ws://localhost:8085/foo",
+                to: "ws://localhost:\(port)/foo",
                 on: app.eventLoopGroup.next()
             ) { _ in  }
             XCTFail("should have failed")

diff --git a/Tests/VaporTests/ClientTests.swift b/Tests/VaporTests/ClientTests.swift
@@ -72,10 +72,15 @@ final class ClientTests: XCTestCase {
             $0.redirect(to: "foo")
         }
 
-        try app.server.start(address: .hostname("localhost", port: 8080))
+        try app.server.start(address: .hostname("localhost", port: 0))
         defer { app.server.shutdown() }
+
+        guard let port = app.http.server.shared.localAddress?.port else {
+            XCTFail("Failed to get port for app")
+            return
+        }
 
-        let res = try app.client.get("http://localhost:8080/redirect").wait()
+        let res = try app.client.get("http://localhost:\(port)/redirect").wait()
 
         XCTAssertEqual(res.status, .seeOther)
     }
@@ -90,13 +95,18 @@ final class ClientTests: XCTestCase {
             $0.redirect(to: "foo")
         }
 
-        try app.server.start(address: .hostname("localhost", port: 8080))
+        try app.server.start(address: .hostname("localhost", port: 0))
         defer { app.server.shutdown() }
+
+        guard let port = app.http.server.shared.localAddress?.port else {
+            XCTFail("Failed to get port for app")
+            return
+        }
 
-        _ = try app.client.get("http://localhost:8080/redirect").wait()
+        _ = try app.client.get("http://localhost:\(port)/redirect").wait()
 
         app.http.client.configuration.redirectConfiguration = .follow(max: 1, allowCycles: false)
-        let res = try app.client.get("http://localhost:8080/redirect").wait()
+        let res = try app.client.get("http://localhost:\(port)/redirect").wait()
         XCTAssertEqual(res.status, .seeOther)
     }
 

diff --git a/Tests/VaporTests/FileTests.swift b/Tests/VaporTests/FileTests.swift
@@ -19,7 +19,7 @@ final class FileTests: XCTestCase {
             }
         }
 
-        try app.testable(method: .running).test(.GET, "/file-stream") { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream") { res in
             let test = "the quick brown fox"
             XCTAssertNotNil(res.headers.first(name: .eTag))
             XCTAssertContains(res.body.string, test)
@@ -36,7 +36,7 @@ final class FileTests: XCTestCase {
 
         var headers = HTTPHeaders()
         headers.replaceOrAdd(name: .connection, value: "close")
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headers) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headers) { res in
             let test = "the quick brown fox"
             XCTAssertNotNil(res.headers.first(name: .eTag))
             XCTAssertContains(res.body.string, test)
@@ -62,7 +62,7 @@ final class FileTests: XCTestCase {
             }
         }
 
-        try app.testable(method: .running).test(.GET, "/file-stream") { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream") { res in
             XCTAssertTrue(res.body.string.isEmpty)
         }
     }
@@ -83,7 +83,7 @@ final class FileTests: XCTestCase {
 
         var headerRequest = HTTPHeaders()
         headerRequest.range = .init(unit: .bytes, ranges: [.tail(value: 20)])
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headerRequest) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headerRequest) { res in
 
             let contentRange = res.headers.first(name: "content-range")
             let contentLength = res.headers.first(name: "content-length")
@@ -114,7 +114,7 @@ final class FileTests: XCTestCase {
 
         var headerRequest = HTTPHeaders()
         headerRequest.range = .init(unit: .bytes, ranges: [.start(value: 20)])
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headerRequest) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headerRequest) { res in
 
             let contentRange = res.headers.first(name: "content-range")
             let contentLength = res.headers.first(name: "content-length")
@@ -145,7 +145,7 @@ final class FileTests: XCTestCase {
 
         var headerRequest = HTTPHeaders()
         headerRequest.range = .init(unit: .bytes, ranges: [.within(start: 20, end: 25)])
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headerRequest) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headerRequest) { res in
 
             let contentRange = res.headers.first(name: "content-range")
             let contentLength = res.headers.first(name: "content-length")
@@ -176,7 +176,7 @@ final class FileTests: XCTestCase {
 
         var headers = HTTPHeaders()
         headers.range = .init(unit: .bytes, ranges: [.within(start: 0, end: 0)])
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headers) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headers) { res in
             XCTAssertEqual(res.status, .partialContent)
 
             XCTAssertEqual(res.headers.first(name: .contentLength), "1")
@@ -203,12 +203,12 @@ final class FileTests: XCTestCase {
 
         var headerRequest = HTTPHeaders()
         headerRequest.range = .init(unit: .bytes, ranges: [.within(start: -20, end: 25)])
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headerRequest) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headerRequest) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
 
         headerRequest.range = .init(unit: .bytes, ranges: [.within(start: 10, end: 100000000)])
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headerRequest) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headerRequest) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
     }
@@ -229,12 +229,12 @@ final class FileTests: XCTestCase {
 
         var headerRequest = HTTPHeaders()
         headerRequest.range = .init(unit: .bytes, ranges: [.start(value: -20)])
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headerRequest) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headerRequest) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
 
         headerRequest.range = .init(unit: .bytes, ranges: [.start(value: 100000000)])
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headerRequest) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headerRequest) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
     }
@@ -255,12 +255,12 @@ final class FileTests: XCTestCase {
 
         var headerRequest = HTTPHeaders()
         headerRequest.range = .init(unit: .bytes, ranges: [.tail(value: -20)])
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headerRequest) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headerRequest) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
 
         headerRequest.range = .init(unit: .bytes, ranges: [.tail(value: 100000000)])
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headerRequest) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headerRequest) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
     }
@@ -404,42 +404,42 @@ final class FileTests: XCTestCase {
 
         var headers = HTTPHeaders()
         headers.replaceOrAdd(name: .range, value: "bytes=0-9223372036854775807")
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headers) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headers) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
 
         headers.replaceOrAdd(name: .range, value: "bytes=-1-10")
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headers) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headers) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
 
         headers.replaceOrAdd(name: .range, value: "bytes=100-10")
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headers) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headers) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
 
         headers.replaceOrAdd(name: .range, value: "bytes=10--100")
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headers) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headers) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
 
         headers.replaceOrAdd(name: .range, value: "bytes=9223372036854775808-")
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headers) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headers) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
 
         headers.replaceOrAdd(name: .range, value: "bytes=922337203-")
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headers) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headers) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
 
         headers.replaceOrAdd(name: .range, value: "bytes=-922337203")
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headers) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headers) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
 
         headers.replaceOrAdd(name: .range, value: "bytes=-9223372036854775808")
-        try app.testable(method: .running).test(.GET, "/file-stream", headers: headers) { res in
+        try app.testable(method: .running(port: 0)).test(.GET, "/file-stream", headers: headers) { res in
             XCTAssertEqual(res.status, .badRequest)
         }
     }