Deprecate TestStore.init that doesn't require equatable state (#1857)

And introduce `TestStore.init(initialState:reducer:observe:send:)` for
testing scoped state and actions.

(cherry picked from commit 0ed5c83d9608518f8ea6ae757b58f42f33ad407f)

Author: stephencelis

Examples/TicTacToe/tic-tac-toe/Tests/GameSwiftUITests/GameSwiftUITests.swift

@@ -11,9 +11,10 @@ final class GameSwiftUITests: XCTestCase {
       oPlayerName: "Blob Jr.",
       xPlayerName: "Blob Sr."
     ),
-    reducer: Game()
+    reducer: Game(),
+    observe: GameView.ViewState.init,
+    send: { $0 }
   )
-  .scope(state: GameView.ViewState.init)
 
   func testFlow_Winner_Quit() async {
     await self.store.send(.cellTapped(row: 0, column: 0)) {

Examples/TicTacToe/tic-tac-toe/Tests/LoginSwiftUITests/LoginSwiftUITests.swift

@@ -10,13 +10,14 @@ final class LoginSwiftUITests: XCTestCase {
   func testFlow_Success() async {
     let store = TestStore(
       initialState: Login.State(),
-      reducer: Login()
+      reducer: Login(),
+      observe: LoginView.ViewState.init,
+      send: action: Login.Action.init
     ) {
       $0.authenticationClient.login = { _ in
         AuthenticationResponse(token: "deadbeefdeadbeef", twoFactorRequired: false)
       }
     }
-    .scope(state: LoginView.ViewState.init, action: Login.Action.init)
 
     await store.send(.emailChanged("blob@pointfree.co")) {
       $0.email = "blob@pointfree.co"
@@ -42,13 +43,14 @@ final class LoginSwiftUITests: XCTestCase {
   func testFlow_Success_TwoFactor() async {
     let store = TestStore(
       initialState: Login.State(),
-      reducer: Login()
+      reducer: Login(),
+      observe: LoginView.ViewState.init,
+      send: action: Login.Action.init
     ) {
       $0.authenticationClient.login = { _ in
         AuthenticationResponse(token: "deadbeefdeadbeef", twoFactorRequired: true)
       }
     }
-    .scope(state: LoginView.ViewState.init, action: Login.Action.init)
 
     await store.send(.emailChanged("2fa@pointfree.co")) {
       $0.email = "2fa@pointfree.co"
@@ -78,13 +80,14 @@ final class LoginSwiftUITests: XCTestCase {
   func testFlow_Failure() async {
     let store = TestStore(
       initialState: Login.State(),
-      reducer: Login()
+      reducer: Login(),
+      observe: LoginView.ViewState.init,
+      send: action: Login.Action.init
     ) {
       $0.authenticationClient.login = { _ in
         throw AuthenticationError.invalidUserPassword
       }
     }
-    .scope(state: LoginView.ViewState.init, action: Login.Action.init)
 
     await store.send(.emailChanged("blob")) {
       $0.email = "blob"

Examples/TicTacToe/tic-tac-toe/Tests/NewGameSwiftUITests/NewGameSwiftUITests.swift

@@ -8,9 +8,10 @@ import XCTest
 final class NewGameSwiftUITests: XCTestCase {
   let store = TestStore(
     initialState: NewGame.State(),
-    reducer: NewGame()
+    reducer: NewGame(),
+    observe: NewGameView.ViewState.init,
+    send: NewGame.Action.init
   )
-  .scope(state: NewGameView.ViewState.init, action: NewGame.Action.init)
 
   func testNewGame() async {
     await self.store.send(.xPlayerNameChanged("Blob Sr.")) {

Examples/TicTacToe/tic-tac-toe/Tests/TwoFactorSwiftUITests/TwoFactorSwiftUITests.swift

@@ -10,13 +10,14 @@ final class TwoFactorSwiftUITests: XCTestCase {
   func testFlow_Success() async {
     let store = TestStore(
       initialState: TwoFactor.State(token: "deadbeefdeadbeef"),
-      reducer: TwoFactor()
+      reducer: TwoFactor(),
+      observe: TwoFactorView.ViewState.init,
+      send: TwoFactor.Action.init
     ) {
       $0.authenticationClient.twoFactor = { _ in
         AuthenticationResponse(token: "deadbeefdeadbeef", twoFactorRequired: false)
       }
     }
-    .scope(state: TwoFactorView.ViewState.init, action: TwoFactor.Action.init)
 
     await store.send(.codeChanged("1")) {
       $0.code = "1"
@@ -50,13 +51,14 @@ final class TwoFactorSwiftUITests: XCTestCase {
   func testFlow_Failure() async {
     let store = TestStore(
       initialState: TwoFactor.State(token: "deadbeefdeadbeef"),
-      reducer: TwoFactor()
+      reducer: TwoFactor(),
+      observe: TwoFactorView.ViewState.init,
+      send: TwoFactor.Action.init
     ) {
       $0.authenticationClient.twoFactor = { _ in
         throw AuthenticationError.invalidTwoFactor
       }
     }
-    .scope(state: TwoFactorView.ViewState.init, action: TwoFactor.Action.init)
 
     await store.send(.codeChanged("1234")) {
       $0.code = "1234"

Sources/ComposableArchitecture/TestStore.swift

@@ -567,16 +567,146 @@ public final class TestStore<State, Action, ScopedState, ScopedAction, Environme
   /// - Parameters:
   ///   - initialState: The state the feature starts in.
   ///   - reducer: The reducer that powers the runtime of the feature.
-  public init<Reducer: ReducerProtocol>(
+  ///   - prepareDependencies: A closure that can be used to override dependencies that will be
+  ///     accessed during the test. These dependencies will be used when producing the initial
+  ///     state.
+  public convenience init<R: ReducerProtocol>(
     initialState: @autoclosure () -> State,
-    reducer: Reducer,
+    reducer: R,
     prepareDependencies: (inout DependencyValues) -> Void = { _ in },
     file: StaticString = #file,
     line: UInt = #line
   )
   where
-    Reducer.State == State,
-    Reducer.Action == Action,
+    R.State == State,
+    R.Action == Action,
+    State == ScopedState,
+    State: Equatable,
+    Action == ScopedAction,
+    Environment == Void
+  {
+    self.init(
+      initialState: initialState(),
+      reducer: reducer,
+      observe: { $0 },
+      send: { $0 },
+      prepareDependencies: prepareDependencies,
+      file: file,
+      line: line
+    )
+  }
+
+  /// Creates a scoped test store with an initial state and a reducer powering its runtime.
+  ///
+  /// See <doc:Testing> and the documentation of ``TestStore`` for more information on how to best
+  /// use a test store.
+  ///
+  /// - Parameters:
+  ///   - initialState: The state the feature starts in.
+  ///   - reducer: The reducer that powers the runtime of the feature.
+  ///   - toScopedState: A function that transforms the reducer's state into scoped state. This
+  ///     state will be asserted against as it is mutated by the reducer. Useful for testing view
+  ///     store state transformations.
+  ///   - prepareDependencies: A closure that can be used to override dependencies that will be
+  ///     accessed during the test. These dependencies will be used when producing the initial
+  ///     state.
+  public convenience init<R: ReducerProtocol>(
+    initialState: @autoclosure () -> State,
+    reducer: R,
+    observe toScopedState: @escaping (State) -> ScopedState,
+    prepareDependencies: (inout DependencyValues) -> Void = { _ in },
+    file: StaticString = #file,
+    line: UInt = #line
+  )
+  where
+    R.State == State,
+    R.Action == Action,
+    ScopedState: Equatable,
+    Action == ScopedAction,
+    Environment == Void
+  {
+    self.init(
+      initialState: initialState(),
+      reducer: reducer,
+      observe: toScopedState,
+      send: { $0 },
+      prepareDependencies: prepareDependencies,
+      file: file,
+      line: line
+    )
+  }
+
+  /// Creates a scoped test store with an initial state and a reducer powering its runtime.
+  ///
+  /// See <doc:Testing> and the documentation of ``TestStore`` for more information on how to best
+  /// use a test store.
+  ///
+  /// - Parameters:
+  ///   - initialState: The state the feature starts in.
+  ///   - reducer: The reducer that powers the runtime of the feature.
+  ///   - toScopedState: A function that transforms the reducer's state into scoped state. This
+  ///     state will be asserted against as it is mutated by the reducer. Useful for testing view
+  ///     store state transformations.
+  ///   - fromScopedAction: A function that wraps a more scoped action in the reducer's action.
+  ///     Scoped actions can be "sent" to the store, while any reducer action may be received.
+  ///     Useful for testing view store action transformations.
+  ///   - prepareDependencies: A closure that can be used to override dependencies that will be
+  ///     accessed during the test. These dependencies will be used when producing the initial
+  ///     state.
+  public init<R: ReducerProtocol>(
+    initialState: @autoclosure () -> State,
+    reducer: R,
+    observe toScopedState: @escaping (State) -> ScopedState,
+    send fromScopedAction: @escaping (ScopedAction) -> Action,
+    prepareDependencies: (inout DependencyValues) -> Void = { _ in },
+    file: StaticString = #file,
+    line: UInt = #line
+  )
+  where
+    R.State == State,
+    R.Action == Action,
+    ScopedState: Equatable,
+    Environment == Void
+  {
+    var dependencies = DependencyValues._current
+    prepareDependencies(&dependencies)
+    let initialState = withDependencies {
+      $0 = dependencies
+    } operation: {
+      initialState()
+    }
+
+    let reducer = TestReducer(Reduce(reducer), initialState: initialState)
+    self._environment = .init(wrappedValue: ())
+    self.file = file
+    self.fromScopedAction = fromScopedAction
+    self.line = line
+    self.reducer = reducer
+    self.store = Store(initialState: initialState, reducer: reducer)
+    self.timeout = 100 * NSEC_PER_MSEC
+    self.toScopedState = toScopedState
+    self.dependencies = dependencies
+  }
+
+  /// Creates a test store with an initial state and a reducer powering its runtime.
+  ///
+  /// See <doc:Testing> and the documentation of ``TestStore`` for more information on how to best
+  /// use a test store.
+  ///
+  /// - Parameters:
+  ///   - initialState: The state the feature starts in.
+  ///   - reducer: The reducer that powers the runtime of the feature.
+  @available(*, deprecated, message: "State must be equatable to perform assertions.")
+  public init<R: ReducerProtocol>(
+    initialState: @autoclosure () -> State,
+    reducer: R,
+    prepareDependencies: (inout DependencyValues) -> Void = { _ in },
+    file: StaticString = #file,
+    line: UInt = #line
+  )
+  where
+    R.State == State,
+    R.Action == Action,
     State == ScopedState,
     Action == ScopedAction,
     Environment == Void
@@ -1751,6 +1881,13 @@ extension TestStore {
   ///   - fromScopedAction: A function that wraps a more scoped action in the reducer's action.
   ///     Scoped actions can be "sent" to the store, while any reducer action may be received.
   ///     Useful for testing view store action transformations.
+  @available(
+    *,
+    deprecated,
+    message: """
+      Use 'TestStore.init(initialState:reducer:observe:send:)' to scope a test store's state and actions.
+      """
+  )
   public func scope<S, A>(
     state toScopedState: @escaping (ScopedState) -> S,
     action fromScopedAction: @escaping (A) -> ScopedAction
@@ -1774,6 +1911,13 @@ extension TestStore {
   /// - Parameter toScopedState: A function that transforms the reducer's state into scoped state.
   ///   This state will be asserted against as it is mutated by the reducer. Useful for testing view
   ///   store state transformations.
+  @available(
+    *,
+    deprecated,
+    message: """
+      Use 'TestStore.init(initialState:reducer:observe:)' to scope a test store's state.
+      """
+  )
   public func scope<S>(
     state toScopedState: @escaping (ScopedState) -> S
   ) -> TestStore<State, Action, S, ScopedAction, Environment> {