basic login tests

Author: rahafjrw

Sources/App/Controllers/Manage/LoginController.swift

@@ -1,4 +1,5 @@
 import Foundation
+import Dependencies
 import Fluent
 import Plot
 import Vapor
@@ -14,13 +15,24 @@ enum LoginController {
 
     @Sendable
     static func login(req: Request) async throws -> Response {
+        @Dependency(\.cognito) var cognito
+        let awsClient = AWSClient(httpClientProvider: .shared(req.application.http.client.shared))
+        let awsCognitoConfiguration = CognitoConfiguration(
+            userPoolId: Environment.get("POOL_ID")!,
+            clientId: Environment.get("CLIENT_ID")!,
+            clientSecret: Environment.get("CLIENT_SECRET")!,
+            cognitoIDP: CognitoIdentityProvider(client: awsClient, region: .useast2),
+            adminClient: true
+        )
+        req.application.cognito.authenticatable = CognitoAuthenticatable(configuration: awsCognitoConfiguration)
         struct UserCreds: Content {
             var email: String
             var password: String
         }
         do {
             let user = try req.content.decode(UserCreds.self)
-            try await Cognito.authenticate(req: req, username: user.email, password: user.password)
+            try await cognito.authenticate(req: req, username: user.email, password: user.password)
+            try await awsClient.shutdown()
             return req.redirect(to: SiteURL.portal.relativeURL(), redirectType: .normal)
         } catch let error as SotoCognitoError {
             var model = Login.Model(errorMessage: "There was an error. Please try again.")
@@ -32,10 +44,13 @@ enum LoginController {
             case .invalidPublicKey:
                 break
             }
+            try await awsClient.shutdown()
             return Login.View(path: req.url.path, model: model).document().encodeResponse(status: .unauthorized)
         } catch let error as AWSClientError {
+            try await awsClient.shutdown()
             return Login.View(path: SiteURL.signup.relativeURL(), model: Login.Model(errorMessage: "An AWS client error occurred: \(error.errorCode)")).document().encodeResponse(status: .unauthorized)
         } catch {
+            try await awsClient.shutdown()
             return Login.View(path: SiteURL.signup.relativeURL(), model: Login.Model(errorMessage: "An unknown error occurred: \(error.localizedDescription)")).document().encodeResponse(status: .unauthorized)
         }
 

Sources/App/Core/Dependencies/CognitoClient.swift

@@ -0,0 +1,42 @@
+// Copyright Dave Verwer, Sven A. Schmidt, and other contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import Dependencies
+import DependenciesMacros
+import Vapor
+
+@DependencyClient
+struct CognitoClient {
+    var authenticate: @Sendable (_ req: Request, _ username: String, _ password: String) async throws -> Void
+}
+
+extension CognitoClient: DependencyKey {
+    static var liveValue: CognitoClient {
+        .init(
+            authenticate: { req, username, password in try await Cognito.authenticate(req: req, username: username, password: password) }
+        )
+    }
+}
+
+extension CognitoClient: Sendable, TestDependencyKey {
+    static var testValue: Self { Self() }
+}
+
+extension DependencyValues {
+    var cognito: CognitoClient {
+        get { self[CognitoClient.self] }
+        set { self[CognitoClient.self] = newValue }
+    }
+}
+    

Sources/App/configure.swift

@@ -81,16 +81,6 @@ public func configure(_ app: Application) async throws -> String {
 
     app.sessions.use(.memory)
 
-    let awsClient = AWSClient(httpClientProvider: .shared(app.http.client.shared))
-    let awsCognitoConfiguration = CognitoConfiguration(
-        userPoolId: Environment.get("POOL_ID")!,
-        clientId: Environment.get("CLIENT_ID")!,
-        clientSecret: Environment.get("CLIENT_SECRET")!,
-        cognitoIDP: CognitoIdentityProvider(client: awsClient, region: .useast2),
-        adminClient: true
-    )
-    app.cognito.authenticatable = CognitoAuthenticatable(configuration: awsCognitoConfiguration)
-    
 
     // Configures cookie value creation.
     app.sessions.configuration.cookieFactory = { sessionID in

Tests/AppTests/ManageTests.swift

@@ -0,0 +1,57 @@
+// Copyright Dave Verwer, Sven A. Schmidt, and other contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+@testable import App
+
+import XCTest
+import Fluent
+import Vapor
+import Dependencies
+
+
+class ManageTests: AppTestCase {
+
+    func test_portal_route_protected() throws {
+        try app.test(.GET, "portal") { res in
+            XCTAssertEqual(res.status, .seeOther)
+        }
+    }
+    
+    func test_login_successful_redirect() throws {
+        // not throwing in auth is a successful authentication and user
+        // should be redirected
+        try withDependencies {
+            var mock: @Sendable (_ req: Request, _ username: String, _ password: String) async throws -> Void = { _, _, _ in }
+            $0.cognito.authenticate = mock
+        } operation: {
+            try app.test(.POST, "login", beforeRequest: { req in try req.content.encode(["email": "testemail", "password": "testpassword"])
+            }, afterResponse: { res in
+                XCTAssertEqual(res.status, .seeOther)
+            })
+        }
+    }
+    
+    func test_login_throws() throws {
+        struct SomeError: Error {}
+        try withDependencies {
+            var mock: @Sendable (_ req: Request, _ username: String, _ password: String) async throws -> Void = { _, _, _ in throw SomeError() }
+            $0.cognito.authenticate = mock
+        } operation: {
+            try app.test(.POST, "login") { res in
+                XCTAssertEqual(res.status, .unauthorized)
+            }
+        }
+    }
+}
+