Update shared_tests README #110
Conversation
Small update on shared test README replacing tc.yaml with test_cases.yml file. Signed-off-by: Marek Aufart <[email protected]>
WalkthroughThe documentation in Changes
Sequence Diagram(s)(Omitted: Documentation-only change with no control flow impact.) Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
Note 🔌 MCP (Model Context Protocol) integration is now available in Early Access!Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
shared_tests/README.md (2)
3-3: Fix minor typos and grammar.Two small wording fixes to improve clarity.
-Konveyor project affers multiple way of application analysis. There is a shared set of end-to-end basic application analyses that is tested with all relevant components (as an addition to their tests) and this is considered as a source of truth for analysis results. +The Konveyor project offers multiple ways of application analysis. There is a shared set of basic end-to-end application analyses that is tested with all relevant components (in addition to their tests) and is considered the source of truth for analysis results.-More information about shared tests in CI generaly: https://github.com/konveyor/enhancements/pull/228 +More information about shared tests in CI generally: https://github.com/konveyor/enhancements/pull/228Also applies to: 29-29
7-7: Nit: add spacing around “&” for readability.-- CLI - kantra tests (container&containerless including Windows) https://github.com/konveyor-ecosystem/kantra-cli-tests/ +- CLI - kantra tests (container & containerless including Windows) https://github.com/konveyor-ecosystem/kantra-cli-tests/
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
shared_tests/README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Verify api and ui tests run via
global-ci-bundle.ymlwith default input / e2e-ui-integration-tests - GitHub Check: Verify api and ui tests run via
global-ci-bundle.ymlwith default input / e2e-api-integration-tests - GitHub Check: Verify api and ui tests run via
global-ci.ymlwith default inputs / e2e-ui-integration-tests - GitHub Check: Verify api and ui tests run via
global-ci.ymlwith default inputs / e2e-api-integration-tests
| ├── book-server_deps # name of the test case | ||
| | ├── dependencies.yaml # analyzer-like dependencies output (produced in full analysis mode) | ||
| | └── output.yaml # analyzer-like analysis output (contain ruleset with violations/issues reported and optionally Tags on technology usage and discovery) | ||
| └── test_cases.yaml # analysis test cases definition (top level keys should match to directory names with expected results) |
There was a problem hiding this comment.
Fix extension mismatch: use test_cases.yml consistently.
The tree lists test_cases.yaml, but the link and PR objective point to test_cases.yml. Standardize on .yml to match the PR intent and avoid confusion.
Apply this diff:
- └── test_cases.yaml # analysis test cases definition (top level keys should match to directory names with expected results)
+ └── test_cases.yml # analysis test cases definition (top level keys should match directory names with expected results)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| └── test_cases.yaml # analysis test cases definition (top level keys should match to directory names with expected results) | |
| └── test_cases.yml # analysis test cases definition (top level keys should match directory names with expected results) |
🤖 Prompt for AI Agents
In shared_tests/README.md at line 17, the filename extension for the test cases
file is listed as .yaml, but the rest of the PR and links use .yml. Change the
filename in the tree listing from test_cases.yaml to test_cases.yml to maintain
consistency and avoid confusion.
| ``` | ||
|
|
||
| Check out [book-server test case](analysis_book-server/) as an example. | ||
| Check out [test cases.yml](test_cases.yml) |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Align link text with actual filename and clarify.
Use the exact filename in the link text for clarity and consistency with the tree.
Apply this diff:
-Check out [test cases.yml](test_cases.yml)
+See [test_cases.yml](test_cases.yml) for the canonical test case definition.Run this script to verify there are no stale references and confirm which file exists:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Searching for stale references to tc.yaml..."
rg -n --hidden --glob '!.git' 'tc\.ya?ml' || true
echo -e "\nListing test_cases files present in the repo..."
fd -a 'test_cases.y*ml' || true
echo -e "\nScanning for references to test_cases.yml/.yaml in the repo..."
rg -n --hidden --glob '!.git' 'test_cases\.ya?ml' || trueLength of output: 1559
Align README references to the actual filename and clarify.
- In
shared_tests/README.mdline 17, the tree listing showstest_cases.yamlbut the file on disk istest_cases.yml. Update it for consistency:
-└── test_cases.yaml # analysis test cases definition …
+└── test_cases.yml # analysis test cases definition …
- In the same file at line 20, use the exact filename in the link text and clarify its purpose:
```diff
-Check out [test cases.yml](test_cases.yml)
+See [test_cases.yml](test_cases.yml) for the canonical test case definition.
Run the provided validation script to ensure there are no stale tc.yaml references and that all test_cases.yml links resolve correctly.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Check out [test cases.yml](test_cases.yml) | |
| └── test_cases.yml # analysis test cases definition … | |
| See [test_cases.yml](test_cases.yml) for the canonical test case definition. |
🤖 Prompt for AI Agents
In shared_tests/README.md at line 20, update the link text from "test cases.yml"
to "test_cases.yml" to match the actual filename exactly and clarify its
purpose, ensuring consistency with the file on disk and the earlier tree
listing. Adjust the link text to be precise and descriptive about the file it
references.
Small update on shared test README replacing tc.yaml with test_cases.yml file.
Summary by CodeRabbit