AWS prescriptive-guidance documentation change
Summary
Updated formatting of TDD acronym, consolidated paragraphs about testing categories, changed image path, modified test output formatting, and updated link text.
Security assessment
Changes are editorial and structural improvements without security context. The mention of 'enforcing security policy' remains unchanged from previous version and isn't new security documentation.
Diff
diff --git a/prescriptive-guidance/latest/best-practices-cdk-typescript-iac/development-best-practices.md b/prescriptive-guidance/latest/best-practices-cdk-typescript-iac/development-best-practices.md index b9550f8f7..9c9df10ac 100644 --- a//prescriptive-guidance/latest/best-practices-cdk-typescript-iac/development-best-practices.md +++ b//prescriptive-guidance/latest/best-practices-cdk-typescript-iac/development-best-practices.md @@ -11 +11 @@ Unit testIntegration test -We recommend that you follow a test-driven development (TDD) approach with the AWS CDK. TDD is a software development approach where you develop test cases to specify and validate your code. In simple terms, first you create test cases for each functionality and if the test fails, then you write the new code to pass the test and make the code simple and bug-free. +We recommend that you follow a test-driven development (TDD) approach with the AWS CDK. TDD**** is a software development approach where you develop test cases to specify and validate your code. In simple terms, first you create test cases for each functionality and if the test fails, then you write the new code to pass the test and make the code simple and bug-free. @@ -13,3 +13 @@ We recommend that you follow a test-driven development (TDD) approach with the A -You can use TDD to write the test case first. This helps you validate the infrastructure with different design constraints in terms of enforcing security policy for the resources and following a unique naming convention for the project. The standard approach to testing AWS CDK applications is to use the AWS CDK [assertions](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions-readme.html) module and popular test frameworks, such as [Jest](https://jestjs.io/) for TypeScript and JavaScript or [pytest](https://docs.pytest.org/en/6.2.x/) for Python. - -There are two categories of tests that you can write for your AWS CDK applications: +You can use TDD to write the test case first. This helps you validate the infrastructure with different design constraints in terms of enforcing security policy for the resources and following a unique naming convention for the project. The standard approach to testing AWS CDK applications is to use the AWS CDK [assertions](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions-readme.html) module and popular test frameworks, such as [Jest](https://jestjs.io/) for TypeScript and JavaScript or [pytest](https://docs.pytest.org/en/6.2.x/) for Python. There are two categories of tests that you can write for your AWS CDK applications: @@ -28 +26 @@ This guide focuses on unit test integration for TypeScript specifically. To enab - + @@ -166 +163 @@ To run a test, run the `npm run test` command in your project. The test returns - ✓ Code Pipeline Created (97 ms) + Code Pipeline Created (97 ms) @@ -172 +169 @@ To run a test, run the `npm run test` command in your project. The test returns -For more information on test cases, see [Testing constructs](https://docs.aws.amazon.com/cdk/v2/guide/testing.html) in the _AWS Cloud Development Kit (AWS CDK) Developer Guide_. +For more information on test cases, see [Testing constructs](https://docs.aws.amazon.com/cdk/v2/guide/testing.html) in the _AWS CDK Developer Guide_.