Update documentation and examples to use Swift Testing (#3413)

* Testing: Case Studies * Testing: Search * Testing: Speech Recognition * Testing: SyncUps * Project Settings * Testing: TicTacToe * Testing: Todos * Testing: Voice Memos * Update tutorials/docs * fix * Fixes * wip * Update ci.yml * Update ci.yml * Update ci.yml * wip * wip * Quiet * fix * wip * wip * flaky * wip * wip * fix
pointfreeco · Oct 2, 2024 · 85417e0 · 85417e0
1 parent 4c08664
commit 85417e0
Show file tree

Hide file tree

Showing 199 changed files with 1,637 additions and 1,223 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,26 +20,35 @@ jobs:
     strategy:
       matrix:
         command: [test, '']
-        platform: [iOS, macOS, tvOS, watchOS, visionOS, macCatalyst]
+        platform: [IOS, MAC_CATALYST, MACOS, TVOS, VISIONOS, WATCHOS]
         xcode: [15.2, 15.4, '16.0']
         exclude:
           - {xcode: 15.2, command: test}
           - {xcode: 15.4, command: ''}
-          - {xcode: 15.2, platform: macCatalyst}
-          - {xcode: 15.2, platform: tvOS}
-          - {xcode: 15.2, platform: visionOS}
-          - {xcode: 15.2, platform: watchOS}
+          - {xcode: 15.2, platform: MAC_CATALYST}
+          - {xcode: 15.2, platform: TVOS}
+          - {xcode: 15.2, platform: VISIONOS}
+          - {xcode: 15.2, platform: WATCHOS}
           - {xcode: '16.0', command: ''}
-          - {xcode: '16.0', platform: macCatalyst}
-          - {xcode: '16.0', platform: tvOS}
-          - {xcode: '16.0', platform: visionOS}
-          - {xcode: '16.0', platform: watchOS}
+          - {xcode: '16.0', platform: MAC_CATALYST}
+          - {xcode: '16.0', platform: TVOS}
+          - {xcode: '16.0', platform: VISIONOS}
+          - {xcode: '16.0', platform: WATCHOS}
         include:
           - {xcode: 15.2, skip_release: 1}
     steps:
       - uses: actions/checkout@v4
       - name: Select Xcode ${{ matrix.xcode }}
         run: sudo xcode-select -s /Applications/Xcode_${{ matrix.xcode }}.app
+      - name: Install visionOS runtime
+        if: matrix.platform == 'visionOS'
+        run: |
+          sudo xcodebuild -runFirstLaunch
+          sudo xcrun simctl list
+          sudo xcodebuild -downloadPlatform visionOS
+          sudo xcodebuild -runFirstLaunch
+      - name: List available devices
+        run: xcrun simctl list devices available
       - name: Cache derived data
         uses: actions/cache@v3
         with:
@@ -49,15 +58,15 @@ jobs:
             deriveddata-xcodebuild-${{ matrix.platform }}-${{ matrix.xcode }}-${{ matrix.command }}-${{ hashFiles('**/Sources/**/*.swift', '**/Tests/**/*.swift') }}
           restore-keys: |
             deriveddata-xcodebuild-${{ matrix.platform }}-${{ matrix.xcode }}-${{ matrix.command }}-
-      - name: Set IgnoreFileSystemDeviceInodeChanges flag 
+      - name: Set IgnoreFileSystemDeviceInodeChanges flag
         run: defaults write com.apple.dt.XCBuild IgnoreFileSystemDeviceInodeChanges -bool YES
-      - name: Update mtime for incremental builds 
+      - name: Update mtime for incremental builds
         uses: chetan/git-restore-mtime-action@v2
       - name: Debug
-        run: make COMMAND="${{ matrix.command }}" CONFIG=Debug PLATFORM="${{ matrix.platform }}" xcodebuild
+        run: make XCODEBUILD_ARGUMENT="${{ matrix.command }}" CONFIG=Debug PLATFORM="${{ matrix.platform }}" WORKSPACE=.github/package.xcworkspace xcodebuild
       - name: Release
         if: matrix.skip_release != '1'
-        run: make COMMAND="${{ matrix.command }}" CONFIG=Release PLATFORM="${{ matrix.platform }}" xcodebuild
+        run: make XCODEBUILD_ARGUMENT="${{ matrix.command }}" CONFIG=Release PLATFORM="${{ matrix.platform }}" WORKSPACE=.github/package.xcworkspace xcodebuild
 
   library-evolution:
     name: Library (evolution)
@@ -89,18 +98,18 @@ jobs:
       - name: Update mtime for incremental builds
         uses: chetan/git-restore-mtime-action@v2
       - name: CaseStudies (SwiftUI)
-        run: make SCHEME="CaseStudies (SwiftUI)" test-example
+        run: make DERIVED_DATA_PATH=~/.derivedData SCHEME="CaseStudies (SwiftUI)" xcodebuild
       - name: CaseStudies (UIKit)
-        run: make SCHEME="CaseStudies (UIKit)" test-example
+        run: make DERIVED_DATA_PATH=~/.derivedData SCHEME="CaseStudies (UIKit)" xcodebuild
       - name: Search
-        run: make SCHEME="Search" test-example
+        run: make DERIVED_DATA_PATH=~/.derivedData SCHEME="Search" xcodebuild
       - name: SyncUps
-        run: make SCHEME="SyncUps" test-example
+        run: make DERIVED_DATA_PATH=~/.derivedData SCHEME="SyncUps" xcodebuild
       - name: SpeechRecognition
-        run: make SCHEME="SpeechRecognition" test-example
+        run: make DERIVED_DATA_PATH=~/.derivedData SCHEME="SpeechRecognition" xcodebuild
       - name: TicTacToe
-        run: make SCHEME="TicTacToe" test-example
+        run: make DERIVED_DATA_PATH=~/.derivedData SCHEME="TicTacToe" xcodebuild
       - name: Todos
-        run: make SCHEME="Todos" test-example
+        run: make DERIVED_DATA_PATH=~/.derivedData SCHEME="Todos" xcodebuild
       - name: VoiceMemos
-        run: make SCHEME="VoiceMemos" test-example
+        run: make DERIVED_DATA_PATH=~/.derivedData SCHEME="VoiceMemos" xcodebuild
diff --git a/.github/workflows/scheduled-ci.yml b/.github/workflows/scheduled-ci.yml
diff --git a/Examples/CaseStudies/CaseStudies.xcodeproj/project.pbxproj b/Examples/CaseStudies/CaseStudies.xcodeproj/project.pbxproj
@@ -853,7 +853,6 @@
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.tvOSCaseStudies;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SDKROOT = appletvos;
-				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = 3;
 			};
 			name = Debug;
@@ -872,7 +871,6 @@
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.tvOSCaseStudies;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SDKROOT = appletvos;
-				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = 3;
 			};
 			name = Release;
@@ -891,7 +889,6 @@
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.tvOSCaseStudiesTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SDKROOT = appletvos;
-				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = 3;
 				TEST_HOST = "$(BUILT_PRODUCTS_DIR)/tvOSCaseStudies.app/tvOSCaseStudies";
 			};
@@ -911,7 +908,6 @@
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.tvOSCaseStudiesTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SDKROOT = appletvos;
-				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = 3;
 				TEST_HOST = "$(BUILT_PRODUCTS_DIR)/tvOSCaseStudies.app/tvOSCaseStudies";
 			};
@@ -931,7 +927,6 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.UIKitCaseStudies;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Debug;
@@ -950,7 +945,6 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.UIKitCaseStudies;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Release;
@@ -968,7 +962,6 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.UIKitCaseStudiesTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				TEST_HOST = "$(BUILT_PRODUCTS_DIR)/UIKitCaseStudies.app/UIKitCaseStudies";
 			};
@@ -987,7 +980,6 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.UIKitCaseStudiesTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				TEST_HOST = "$(BUILT_PRODUCTS_DIR)/UIKitCaseStudies.app/UIKitCaseStudies";
 			};
@@ -1053,6 +1045,7 @@
 				SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG;
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
 				SWIFT_STRICT_CONCURRENCY = complete;
+				SWIFT_VERSION = 6.0;
 			};
 			name = Debug;
 		};
@@ -1109,6 +1102,7 @@
 				SWIFT_COMPILATION_MODE = wholemodule;
 				SWIFT_OPTIMIZATION_LEVEL = "-O";
 				SWIFT_STRICT_CONCURRENCY = complete;
+				SWIFT_VERSION = 6.0;
 				VALIDATE_PRODUCT = YES;
 			};
 			name = Release;
@@ -1126,7 +1120,6 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.SwiftUICaseStudies;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 6.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Debug;
@@ -1144,7 +1137,6 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.SwiftUICaseStudies;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 6.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Release;
@@ -1162,7 +1154,6 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.SwiftUICaseStudiesTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 6.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				TEST_HOST = "$(BUILT_PRODUCTS_DIR)/SwiftUICaseStudies.app/SwiftUICaseStudies";
 			};
@@ -1181,7 +1172,6 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = co.pointfree.SwiftUICaseStudiesTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_VERSION = 6.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				TEST_HOST = "$(BUILT_PRODUCTS_DIR)/SwiftUICaseStudies.app/SwiftUICaseStudies";
 			};

diff --git a/...Studies/SwiftUICaseStudiesTests/01-GettingStarted-AlertsAndConfirmationDialogsTests.swift b/...Studies/SwiftUICaseStudiesTests/01-GettingStarted-AlertsAndConfirmationDialogsTests.swift
@@ -1,11 +1,13 @@
 import ComposableArchitecture
-import XCTest
+import Testing
 
 @testable import SwiftUICaseStudies
 
-final class AlertsAndConfirmationDialogsTests: XCTestCase {
-  func testAlert() async {
-    let store = await TestStore(initialState: AlertAndConfirmationDialog.State()) {
+@MainActor
+struct AlertsAndConfirmationDialogsTests {
+  @Test
+  func alert() async {
+    let store = TestStore(initialState: AlertAndConfirmationDialog.State()) {
       AlertAndConfirmationDialog()
     }
 
@@ -32,8 +34,9 @@ final class AlertsAndConfirmationDialogsTests: XCTestCase {
     }
   }
 
-  func testConfirmationDialog() async {
-    let store = await TestStore(initialState: AlertAndConfirmationDialog.State()) {
+  @Test
+  func confirmationDialog() async {
+    let store = TestStore(initialState: AlertAndConfirmationDialog.State()) {
       AlertAndConfirmationDialog()
     }
 

diff --git a/Examples/CaseStudies/SwiftUICaseStudiesTests/01-GettingStarted-AnimationsTests.swift b/Examples/CaseStudies/SwiftUICaseStudiesTests/01-GettingStarted-AnimationsTests.swift
@@ -1,14 +1,16 @@
 import Clocks
 import ComposableArchitecture
-import XCTest
+import Testing
 
 @testable import SwiftUICaseStudies
 
-final class AnimationTests: XCTestCase {
-  func testRainbow() async {
+@MainActor
+struct AnimationTests {
+  @Test
+  func rainbow() async {
     let clock = TestClock()
 
-    let store = await TestStore(initialState: Animations.State()) {
+    let store = TestStore(initialState: Animations.State()) {
       Animations()
     } withDependencies: {
       $0.continuousClock = clock
@@ -57,10 +59,11 @@ final class AnimationTests: XCTestCase {
     await clock.run()
   }
 
-  func testReset() async {
+  @Test
+  func reset() async {
     let clock = TestClock()
 
-    let store = await TestStore(initialState: Animations.State()) {
+    let store = TestStore(initialState: Animations.State()) {
       Animations()
     } withDependencies: {
       $0.continuousClock = clock

diff --git a/Examples/CaseStudies/SwiftUICaseStudiesTests/01-GettingStarted-BindingBasicsTests.swift b/Examples/CaseStudies/SwiftUICaseStudiesTests/01-GettingStarted-BindingBasicsTests.swift
@@ -1,11 +1,13 @@
 import ComposableArchitecture
-import XCTest
+import Testing
 
 @testable import SwiftUICaseStudies
 
-final class BindingFormTests: XCTestCase {
-  func testBasics() async {
-    let store = await TestStore(initialState: BindingForm.State()) {
+@MainActor
+struct BindingFormTests {
+  @Test
+  func basics() async {
+    let store = TestStore(initialState: BindingForm.State()) {
       BindingForm()
     }
 

diff --git a/...s/CaseStudies/SwiftUICaseStudiesTests/02-GettingStarted-SharedStateFileStorageTests.swift b/...s/CaseStudies/SwiftUICaseStudiesTests/02-GettingStarted-SharedStateFileStorageTests.swift
@@ -1,11 +1,13 @@
 import ComposableArchitecture
-import XCTest
+import Testing
 
 @testable import SwiftUICaseStudies
 
-final class SharedStateFileStorageTests: XCTestCase {
-  func testTabSelection() async {
-    let store = await TestStore(initialState: SharedStateFileStorage.State()) {
+@MainActor
+struct SharedStateFileStorageTests {
+  @Test
+  func tabSelection() async {
+    let store = TestStore(initialState: SharedStateFileStorage.State()) {
       SharedStateFileStorage()
     }
 
@@ -17,8 +19,9 @@ final class SharedStateFileStorageTests: XCTestCase {
     }
   }
 
-  func testSharedCounts() async {
-    let store = await TestStore(initialState: SharedStateFileStorage.State()) {
+  @Test
+  func sharedCounts() async {
+    let store = TestStore(initialState: SharedStateFileStorage.State()) {
       SharedStateFileStorage()
     }
 
@@ -35,8 +38,9 @@ final class SharedStateFileStorageTests: XCTestCase {
     }
   }
 
-  func testAlert() async {
-    let store = await TestStore(initialState: SharedStateFileStorage.State()) {
+  @Test
+  func alert() async {
+    let store = TestStore(initialState: SharedStateFileStorage.State()) {
       SharedStateFileStorage()
     }
 

diff --git a/...ples/CaseStudies/SwiftUICaseStudiesTests/02-GettingStarted-SharedStateInMemoryTests.swift b/...ples/CaseStudies/SwiftUICaseStudiesTests/02-GettingStarted-SharedStateInMemoryTests.swift
@@ -1,11 +1,13 @@
 import ComposableArchitecture
-import XCTest
+import Testing
 
 @testable import SwiftUICaseStudies
 
-final class SharedStateInMemoryTests: XCTestCase {
-  func testTabSelection() async {
-    let store = await TestStore(initialState: SharedStateInMemory.State()) {
+@MainActor
+struct SharedStateInMemoryTests {
+  @Test
+  func tabSelection() async {
+    let store = TestStore(initialState: SharedStateInMemory.State()) {
       SharedStateInMemory()
     }
 
@@ -17,8 +19,9 @@ final class SharedStateInMemoryTests: XCTestCase {
     }
   }
 
-  func testSharedCounts() async {
-    let store = await TestStore(initialState: SharedStateInMemory.State()) {
+  @Test
+  func sharedCounts() async {
+    let store = TestStore(initialState: SharedStateInMemory.State()) {
       SharedStateInMemory()
     }
 
@@ -35,8 +38,9 @@ final class SharedStateInMemoryTests: XCTestCase {
     }
   }
 
-  func testAlert() async {
-    let store = await TestStore(initialState: SharedStateInMemory.State()) {
+  @Test
+  func alert() async {
+    let store = TestStore(initialState: SharedStateInMemory.State()) {
       SharedStateInMemory()
     }