Merge pull request #536 from Iterable/tapash/mob-4101-session-tracking-ui-tests

tapashmajumder · web-flow · commit 51d886e44027 · 2022-03-22T09:29:42.000+05:30
[MOB-4101] - Add UI tests for session tracking.
diff --git a/swift-sdk.xcodeproj/project.pbxproj b/swift-sdk.xcodeproj/project.pbxproj
@@ -38,6 +38,8 @@
 		55DD207F26A0D83800773CC7 /* IterableAuthManagerProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = 55DD207E26A0D83800773CC7 /* IterableAuthManagerProtocol.swift */; };
 		55E02D39253F8D86009DB8BC /* WebViewProtocolTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 55E02D38253F8D86009DB8BC /* WebViewProtocolTests.swift */; };
 		55E6F462238E066400808BCE /* DeepLinkTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 55E6F45E238E066400808BCE /* DeepLinkTests.swift */; };
+		5B49BB3E27CFB71500E6F00C /* PopupInboxSessionUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5B49BB3D27CFB71500E6F00C /* PopupInboxSessionUITests.swift */; };
+		5B6C3C1127CE871F00B9A753 /* NavInboxSessionUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5B6C3C1027CE871F00B9A753 /* NavInboxSessionUITests.swift */; };
 		AC02480822791E2100495FB9 /* IterableInboxNavigationViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = AC02480722791E2100495FB9 /* IterableInboxNavigationViewController.swift */; };
 		AC02CAA6234E50B5006617E0 /* RegistrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = AC02CAA5234E50B5006617E0 /* RegistrationTests.swift */; };
 		AC03094B21E532470003A288 /* InAppPersistence.swift in Sources */ = {isa = PBXBuildFile; fileRef = AC03094A21E532470003A288 /* InAppPersistence.swift */; };
@@ -403,6 +405,8 @@
 		55DD207E26A0D83800773CC7 /* IterableAuthManagerProtocol.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IterableAuthManagerProtocol.swift; sourceTree = "<group>"; };
 		55E02D38253F8D86009DB8BC /* WebViewProtocolTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WebViewProtocolTests.swift; sourceTree = "<group>"; };
 		55E6F45E238E066400808BCE /* DeepLinkTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DeepLinkTests.swift; sourceTree = "<group>"; };
+		5B49BB3D27CFB71500E6F00C /* PopupInboxSessionUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PopupInboxSessionUITests.swift; sourceTree = "<group>"; };
+		5B6C3C1027CE871F00B9A753 /* NavInboxSessionUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NavInboxSessionUITests.swift; sourceTree = "<group>"; };
 		AC02480722791E2100495FB9 /* IterableInboxNavigationViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IterableInboxNavigationViewController.swift; sourceTree = "<group>"; };
 		AC02CAA5234E50B5006617E0 /* RegistrationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RegistrationTests.swift; sourceTree = "<group>"; };
 		AC03094A21E532470003A288 /* InAppPersistence.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InAppPersistence.swift; sourceTree = "<group>"; };
@@ -1215,6 +1219,8 @@
 				ACBDDE5B23C4EDEC0008CC4D /* InboxCustomizationTests.swift */,
 				ACDA977023159C39004C412E /* InboxUITests.swift */,
 				ACC6A851232407B5003CC4BE /* InboxUITestsHelper.swift */,
+				5B6C3C1027CE871F00B9A753 /* NavInboxSessionUITests.swift */,
+				5B49BB3D27CFB71500E6F00C /* PopupInboxSessionUITests.swift */,
 				ACDA977223159C39004C412E /* Info.plist */,
 			);
 			path = "inbox-ui-tests";
@@ -1972,9 +1978,11 @@
 			files = (
 				ACBDDE5C23C4EDEC0008CC4D /* InboxCustomizationTests.swift in Sources */,
 				ACC6A852232407B5003CC4BE /* InboxUITestsHelper.swift in Sources */,
+				5B49BB3E27CFB71500E6F00C /* PopupInboxSessionUITests.swift in Sources */,
 				ACFF428824656A2000FDF10D /* CommonMocks.swift in Sources */,
 				AC19520D231D9AC600CD5B61 /* Common.swift in Sources */,
 				AC195210231DAD6B00CD5B61 /* TestUtils.swift in Sources */,
+				5B6C3C1127CE871F00B9A753 /* NavInboxSessionUITests.swift in Sources */,
 				ACDA977123159C39004C412E /* InboxUITests.swift in Sources */,
 				ACC6A8502323910D003CC4BE /* UITestsHelper.swift in Sources */,
 				ACFF4287246569D300FDF10D /* CommonExtensions.swift in Sources */,
diff --git a/tests/inbox-ui-tests/InboxUITestsHelper.swift b/tests/inbox-ui-tests/InboxUITestsHelper.swift
@@ -27,17 +27,25 @@ extension IterableInboxUITestsProtocol where Self: XCTestCase {
         return request.body! as! [String: Any]
     }
     
+    func count(forEvent event: String) -> Int {
+        allEventRows(forEvent: event).count
+    }
+    
     func serializableRequest(forEvent event: String) -> SerializableRequest {
         let serializedString = lastElement(forEvent: event).staticTexts["serializedString"].label
         return SerializableRequest.create(from: serializedString)
     }
     
     private func lastElement(forEvent event: String) -> XCUIElement {
-        let eventRows = app.tables.cells.containing(.staticText, identifier: Const.apiPath + event)
+        let eventRows = allEventRows(forEvent: event)
         let count = eventRows.count
         return eventRows.element(boundBy: count - 1)
     }
     
+    private func allEventRows(forEvent event: String) -> XCUIElementQuery {
+        app.tables.cells.containing(.staticText, identifier: Const.apiPath + event)
+    }
+    
     func gotoTab(_ tabName: TabName) {
         app.gotoTab(tabName.rawValue)
     }
diff --git a/tests/inbox-ui-tests/NavInboxSessionUITests.swift b/tests/inbox-ui-tests/NavInboxSessionUITests.swift
@@ -0,0 +1,96 @@
+//
+//  Copyright © 2022 Iterable. All rights reserved.
+//
+
+import XCTest
+
+@testable import IterableSDK
+
+class NavInboxSessionUITests: XCTestCase, IterableInboxUITestsProtocol {
+    lazy var app: XCUIApplication! = UITestsGlobal.application
+    
+    override func setUp() {
+        // In UI tests it is usually best to stop immediately when a failure occurs.
+        continueAfterFailure = false
+
+        clearNetwork()
+    }
+    
+    func test_simple_tab_switch() {
+        gotoTab(.home)
+        app.button(withText: "Load Dataset 1").tap()
+        
+        gotoTab(.customInbox)
+        sleep(1)
+        gotoTab(.network)
+
+        XCTAssertEqual(count(forEvent: Const.Path.trackInboxSession), 1)
+
+        let dict = body(forEvent: Const.Path.trackInboxSession)
+        let impressions = dict[keyPath: KeyPath(keys: JsonKey.impressions)] as! [[String: Any]]
+        XCTAssertEqual(impressions.count, 3)
+    }
+
+    func test_view_messages_continues_session() {
+        gotoTab(.home)
+        app.button(withText: "Load Dataset 1").tap()
+        
+        gotoTab(.customInbox)
+        // view first message
+        app.tableCell(withText: "title1").waitToAppear().tap()
+        app.navButton(withText: "Custom Inbox").waitToAppear().tap()
+        // view second message
+        app.tableCell(withText: "title2").waitToAppear().tap()
+        app.navButton(withText: "Custom Inbox").waitToAppear().tap()
+        
+        gotoTab(.network)
+        XCTAssertEqual(count(forEvent: Const.Path.trackInboxSession), 1)
+
+        let dict = body(forEvent: Const.Path.trackInboxSession)
+        let impressions = dict[keyPath: KeyPath(keys: JsonKey.impressions)] as! [[String: Any]]
+        XCTAssertEqual(impressions.count, 3)
+    }
+
+    func test_currently_viewing_message_continues_session() {
+        gotoTab(.home)
+        app.button(withText: "Load Dataset 1").tap()
+        
+        gotoTab(.customInbox)
+        // view first message
+        app.tableCell(withText: "title1").waitToAppear().tap()
+        gotoTab(.network)
+        app.swipeUp()
+        app.swipeUp()
+        XCTAssertEqual(count(forEvent: Const.Path.trackInboxSession), 1)
+
+        let dict = body(forEvent: Const.Path.trackInboxSession)
+        let impressions = dict[keyPath: KeyPath(keys: JsonKey.impressions)] as! [[String: Any]]
+        XCTAssertEqual(impressions.count, 3)
+
+        // remove the showing message
+        gotoTab(.customInbox)
+        app.navButton(withText: "Custom Inbox").waitToAppear().tap()
+    }
+
+    func test_back_to_viewing_message_starts_new_session() {
+        gotoTab(.home)
+        app.button(withText: "Load Dataset 1").tap()
+        
+        gotoTab(.customInbox)
+        // view first message
+        app.tableCell(withText: "title1").waitToAppear().tap()
+        gotoTab(.network)
+        app.swipeUp()
+        app.swipeUp()
+        XCTAssertEqual(count(forEvent: Const.Path.trackInboxSession), 1)
+
+        // back to inbox
+        gotoTab(.customInbox)
+        gotoTab(.network)
+        XCTAssertEqual(count(forEvent: Const.Path.trackInboxSession), 2)
+
+        // remove the showing message
+        gotoTab(.customInbox)
+        app.navButton(withText: "Custom Inbox").waitToAppear().tap()
+    }
+}
diff --git a/tests/inbox-ui-tests/PopupInboxSessionUITests.swift b/tests/inbox-ui-tests/PopupInboxSessionUITests.swift
@@ -0,0 +1,55 @@
+//
+//  Copyright © 2022 Iterable. All rights reserved.
+//
+
+import XCTest
+
+@testable import IterableSDK
+
+class PopupInboxSessionUITests: XCTestCase, IterableInboxUITestsProtocol {
+    lazy var app: XCUIApplication! = UITestsGlobal.application
+    
+    override func setUp() {
+        // In UI tests it is usually best to stop immediately when a failure occurs.
+        continueAfterFailure = false
+
+        clearNetwork()
+    }
+    
+    func test_simple_tab_switch() {
+        gotoTab(.home)
+        app.button(withText: "Load Dataset 1").tap()
+        
+        gotoTab(.inbox)
+        sleep(1)
+        gotoTab(.network)
+
+        XCTAssertEqual(count(forEvent: Const.Path.trackInboxSession), 1)
+
+        let dict = body(forEvent: Const.Path.trackInboxSession)
+        let impressions = dict[keyPath: KeyPath(keys: JsonKey.impressions)] as! [[String: Any]]
+        XCTAssertEqual(impressions.count, 3)
+    }
+
+    func test_view_messages_continues_session() {
+        gotoTab(.home)
+        app.button(withText: "Load Dataset 1").tap()
+        
+        gotoTab(.inbox)
+        // view first message
+        app.tableCell(withText: "title1").waitToAppear().tap()
+        app.link(withText: "Click Here1").waitToAppear().tap()
+        // view second message
+        app.tableCell(withText: "title2").waitToAppear().tap()
+        app.link(withText: "Click Here2").waitToAppear().tap()
+        
+        gotoTab(.network)
+        app.swipeUp()
+        app.swipeUp()
+        XCTAssertEqual(count(forEvent: Const.Path.trackInboxSession), 1)
+
+        let dict = body(forEvent: Const.Path.trackInboxSession)
+        let impressions = dict[keyPath: KeyPath(keys: JsonKey.impressions)] as! [[String: Any]]
+        XCTAssertEqual(impressions.count, 3)
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -27,17 +27,25 @@ extension IterableInboxUITestsProtocol where Self: XCTestCase {`
`27`	`27`	`return request.body! as! [String: Any]`
`28`	`28`	`}`
`29`	`29`
	`30`	`+ func count(forEvent event: String) -> Int {`
	`31`	`+ allEventRows(forEvent: event).count`
	`32`	`+ }`
	`33`	`+`
`30`	`34`	`func serializableRequest(forEvent event: String) -> SerializableRequest {`
`31`	`35`	`let serializedString = lastElement(forEvent: event).staticTexts["serializedString"].label`
`32`	`36`	`return SerializableRequest.create(from: serializedString)`
`33`	`37`	`}`
`34`	`38`
`35`	`39`	`private func lastElement(forEvent event: String) -> XCUIElement {`
`36`		`- let eventRows = app.tables.cells.containing(.staticText, identifier: Const.apiPath + event)`
	`40`	`+ let eventRows = allEventRows(forEvent: event)`
`37`	`41`	`let count = eventRows.count`
`38`	`42`	`return eventRows.element(boundBy: count - 1)`
`39`	`43`	`}`
`40`	`44`
	`45`	`+ private func allEventRows(forEvent event: String) -> XCUIElementQuery {`
	`46`	`+ app.tables.cells.containing(.staticText, identifier: Const.apiPath + event)`
	`47`	`+ }`
	`48`	`+`
`41`	`49`	`func gotoTab(_ tabName: TabName) {`
`42`	`50`	`app.gotoTab(tabName.rawValue)`
`43`	`51`	`}`