AWS durable-functions documentation change
Summary
Updated documentation structure with improved navigation links, expanded table of contents, and added detailed testing patterns including status checking, result verification, operation-specific assertions, and test organization tips.
Security assessment
The changes are purely documentation improvements focused on testing patterns, navigation structure, and content organization. There is no mention of security vulnerabilities, security patches, authentication, authorization, encryption, or any security-related features. The changes are routine documentation updates to enhance usability and clarity.
Diff
diff --git a/durable-functions/testing/basic-tests.md b/durable-functions/testing/basic-tests.md index eefe2539c..b8cf56d65 100644 --- a//durable-functions/testing/basic-tests.md +++ b//durable-functions/testing/basic-tests.md @@ -15,3 +15,3 @@ Search - * [ SDK Reference ](../../sdk-reference/operations/step/) - * [ Testing ](././) - * [ Patterns ](../../patterns/best-practices/) + * [ SDK Reference ](../../sdk-reference/) + * [ Testing ](../) + * [ Patterns ](../../patterns/) @@ -30,2 +30,7 @@ Getting Started - * [ Quick Start ](../../getting-started/quick-start/) - * SDK Reference SDK Reference + * [ Quickstart ](../../getting-started/quickstart/) + * [ Quickstart for Container Image ](../../getting-started/quickstart-container-image/) + * [ Manage Executions ](../../getting-started/manage-executions/) + * [ Development Environment ](../../getting-started/development-environment/) + * [ SDK Reference ](../../sdk-reference/) + +SDK Reference @@ -48,2 +53,42 @@ Getting Started - * Testing Testing - * [ Basic Tests ](././) + * [ Configuration ](../../sdk-reference/configuration/) + +Configuration + * [ Custom Lambda Client ](../../sdk-reference/configuration/custom-lambda-client/) + * [ Language Guides ](../../sdk-reference/languages/) + +Language Guides + * [ TypeScript ](../../sdk-reference/languages/typescript/) + * [ Python ](../../sdk-reference/languages/python/) + * [ Java ](../../sdk-reference/languages/java/) + * [ Testing ](../) + +Testing + * Basic Tests [ Basic Tests ](././) On this page + * Table of Contents + * Overview + * Prerequisites + * Project structure + * Getting started + * Status checking patterns + * Check for successful execution + * Check for expected failures + * Check execution with timeout + * Result verification patterns + * Verify simple return values + * Verify complex return values + * Verify list results + * Operation-specific assertions + * Verify step operations + * Verify wait operations + * Verify callback operations + * Verify child context operations + * Verify parallel operations + * Test organization tips + * Use descriptive test names + * Group related tests + * Use fixtures for common test data + * Add docstrings to tests + * Use parametrized tests for similar cases + * Keep tests focused + * FAQ + * See also @@ -53 +98,3 @@ Getting Started - * Patterns Patterns + * [ Patterns ](../../patterns/) + +Patterns @@ -92 +139 @@ On this page - 2. [ Testing ](././) + 2. [ Testing ](../) @@ -96 +143 @@ On this page -# Basic Test Patterns +# Basic Test Patterns¶ @@ -98 +145 @@ On this page -## Table of Contents +## Table of Contents¶ @@ -115 +162 @@ On this page -## Overview +## Overview¶ @@ -123 +170 @@ The testing SDK (`aws-durable-execution-sdk-python-testing`) provides tools to r -## Prerequisites +## Prerequisites¶ @@ -142 +189 @@ The core SDK provides the decorators and context for writing durable functions. -## Project structure +## Project structure¶ @@ -198 +245 @@ TypeScriptPythonJava -## Getting started +## Getting started¶ @@ -255 +302 @@ This test: 1\. Marks the test with `@pytest.mark.durable_execution` to configure -## Status checking patterns +## Status checking patterns¶ @@ -257 +304 @@ This test: 1\. Marks the test with `@pytest.mark.durable_execution` to configure -### Check for successful execution +### Check for successful execution¶ @@ -284 +331 @@ TypeScriptPythonJava -### Check for expected failures +### Check for expected failures¶ @@ -312 +359 @@ TypeScriptPythonJava -### Check execution with timeout +### Check execution with timeout¶ @@ -342 +389 @@ TypeScriptPythonJava -## Result verification patterns +## Result verification patterns¶ @@ -344 +391 @@ TypeScriptPythonJava -### Verify simple return values +### Verify simple return values¶ @@ -374 +421 @@ TypeScriptPythonJava -### Verify complex return values +### Verify complex return values¶ @@ -409 +456 @@ TypeScriptPythonJava -### Verify list results +### Verify list results¶ @@ -446 +493 @@ TypeScriptPythonJava -## Operation-specific assertions +## Operation-specific assertions¶ @@ -448 +495 @@ TypeScriptPythonJava -### Verify step operations +### Verify step operations¶ @@ -515 +562 @@ TypeScriptPythonJava -### Verify wait operations +### Verify wait operations¶ @@ -629 +676 @@ TypeScriptPythonJava -### Verify callback operations +### Verify callback operations¶ @@ -698 +745 @@ TypeScriptPythonJava -### Verify child context operations +### Verify child context operations¶ @@ -761 +808 @@ TypeScriptPythonJava -### Verify parallel operations +### Verify parallel operations¶ @@ -829 +876 @@ TypeScriptPythonJava -## Test organization tips +## Test organization tips¶ @@ -831 +878 @@ TypeScriptPythonJava -### Use descriptive test names +### Use descriptive test names¶ @@ -861 +908 @@ TypeScriptPythonJava -### Group related tests +### Group related tests¶ @@ -899 +946 @@ TypeScriptPythonJava -### Use fixtures for common test data +### Use fixtures for common test data¶ @@ -938 +985 @@ TypeScriptPythonJava -### Add docstrings to tests +### Add docstrings to tests¶ @@ -968 +1015 @@ TypeScriptPythonJava -### Use parametrized tests for similar cases +### Use parametrized tests for similar cases¶ @@ -999 +1046 @@ TypeScriptPythonJava -### Keep tests focused +### Keep tests focused¶ @@ -1046 +1093 @@ TypeScriptPythonJava -## FAQ +## FAQ¶ @@ -1090 +1137 @@ A: Set environment variables in your test setup or use pytest fixtures to manage -## See also +## See also¶ @@ -1103 +1150 @@ A: Set environment variables in your test setup or use pytest fixtures to manage -Back to top [ Previous Logging ](../../sdk-reference/observability/logging/) [ Next Complex Workflows ](../complex-workflows/) +Back to top [ Previous Testing ](../) [ Next Complex Workflows ](../complex-workflows/)