fix: Fix Hashable compliance on Headers & Header types, disable tests that use httpbin.org (#548)

Author: jbelkins

Sources/ClientRuntime/Networking/Http/Headers.swift

@@ -5,7 +5,7 @@
 
 import AwsCommonRuntimeKit
 
-public struct Headers: Hashable {
+public struct Headers {
     public var headers: [Header] = []
 
     /// Creates an empty instance.
@@ -172,6 +172,13 @@ extension Headers: Equatable {
     }
 }
 
+extension Headers: Hashable {
+
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(headers.sorted())
+    }
+}
+
 extension Array where Element == Header {
     /// Case-insensitively finds the index of an `Header` with the provided name, if it exists.
     func index(of name: String) -> Int? {
@@ -186,7 +193,7 @@ extension Array where Element == Header {
     }
 }
 
-public struct Header: Hashable {
+public struct Header {
     public var name: String
     public var value: [String]
 
@@ -207,6 +214,14 @@ extension Header: Equatable {
     }
 }
 
+extension Header: Hashable {
+
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(name)
+        hasher.combine(value.sorted())
+    }
+}
+
 extension Header: Comparable {
     /// Compares two `Header` instances by name.
     /// - Parameters:

Tests/ClientRuntimeTests/ClientRuntimeTests/NetworkingTests/HttpHeadersTests.swift

@@ -64,4 +64,62 @@ class HttpHeadersTests: XCTestCase {
 
         XCTAssertEqual(httpHeaders.dictionary.count, 0)
     }
+
+    // MARK: - Equatable & Hashable implementations
+
+    func test_headers_equatableAndHashable_nonIdenticalHeaders() {
+        var headersA = Headers()
+        headersA.add(name: "A", values: ["X", "Y"])
+        var headersB = Headers()
+        headersB.add(name: "B", values: ["X", "Y"])
+
+        XCTAssertNotEqual(headersA, headersB)
+    }
+
+    func test_headers_equatableAndHashable_identicalHeaders() {
+        var headersA = Headers()
+        headersA.add(name: "A", values: ["X", "Y"])
+        headersA.add(name: "B", values: ["X", "Y"])
+        var headersB = Headers()
+        headersB.add(name: "A", values: ["X", "Y"])
+        headersB.add(name: "B", values: ["X", "Y"])
+
+        XCTAssertEqual(headersA, headersB)
+        XCTAssertEqual(headersA.hashValue, headersB.hashValue)
+    }
+
+    func test_headers_equatableAndHashable_outOfOrderHeaders() {
+        var headersA = Headers()
+        headersA.add(name: "A", values: ["X", "Y"])
+        headersA.add(name: "B", values: ["X", "Y"])
+        var headersB = Headers()
+        headersB.add(name: "B", values: ["X", "Y"])
+        headersB.add(name: "A", values: ["X", "Y"])
+
+        XCTAssertEqual(headersA, headersB)
+        XCTAssertEqual(headersA.hashValue, headersB.hashValue)
+    }
+
+    func test_header_equatableAndHashable_nonIdenticalValues() {
+        let headerA = Header(name: "A", values: ["X", "Y"])
+        let headerB = Header(name: "B", values: ["X", "Y"])
+
+        XCTAssertNotEqual(headerA, headerB)
+    }
+
+    func test_header_equatableAndHashable_identicalValues() {
+        let headerA = Header(name: "A", values: ["X", "Y"])
+        let headerB = Header(name: "A", values: ["X", "Y"])
+
+        XCTAssertEqual(headerA, headerB)
+        XCTAssertEqual(headerA.hashValue, headerB.hashValue)
+    }
+
+    func test_header_equatableAndHashable_outOfOrderValues() {
+        let headerA = Header(name: "A", values: ["X", "Y"])
+        let headerB = Header(name: "A", values: ["Y", "X"])
+
+        XCTAssertEqual(headerA, headerB)
+        XCTAssertEqual(headerA.hashValue, headerB.hashValue)
+    }
 }

Tests/ClientRuntimeTests/MiddlewareTests/MiddlewareStackTests.swift

@@ -71,7 +71,10 @@ class MiddlewareStackTests: XCTestCase {
         XCTAssert(result.value == 200)
     }
 
-    func testFullBlownOperationRequestWithClientHandler() async throws {
+    // This test is disabled because unreliability of httpbin.org is causing spurious failures.
+    // Github issue to track correction of these tests: https://github.com/awslabs/aws-sdk-swift/issues/962
+
+    func xtestFullBlownOperationRequestWithClientHandler() async throws {
         let httpClientConfiguration = HttpClientConfiguration()
         let clientEngine = CRTClientEngine()
         let httpClient = SdkHttpClient(engine: clientEngine, config: httpClientConfiguration)

Tests/ClientRuntimeTests/NetworkingTests/CRTClientEngineIntegrationTests.swift

@@ -7,6 +7,9 @@ import XCTest
 @testable import ClientRuntime
 import AwsCommonRuntimeKit
 
+// These tests are disabled because unreliability of httpbin.org is causing spurious failures.
+// Github issue to track correction of these tests: https://github.com/awslabs/aws-sdk-swift/issues/962
+
 class CRTClientEngineIntegrationTests: NetworkingTestUtils {
 
     var httpClient: SdkHttpClient!
@@ -22,7 +25,7 @@ class CRTClientEngineIntegrationTests: NetworkingTestUtils {
         super.tearDown()
     }
 
-    func testMakeHttpGetRequest() async throws {
+    func xtestMakeHttpGetRequest() async throws {
         var headers = Headers()
         headers.add(name: "Content-type", value: "application/json")
         headers.add(name: "Host", value: "httpbin.org")
@@ -33,7 +36,7 @@ class CRTClientEngineIntegrationTests: NetworkingTestUtils {
         XCTAssert(response.statusCode == HttpStatusCode.ok)
     }
 
-    func testMakeHttpPostRequest() async throws {
+    func xtestMakeHttpPostRequest() async throws {
         //used https://httpbin.org
         var headers = Headers()
         headers.add(name: "Content-type", value: "application/json")
@@ -50,7 +53,7 @@ class CRTClientEngineIntegrationTests: NetworkingTestUtils {
         XCTAssert(response.statusCode == HttpStatusCode.ok)
     }
 
-    func testMakeHttpStreamRequestDynamicReceive() async throws {
+    func xtestMakeHttpStreamRequestDynamicReceive() async throws {
         //used https://httpbin.org
         var headers = Headers()
         headers.add(name: "Content-type", value: "application/json")
@@ -64,7 +67,7 @@ class CRTClientEngineIntegrationTests: NetworkingTestUtils {
         XCTAssert(response.statusCode == HttpStatusCode.ok)
     }
 
-    func testMakeHttpStreamRequestReceive() async throws {
+    func xtestMakeHttpStreamRequestReceive() async throws {
         //used https://httpbin.org
         var headers = Headers()
         headers.add(name: "Content-type", value: "application/json")
@@ -84,7 +87,7 @@ class CRTClientEngineIntegrationTests: NetworkingTestUtils {
         XCTAssert(response.statusCode == HttpStatusCode.ok)
     }
 
-    func testMakeHttpStreamRequestReceiveOneByte() async throws {
+    func xtestMakeHttpStreamRequestReceiveOneByte() async throws {
         //used https://httpbin.org
         var headers = Headers()
         headers.add(name: "Content-type", value: "application/json")
@@ -104,7 +107,7 @@ class CRTClientEngineIntegrationTests: NetworkingTestUtils {
         XCTAssert(response.statusCode == HttpStatusCode.ok)
     }
 
-    func testMakeHttpStreamRequestReceive3ThousandBytes() async throws {
+    func xtestMakeHttpStreamRequestReceive3ThousandBytes() async throws {
         //used https://httpbin.org
         var headers = Headers()
         headers.add(name: "Content-type", value: "application/json")
@@ -124,7 +127,7 @@ class CRTClientEngineIntegrationTests: NetworkingTestUtils {
         XCTAssert(response.statusCode == HttpStatusCode.ok)
     }
 
-    func testMakeHttpStreamRequestFromData() async throws {
+    func xtestMakeHttpStreamRequestFromData() async throws {
         //used https://httpbin.org
         var headers = Headers()
         headers.add(name: "Content-type", value: "application/json")