UITests and Mock Screens

Adds the test targets for Unit and UI tests
Adds mock screen data and utilities to render each mock screen for previews/ui tests.
Changes Published property in the service to CurrentValueSubject. we don't need the synthesized aspect of Published and property wrappers cannot be included in protocols.

RiotSwiftUI/Modules/Template/SimpleUserProfileExample/Service/MatrixSDK/TemplateUserProfileService.swift

@@ -27,8 +27,6 @@ class TemplateUserProfileService: TemplateUserProfileServiceProtocol {
     private let session: MXSession
     private var listenerReference: Any?
     
-    @Published private var presence: TemplateUserProfilePresence = .offline
-    
     // MARK: Public
     
     var userId: String {
@@ -43,14 +41,13 @@ class TemplateUserProfileService: TemplateUserProfileServiceProtocol {
         session.myUser.avatarUrl
     }
     
-    var presencePublisher: AnyPublisher<TemplateUserProfilePresence, Never> {
-        $presence.eraseToAnyPublisher()
-    }
+    private(set) var presenceSubject: CurrentValueSubject<TemplateUserProfilePresence, Never>
     
     // MARK: - Setup
     
     init(session: MXSession) {
         self.session = session
+        self.presenceSubject = CurrentValueSubject(TemplateUserProfilePresence(mxPresence: session.myUser.presence))
         self.listenerReference = setupPresenceListener()
     }
 
@@ -65,7 +62,7 @@ class TemplateUserProfileService: TemplateUserProfileServiceProtocol {
                   let event = event,
                   case .presence = MXEventType(identifier: event.eventId)
             else { return }
-            self.presence = TemplateUserProfilePresence(mxPresence: self.session.myUser.presence)
+            self.presenceSubject.send(TemplateUserProfilePresence(mxPresence: self.session.myUser.presence)) 
         }
 //        TODO: Add log back when abstract logger added to RiotSwiftUI
 //        if reference == nil {

RiotSwiftUI/Modules/Template/SimpleUserProfileExample/Service/Mock/MockTemplateProfileUserScreen.swift

@@ -0,0 +1,45 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// 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 Foundation
+import SwiftUI
+
+/**
+ Using an enum for the screen allows you define the different state cases with
+ the relevant associated data for each case.
+ */
+@available(iOS 14.0, *)
+enum MockTemplateProfileUserScreenStates: MockScreen {
+    
+    case mockPresenceStates(TemplateUserProfilePresence)
+    case mockLongDisplayName(String)
+    
+    static var screenStates: [MockTemplateProfileUserScreenStates] = TemplateUserProfilePresence.allCases.map(MockTemplateProfileUserScreenStates.mockPresenceStates)
+        + [.mockLongDisplayName("Somebody with a super long name we would like to test")]
+    
+    static func screen(for state: MockTemplateProfileUserScreenStates) -> some View {
+        let service: MockTemplateUserProfileService
+        switch state {
+        case .mockPresenceStates(let presence):
+            service = MockTemplateUserProfileService(presence: presence)
+        case .mockLongDisplayName(let displayName):
+            service = MockTemplateUserProfileService(displayName: displayName)
+        }
+        let viewModel = TemplateUserProfileViewModel(userService: service)
+        return TemplateUserProfile(viewModel: viewModel)
+                .addDependency(MockAvatarService.example)
+    }
+}

RiotSwiftUI/Modules/Template/SimpleUserProfileExample/Service/Mock/MockTemplateUserProfileService.swift

@@ -19,20 +19,24 @@ import Combine
 
 @available(iOS 14.0, *)
 class MockTemplateUserProfileService: TemplateUserProfileServiceProtocol {
-
-    static let example = MockTemplateUserProfileService()
-    static let initialPresenceState: TemplateUserProfilePresence = .offline
-    @Published var presence: TemplateUserProfilePresence = initialPresenceState
-    var presencePublisher: AnyPublisher<TemplateUserProfilePresence, Never> {
-        $presence.eraseToAnyPublisher()
+    var presenceSubject: CurrentValueSubject<TemplateUserProfilePresence, Never>
+    
+    let userId: String
+    var displayName: String?
+    let avatarUrl: String?
+    init(
+        userId: String = "123",
+        displayName:  String? = "Alice",
+        avatarUrl: String? = "mx123@matrix.com",
+        presence: TemplateUserProfilePresence = .offline
+    ) {
+        self.userId = userId
+        self.displayName = displayName
+        self.avatarUrl = avatarUrl
+        self.presenceSubject = CurrentValueSubject<TemplateUserProfilePresence, Never>(presence)
     }
-    let userId: String = "123"
-    let displayName: String? = "Alice"
-    let avatarUrl: String? = "mx123@matrix.com"
-    let currentlyActive: Bool = true
-    let lastActive: UInt = 1630596918513
     
     func simulateUpdate(presence: TemplateUserProfilePresence) {
-        self.presence = presence
+        self.presenceSubject.send(presence)
     }
 }

RiotSwiftUI/Modules/Template/SimpleUserProfileExample/Service/TemplateUserProfileServiceProtocol.swift

@@ -22,7 +22,7 @@ protocol TemplateUserProfileServiceProtocol: Avatarable {
     var userId: String { get }
     var displayName: String? { get }
     var avatarUrl: String? { get }
-    var presencePublisher: AnyPublisher<TemplateUserProfilePresence, Never> { get }
+    var presenceSubject: CurrentValueSubject<TemplateUserProfilePresence, Never> { get }
 }
 
 @available(iOS 14.0, *)