Test Coverage Checklist for Enhanced Dynamo DB PRs #6067
Conversation
joviegas
force-pushed
the
joviegas/ddb-testing-instructions
branch
from
a9c8b5a to
5439829
Compare
joviegas
force-pushed
the
joviegas/ddb-testing-instructions
branch
from
5439829 to
942d804
Compare
| | c. TableSchema.documentSchemaBuilder().build() | [ ] | | | ||
| | d. StaticTableSchema.builder(Customer.class) | [ ] | | | ||
| | **2. Nesting of Different TableSchema Types** | | | | ||
| | a. @DynamoDbBean with nested @DynamoDbBean as NonNull | [ ] | | |
There was a problem hiding this comment.
As in null reference , updated to make it clear
| | **4. Data Types and Null Handling** | | | | ||
| | a. top-level null attributes | [ ] | | | ||
| | b. collections with null elements | [ ] | | | ||
| | c. maps with null values | [ ] | | | ||
| | d. conversion between null Java values and AttributeValue | [ ] | | | ||
| | e. full serialization/deserialization cycle with null values | [ ] | | |
There was a problem hiding this comment.
As a DDB noob, I don't really know what this means... Can we point out to existing test cases or test classes?
There was a problem hiding this comment.
Updated a reference table also mentioned a link below
| - [Reference for Data Types and Null Handling](https://github.com/aws/aws-sdk-java-v2/blob/master/services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/document/EnhancedDocumentTestData.java) | ||
|
|
||
| ```md | ||
| ## Test Coverage Checklist |
There was a problem hiding this comment.
Does it make sense to categorize the changes and specify tests required for each category?
For example:
- Adding/updating an annotation
- Add tests for all TableSchemas
- ...
- Add tests for all TableSchemas
- Adding/updating an API in DynamoDbTable
- Add tests for ...
- Adding/updating CRUD operations
- Adding/updating Extensions
...
There was a problem hiding this comment.
While initially I thought of categorizing it , but I believe we should maintain a comprehensive checklist approach rather than categorizing tests by change type. Here's why:
- Test cases represent independent DynamoDB features that can be impacted by various types of changes
- Categorization might inadvertently narrow focus to specific test areas, potentially missing edge cases
- A complete checklist ensures thorough coverage regardless of the change type
- PR reviewers can verify all relevant test cases are addressed
- For tests already covered, contributors can simply reference existing coverage
Most scenarios are already addressed in our test suite, but a comprehensive checklist approach helps us proactively identify gaps rather than discovering issues later in the development cycle.
For now, I think a complete checklist is more practical and ensures we don't miss anything important. We could consider developing a structured categorization approach in the future when we have time to properly map all test scenarios. What do you say?
|
Motivation and Context
Modifications
Testing
Test Coverage Checklist
Sample Test Scenario checklist for this PR , since this PR just updated MD file no need of tests, this below is just a demo on how this should be used.
Screenshots (if appropriate)
License