test(headers): standardize client setup in header tests

Author: donnywals

Tests/TUSKitTests/TUSClient/TUSClient_HeaderGenerationTests.swift

@@ -36,8 +36,7 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
 
     /// Verifies the generator receives exactly the caller supplied custom headers and the upload identifier for correlation.
     func testGenerateHeadersReceivesOnlyCallerSuppliedHeaders() throws {
-        let configuration = URLSessionConfiguration.default
-        configuration.protocolClasses = [MockURLProtocol.self]
+        let configuration = makeConfiguration()
 
         let expectedHeaders = [
             "Authorization": "Bearer token",
@@ -47,19 +46,12 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
         var receivedRequestID: UUID?
         let generatorCalled = expectation(description: "Header generator called")
 
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { requestID, headers, onHeadersGenerated in
-                receivedRequestID = requestID
-                receivedHeaders = headers
-                onHeadersGenerated(headers)
-                generatorCalled.fulfill()
-            }
-        )
+        client = try makeClient(configuration: configuration) { requestID, headers, onHeadersGenerated in
+            receivedRequestID = requestID
+            receivedHeaders = headers
+            onHeadersGenerated(headers)
+            generatorCalled.fulfill()
+        }
         client.delegate = tusDelegate
 
         let uploadID = try client.upload(data: data, customHeaders: expectedHeaders)
@@ -71,23 +63,15 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
 
     /// Verifies we don't bother clients when there are no custom headers to override.
     func testGenerateHeadersNotCalledWhenNoCustomHeaders() throws {
-        let configuration = URLSessionConfiguration.default
-        configuration.protocolClasses = [MockURLProtocol.self]
+        let configuration = makeConfiguration()
 
         let generatorNotCalled = expectation(description: "Header generator should not be invoked")
         generatorNotCalled.isInverted = true
 
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { _, _, onHeadersGenerated in
-                generatorNotCalled.fulfill()
-                onHeadersGenerated([:])
-            }
-        )
+        client = try makeClient(configuration: configuration) { _, _, onHeadersGenerated in
+            generatorNotCalled.fulfill()
+            onHeadersGenerated([:])
+        }
         client.delegate = tusDelegate
 
         XCTAssertNoThrow(try client.upload(data: data))
@@ -96,8 +80,7 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
 
     /// Ensures the generator receives the headers that were actually used on the previous request when retrying.
     func testGenerateHeadersReceivesLastAppliedValuesOnAutomaticRetry() throws {
-        let configuration = URLSessionConfiguration.default
-        configuration.protocolClasses = [MockURLProtocol.self]
+        let configuration = makeConfiguration()
 
         prepareNetworkForSuccesfulUploads(data: data)
         prepareNetworkForFailingUploads()
@@ -110,23 +93,16 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
         let uploadFailed = expectation(description: "Upload should fail after retries")
         tusDelegate.uploadFailedExpectation = uploadFailed
 
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { _, headers, onHeadersGenerated in
-                let current = headers["Authorization"] ?? ""
-                receivedAuthorizationHeaders.append(current)
-                let nextValue = current.isEmpty ? "Bearer mutated\(receivedAuthorizationHeaders.count)" : "\(current)-mutated\(receivedAuthorizationHeaders.count - 1)"
-                onHeadersGenerated(["Authorization": nextValue])
-                if trackedCalls < 2 {
-                    generatorCalledTwice.fulfill()
-                }
-                trackedCalls += 1
+        client = try makeClient(configuration: configuration) { _, headers, onHeadersGenerated in
+            let current = headers["Authorization"] ?? ""
+            receivedAuthorizationHeaders.append(current)
+            let nextValue = current.isEmpty ? "Bearer mutated\(receivedAuthorizationHeaders.count)" : "\(current)-mutated\(receivedAuthorizationHeaders.count - 1)"
+            onHeadersGenerated(["Authorization": nextValue])
+            if trackedCalls < 2 {
+                generatorCalledTwice.fulfill()
             }
-        )
+            trackedCalls += 1
+        }
         client.delegate = tusDelegate
 
         _ = try client.upload(data: data, customHeaders: ["Authorization": "Bearer original"])
@@ -139,8 +115,7 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
 
     /// Ensures resuming an upload reuses the previously applied headers.
     func testGenerateHeadersCalledWhenResumingUpload() throws {
-        let configuration = URLSessionConfiguration.default
-        configuration.protocolClasses = [MockURLProtocol.self]
+        let configuration = makeConfiguration()
 
         prepareNetworkForSuccesfulUploads(data: data)
 
@@ -149,20 +124,13 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
         tusDelegate.startUploadExpectation = uploadStarted
 
         var firstFulfilled = false
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { _, headers, onHeadersGenerated in
-                onHeadersGenerated(["Authorization": "Bearer resume-mutated"])
-                if !firstFulfilled {
-                    firstFulfilled = true
-                    firstGeneratorCalled.fulfill()
-                }
+        client = try makeClient(configuration: configuration) { _, headers, onHeadersGenerated in
+            onHeadersGenerated(["Authorization": "Bearer resume-mutated"])
+            if !firstFulfilled {
+                firstFulfilled = true
+                firstGeneratorCalled.fulfill()
             }
-        )
+        }
         client.delegate = tusDelegate
 
         let uploadID = try client.upload(data: data, customHeaders: ["Authorization": "Bearer resume"])
@@ -178,17 +146,10 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
         tusDelegate.finishUploadExpectation = finishExpectation
 
         var resumedHeaders: [String] = []
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { _, headers, onHeadersGenerated in
-                resumedHeaders.append(headers["Authorization"] ?? "")
-                onHeadersGenerated(headers)
-            }
-        )
+        client = try makeClient(configuration: configuration) { _, headers, onHeadersGenerated in
+            resumedHeaders.append(headers["Authorization"] ?? "")
+            onHeadersGenerated(headers)
+        }
         client.delegate = tusDelegate
 
         let resumedUploads = client.start().map(\.0)
@@ -200,28 +161,20 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
 
     /// Ensures uploads wait for asynchronous header generation before proceeding.
     func testGenerateHeadersSupportsAsynchronousCompletion() throws {
-        let configuration = URLSessionConfiguration.default
-        configuration.protocolClasses = [MockURLProtocol.self]
+        let configuration = makeConfiguration()
         prepareNetworkForSuccesfulUploads(data: data)
 
         let asyncExpectation = expectation(description: "Async header generator invoked")
         asyncExpectation.expectedFulfillmentCount = 2
         let finishExpectation = expectation(description: "Upload finished")
         tusDelegate.finishUploadExpectation = finishExpectation
 
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { _, headers, onHeadersGenerated in
-                DispatchQueue.global().asyncAfter(deadline: .now() + 0.2) {
-                    asyncExpectation.fulfill()
-                    onHeadersGenerated(headers.merging(["Authorization": "Bearer async"]) { _, new in new })
-                }
+        client = try makeClient(configuration: configuration) { _, headers, onHeadersGenerated in
+            DispatchQueue.global().asyncAfter(deadline: .now() + 0.2) {
+                asyncExpectation.fulfill()
+                onHeadersGenerated(headers.merging(["Authorization": "Bearer async"]) { _, new in new })
             }
-        )
+        }
         client.delegate = tusDelegate
 
         _ = try client.upload(data: data, customHeaders: ["Authorization": "Bearer original"])
@@ -230,30 +183,22 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
 
     /// Ensures the generator only receives caller-supplied headers during upload creation.
     func testGenerateHeadersReceivesOnlyCustomHeadersDuringCreate() throws {
-        let configuration = URLSessionConfiguration.default
-        configuration.protocolClasses = [MockURLProtocol.self]
+        let configuration = makeConfiguration()
         prepareNetworkForSuccesfulUploads(data: data)
 
         let customHeaders = ["Authorization": "Bearer foo", "X-Trace": "123"]
         var observedHeaders: [[String: String]] = []
         let createGeneratorCalled = expectation(description: "Header generator called during create")
 
         var createInvocationRecorded = false
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { _, headers, onHeadersGenerated in
-                if !createInvocationRecorded {
-                    observedHeaders.append(headers)
-                    createInvocationRecorded = true
-                    createGeneratorCalled.fulfill()
-                }
-                onHeadersGenerated(headers)
+        client = try makeClient(configuration: configuration) { _, headers, onHeadersGenerated in
+            if !createInvocationRecorded {
+                observedHeaders.append(headers)
+                createInvocationRecorded = true
+                createGeneratorCalled.fulfill()
             }
-        )
+            onHeadersGenerated(headers)
+        }
         tusDelegate.finishUploadExpectation = expectation(description: "Upload finished")
         client.delegate = tusDelegate
 
@@ -265,23 +210,15 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
 
     /// Ensures the generator only receives caller-supplied headers when a status check runs.
     func testGenerateHeadersReceivesOnlyCustomHeadersDuringStatus() throws {
-        let configuration = URLSessionConfiguration.default
-        configuration.protocolClasses = [MockURLProtocol.self]
+        let configuration = makeConfiguration()
         prepareNetworkForSuccesfulUploads(data: data)
 
         let customHeaders = ["Authorization": "Bearer bar", "X-Trace": "resume-123"]
         tusDelegate.startUploadExpectation = expectation(description: "Upload started")
 
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { _, headers, onHeadersGenerated in
-                onHeadersGenerated(headers)
-            }
-        )
+        client = try makeClient(configuration: configuration) { _, headers, onHeadersGenerated in
+            onHeadersGenerated(headers)
+        }
         client.delegate = tusDelegate
 
         let uploadID = try client.upload(data: data, customHeaders: customHeaders)
@@ -298,20 +235,13 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
         tusDelegate.finishUploadExpectation = finishExpectation
 
         var observedHeaders: [[String: String]] = []
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { _, headers, onHeadersGenerated in
-                observedHeaders.append(headers)
-                onHeadersGenerated(headers)
-                if observedHeaders.count == 1 {
-                    statusGeneratorCalled.fulfill()
-                }
+        client = try makeClient(configuration: configuration) { _, headers, onHeadersGenerated in
+            observedHeaders.append(headers)
+            onHeadersGenerated(headers)
+            if observedHeaders.count == 1 {
+                statusGeneratorCalled.fulfill()
             }
-        )
+        }
         client.delegate = tusDelegate
 
         let resumedUploads = client.start().map(\.0)
@@ -322,25 +252,17 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
 
     /// Ensures the generator only receives caller-supplied headers during the upload (PATCH) step.
     func testGenerateHeadersReceivesOnlyCustomHeadersDuringUpload() throws {
-        let configuration = URLSessionConfiguration.default
-        configuration.protocolClasses = [MockURLProtocol.self]
+        let configuration = makeConfiguration()
         prepareNetworkForSuccesfulUploads(data: data)
 
         let customHeaders = ["Authorization": "Bearer data", "X-Trace": "upload-step"]
         tusDelegate.finishUploadExpectation = expectation(description: "Upload finished")
 
         var uploadHeaders: [[String: String]] = []
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { _, headers, onHeadersGenerated in
-                uploadHeaders.append(headers)
-                onHeadersGenerated(headers)
-            }
-        )
+        client = try makeClient(configuration: configuration) { _, headers, onHeadersGenerated in
+            uploadHeaders.append(headers)
+            onHeadersGenerated(headers)
+        }
         client.delegate = tusDelegate
 
         _ = try client.upload(data: data, customHeaders: customHeaders)
@@ -351,27 +273,19 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
 
     /// Ensures the generator cannot override headers that TUSClient manages itself.
     func testGenerateHeadersCannotOverrideReservedHeaders() throws {
-        let configuration = URLSessionConfiguration.default
-        configuration.protocolClasses = [MockURLProtocol.self]
+        let configuration = makeConfiguration()
         MockURLProtocol.reset()
         prepareNetworkForSuccesfulUploads(data: data)
 
         let customHeaders = ["Authorization": "Bearer original"]
         tusDelegate.finishUploadExpectation = expectation(description: "Upload finished")
 
-        client = try TUSClient(
-            server: URL(string: "https://tusd.tusdemo.net/files")!,
-            sessionIdentifier: "TEST",
-            sessionConfiguration: configuration,
-            storageDirectory: relativeStoragePath,
-            supportedExtensions: [.creation],
-            generateHeaders: { _, headers, onHeadersGenerated in
-                var newHeaders = headers
-                newHeaders["Authorization"] = "Bearer mutated"
-                newHeaders["Upload-Offset"] = "999"
-                onHeadersGenerated(newHeaders)
-            }
-        )
+        client = try makeClient(configuration: configuration) { _, headers, onHeadersGenerated in
+            var newHeaders = headers
+            newHeaders["Authorization"] = "Bearer mutated"
+            newHeaders["Upload-Offset"] = "999"
+            onHeadersGenerated(newHeaders)
+        }
         client.delegate = tusDelegate
 
         _ = try client.upload(data: data, customHeaders: customHeaders)
@@ -386,4 +300,23 @@ final class TUSClient_HeaderGenerationTests: XCTestCase {
         XCTAssertEqual(patchHeaders["Authorization"], "Bearer mutated")
         XCTAssertNotEqual(patchHeaders["Upload-Offset"], "999")
     }
+
+    private func makeConfiguration() -> URLSessionConfiguration {
+        let configuration = URLSessionConfiguration.default
+        configuration.protocolClasses = [MockURLProtocol.self]
+        return configuration
+    }
+
+    private func makeClient(configuration: URLSessionConfiguration? = nil,
+                            generateHeaders: HeaderGenerationHandler? = nil) throws -> TUSClient {
+        let configuration = configuration ?? makeConfiguration()
+        return try TUSClient(
+            server: URL(string: "https://tusd.tusdemo.net/files")!,
+            sessionIdentifier: "TEST",
+            sessionConfiguration: configuration,
+            storageDirectory: relativeStoragePath,
+            supportedExtensions: [.creation],
+            generateHeaders: generateHeaders
+        )
+    }
 }