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/Common/Mock/MockScreen.swift

@@ -0,0 +1,58 @@
+// 
+// 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 SwiftUI
+
+/*
+ Used for mocking top level screens and their various state.
+ */
+@available(iOS 14.0, *)
+protocol MockScreen {
+    associatedtype ScreenType: View
+    static func screen(for state: Self) -> ScreenType
+    static var screenStates: [Self] { get }
+}
+
+
+@available(iOS 14.0, *)
+extension MockScreen {
+    
+    /*
+     Get a list of the screens for every screen state.
+     */
+    static var screens: [ScreenType] {
+        Self.screenStates.map(screen(for:))
+    }
+    
+    /*
+     Render each of the screen states in a group applying
+     any optional environment variables.
+     */
+    static func screenGroup(
+        themeId: ThemeIdentifier = .light,
+        locale: Locale = Locale.current,
+        sizeCategory: ContentSizeCategory = ContentSizeCategory.medium
+    ) -> some View {
+        Group {
+            ForEach(0..<screens.count) { index in
+                screens[index]
+            }
+        }
+        .theme(themeId)
+        .environment(\.locale, locale)
+        .environment(\.sizeCategory, sizeCategory)
+    }
+}

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, *)

RiotSwiftUI/Modules/Template/SimpleUserProfileExample/Test/UI/TestUserProfileUITests.swift

@@ -0,0 +1,47 @@
+// 
+// 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 XCTest
+
+@testable import RiotSwiftUI
+
+@available(iOS 14.0, *)
+class TestUserProfileUITests: XCTestCase {
+
+    let app = XCUIApplication()
+    
+    override func setUpWithError() throws {
+        // Put setup code here. This method is called before the invocation of each test method in the class.
+
+        // In UI tests it is usually best to stop immediately when a failure occurs.
+        continueAfterFailure = false
+
+        // UI tests must launch the application that they test. Doing this in setup will make sure it happens for each test method.
+        app.launch()
+
+        // In UI tests it’s important to set the initial state - such as interface orientation - required for your tests before they run. The setUp method is a good place to do this.
+    }
+
+    override func tearDownWithError() throws {
+        // Put teardown code here. This method is called after the invocation of each test method in the class.
+    }
+
+    func testUserContentTextDisplayed() throws {
+        let userContentText = app.staticTexts["More great user content!"]
+        XCTAssert(userContentText.exists)
+    }
+
+}

RiotSwiftUI/Modules/Template/SimpleUserProfileExample/Test/Unit/TemplateUserProfileViewModelTests.swift

@@ -17,27 +17,30 @@
 import XCTest
 import Combine
 
-@testable import Riot
+@testable import RiotSwiftUI
 
 @available(iOS 14.0, *)
 class TemplateUserProfileViewModelTests: XCTestCase {
+    private enum Constants {
+        static let presenceInitialValue: TemplateUserProfilePresence = .offline
+        static let displayName = "Alice"
+    }
     var service: MockTemplateUserProfileService!
     var viewModel: TemplateUserProfileViewModel!
     var cancellables = Set<AnyCancellable>()
     override func setUpWithError() throws {
-        service = MockTemplateUserProfileService()
+        service = MockTemplateUserProfileService(displayName: Constants.displayName, presence: Constants.presenceInitialValue)
         viewModel = TemplateUserProfileViewModel(userService: service)
     }
     
     func testInitialState() {
-        XCTAssertEqual(viewModel.viewState.displayName, MockTemplateUserProfileService.example.displayName)
-        XCTAssertEqual(viewModel.viewState.avatar?.mxContentUri, MockTemplateUserProfileService.example.avatarUrl)
-        XCTAssertEqual(viewModel.viewState.presence, MockTemplateUserProfileService.initialPresenceState)
+        XCTAssertEqual(viewModel.viewState.displayName, Constants.displayName)
+        XCTAssertEqual(viewModel.viewState.presence, Constants.presenceInitialValue)
     }
 
     func testFirstPresenceRecieved() throws {
         let presencePublisher = viewModel.$viewState.map(\.presence).removeDuplicates().collect(1).first()
-        XCTAssertEqual(try xcAwait(presencePublisher), [MockTemplateUserProfileService.initialPresenceState])
+        XCTAssertEqual(try xcAwait(presencePublisher), [Constants.presenceInitialValue])
     }
     
     func testPresenceUpdatesRecieved() throws {
@@ -46,8 +49,6 @@ class TemplateUserProfileViewModelTests: XCTestCase {
         let newPresenceValue2: TemplateUserProfilePresence = .idle
         service.simulateUpdate(presence: newPresenceValue1)
         service.simulateUpdate(presence: newPresenceValue2)
-        XCTAssertEqual(try xcAwait(presencePublisher), [MockTemplateUserProfileService.initialPresenceState, newPresenceValue1, newPresenceValue2])
+        XCTAssertEqual(try xcAwait(presencePublisher), [Constants.presenceInitialValue, newPresenceValue1, newPresenceValue2])
     }
-    
-    
 }

RiotSwiftUI/Modules/Template/SimpleUserProfileExample/View/TemplateUserProfile.swift

@@ -45,6 +45,7 @@ struct TemplateUserProfile: View {
             }
             .frame(maxHeight: .infinity)
         }
+        .background(theme.colors.background)
         .frame(maxHeight: .infinity)
         .navigationTitle(viewModel.viewState.displayName ?? "")
         .navigationBarItems(leading: leftButton, trailing: rightButton)
@@ -70,7 +71,6 @@ struct TemplateUserProfile: View {
 @available(iOS 14.0, *)
 struct TemplateUserProfile_Previews: PreviewProvider {
     static var previews: some View {
-        TemplateUserProfile(viewModel: TemplateUserProfileViewModel(userService: MockTemplateUserProfileService.example))
-        .addDependency(MockAvatarService.example)
+        MockTemplateProfileUserScreenStates.screenGroup()
     }
 }

RiotSwiftUI/Modules/Template/SimpleUserProfileExample/ViewModel/TemplateUserProfileViewModel.swift

@@ -36,7 +36,7 @@ class TemplateUserProfileViewModel: ObservableObject, TemplateUserProfileViewMod
         self.userService = userService
         self.viewState = initialState ?? Self.defaultState(userService: userService)
         
-        userService.presencePublisher
+        userService.presenceSubject
             .map(TemplateUserProfileStateAction.updatePresence)
             .receive(on: DispatchQueue.main)
             .sink(receiveValue: { [weak self] action in
@@ -46,7 +46,7 @@ class TemplateUserProfileViewModel: ObservableObject, TemplateUserProfileViewMod
     }
     
     private static func defaultState(userService: TemplateUserProfileServiceProtocol) -> TemplateUserProfileViewState {
-        return TemplateUserProfileViewState(avatar: userService.avatarData, displayName: userService.displayName, presence: .offline)
+        return TemplateUserProfileViewState(avatar: userService.avatarData, displayName: userService.displayName, presence: userService.presenceSubject.value)
     }
     
     // MARK: - Public

RiotSwiftUI/RiotSwiftUIApp.swift

@@ -16,8 +16,7 @@
 import SwiftUI
 
 /**
- Just needed so the application target has an entry point for the moment.
- Could use to render the different screens.
+ RiotSwiftUI screens rendered for UI Tests.
  */
 @available(iOS 14.0, *)
 @main

RiotSwiftUI/targetUITests.yml

@@ -0,0 +1,62 @@
+name: RiotSwiftUITests
+
+schemes:
+  RiotSwiftUITests:
+    analyze:
+      config: Debug
+    archive:
+      config: Release
+    build:
+      targets:
+        RiotSwiftUITests:
+        - running
+        - testing
+        - profiling
+        - analyzing
+        - archiving
+    profile:
+      config: Release
+    run:
+      config: Debug
+      disableMainThreadChecker: true
+    test:
+      config: Debug
+      disableMainThreadChecker: true
+      targets:
+      - RiotSwiftUITests
+
+targets:
+  RiotSwiftUITests:
+    type: bundle.ui-testing
+    platform: iOS
+
+    dependencies:
+    - target: RiotSwiftUI
+
+#    configFiles:
+#      Debug: Debug.xcconfig
+#      Release: Release.xcconfig
+
+    settings:
+      base:
+        TEST_TARGET_NAME: RiotSwiftUI
+#        PRODUCT_NAME: RiotSwiftUITests
+        PRODUCT_BUNDLE_IDENTIFIER: org.matrix.RiotSwiftUITests$(rfc1034identifier)
+#        BUNDLE_LOADER: $(TEST_HOST)
+#        FRAMEWORK_SEARCH_PATHS: $(SDKROOT)/Developer/Library/Frameworks $(inherited)
+#        INFOPLIST_FILE: RiotSwiftUI/Info.plist
+#        LD_RUNPATH_SEARCH_PATHS: $(inherited) @executable_path/Frameworks @loader_path/Frameworks
+#        PRODUCT_BUNDLE_IDENTIFIER: org.matrix.$(PRODUCT_NAME:rfc1034identifier)
+#        PRODUCT_NAME: RiotSwiftUITests
+#        TEST_TARGET_NAME: $(BUILT_PRODUCTS_DIR)/RiotSwiftUI.app/RiotSwiftUI
+#      configs:
+#        Debug:
+#        Release:
+#          PROVISIONING_PROFILE: $(RIOT_PROVISIONING_PROFILE)
+#          PROVISIONING_PROFILE_SPECIFIER: $(RIOT_PROVISIONING_PROFILE_SPECIFIER)
+    sources:
+    - path: ../RiotSwiftUI/Modules
+      includes:
+      - "**/Test"
+      excludes:
+      - "**/Test/Unit/**"

RiotSwiftUI/targetUnitTests.yml

@@ -0,0 +1,57 @@
+name: RiotSwiftUnitTests
+
+schemes:
+  RiotSwiftUnitTests:
+    analyze:
+      config: Debug
+    archive:
+      config: Release
+    build:
+      targets:
+        RiotSwiftUnitTests:
+        - running
+        - testing
+        - profiling
+        - analyzing
+        - archiving
+    profile:
+      config: Release
+    run:
+      config: Debug
+      disableMainThreadChecker: true
+    test:
+      config: Debug
+      disableMainThreadChecker: true
+      targets:
+      - RiotSwiftUnitTests
+
+targets:
+  RiotSwiftUnitTests:
+    type: bundle.unit-test
+    platform: iOS
+
+    dependencies:
+    - target: RiotSwiftUI
+
+    configFiles:
+      Debug: Debug.xcconfig
+      Release: Release.xcconfig
+
+    settings:
+      base:
+        FRAMEWORK_SEARCH_PATHS: $(SDKROOT)/Developer/Library/Frameworks $(inherited)
+        INFOPLIST_FILE: RiotSwiftUI/Info.plist
+        LD_RUNPATH_SEARCH_PATHS: $(inherited) @executable_path/Frameworks @loader_path/Frameworks
+        PRODUCT_BUNDLE_IDENTIFIER: org.matrix.$(PRODUCT_NAME:rfc1034identifier)
+        PRODUCT_NAME: RiotSwiftUnitTests
+      configs:
+        Debug:
+        Release:
+          PROVISIONING_PROFILE: $(RIOT_PROVISIONING_PROFILE)
+          PROVISIONING_PROFILE_SPECIFIER: $(RIOT_PROVISIONING_PROFILE_SPECIFIER)
+    sources:
+    - path: ../RiotSwiftUI/Modules
+      includes:
+      - "**/Test"
+      excludes:
+      - "**/Test/UI/**"

RiotTests/target.yml

@@ -65,6 +65,3 @@ targets:
     - path: ../Riot/Managers/EncryptionKeyManager/EncryptionKeyManager.swift
     - path: ../Riot/Managers/KeyValueStorage/
     - path: ../Riot/PropertyWrappers/UserDefaultsBackedPropertyWrapper.swift
-    - path: ../RiotSwiftUI/Modules
-      includes:
-      - "**/Test/**"

project.yml

@@ -33,3 +33,5 @@ include:
   - path: RiotNSE/target.yml
   - path: DesignKit/target.yml
   - path: RiotSwiftUI/target.yml
+  - path: RiotSwiftUI/targetUnitTests.yml
+  - path: RiotSwiftUI/targetUITests.yml