LCORE-1207: add guide for e2e tests#1234
LCORE-1207: add guide for e2e tests#1234radofuchs wants to merge 1 commit intolightspeed-core:mainfrom
Conversation
WalkthroughNew E2E testing documentation added to the Lightspeed Core Stack repository. A comprehensive guide ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![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
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/e2e_testing.md`:
- Line 36: Update the two markdown fenced code blocks in docs/e2e_testing.md
that currently use plain ``` fences (the blocks around the repo tree examples)
to include a language identifier (e.g., change ``` to ```text) so they pass
MD040; locate the two tree snippets and replace their opening fences with
```text for both occurrences.
In `@tests/e2e/README.md`:
- Line 9: Update the README entry that currently references "test_list.txt" to
use the repository-relative path "tests/e2e/test_list.txt" so the feature
run-order file reference is explicit and consistent; locate the line containing
the bullet "* Feature list (run order): `test_list.txt`" and replace the
filename token with the full path string.
|
|
||
| **E2E tests (Behave, feature files, steps):** | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Add language identifiers to fenced code blocks to satisfy markdown linting.
Both tree snippets currently trigger MD040.
🧹 Proposed lint fix
-```
+```text
tests/e2e/
├── README.md # Short pointer to this guide (docs/e2e_testing.md)
...
└── rag/ # RAG test data (e.g. for FAISS)@@
- +text
tests/e2e-prow/
└── rhoai/ # RHOAI / OpenShift E2E
...
└── gpu/ # NFD and cluster policy for GPU
Also applies to: 68-68
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 36-36: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/e2e_testing.md` at line 36, Update the two markdown fenced code blocks
in docs/e2e_testing.md that currently use plain ``` fences (the blocks around
the repo tree examples) to include a language identifier (e.g., change ``` to
```text) so they pass MD040; locate the two tree snippets and replace their
opening fences with ```text for both occurrences.
|
|
||
| * Tests: `tests/e2e/features/*.feature` | ||
| * Step definitions: `tests/e2e/features/steps/` | ||
| * Feature list (run order): `test_list.txt` |
There was a problem hiding this comment.
Use the full path for the feature run-order file.
test_list.txt works in-context, but using tests/e2e/test_list.txt here would be clearer and consistent with the rest of the docs.
✏️ Proposed documentation tweak
-* Feature list (run order): `test_list.txt`
+* Feature list (run order): `tests/e2e/test_list.txt`Based on learnings, maintain test list in tests/e2e/test_list.txt for end-to-end tests.
📝 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.
| * Feature list (run order): `test_list.txt` | |
| * Feature list (run order): `tests/e2e/test_list.txt` |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@tests/e2e/README.md` at line 9, Update the README entry that currently
references "test_list.txt" to use the repository-relative path
"tests/e2e/test_list.txt" so the feature run-order file reference is explicit
and consistent; locate the line containing the bullet "* Feature list (run
order): `test_list.txt`" and replace the filename token with the full path
string.
1 participant
Description
Add guide for E2E testing
Type of change
Tools used to create PR
Identify any AI code assistants used in this PR (for transparency and review context)
Related Tickets & Documents
Checklist before requesting a review
Testing
Summary by CodeRabbit