Swift Testing for Unit Tests PART 1 (#5119)

* migrated a lot of unit tests to Swift Testing and added a new implementation for deferred fulfillment more tests migration Cleaned the code manually to establish some good patterns more code improvements some more code improvements removed empty tests update project * more pr suggestions and cleanups * removed the TestSetup pattern * fixing claude not reusing tests * pr suggestion + added indent rule to swiftformat so that we can prevent AIs to change that
2026-11-02 21:33:26 +00:00 · 2026-02-19 16:20:47 +01:00
parent fc03e05697
commit 7982aef855
118 changed files with 4630 additions and 4129 deletions
@@ -8,90 +8,24 @@

 import Combine
@testable import ElementX
-import XCTest
+import Testing

@MainActor
-class SpacesScreenViewModelTests: XCTestCase {
-    var topLevelSpacesSubject: CurrentValueSubject<[SpaceServiceRoom], Never>!
-    var spaceServiceProxy: SpaceServiceProxyMock!
-    var appSettings: AppSettings!
-    
-    var viewModel: SpacesScreenViewModelProtocol!
+@Suite
+final class SpacesScreenViewModelTests {
+    var topLevelSpacesSubject: CurrentValueSubject<[SpaceServiceRoom], Never>
+    var spaceServiceProxy: SpaceServiceProxyMock
+    var appSettings: AppSettings
+    var viewModel: SpacesScreenViewModelProtocol
    
    var context: SpacesScreenViewModelType.Context {
        viewModel.context
    }
    
-    override func setUp() {
+    init() {
        AppSettings.resetAllSettings()
        appSettings = AppSettings()
-    }
-    
-    override func tearDown() {
-        AppSettings.resetAllSettings()
-    }
-
-    func testInitialState() {
-        setupViewModel()
-        XCTAssertEqual(context.viewState.topLevelSpaces.count, 3)
-    }
-    
-    func testTopLevelSpacesSubscription() async throws {
-        setupViewModel()
        
-        var deferred = deferFulfillment(context.observe(\.viewState.topLevelSpaces)) { $0.count == 0 }
-        topLevelSpacesSubject.send([])
-        try await deferred.fulfill()
-        XCTAssertEqual(context.viewState.topLevelSpaces.count, 0)
-        
-        deferred = deferFulfillment(context.observe(\.viewState.topLevelSpaces)) { $0.count == 1 }
-        topLevelSpacesSubject.send([
-            SpaceServiceRoom.mock(isSpace: true)
-        ])
-        try await deferred.fulfill()
-        XCTAssertEqual(context.viewState.topLevelSpaces.count, 1)
-    }
-    
-    func testSelectingSpace() async throws {
-        setupViewModel()
-        
-        let selectedSpace = topLevelSpacesSubject.value[0]
-        let deferred = deferFulfillment(viewModel.actionsPublisher) { _ in true }
-        viewModel.context.send(viewAction: .spaceAction(.select(selectedSpace)))
-        let action = try await deferred.fulfill()
-        
-        switch action {
-        case .selectSpace(let spaceRoomListProxy) where spaceRoomListProxy.id == selectedSpace.id:
-            break
-        default:
-            XCTFail("The action should select the space.")
-        }
-    }
-    
-    func testFeatureAnnouncement() async throws {
-        setupViewModel()
-        XCTAssertFalse(appSettings.hasSeenSpacesAnnouncement)
-        XCTAssertFalse(context.isPresentingFeatureAnnouncement)
-        
-        let deferred = deferFulfillment(context.observe(\.isPresentingFeatureAnnouncement)) { $0 == true }
-        viewModel.context.send(viewAction: .screenAppeared)
-        try await deferred.fulfill()
-        XCTAssertTrue(context.isPresentingFeatureAnnouncement)
-        
-        viewModel.context.send(viewAction: .featureAnnouncementAppeared)
-        XCTAssertTrue(appSettings.hasSeenSpacesAnnouncement)
-        
-        context.isPresentingFeatureAnnouncement = false
-        
-        let deferredFailure = deferFailure(context.observe(\.isPresentingFeatureAnnouncement), timeout: 1) { $0 == true }
-        viewModel.context.send(viewAction: .screenAppeared)
-        try await deferredFailure.fulfill()
-        XCTAssertFalse(context.isPresentingFeatureAnnouncement)
-    }
-    
-    // MARK: - Helpers
-    
-    private func setupViewModel() {
        let clientProxy = ClientProxyMock(.init())
        let userSession = UserSessionMock(.init(clientProxy: clientProxy))
        
@@ -103,7 +37,7 @@ class SpacesScreenViewModelTests: XCTestCase {
        spaceServiceProxy = SpaceServiceProxyMock(.init())
        spaceServiceProxy.topLevelSpacesPublisher = topLevelSpacesSubject.asCurrentValuePublisher()
        spaceServiceProxy.spaceRoomListSpaceIDClosure = { [topLevelSpacesSubject] spaceID in
-            guard let spaceServiceRoom = topLevelSpacesSubject?.value.first(where: { $0.id == spaceID }) else { return .failure(.missingSpace) }
+            guard let spaceServiceRoom = topLevelSpacesSubject.value.first(where: { $0.id == spaceID }) else { return .failure(.missingSpace) }
            return .success(SpaceRoomListProxyMock(.init(spaceServiceRoom: spaceServiceRoom)))
        }
        clientProxy.spaceService = spaceServiceProxy
@@ -113,4 +47,64 @@ class SpacesScreenViewModelTests: XCTestCase {
                                          appSettings: ServiceLocator.shared.settings,
                                          userIndicatorController: UserIndicatorControllerMock())
    }
+    
+    deinit {
+        AppSettings.resetAllSettings()
+    }
+    
+    @Test
+    func initialState() {
+        #expect(context.viewState.topLevelSpaces.count == 3)
+    }
+    
+    @Test
+    func topLevelSpacesSubscription() async throws {
+        var deferred = deferFulfillment(context.observe(\.viewState.topLevelSpaces)) { $0.count == 0 }
+        topLevelSpacesSubject.send([])
+        try await deferred.fulfill()
+        #expect(context.viewState.topLevelSpaces.count == 0)
+        
+        deferred = deferFulfillment(context.observe(\.viewState.topLevelSpaces)) { $0.count == 1 }
+        topLevelSpacesSubject.send([
+            SpaceServiceRoom.mock(isSpace: true)
+        ])
+        try await deferred.fulfill()
+        #expect(context.viewState.topLevelSpaces.count == 1)
+    }
+    
+    @Test
+    func selectingSpace() async throws {
+        let selectedSpace = topLevelSpacesSubject.value[0]
+        let deferred = deferFulfillment(viewModel.actionsPublisher) { _ in true }
+        viewModel.context.send(viewAction: .spaceAction(.select(selectedSpace)))
+        let action = try await deferred.fulfill()
+        
+        switch action {
+        case .selectSpace(let spaceRoomListProxy) where spaceRoomListProxy.id == selectedSpace.id:
+            break
+        default:
+            Issue.record("The action should select the space.")
+        }
+    }
+    
+    @Test
+    func featureAnnouncement() async throws {
+        #expect(!appSettings.hasSeenSpacesAnnouncement)
+        #expect(!context.isPresentingFeatureAnnouncement)
+        
+        let deferred = deferFulfillment(context.observe(\.isPresentingFeatureAnnouncement)) { $0 == true }
+        viewModel.context.send(viewAction: .screenAppeared)
+        try await deferred.fulfill()
+        #expect(context.isPresentingFeatureAnnouncement)
+        
+        viewModel.context.send(viewAction: .featureAnnouncementAppeared)
+        #expect(appSettings.hasSeenSpacesAnnouncement)
+        
+        context.isPresentingFeatureAnnouncement = false
+        
+        let deferredFailure = deferFailure(context.observe(\.isPresentingFeatureAnnouncement), timeout: .seconds(1)) { $0 == true }
+        viewModel.context.send(viewAction: .screenAppeared)
+        try await deferredFailure.fulfill()
+        #expect(!context.isPresentingFeatureAnnouncement)
+    }
 }