Assert expectations on the line they were expected on, not on the render call

Author: bencochran

WorkflowTesting/Sources/Internal/RenderExpectations.swift

@@ -22,20 +22,25 @@
         internal class AnyExpectedWorkflow {
             let workflowType: Any.Type
             let key: String
-            fileprivate init(workflowType: Any.Type, key: String) {
+            let file: StaticString
+            let line: UInt
+
+            fileprivate init(workflowType: Any.Type, key: String, file: StaticString, line: UInt) {
                 self.workflowType = workflowType
                 self.key = key
+                self.file = file
+                self.line = line
             }
         }
 
         internal class ExpectedWorkflow<ExpectedWorkflowType: Workflow>: AnyExpectedWorkflow {
             let rendering: ExpectedWorkflowType.Rendering
             let output: ExpectedWorkflowType.Output?
 
-            init(key: String, rendering: ExpectedWorkflowType.Rendering, output: ExpectedWorkflowType.Output?) {
+            init(key: String, rendering: ExpectedWorkflowType.Rendering, output: ExpectedWorkflowType.Output?, file: StaticString, line: UInt) {
                 self.rendering = rendering
                 self.output = output
-                super.init(workflowType: ExpectedWorkflowType.self, key: key)
+                super.init(workflowType: ExpectedWorkflowType.self, key: key, file: file, line: line)
             }
         }
     }
@@ -44,30 +49,39 @@
         internal class AnyExpectedWorker {
             let erasedWorker: Any
             let workerType: Any.Type
-            fileprivate init(workerType: Any.Type, erasedWorker: Any) {
+            let file: StaticString
+            let line: UInt
+
+            fileprivate init(workerType: Any.Type, erasedWorker: Any, file: StaticString, line: UInt) {
                 self.workerType = workerType
                 self.erasedWorker = erasedWorker
+                self.file = file
+                self.line = line
             }
         }
 
         internal final class ExpectedWorker<WorkerType: Worker>: AnyExpectedWorker {
             let worker: WorkerType
             let output: WorkerType.Output?
 
-            internal init(worker: WorkerType, output: WorkerType.Output?) {
+            internal init(worker: WorkerType, output: WorkerType.Output?, file: StaticString, line: UInt) {
                 self.worker = worker
                 self.output = output
-                super.init(workerType: WorkerType.self, erasedWorker: worker)
+                super.init(workerType: WorkerType.self, erasedWorker: worker, file: file, line: line)
             }
         }
     }
 
     extension RenderTester {
         internal class ExpectedSideEffect<WorkflowType: Workflow> {
             let key: AnyHashable
+            let file: StaticString
+            let line: UInt
 
-            init(key: AnyHashable) {
+            init(key: AnyHashable, file: StaticString, line: UInt) {
                 self.key = key
+                self.file = file
+                self.line = line
             }
 
             func apply<ContextType>(context: ContextType) where ContextType: RenderContextType, ContextType.WorkflowType == WorkflowType {}
@@ -76,9 +90,9 @@
         internal final class ExpectedSideEffectWithAction<WorkflowType, ActionType: WorkflowAction>: ExpectedSideEffect<WorkflowType> where ActionType.WorkflowType == WorkflowType {
             let action: ActionType
 
-            internal init(key: AnyHashable, action: ActionType) {
+            internal init(key: AnyHashable, action: ActionType, file: StaticString, line: UInt) {
                 self.action = action
-                super.init(key: key)
+                super.init(key: key, file: file, line: line)
             }
 
             override func apply<ContextType>(context: ContextType) where ContextType: RenderContextType, ContextType.WorkflowType == WorkflowType {

WorkflowTesting/Sources/Internal/RenderTester+TestContext.swift

@@ -120,15 +120,15 @@
             /// Validate the expectations were fulfilled, or fail if not.
             func assertNoLeftOverExpectations() {
                 for expectedWorker in expectedWorkers {
-                    XCTFail("Expected worker \(expectedWorker.erasedWorker)", file: file, line: line)
+                    XCTFail("Expected worker \(expectedWorker.erasedWorker)", file: expectedWorker.file, line: expectedWorker.line)
                 }
 
                 for expectedWorkflow in expectedWorkflows {
-                    XCTFail("Expected child workflow of type: \(expectedWorkflow.workflowType), key: \"\(expectedWorkflow.key)\"", file: file, line: line)
+                    XCTFail("Expected child workflow of type: \(expectedWorkflow.workflowType), key: \"\(expectedWorkflow.key)\"", file: file, line: expectedWorkflow.line)
                 }
 
-                for (key, _) in expectedSideEffects {
-                    XCTFail("Expected side-effect with key: \"\(key)\"", file: file, line: line)
+                for (key, expectedSideEffect) in expectedSideEffects {
+                    XCTFail("Expected side-effect with key: \"\(key)\"", file: expectedSideEffect.file, line: expectedSideEffect.line)
                 }
             }
 

WorkflowTesting/Sources/WorkflowRenderTester.swift

@@ -153,6 +153,7 @@
             key: String = "",
             producingRendering rendering: ExpectedWorkflowType.Rendering,
             producingOutput output: ExpectedWorkflowType.Output? = nil,
+            file: StaticString = #file, line: UInt = #line,
             assertions: (ExpectedWorkflowType) -> Void = { _ in }
         ) -> RenderTester<WorkflowType> {
             return RenderTester(
@@ -162,7 +163,9 @@
                     ExpectedWorkflow<ExpectedWorkflowType>(
                         key: key,
                         rendering: rendering,
-                        output: output
+                        output: output,
+                        file: file,
+                        line: line
                     )
                 ),
                 expectedWorkers: expectedWorkers,
@@ -177,7 +180,8 @@
         ///   - output: An output that should be returned when this worker is requested, if any.
         public func expect<ExpectedWorkerType: Worker>(
             worker: ExpectedWorkerType,
-            producingOutput output: ExpectedWorkerType.Output? = nil
+            producingOutput output: ExpectedWorkerType.Output? = nil,
+            file: StaticString = #file, line: UInt = #line
         ) -> RenderTester<WorkflowType> {
             return RenderTester(
                 workflow: workflow,
@@ -186,7 +190,9 @@
                 expectedWorkers: expectedWorkers.appending(
                     ExpectedWorker(
                         worker: worker,
-                        output: output
+                        output: output,
+                        file: file,
+                        line: line
                     )
                 ),
                 expectedSideEffects: expectedSideEffects
@@ -196,15 +202,22 @@
         /// Expect a side-effect for the given key.
         ///
         /// - Parameter key: The key to expect.
-        public func expectSideEffect(key: AnyHashable) -> RenderTester<WorkflowType> {
+        public func expectSideEffect(
+            key: AnyHashable,
+            file: StaticString = #file, line: UInt = #line
+        ) -> RenderTester<WorkflowType> {
             return RenderTester(
                 workflow: workflow,
                 state: state,
                 expectedWorkflows: expectedWorkflows,
                 expectedWorkers: expectedWorkers,
                 expectedSideEffects: expectedSideEffects.setting(
                     key: key,
-                    value: ExpectedSideEffect(key: key)
+                    value: ExpectedSideEffect(
+                        key: key,
+                        file: file,
+                        line: line
+                    )
                 )
             )
         }
@@ -216,7 +229,8 @@
         ///   - action: The action to produce when this side-effect is requested.
         public func expectSideEffect<ActionType>(
             key: AnyHashable,
-            producingAction action: ActionType
+            producingAction action: ActionType,
+            file: StaticString = #file, line: UInt = #line
         ) -> RenderTester<WorkflowType> where ActionType: WorkflowAction, ActionType.WorkflowType == WorkflowType {
             return RenderTester(
                 workflow: workflow,
@@ -225,7 +239,12 @@
                 expectedWorkers: expectedWorkers,
                 expectedSideEffects: expectedSideEffects.setting(
                     key: key,
-                    value: ExpectedSideEffectWithAction(key: key, action: action)
+                    value: ExpectedSideEffectWithAction(
+                        key: key,
+                        action: action,
+                        file: file,
+                        line: line
+                    )
                 )
             )
         }