tests & docs

Author: tib

README.md

@@ -151,6 +151,39 @@ You can transform a HttpRequest into a URLReequest via the `.urlRequest` propert
 You can print the cURL representation of a request by using the `.curlString` property on a URLRequest object.
 
 
+## Response validation
+
+You can validate a response by using a HttpResponseValidator object.
+
+```swift
+// mock response
+let response = HttpRawResponse(statusCode: .ok,
+                               headers: [
+                                .key(.contentType): "application/json",
+                               ],
+                               data: .init())
+
+// check if the status code is between 200 and 299               
+let validator1 = HttpStatusCodeValidator() // -> (.ok), (.notFound), etc.
+try validator1.validate(response)
+
+
+// check if a header key exists and the value is equal to "application/json"
+let validator2 = HttpHeaderValidator(.key(.contentType)) { value in
+    value == "application/json"
+}
+
+try validator2.validate(response)
+
+
+// validate using multiple validators
+let validation = HttpResponseValidation([validator1, validator2])
+try validation.validate(response)
+```
+
+It is possible to check for multiple validation criterias using a HttpResponseValidation. 
+
+
 ## Pipelines
 
 A pipeline allows you to transform a raw request and a raw response using a set of custom actions. 
@@ -160,3 +193,5 @@ You can create your own HttpRequestTransformer object to add extra headers to yo
 You can create your own HttpResponseTransformer object to validate the response and decode a custom value from the response data.
 
 The codable (encodable, decodable, codable) pipelines are a good example of this approach.
+
+

Tests/SwiftHttpTests/HttpRequestTests.swift

@@ -21,14 +21,12 @@ final class HttpRequestTests: XCTestCase {
                                  method: .post,
                                  headers: [
                                     .key(.authorization): "Bearer \(token)",
-                                    .custom("my-header"): "my-header-value",
                                  ],
                                  body: body)
 
         let expectation = """
             curl "https://localhost/login/" \\
             \t-X POST \\
-            \t-H 'my-header: my-header-value' \\
             \t-H 'Authorization: Bearer valid-token' \\
             \t-d '{"foo":"bar"}'
             """

Tests/SwiftHttpTests/HttpUrlTests.swift

@@ -23,10 +23,9 @@ final class HttpUrlTests: XCTestCase {
         XCTAssertEqual(query1Url.url.absoluteString, "https://jsonplaceholder.typicode.com/todos/?foo=bar")
 
         let query2Url = baseUrl.path("todos").query([
-            "foo": "baz",
-            "bar": "1",
+            "foo": "1",
         ])
-        XCTAssertEqual(query2Url.url.absoluteString, "https://jsonplaceholder.typicode.com/todos/?foo=baz&bar=1")
+        XCTAssertEqual(query2Url.url.absoluteString, "https://jsonplaceholder.typicode.com/todos/?foo=1")
     }
 }
 

Tests/SwiftHttpTests/HttpValidationTests.swift

@@ -0,0 +1,91 @@
+//
+//  HttpValidationTests.swift
+//  SwiftHttp
+//
+//  Created by Tibor Bodecs on 2022. 03. 13..
+//
+
+import XCTest
+@testable import SwiftHttp
+
+final class HttpValidationTests: XCTestCase {
+    
+    func testStatusCodeValidator() async throws {
+        let response = HttpRawResponse(statusCode: .ok, headers: [:], data: .init())
+        let validator1 = HttpStatusCodeValidator() // 200...299
+        try validator1.validate(response)
+        
+        let validator2 = HttpStatusCodeValidator(.ok) // 200
+        try validator2.validate(response)
+    }
+    
+    func testBadStatusCodeValidator() async throws {
+        let response = HttpRawResponse(statusCode: .notFound, headers: [:], data: .init())
+        let validator = HttpStatusCodeValidator() // 200...299
+        do {
+            try validator.validate(response)
+            XCTFail("Bad validation result")
+        }
+        catch {
+            
+        }
+    }
+    
+    func testBadStatusCodeValidator2() async throws {
+        let response = HttpRawResponse(statusCode: .notFound, headers: [:], data: .init())
+        let validator = HttpStatusCodeValidator(.ok)
+        do {
+            try validator.validate(response)
+            XCTFail("Bad validation result")
+        }
+        catch {
+            
+        }
+    }
+    
+    func testHeaderValidator() async throws {
+        let response = HttpRawResponse(statusCode: .ok,
+                                       headers: [
+                                        .key(.contentType): "application/json",
+                                       ],
+                                       data: .init())
+        let validator = HttpHeaderValidator(.key(.contentType)) { value in
+            value == "application/json"
+        }
+        try validator.validate(response)
+    }
+    
+    func testInvalidHeaderValidator() async throws {
+        let response = HttpRawResponse(statusCode: .ok,
+                                       headers: [
+                                        .key(.contentType): "application/json",
+                                       ],
+                                       data: .init())
+        let validator = HttpHeaderValidator(.key(.contentType)) { value in
+            value == "application/xml"
+        }
+        do {
+            try validator.validate(response)
+            XCTFail("Bad validation result")
+        }
+        catch {
+            
+        }
+    }
+    
+    func testMultipleValidation() async throws {
+        let response = HttpRawResponse(statusCode: .ok,
+                                       headers: [
+                                        .key(.contentType): "application/json",
+                                       ],
+                                       data: .init())
+        
+        let validator1 = HttpStatusCodeValidator(.ok)
+        let validator2 = HttpHeaderValidator(.key(.contentType)) { value in
+            value == "application/json"
+        }
+        let validation = HttpResponseValidation([validator1, validator2])
+        try validation.validate(response)
+    }
+}
+