Improve Unit Tests by fixing warnings

Author: Andrea Scuderi

Tests/BreezeDynamoDBServiceTests/BreezeDynamoDBManagerMock.swift

@@ -0,0 +1,86 @@
+//    Copyright 2024 (c) Andrea Scuderi - https://github.com/swift-serverless
+//
+//    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 BreezeDynamoDBService
+@testable import BreezeLambdaAPI
+import SotoDynamoDB
+
+actor BreezeDynamoDBManagerMock: BreezeDynamoDBManaging {
+    let keyName: String
+    
+    enum BreezeDynamoDBManagerError: Error {
+        case invalidRequest
+        case invalidItem
+    }
+        
+    
+    private var response: (any BreezeCodable)?
+    private var keyedResponse: (any BreezeCodable)?
+    
+    func setupMockResponse(response: (any BreezeCodable)?, keyedResponse: (any BreezeCodable)?) {
+        self.keyedResponse = keyedResponse
+        self.response = response
+    }
+    
+    init(db: SotoDynamoDB.DynamoDB, tableName: String, keyName: String) {
+        self.keyName = keyName
+    }
+    
+    func createItem<T: BreezeCodable>(item: T) async throws -> T {
+        guard let response = self.response as? T else {
+            throw BreezeDynamoDBManagerError.invalidRequest
+        }
+        return response
+    }
+    
+    func readItem<T: BreezeCodable>(key: String) async throws -> T {
+        guard let response = self.keyedResponse as? T,
+              response.key == key
+        else {
+            throw BreezeDynamoDBManagerError.invalidRequest
+        }
+        return response
+    }
+    
+    func updateItem<T: BreezeCodable>(item: T) async throws -> T {
+        guard let response = self.keyedResponse as? T,
+              response.key == item.key
+        else {
+            throw BreezeDynamoDBManagerError.invalidRequest
+        }
+        return response
+    }
+    
+    func deleteItem<T: BreezeCodable>(item: T) async throws {
+        guard let response = self.keyedResponse,
+              response.key == item.key,
+              response.createdAt == item.createdAt,
+              response.updatedAt == item.updatedAt
+        else {
+            throw BreezeDynamoDBManagerError.invalidRequest
+        }
+        return
+    }
+    
+    var limit: Int?
+    var exclusiveKey: String?
+    func listItems<T: BreezeCodable>(key: String?, limit: Int?) async throws -> ListResponse<T> {
+        guard let response = self.response as? T else {
+            throw BreezeDynamoDBManagerError.invalidItem
+        }
+        self.limit = limit
+        self.exclusiveKey = key
+        return ListResponse(items: [response], lastEvaluatedKey: key)
+    }
+}

Tests/BreezeDynamoDBServiceTests/BreezeDynamoDBManagerTests.swift

@@ -73,9 +73,10 @@ struct BreezeDynamoDBManagerTests {
         try #require(value.updatedAt?.iso8601 != nil)
         do {
             _ = try await sut.createItem(item: product2023)
-            Issue.record("It should throw conditionalCheckFailedException")
+            Issue.record("It should throw DynamoDBErrorType.conditionalCheckFailedException")
         } catch {
-            try #require(error != nil)
+            let dynamoDBError = try #require(error as? DynamoDBErrorType)
+            #expect(dynamoDBError == .conditionalCheckFailedException)
         }
         try await removeTable(tableName: uuid)
     }
@@ -102,9 +103,10 @@ struct BreezeDynamoDBManagerTests {
         #expect(value.key == "2023")
         do {
             let _: Product = try await sut.readItem(key: "2022")
-            Issue.record("It should throw when Item is missing")
+            Issue.record("It should throw ServiceError.notfound when Item is missing")
         } catch {
-            try #require(error != nil)
+            let dynamoDBError = try #require(error as? BreezeDynamoDBManager.ServiceError)
+            #expect(dynamoDBError == .notFound)
         }
         try await removeTable(tableName: uuid)
     }
@@ -140,16 +142,18 @@ struct BreezeDynamoDBManagerTests {
         #expect(value.updatedAt?.iso8601 != newValue.updatedAt?.iso8601)
         do {
             let _: Product = try await sut.updateItem(item: product2023)
-            Issue.record("It should throw conditionalCheckFailedException")
+            Issue.record("It should throw AWSResponseError ValidationException")
         } catch {
-            try #require(error != nil)
+            let dynamoDBError = try #require(error as? AWSResponseError)
+            #expect(dynamoDBError.errorCode == "ValidationException")
         }
 
         do {
             let _: Product = try await sut.updateItem(item: product2022)
-            Issue.record("It should throw conditionalCheckFailedException")
+            Issue.record("It should throw AWSResponseError ValidationException")
         } catch {
-            try #require(error != nil)
+            let dynamoDBError = try #require(error as? AWSResponseError)
+            #expect(dynamoDBError.errorCode == "ValidationException")
         }
         try await removeTable(tableName: uuid)
     }
@@ -171,9 +175,10 @@ struct BreezeDynamoDBManagerTests {
         let sut = try await givenTable(tableName: uuid)
         do {
             try await sut.deleteItem(item: product2022)
-            Issue.record("It should throw ServiceError.missingParameters")
+            Issue.record("It should throw DynamoDBErrorType.conditionalCheckFailedException")
         } catch {
-            try #require(error != nil)
+            let dynamoDBError = try #require(error as? DynamoDBErrorType)
+            #expect(dynamoDBError == .conditionalCheckFailedException)
         }
         try await removeTable(tableName: uuid)
     }
@@ -189,7 +194,8 @@ struct BreezeDynamoDBManagerTests {
             try await sut.deleteItem(item: value)
             Issue.record("It should throw ServiceError.missingParameters")
         } catch {
-            try #require(error != nil)
+            let dynamoDBError = try #require(error as? BreezeDynamoDBManager.ServiceError)
+            #expect(dynamoDBError == .missingParameters)
         }
         try await removeTable(tableName: uuid)
     }
@@ -205,7 +211,8 @@ struct BreezeDynamoDBManagerTests {
             try await sut.deleteItem(item: value)
             Issue.record("It should throw ServiceError.missingParameters")
         } catch {
-            try #require(error != nil)
+            let dynamoDBError = try #require(error as? BreezeDynamoDBManager.ServiceError)
+            #expect(dynamoDBError == .missingParameters)
         }
         try await removeTable(tableName: uuid)
     }
@@ -219,9 +226,10 @@ struct BreezeDynamoDBManagerTests {
         value.updatedAt = Date().iso8601
         do {
             try await sut.deleteItem(item: value)
-            Issue.record("It should throw ServiceError.missingParameters")
+            Issue.record("It should throw DynamoDBErrorType.conditionalCheckFailedException")
         } catch {
-            try #require(error != nil)
+            let dynamoDBError = try #require(error as? DynamoDBErrorType)
+            #expect(dynamoDBError == .conditionalCheckFailedException)
         }
         try await removeTable(tableName: uuid)
     }
@@ -235,9 +243,10 @@ struct BreezeDynamoDBManagerTests {
         value.createdAt = Date().iso8601
         do {
             try await sut.deleteItem(item: value)
-            Issue.record("It should throw ServiceError.missingParameters")
+            Issue.record("It should throw DynamoDBErrorType.conditionalCheckFailedException")
         } catch {
-            try #require(error != nil)
+            let dynamoDBError = try #require(error as? DynamoDBErrorType)
+            #expect(dynamoDBError == .conditionalCheckFailedException)
         }
         try await removeTable(tableName: uuid)
     }

Tests/BreezeDynamoDBServiceTests/BreezeDynamoDBServiceTests.swift

@@ -0,0 +1,72 @@
+//    Copyright 2024 (c) Andrea Scuderi - https://github.com/swift-serverless
+//
+//    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 SotoDynamoDB
+import AsyncHTTPClient
+import Logging
+import Testing
+@testable import BreezeDynamoDBService
+
+@Suite
+struct BreezeDynamoDBServiceTests {
+    @Test
+    func testInitPrepareBreezeDynamoDBManager() async throws {
+        let sut = await makeBreezeDynamoDBConfig()
+        let manager = await sut.dbManager()
+        #expect(manager is BreezeDynamoDBManager, "Expected BreezeDynamoDBManager instance")
+        try await sut.gracefulShutdown()
+    }
+    
+    @Test
+    func testGracefulShutdownCanBeCalledMultipleTimes() async throws {
+        let sut = await makeBreezeDynamoDBConfig()
+        try await sut.gracefulShutdown()
+        try await sut.gracefulShutdown()
+    }
+    
+    @Test
+    func testMockInjection() async throws {
+        let config = BreezeDynamoDBConfig(
+            region: .useast1,
+            tableName: "TestTable",
+            keyName: "TestKey",
+        )
+        let logger = Logger(label: "BreezeDynamoDBServiceTests")
+        let httpConfig = BreezeHTTPClientConfig(timeout: .seconds(10), logger: logger)
+        let sut = await BreezeDynamoDBService(
+            config: config,
+            httpConfig: httpConfig,
+            logger: logger,
+            DBManagingType: BreezeDynamoDBManagerMock.self
+        )
+        let manager = await sut.dbManager()
+        #expect(manager is BreezeDynamoDBManagerMock, "Expected BreezeDynamoDBManager instance")
+        try await sut.gracefulShutdown()
+    }
+    
+    private func makeBreezeDynamoDBConfig() async -> BreezeDynamoDBService {
+        let config = BreezeDynamoDBConfig(
+            region: .useast1,
+            tableName: "TestTable",
+            keyName: "TestKey",
+        )
+        let logger = Logger(label: "BreezeDynamoDBServiceTests")
+        let httpConfig = BreezeHTTPClientConfig(timeout: .seconds(10), logger: logger)
+        return await BreezeDynamoDBService(
+            config: config,
+            httpConfig: httpConfig,
+            logger: logger,
+        )
+    }
+}

Tests/BreezeLambdaAPITests/BreezeDynamoDBManagerMock.swift

@@ -18,26 +18,26 @@ import SotoDynamoDB
 
 actor BreezeDynamoDBManagerMock: BreezeDynamoDBManaging {
     let keyName: String
-
+    
     private var response: (any BreezeCodable)?
     private var keyedResponse: (any BreezeCodable)?
 
     func setupMockResponse(response: (any BreezeCodable)?, keyedResponse: (any BreezeCodable)?) {
-            self.keyedResponse = keyedResponse
-            self.response = response
+        self.keyedResponse = keyedResponse
+        self.response = response
     }
-
+    
     init(db: SotoDynamoDB.DynamoDB, tableName: String, keyName: String) {
         self.keyName = keyName
     }
-
+    
     func createItem<T: BreezeCodable>(item: T) async throws -> T {
         guard let response = self.response as? T else {
             throw BreezeLambdaAPIError.invalidRequest
         }
         return response
     }
-
+    
     func readItem<T: BreezeCodable>(key: String) async throws -> T {
         guard let response = self.keyedResponse as? T,
               response.key == key
@@ -46,7 +46,7 @@ actor BreezeDynamoDBManagerMock: BreezeDynamoDBManaging {
         }
         return response
     }
-
+    
     func updateItem<T: BreezeCodable>(item: T) async throws -> T {
         guard let response = self.keyedResponse as? T,
               response.key == item.key
@@ -55,7 +55,7 @@ actor BreezeDynamoDBManagerMock: BreezeDynamoDBManaging {
         }
         return response
     }
-
+    
     func deleteItem<T: BreezeCodable>(item: T) async throws {
         guard let response = self.keyedResponse,
               response.key == item.key,
@@ -66,7 +66,7 @@ actor BreezeDynamoDBManagerMock: BreezeDynamoDBManaging {
         }
         return
     }
-
+    
     var limit: Int?
     var exclusiveKey: String?
     func listItems<T: BreezeCodable>(key: String?, limit: Int?) async throws -> ListResponse<T> {

Tests/BreezeLambdaAPITests/BreezeLambdaHandlerTests.swift

@@ -222,10 +222,9 @@ struct BreezeLambdaHandlerTests {
             keyedResponse: keyedResponse,
             with: request
         )
-        let response: BreezeEmptyResponse = try apiResponse.decodeBody()
+        let _: BreezeEmptyResponse = try apiResponse.decodeBody()
         #expect(apiResponse.statusCode == .ok)
         #expect(apiResponse.headers == [ "Content-Type": "application/json" ])
-        #expect(response != nil)
     }
 
     @Test
@@ -241,10 +240,9 @@ struct BreezeLambdaHandlerTests {
             keyedResponse: keyedResponse,
             with: request
         )
-        let response: BreezeEmptyResponse = try apiResponse.decodeBody()
+        let _: BreezeEmptyResponse = try apiResponse.decodeBody()
         #expect(apiResponse.statusCode == .notFound)
         #expect(apiResponse.headers == [ "Content-Type": "application/json" ])
-        #expect(response != nil)
     }
 
     @Test