feat: add automatically generated test index #3078
Conversation
Signed-off-by: xstefank <[email protected]>
There was a problem hiding this comment.
Pull request overview
This PR adds an automatically generated test index documentation file that catalogs all integration tests annotated with @Sample in the codebase. The file is generated during the Maven build process (specifically during the process-test-classes phase) and provides comprehensive documentation for developers looking to understand available test samples and use cases.
The PR description indicates uncertainty about whether this generated file should be version controlled or added to .gitignore, presenting it as an "either/or" decision to prevent uncommitted generated files from remaining after builds.
Key Changes
- Adds comprehensive test index documentation with 1,252 lines covering 116 integration tests
- Organizes tests into three main categories: Base API (61 tests), Dependent Resources (45 tests), and Workflows (10 tests)
- Provides descriptions, links to source code, and categorized navigation for each test sample
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
|
|
||
| --- | ||
|
|
||
| ## WorkflowActivationConditionIT |
There was a problem hiding this comment.
Duplicate heading ID: There are two test classes with the same name WorkflowActivationConditionIT (lines 1132 and 1187), which will generate the same anchor link #workflowactivationconditionit. This causes the table of contents links on lines 111 and 116 to both point to the first occurrence (line 1132) instead of their respective sections.
The second occurrence is from package io.javaoperatorsdk.operator.workflow.workflowactivationcondition while the first is from io.javaoperatorsdk.operator.workflow.getnonactivesecondary. Consider differentiating these headings or modifying the test class names to avoid this collision.
| ## WorkflowActivationConditionIT | |
| ## WorkflowActivationConditionIT (workflowactivationcondition) |
There was a problem hiding this comment.
This is something that should probably be addressed in the generator. /cc @csviri
|
pls add it to the git ignore, I don't think we should store generated sources, we don't do it anywhere |
|
Replaced by #3079 |
3 participants
@csviri I'm not sure if this file should be version controlled but we should not generate files that are stuck after the build it finished. So either this or I will add it to .gitignore :).