AWS durable-functions documentation change
Summary
Major restructuring and expansion of testing documentation with comprehensive table of contents, detailed sections on configuration, deployment workflow, testing modes (local vs cloud), best practices, and troubleshooting guides.
Security assessment
The changes are purely documentation improvements and restructuring with no mention of security vulnerabilities, patches, or security incidents. The content focuses on testing methodologies, configuration options, and best practices for testing durable functions in local vs cloud environments. No security-related terminology, vulnerability disclosures, or security feature announcements are present.
Diff
diff --git a/durable-functions/testing/testing-modes.md b/durable-functions/testing/testing-modes.md index 887797ee0..5e81c67c5 100644 --- a//durable-functions/testing/testing-modes.md +++ b//durable-functions/testing/testing-modes.md @@ -15,3 +15,3 @@ Search - * [ SDK Reference ](../../sdk-reference/operations/step/) - * [ Testing ](../basic-tests/) - * [ 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 +53,13 @@ Getting Started - * Testing Testing + * [ 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 @@ -52,2 +69,45 @@ Getting Started - * [ Testing Modes ](././) - * Patterns Patterns + * Testing Modes [ Testing Modes ](././) On this page + * Table of Contents + * Overview + * Terminology + * Key features + * Getting started + * Configuration + * Environment Variables + * CLI Options + * Test Markers + * Deployment workflow + * 1\. Deploy your function + * 2\. Get the function ARN + * 3\. Set environment variables + * 4\. Run tests + * Running tests in different modes + * Run all tests in local mode (default) + * Run all tests in cloud mode + * Run specific test in cloud mode + * Run with custom timeout + * Mode-specific assertions + * Local vs cloud modes + * Comparison + * When to use local mode + * When to use cloud mode + * Writing mode-agnostic tests + * Best practices + * Use local mode for development + * Use cloud mode for validation + * Set appropriate timeouts + * Use environment-specific configuration + * Test one function at a time + * Use CI/CD for automated cloud testing + * Troubleshooting + * TimeoutError: Execution did not complete + * Environment variables not set + * Test skipped: doesn't match LAMBDA_FUNCTION_TEST_NAME + * Failed to invoke Lambda function + * No DurableExecutionArn in response + * Lambda function failed + * Failed to get execution status + * See also + * [ Patterns ](../../patterns/) + +Patterns @@ -105 +165 @@ On this page - 2. [ Testing ](../basic-tests/) + 2. [ Testing ](../) @@ -109 +169 @@ On this page -# Testing Modes: Local vs Cloud +# Testing Modes: Local vs Cloud¶ @@ -111 +171 @@ On this page -## Table of Contents +## Table of Contents¶ @@ -129 +189 @@ On this page -## Overview +## Overview¶ @@ -139 +199 @@ The [AWS Durable Execution SDK Testing Framework](https://github.com/aws/aws-dur -## Terminology +## Terminology¶ @@ -153 +213 @@ The [AWS Durable Execution SDK Testing Framework](https://github.com/aws/aws-dur -## Key features +## Key features¶ @@ -165 +225 @@ The [AWS Durable Execution SDK Testing Framework](https://github.com/aws/aws-dur -## Getting started +## Getting started¶ @@ -212 +272 @@ Run the test in cloud mode: -## Configuration +## Configuration¶ @@ -214 +274 @@ Run the test in cloud mode: -### Environment Variables +### Environment Variables¶ @@ -243 +303 @@ Cloud mode requires these environment variables: -### CLI Options +### CLI Options¶ @@ -251 +311 @@ Cloud mode requires these environment variables: -### Test Markers +### Test Markers¶ @@ -284 +344 @@ TypeScriptPythonJava -## Deployment workflow +## Deployment workflow¶ @@ -288 +348 @@ Follow these steps to deploy and test your durable functions in the cloud: -### 1\. Deploy your function +### 1\. Deploy your function¶ @@ -298 +358 @@ Deploy your Lambda function to AWS using your preferred deployment tool (SAM, CD -### 2\. Get the function ARN +### 2\. Get the function ARN¶ @@ -307 +367 @@ After deployment, get the qualified function name or ARN: -### 3\. Set environment variables +### 3\. Set environment variables¶ @@ -317 +377 @@ Configure the environment for cloud testing: -### 4\. Run tests +### 4\. Run tests¶ @@ -327 +387 @@ Execute your tests in cloud mode: -## Running tests in different modes +## Running tests in different modes¶ @@ -329 +389 @@ Execute your tests in cloud mode: -### Run all tests in local mode (default) +### Run all tests in local mode (default)¶ @@ -335 +395 @@ Execute your tests in cloud mode: -### Run all tests in cloud mode +### Run all tests in cloud mode¶ @@ -341 +401 @@ Execute your tests in cloud mode: -### Run specific test in cloud mode +### Run specific test in cloud mode¶ @@ -347 +407 @@ Execute your tests in cloud mode: -### Run with custom timeout +### Run with custom timeout¶ @@ -369 +429 @@ TypeScriptPythonJava -### Mode-specific assertions +### Mode-specific assertions¶ @@ -400 +460 @@ TypeScriptPythonJava -## Local vs cloud modes +## Local vs cloud modes¶ @@ -402 +462 @@ TypeScriptPythonJava -### Comparison +### Comparison¶ @@ -415 +475 @@ Feature | Local Mode | Cloud Mode -### When to use local mode +### When to use local mode¶ @@ -419 +479 @@ Use local mode for: \- **Development** \- Fast iteration during development \- * -### When to use cloud mode +### When to use cloud mode¶ @@ -423 +483 @@ Use cloud mode for: \- **Integration testing** \- Validate real AWS service inte -### Writing mode-agnostic tests +### Writing mode-agnostic tests¶ @@ -454 +514 @@ TypeScriptPythonJava -## Best practices +## Best practices¶ @@ -456 +516 @@ TypeScriptPythonJava -### Use local mode for development +### Use local mode for development¶ @@ -465 +525 @@ Run tests locally during development for fast feedback: -### Use cloud mode for validation +### Use cloud mode for validation¶ @@ -474 +534 @@ Run cloud tests before merging or deploying: -### Set appropriate timeouts +### Set appropriate timeouts¶ @@ -496 +556 @@ TypeScriptPythonJava -### Use environment-specific configuration +### Use environment-specific configuration¶ @@ -510 +570 @@ Configure different settings for different environments: -### Test one function at a time +### Test one function at a time¶ @@ -520 +580 @@ When running cloud tests, test one function at a time to avoid confusion: -### Use CI/CD for automated cloud testing +### Use CI/CD for automated cloud testing¶ @@ -539 +599 @@ Integrate cloud testing into your CI/CD pipeline: -## Troubleshooting +## Troubleshooting¶ @@ -541 +601 @@ Integrate cloud testing into your CI/CD pipeline: -### TimeoutError: Execution did not complete +### TimeoutError: Execution did not complete¶ @@ -570 +630 @@ Check the Lambda function logs to see if it's actually running: -### Environment variables not set +### Environment variables not set¶ @@ -583 +643 @@ Check the Lambda function logs to see if it's actually running: -### Test skipped: doesn't match LAMBDA_FUNCTION_TEST_NAME +### Test skipped: doesn't match LAMBDA_FUNCTION_TEST_NAME¶ @@ -603 +663 @@ Check the Lambda function logs to see if it's actually running: -### Failed to invoke Lambda function