Add snapshot tests for Requests (#72)

dcaunt · web-flow · commit da86e72f3c11 · 2025-03-14T15:40:26.000Z
diff --git a/Package.swift b/Package.swift
@@ -43,15 +43,21 @@ let package = Package(
             targets: ["OpenPassObjC"]
         )
     ],
-    dependencies: [],
+    dependencies: [
+        .package(url: "https://github.com/pointfreeco/swift-snapshot-testing", from: "1.18.0")
+    ],
     targets: [
         .target(
             name: "OpenPass",
             dependencies: []
         ),
         .testTarget(
             name: "OpenPassTests",
-            dependencies: ["OpenPass"],
+            dependencies: [
+                "OpenPass",
+                .product(name: "InlineSnapshotTesting", package: "swift-snapshot-testing"),
+                .product(name: "SnapshotTesting", package: "swift-snapshot-testing"),
+            ],
             resources: [
                 .copy("TestData")
             ]
@@ -72,4 +78,5 @@ let package = Package(
             path: "Tests/ObjCTestHelpers"
         )
     ],
-    swiftLanguageVersions: [.v5])
+    swiftLanguageVersions: [.v5]
+)
diff --git a/Sources/OpenPass/OpenPassClient.swift b/Sources/OpenPass/OpenPassClient.swift
@@ -46,22 +46,23 @@ internal final class OpenPassClient {
     convenience init(configuration: OpenPassConfiguration) {
         self.init(
             baseURL: configuration.baseURL,
-            sdkName: configuration.sdkName,
-            sdkVersion: configuration.sdkVersion,
+            baseRequestParameters: BaseRequestParameters(
+                sdkName: configuration.sdkName,
+                sdkVersion: configuration.sdkVersion
+            ),
             clientId: configuration.clientId,
             isLoggingEnabled: configuration.isLoggingEnabled
         )
     }
 
     init(
         baseURL: String,
-        sdkName: String,
-        sdkVersion: String = openPassSdkVersion,
+        baseRequestParameters: BaseRequestParameters,
         clientId: String,
         isLoggingEnabled: Bool
     ) {
         self.baseURL = baseURL
-        self.baseRequestParameters = BaseRequestParameters(sdkName: sdkName, sdkVersion: sdkVersion)
+        self.baseRequestParameters = baseRequestParameters
         self.clientId = clientId
         self.log = isLoggingEnabled
             ? .init(subsystem: "com.myopenpass", category: "OpenPassClient")
diff --git a/Tests/OpenPassTests/OpenPassManagerTests.swift b/Tests/OpenPassTests/OpenPassManagerTests.swift
@@ -45,7 +45,7 @@ final class OpenPassManagerTests: XCTestCase {
     @MainActor
     /// Test helper. Runs the sign in flow with default, 'success' parameters. Override parameters to test failure scenarios.
     private func _testSignInUXFlow(
-        configuration: OpenPassConfiguration? = nil,
+        client: OpenPassClient? = nil,
         authenticationState: String = "state123",
         authenticationSession: TestAuthenticationSession? = nil,
         overrideFixtures: [String:(String, Int)] = [:],
@@ -55,15 +55,12 @@ final class OpenPassManagerTests: XCTestCase {
             "/v1/api/token": ("openpasstokens-200", 200),
             "/.well-known/jwks": ("jwks", 200),
         ]
-        let defaultConfiguration = OpenPassConfiguration.testConfiguration
         // overrides in fixtures replace defaults
         let fixtures = defaultFixtures.merging(overrideFixtures) { $1 }
         try HTTPStub.shared.stub(fixtures: fixtures)
 
         let flow = SignInFlow(
-            openPassClient: OpenPassClient(
-                configuration: configuration ?? defaultConfiguration
-            ),
+            openPassClient: client ?? OpenPassClient(configuration: OpenPassConfiguration.testConfiguration),
             tokenValidator: tokenValidator,
             redirectHost: "com.openpass",
             isLoggingEnabled: false,
@@ -250,7 +247,7 @@ final class OpenPassManagerTests: XCTestCase {
             XCTAssertEqual(components.host, "auth.myopenpass.com")
             XCTAssertEqual(components.path, "/v1/api/authorize")
 
-            let ignoredQueryItems: Set = ["code_challenge", "device_model", "device_platform", "device_platform_version", "sdk_version"]
+            let ignoredQueryItems: Set = ["code_challenge"]
             let allQueryItemNames = (components.queryItems ?? [])
                 .map(\.name)
             let allQueryItemNamesSet = Set(allQueryItemNames)
@@ -265,16 +262,33 @@ final class OpenPassManagerTests: XCTestCase {
                 .init(name: "client_id", value: "test-client"),
                 .init(name: "code_challenge_method", value: "S256"),
                 .init(name: "device_manufacturer", value: "Apple"),
+                .init(name: "device_model", value: "iPhone"),
+                .init(name: "device_platform", value: "iOS"),
+                .init(name: "device_platform_version", value: "13.0.0"),
                 .init(name: "redirect_uri", value: "com.myopenpass.auth.test-client://com.openpass"),
                 .init(name: "response_type", value: "code"),
                 .init(name: "scope", value: "openid"),
                 .init(name: "sdk_name", value: "openpass-ios-sdk"),
+                .init(name: "sdk_version", value: "1.0.0"),
                 .init(name: "state", value: "state123"),
             ])
 
             return Self.defaultAuthenticationCallbackURL
         }
         let _ = try await _testSignInUXFlow(
+            client: OpenPassClient(
+                baseURL: "https://auth.myopenpass.com/",
+                baseRequestParameters: .init(
+                    sdkName: "openpass-ios-sdk",
+                    sdkVersion: "1.0.0",
+                    devicePlatform: "iOS",
+                    devicePlatformVersion: "13.0.0",
+                    deviceManufacturer: "Apple",
+                    deviceModel: "iPhone"
+                ),
+                clientId: "test-client",
+                isLoggingEnabled: false
+            ),
             authenticationSession: session,
             tokenValidator: IDTokenValidationStub.valid
         )
@@ -290,12 +304,12 @@ final class OpenPassManagerTests: XCTestCase {
             return Self.defaultAuthenticationCallbackURL
         }
         let _ = try await _testSignInUXFlow(
-            configuration: .init(
+            client: OpenPassClient(configuration: .init(
                 clientId: "test-client",
                 redirectHost: "",
                 isLoggingEnabled: false,
                 sdkNameSuffix: "-test-suffix"
-            ),
+            )),
             authenticationSession: session,
             tokenValidator: IDTokenValidationStub.valid
         )
diff --git a/Tests/OpenPassTests/RequestTests.swift b/Tests/OpenPassTests/RequestTests.swift
@@ -0,0 +1,130 @@
+//
+//  RequestTests.swift
+//
+// MIT License
+//
+// Copyright (c) 2025 The Trade Desk (https://www.thetradedesk.com/)
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+
+import Foundation
+import InlineSnapshotTesting
+@testable import OpenPass
+import XCTest
+
+final class RequestTests: XCTestCase {
+
+    private let client = OpenPassClient(
+        baseURL: OpenPassConfiguration.defaultBaseURL,
+        baseRequestParameters: BaseRequestParameters(
+            sdkName: OpenPassConfiguration.defaultSdkName,
+            sdkVersion: "1.0.0",
+            devicePlatform: "iOS",
+            devicePlatformVersion: "18.0",
+            deviceManufacturer: "Apple",
+            deviceModel: "iPhone"
+        ),
+        clientId: "test-client-id",
+        isLoggingEnabled: false
+    )
+
+    func testAuthorizationCodeRequest() {
+        let request = Request.authorizationCode(
+            clientId: "client_id_5",
+            code: "code-123",
+            codeVerifier: "code-verifier-456",
+            redirectUri: "redirect-uri-789"
+        )
+        assertInlineSnapshot(of: client.urlRequest(request), as: .raw(pretty: true)) {
+            """
+            POST https://auth.myopenpass.com/v1/api/token
+            Content-Type: application/x-www-form-urlencoded
+            Device-Manufacturer: Apple
+            Device-Model: iPhone
+            Device-Platform-Version: 18.0
+            Device-Platform: iOS
+            SDK-Name: openpass-ios-sdk
+            SDK-Version: 1.0.0
+
+            client_id=client_id_5&code_verifier=code-verifier-456&code=code-123&grant_type=authorization_code&redirect_uri=redirect-uri-789
+            """
+        }
+    }
+
+    func testAuthorizeDeviceRequest() {
+        let request = Request.authorizeDevice(clientId: "client-id-7")
+        assertInlineSnapshot(of: client.urlRequest(request), as: .raw(pretty: true)) {
+            """
+            POST https://auth.myopenpass.com/v1/api/authorize-device
+            Content-Type: application/x-www-form-urlencoded
+            Device-Manufacturer: Apple
+            Device-Model: iPhone
+            Device-Platform-Version: 18.0
+            Device-Platform: iOS
+            SDK-Name: openpass-ios-sdk
+            SDK-Version: 1.0.0
+
+            client_id=client-id-7&scope=openid
+            """
+        }
+    }
+
+    func testDeviceTokenRequest() {
+        let request = Request.deviceToken(
+            clientId: "client-id-0",
+            deviceCode: "device-code-1"
+        )
+        assertInlineSnapshot(of: client.urlRequest(request), as: .raw(pretty: true)) {
+            """
+            POST https://auth.myopenpass.com/v1/api/device-token
+            Content-Type: application/x-www-form-urlencoded
+            Device-Manufacturer: Apple
+            Device-Model: iPhone
+            Device-Platform-Version: 18.0
+            Device-Platform: iOS
+            SDK-Name: openpass-ios-sdk
+            SDK-Version: 1.0.0
+
+            client_id=client-id-0&device_code=device-code-1&grant_type=urn:ietf:params:oauth:grant-type:device_code
+            """
+        }
+    }
+
+    func testRefreshRequest() {
+        let request = Request.refresh(
+            clientId: "client_id_3",
+            refreshToken: "refresh-token-value"
+        )
+        assertInlineSnapshot(of: client.urlRequest(request), as: .raw(pretty: true)) {
+            """
+            POST https://auth.myopenpass.com/v1/api/token
+            Content-Type: application/x-www-form-urlencoded
+            Device-Manufacturer: Apple
+            Device-Model: iPhone
+            Device-Platform-Version: 18.0
+            Device-Platform: iOS
+            SDK-Name: openpass-ios-sdk
+            SDK-Version: 1.0.0
+
+            client_id=client_id_3&grant_type=refresh_token&refresh_token=refresh-token-value
+            """
+        }
+    }
+}
diff --git a/Tests/OpenPassTests/TestExtensions/OpenPassClient+TestExtensions.swift b/Tests/OpenPassTests/TestExtensions/OpenPassClient+TestExtensions.swift
@@ -30,7 +30,7 @@
 extension OpenPassClient {
     static let test = OpenPassClient(
         baseURL: "https://auth.myopenpass.com/",
-        sdkName: "OpenPassTest",
+        baseRequestParameters: BaseRequestParameters(sdkName: "OpenPassTest", sdkVersion: "1.0.0"),
         clientId: "test-client",
         isLoggingEnabled: false
     )

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`extension OpenPassClient {`
`31`	`31`	`static let test = OpenPassClient(`
`32`	`32`	`baseURL: "https://auth.myopenpass.com/",`
`33`		`- sdkName: "OpenPassTest",`
	`33`	`+ baseRequestParameters: BaseRequestParameters(sdkName: "OpenPassTest", sdkVersion: "1.0.0"),`
`34`	`34`	`clientId: "test-client",`
`35`	`35`	`isLoggingEnabled: false`
`36`	`36`	`)`