test(DataStore): Add V2 Connection Integration tests (#1557)

* test: Add V2 Connection schema and files

* Blog Post Comment 6 V2 - integration tests

* Blog Post Comment 7 V2 - integration tests

* Project1V2 Team1V2 hasOne Implicit

* Project2V2 Team2V2 hasOne Explicit

* Comment3aV2 Post3aV2 HasMany Implicit and Explicit

* Post5V2 User5V2 ManyToMany

* Comment4V2 Post4V2 Bi-directional Has Many

* Model with Secondary Index
Model With Custom Timestamps
Model with Default Value

* Add code compiling for BelongsTo Implicit and Explicit (Project4aV2 Project4bV2 Team4aV2 Team4bV2

* Blog7V2 Post7V2 to latest codegen - compiling

* clean up - rename folder, remove dedup schema file

* Blog6V2 Post6V2 Comment6V2 cascade delete Blog deletes post and comments

* Team1V2 Project1V2 cascade delete test - disabled

* CustomerSecondaryIndexV2 add update and delete test

* TodoWithDefaultValueV2 test without explicit content

* TodoCustomTimestampV2 with failing update and passing delete

* Project1V2 Team1V2 Has One (Implicit) DataStoreConnectionScenario1V2Tests update test with sync for updated and deleted models

* Project1/1V2/2/2V2 Add unit test showcasing cascade delete is not working

* CRUD with cascade tests in 3aV2 (implicit has-many)  3V2 (explicit has-many) and 5V2 (many-to-many)

* CRUD with cacade tests in 4V2 DataStoreConnectionScenario4V2Tests

* CRUD with cascade test in 7V2 DataStoreConnectionScenario7V2Tests

* add github issue related to DataStoreModelWithCustomTimestampTests missing id in update mutation

* latest codegen changes for Project4aV2 Project4bV2

* DataStoreConnectionScenario8V2Tests for use case 13

* Update AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginIntegrationTests/TransformerV2/DataStoreModelWithDefaultValueTests.swift

Co-authored-by: Diego Costantino <[email protected]>

* Update AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginIntegrationTests/TransformerV2/DataStoreModelWithDefaultValueTests.swift

Co-authored-by: Diego Costantino <[email protected]>

* Update AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginIntegrationTests/TransformerV2/DataStoreModelWithSecondaryIndexTests.swift

Co-authored-by: Diego Costantino <[email protected]>

* update readme

* fix podfile.lock

* schema update

Co-authored-by: Diego Costantino <[email protected]>

Author: lawmicha

Amplify.xcodeproj/project.pbxproj

@@ -185,13 +185,48 @@ class DataStoreConnectionScenario1Tests: SyncEngineIntegrationTestBase {
         wait(for: [queriedProjectCompleted, syncUpdatedProjectReceived], timeout: networkTimeout)
     }
 
-    func testDeleteAndGetProject() throws {
+    func testDeleteAndGetProjectReturnsNilWithSync() throws {
         try startAmplifyAndWaitForSync()
         guard let team = saveTeam(name: "name"),
               let project = saveProject(teamID: team.id, team: team) else {
             XCTFail("Could not save team and project")
             return
         }
+        let createReceived = expectation(description: "received created items from cloud")
+        createReceived.expectedFulfillmentCount = 2 // 1 project and 1 team
+        let deleteReceived = expectation(description: "Delete notification received")
+        deleteReceived.expectedFulfillmentCount = 2 // 1 project and 1 team
+        let hubListener = Amplify.Hub.listen(to: .dataStore,
+                                             eventName: HubPayload.EventName.DataStore.syncReceived) { payload in
+            guard let mutationEvent = payload.data as? MutationEvent else {
+                XCTFail("Could not cast payload to mutation event")
+                return
+            }
+
+            if let projectEvent = try? mutationEvent.decodeModel() as? Project1,
+               projectEvent.id == project.id {
+                if mutationEvent.mutationType == GraphQLMutationType.create.rawValue {
+                    XCTAssertEqual(mutationEvent.version, 1)
+                    createReceived.fulfill()
+                } else if mutationEvent.mutationType == GraphQLMutationType.delete.rawValue {
+                    deleteReceived.fulfill()
+                }
+
+            } else if let teamEvent = try? mutationEvent.decodeModel() as? Team1, teamEvent.id == team.id {
+                if mutationEvent.mutationType == GraphQLMutationType.create.rawValue {
+                    XCTAssertEqual(mutationEvent.version, 1)
+                    createReceived.fulfill()
+                } else if mutationEvent.mutationType == GraphQLMutationType.delete.rawValue {
+                    deleteReceived.fulfill()
+                }
+            }
+
+        }
+        guard try HubListenerTestUtilities.waitForListener(with: hubListener, timeout: 5.0) else {
+            XCTFail("Listener not registered for hub")
+            return
+        }
+        wait(for: [createReceived], timeout: TestCommonConstants.networkTimeout)
 
         let deleteProjectSuccessful = expectation(description: "delete project")
         Amplify.DataStore.delete(project) { result in
@@ -203,6 +238,20 @@ class DataStoreConnectionScenario1Tests: SyncEngineIntegrationTestBase {
             }
         }
         wait(for: [deleteProjectSuccessful], timeout: TestCommonConstants.networkTimeout)
+
+        // TODO: Delete Team should not be necessary, cascade delete should delete the team when deleting the project.
+        // Once cascade works for hasOne, the following code can be removed.
+        let deleteTeamSuccessful = expectation(description: "delete team")
+        Amplify.DataStore.delete(team) { result in
+            switch result {
+            case .success:
+                deleteTeamSuccessful.fulfill()
+            case .failure(let error):
+                XCTFail("\(error)")
+            }
+        }
+        wait(for: [deleteTeamSuccessful, deleteReceived], timeout: TestCommonConstants.networkTimeout)
+
         let getProjectAfterDeleteCompleted = expectation(description: "get project after deleted complete")
         Amplify.DataStore.query(Project1.self, byId: project.id) { result in
             switch result {

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginIntegrationTests/Connection/DataStoreConnectionScenario1Tests.swift

@@ -183,13 +183,48 @@ class DataStoreConnectionScenario2Tests: SyncEngineIntegrationTestBase {
         wait(for: [queriedProjectCompleted, syncUpdatedProjectReceived], timeout: networkTimeout)
     }
 
-    func testDeleteAndGetProject() throws {
+    func testDeleteAndGetProjectReturnsNilWithSync() throws {
         try startAmplifyAndWaitForSync()
         guard let team = saveTeam(name: "name"),
               let project = saveProject(teamID: team.id, team: team) else {
             XCTFail("Could not save team and project")
             return
         }
+        let createReceived = expectation(description: "received created items from cloud")
+        createReceived.expectedFulfillmentCount = 2 // 1 project and 1 team
+        let deleteReceived = expectation(description: "Delete notification received")
+        deleteReceived.expectedFulfillmentCount = 2 // 1 project and 1 team
+        let hubListener = Amplify.Hub.listen(to: .dataStore,
+                                             eventName: HubPayload.EventName.DataStore.syncReceived) { payload in
+            guard let mutationEvent = payload.data as? MutationEvent else {
+                XCTFail("Could not cast payload to mutation event")
+                return
+            }
+
+            if let projectEvent = try? mutationEvent.decodeModel() as? Project2,
+               projectEvent.id == project.id {
+                if mutationEvent.mutationType == GraphQLMutationType.create.rawValue {
+                    XCTAssertEqual(mutationEvent.version, 1)
+                    createReceived.fulfill()
+                } else if mutationEvent.mutationType == GraphQLMutationType.delete.rawValue {
+                    deleteReceived.fulfill()
+                }
+
+            } else if let teamEvent = try? mutationEvent.decodeModel() as? Team2, teamEvent.id == team.id {
+                if mutationEvent.mutationType == GraphQLMutationType.create.rawValue {
+                    XCTAssertEqual(mutationEvent.version, 1)
+                    createReceived.fulfill()
+                } else if mutationEvent.mutationType == GraphQLMutationType.delete.rawValue {
+                    deleteReceived.fulfill()
+                }
+            }
+
+        }
+        guard try HubListenerTestUtilities.waitForListener(with: hubListener, timeout: 5.0) else {
+            XCTFail("Listener not registered for hub")
+            return
+        }
+        wait(for: [createReceived], timeout: TestCommonConstants.networkTimeout)
 
         let deleteProjectSuccessful = expectation(description: "delete project")
         Amplify.DataStore.delete(project) { result in
@@ -201,6 +236,20 @@ class DataStoreConnectionScenario2Tests: SyncEngineIntegrationTestBase {
             }
         }
         wait(for: [deleteProjectSuccessful], timeout: TestCommonConstants.networkTimeout)
+
+        // TODO: Delete Team should not be necessary, cascade delete should delete the team when deleting the project.
+        // Once cascade works for hasOne, the following code can be removed.
+        let deleteTeamSuccessful = expectation(description: "delete team")
+        Amplify.DataStore.delete(team) { result in
+            switch result {
+            case .success:
+                deleteTeamSuccessful.fulfill()
+            case .failure(let error):
+                XCTFail("\(error)")
+            }
+        }
+        wait(for: [deleteTeamSuccessful, deleteReceived], timeout: TestCommonConstants.networkTimeout)
+
         let getProjectAfterDeleteCompleted = expectation(description: "get project after deleted complete")
         Amplify.DataStore.query(Project2.self, byId: project.id) { result in
             switch result {

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginIntegrationTests/Connection/DataStoreConnectionScenario2Tests.swift

@@ -14,7 +14,7 @@ import AWSMobileClient
 @testable import AWSDataStoreCategoryPlugin
 
 /*
-(HasMany) A Post that can have many comments
+(HasMany) A Post that can have many comments (Explicit)
 ```
 type Post3 @model {
   id: ID!

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginIntegrationTests/Connection/DataStoreConnectionScenario3Tests.swift

@@ -234,6 +234,7 @@ type CustomerOrder @model
    orderId: String!
    email: String!
 }
+
 ```
 3. `amplify push`
 

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginIntegrationTests/README.md

@@ -0,0 +1,127 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import XCTest
+
+import AmplifyPlugins
+import AWSMobileClient
+
+@testable import Amplify
+@testable import AmplifyTestCommon
+@testable import AWSDataStoreCategoryPlugin
+
+class SyncEngineIntegrationV2TestBase: DataStoreTestBase {
+
+    static let amplifyConfigurationFile = "testconfiguration/AWSDataStoreCategoryPluginIntegrationV2Tests-amplifyconfiguration"
+
+    static let networkTimeout = TimeInterval(180)
+    let networkTimeout = SyncEngineIntegrationTestBase.networkTimeout
+
+    // Convenience property to obtain a handle to the underlying storage adapter implementation, for use in asserting
+    // database behaviors. Full of force-unwrapped badness.
+    // swiftlint:disable force_try
+    // swiftlint:disable force_cast
+    var storageAdapter: SQLiteStorageEngineAdapter {
+        let plugin = try! Amplify.DataStore.getPlugin(for: "awsDataStorePlugin") as! AWSDataStorePlugin
+        let storageEngine = plugin.storageEngine as! StorageEngine
+        let storageAdapter = storageEngine.storageAdapter as! SQLiteStorageEngineAdapter
+        return storageAdapter
+    }
+    // swiftlint:enable force_try
+    // swiftlint:enable force_cast
+
+    override func setUp() {
+        super.setUp()
+
+        continueAfterFailure = false
+
+        Amplify.reset()
+        Amplify.Logging.logLevel = .verbose
+
+        do {
+            try Amplify.add(plugin: AWSAPIPlugin(modelRegistration: TestModelV2Registration()))
+            try Amplify.add(plugin: AWSDataStorePlugin(modelRegistration: TestModelV2Registration()))
+        } catch {
+            XCTFail(String(describing: error))
+            return
+        }
+    }
+
+    func stopDataStore() {
+        let stopped = expectation(description: "DataStore stopped")
+        Amplify.DataStore.stop { result in
+            switch result {
+            case .success:
+                stopped.fulfill()
+            case .failure(let error):
+                XCTFail("\(error)")
+            }
+        }
+        wait(for: [stopped], timeout: 2)
+    }
+
+    func clearDataStore() {
+        let cleared = expectation(description: "DataStore cleared")
+        Amplify.DataStore.clear { result in
+            switch result {
+            case .success:
+                cleared.fulfill()
+            case .failure(let error):
+                XCTFail("\(error)")
+            }
+        }
+        wait(for: [cleared], timeout: 2)
+    }
+
+    func startAmplify(_ completion: BasicClosure? = nil) throws {
+        let amplifyConfig = try TestConfigHelper.retrieveAmplifyConfiguration(forResource: Self.amplifyConfigurationFile)
+
+        DispatchQueue.global().async {
+            do {
+                try Amplify.configure(amplifyConfig)
+                completion?()
+            } catch {
+                XCTFail(String(describing: error))
+            }
+        }
+    }
+
+    func startAmplifyAndWaitForSync() throws {
+        try startAmplifyAndWait(for: HubPayload.EventName.DataStore.syncStarted)
+    }
+
+    func startAmplifyAndWaitForReady() throws {
+        try startAmplifyAndWait(for: HubPayload.EventName.DataStore.ready)
+    }
+
+    private func startAmplifyAndWait(for eventName: String) throws {
+        let eventReceived = expectation(description: "DataStore \(eventName) event")
+
+        var token: UnsubscribeToken!
+        token = Amplify.Hub.listen(to: .dataStore,
+                                   eventName: eventName) { _ in
+            eventReceived.fulfill()
+            Amplify.Hub.removeListener(token)
+        }
+
+        guard try HubListenerTestUtilities.waitForListener(with: token, timeout: 5.0) else {
+            XCTFail("Hub Listener not registered")
+            return
+        }
+
+        try startAmplify {
+            Amplify.DataStore.start { result in
+                if case .failure(let error) = result {
+                    XCTFail("\(error)")
+                }
+            }
+        }
+
+        wait(for: [eventReceived], timeout: 100.0)
+    }
+
+}

AmplifyPlugins/DataStore/AWSDataStoreCategoryPluginIntegrationTests/TestSupport/SyncEngineIntegrationV2TestBase.swift

@@ -0,0 +1,44 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Amplify
+import AmplifyTestCommon
+
+struct TestModelV2Registration: AmplifyModelRegistration {
+
+    func registerModels(registry: ModelRegistry.Type) {
+        registry.register(modelType: Project1V2.self)
+        registry.register(modelType: Team1V2.self)
+        registry.register(modelType: Project2V2.self)
+        registry.register(modelType: Team2V2.self)
+        registry.register(modelType: Post3aV2.self)
+        registry.register(modelType: Comment3aV2.self)
+        registry.register(modelType: Post3V2.self)
+        registry.register(modelType: Comment3V2.self)
+        registry.register(modelType: Post4V2.self)
+        registry.register(modelType: Comment4V2.self)
+        registry.register(modelType: Post5V2.self)
+        registry.register(modelType: PostEditor5V2.self)
+        registry.register(modelType: User5V2.self)
+        registry.register(modelType: Blog6V2.self)
+        registry.register(modelType: Post6V2.self)
+        registry.register(modelType: Comment6V2.self)
+        registry.register(modelType: Blog7V2.self)
+        registry.register(modelType: Post7V2.self)
+        registry.register(modelType: Comment7V2.self)
+        registry.register(modelType: Meeting8V2.self)
+        registry.register(modelType: Attendee8V2.self)
+        registry.register(modelType: Registration8V2.self)
+
+        registry.register(modelType: CustomerSecondaryIndexV2.self)
+        registry.register(modelType: TodoWithDefaultValueV2.self)
+        registry.register(modelType: TodoCustomTimestampV2.self)
+    }
+
+    let version: String = "1"
+
+}