PR feedback

Author: andystaples

samples-v2/blueprint/tests/readme.md

@@ -1,7 +1,28 @@
 # Durable Functions Sample – Unit Tests (Python)
 
+## Overview
+
 This directory contains a simple **unit test** for the sample [Durable Azure Functions](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-overview) written in Python. This test demonstrates how to validate the logic of the orchestrator function in isolation using mocks.
 
+Writing unit tests for Durable functions requires sligtly different syntax for accessing the original method definition. Orchestrator functions, client functions, and entity functions all come with their own ways to access the user code: 
+
+### Orchestrator functions
+```
+my_orchestrator.build().get_user_function().orchestrator_function
+```
+
+### Client functions
+```
+my_client_function.build().get_user_function().client_function
+```
+
+### Entity functions
+```
+my_entity_function.build().get_user_function().entity_function
+```
+
+This sample app demonstrates using these accessors to get and test Durable functions. It also demonstrates how to mock the calling behavior that Durable uses to run orchestrators during replay with the orchestrator_generator_wrapper method defined in test_my_orchestrator.py and simulates the Tasks yielded by DurableOrchestrationContext with MockTask objects in the same file.
+
 ## Prerequisites
 
 - Python 

samples-v2/blueprint/tests/test_my_orchestrator.py

@@ -6,7 +6,7 @@
 
 # A way to wrap an orchestrator generator to simplify calling it and getting the results.
 # Because orchestrators in Durable Functions always accept the result of the previous activity for the next send() call, 
-# we can simplify the orchestrator like this to also simplify per-test code. 
+# we can unwrap the orchestrator generator using this method to simplify per-test code. 
 def orchestrator_generator_wrapper(generator):
   previous =  next(generator)
   yield previous

samples-v2/blueprint/tests/test_start_orchestrator.py

@@ -18,7 +18,7 @@ def test_HttpStart(self, client):
     client.start_new = AsyncMock(return_value="instance_id")
     client.create_check_status_response = Mock(return_value="check_status_response")
 
-    # Create a generator using the method and mocked context
+    # Execute the function code
     result = asyncio.run(func_call(req, client))
 
     client.start_new.assert_called_once_with("my_orchestrator")

samples-v2/fan_in_fan_out/tests/readme.md

@@ -1,7 +1,28 @@
 # Durable Functions Sample – Unit Tests (Python)
 
+## Overview
+
 This directory contains a simple **unit test** for the sample [Durable Azure Functions](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-overview) written in Python. This test demonstrates how to validate the logic of the orchestrator function in isolation using mocks.
 
+Writing unit tests for Durable functions requires sligtly different syntax for accessing the original method definition. Orchestrator functions, client functions, and entity functions all come with their own ways to access the user code: 
+
+### Orchestrator functions
+```
+my_orchestrator.build().get_user_function().orchestrator_function
+```
+
+### Client functions
+```
+my_client_function.build().get_user_function().client_function
+```
+
+### Entity functions
+```
+my_entity_function.build().get_user_function().entity_function
+```
+
+This sample app demonstrates using these accessors to get and test Durable functions. It also demonstrates how to mock the calling behavior that Durable uses to run orchestrators during replay with the orchestrator_generator_wrapper method defined in test_E2_BackupSiteContent.py and simulates the Tasks yielded by DurableOrchestrationContext with MockTask objects in the same file.
+
 ## Prerequisites
 
 - Python 

samples-v2/fan_in_fan_out/tests/test_E2_BackupSiteContent.py

@@ -5,7 +5,7 @@
 
 # A way to wrap an orchestrator generator to simplify calling it and getting the results.
 # Because orchestrators in Durable Functions always accept the result of the previous activity for the next send() call, 
-# we can simplify the orchestrator like this to also simplify per-test code. 
+# we can unwrap the orchestrator generator using this method to simplify per-test code. 
 def orchestrator_generator_wrapper(generator):
   previous =  next(generator)
   yield previous
@@ -45,7 +45,7 @@ def test_E2_BackupSiteContent(self, context):
     context.call_activity = Mock(side_effect=mock_activity)
     context.task_all = Mock(return_value=MockTask([100, 200, 300]))
 
-    # Create a generator using the method and mocked context
+    # Execute the function code
     user_orchestrator = func_call(context)
 
     # Use a method defined above to get the values from the generator. Quick unwrap for easy access

samples-v2/fan_in_fan_out/tests/test_HttpStart.py

@@ -19,7 +19,7 @@ def test_HttpStart(self, client):
     client.start_new = AsyncMock(return_value="instance_id")
     client.create_check_status_response = Mock(return_value="check_status_response")
 
-    # Create a generator using the method and mocked context
+    # Execute the function code
     result = asyncio.run(func_call(req, client))
 
     client.start_new.assert_called_once_with("E2_BackupSiteContent", client_input={})

samples-v2/function_chaining/tests/readme.md

@@ -1,7 +1,28 @@
 # Durable Functions Sample – Unit Tests (Python)
 
+## Overview
+
 This directory contains a simple **unit test** for the sample [Durable Azure Functions](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-overview) written in Python. This test demonstrates how to validate the logic of the orchestrator function in isolation using mocks.
 
+Writing unit tests for Durable functions requires sligtly different syntax for accessing the original method definition. Orchestrator functions, client functions, and entity functions all come with their own ways to access the user code: 
+
+### Orchestrator functions
+```
+my_orchestrator.build().get_user_function().orchestrator_function
+```
+
+### Client functions
+```
+my_client_function.build().get_user_function().client_function
+```
+
+### Entity functions
+```
+my_entity_function.build().get_user_function().entity_function
+```
+
+This sample app demonstrates using these accessors to get and test Durable functions. It also demonstrates how to mock the calling behavior that Durable uses to run orchestrators during replay with the orchestrator_generator_wrapper method defined in test_my_orchestrator.py and simulates the Tasks yielded by DurableOrchestrationContext with MockTask objects in the same file.
+
 ## Prerequisites
 
 - Python 

samples-v2/function_chaining/tests/test_http_start.py

@@ -19,7 +19,7 @@ def test_HttpStart(self, client):
     client.start_new = AsyncMock(return_value="instance_id")
     client.create_check_status_response = Mock(return_value="check_status_response")
 
-    # Create a generator using the method and mocked context
+    # Execute the function code
     result = asyncio.run(func_call(req, client))
 
     client.start_new.assert_called_once_with("my_orchestrator")

samples-v2/function_chaining/tests/test_my_orchestrator.py

@@ -6,7 +6,7 @@
 
 # A way to wrap an orchestrator generator to simplify calling it and getting the results.
 # Because orchestrators in Durable Functions always accept the result of the previous activity for the next send() call, 
-# we can simplify the orchestrator like this to also simplify per-test code. 
+# we can unwrap the orchestrator generator using this method to simplify per-test code. 
 def orchestrator_generator_wrapper(generator):
   previous =  next(generator)
   yield previous
@@ -43,6 +43,7 @@ def test_chaining_orchestrator(self, context):
     func_call = my_orchestrator.build().get_user_function().orchestrator_function
 
     context.call_activity = Mock(side_effect=mock_activity)
+
     # Create a generator using the method and mocked context
     user_orchestrator = func_call(context)