LCORE-303: fixes made in E2E tests

[tisnik]

Description

LCORE-303: fixes made in E2E tests

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Related Tickets & Documents

• Related Issue #LCORE-303

Summary by CodeRabbit

• Tests
  • Added assertions to end-to-end test steps to ensure required input data is present before proceeding, providing clearer error messages when data is missing.
  • Updated import statements to suppress static type checking warnings.
  • Improved URL construction and file handling in scenario generation script for greater consistency and clarity.

[coderabbitai]

Walkthrough

Assertions were added to several test step implementations to ensure required context data is present before proceeding, providing clear error messages on missing input. Import statements were updated to suppress static analysis warnings. In the scenario list generator, repository URL handling was refactored for clarity, and file operations now explicitly use UTF-8 encoding.

Changes

File(s)	Change Summary
tests/e2e/features/steps/common_http.py	Added assertions for context.text and context.table presence; updated import with Pyright comment.
tests/e2e/features/steps/llm_query_response.py	Added assertion for context.table presence; updated import with Pyright comment.
tests/e2e/gen_scenario_list.py	Refactored repo URL handling; removed directory variable; enforced UTF-8 file encoding; switched to f-strings.

Poem

A bunny checks before it hops,
Ensuring context never stops.
With URLs neat and files in line,
It reads in UTF-8 just fine.
Assertions guard each testy leap—
Now every step is safe and deep!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b074aea and 8dfdd6e.

📒 Files selected for processing (3)

• tests/e2e/features/steps/common_http.py (7 hunks)
• tests/e2e/features/steps/llm_query_response.py (2 hunks)
• tests/e2e/gen_scenario_list.py (2 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). (1)

• GitHub Check: build-pr

🔇 Additional comments (14)

tests/e2e/gen_scenario_list.py (5)

24-26: LGTM! Good refactoring for maintainability.

Adding the REPO_URL constant centralizes the base repository URL, making it easier to maintain and update if the repository location changes.

---

28-28: LGTM! Modern and readable URL construction.

Using an f-string for dynamic URL construction improves readability and is the preferred modern Python approach.

---

49-49: LGTM! Simplified variable usage.

Directly using FEATURE_DIRECTORY eliminates the unnecessary intermediate directory variable, making the code more concise.

---

54-54: LGTM! Modern string formatting.

The f-string syntax is more readable and performant than the .format() method.

---

55-57: LGTM! Explicit UTF-8 encoding improves cross-platform compatibility.

Explicitly specifying UTF-8 encoding ensures consistent file handling across different platforms and locales, preventing potential encoding issues.

tests/e2e/features/steps/llm_query_response.py (2)

4-4: LGTM! Appropriate static analysis suppression.

The pyright ignore comment properly suppresses a known false positive with behave imports while maintaining type checking for the rest of the code.

---

44-45: LGTM! Excellent defensive programming.

The assertion ensures context.table is present before processing, providing a clear error message if the expected data structure is missing. This prevents cryptic errors and improves test debugging.

tests/e2e/features/steps/common_http.py (7)

6-6: LGTM! Consistent static analysis suppression.

The pyright ignore comment is consistent with the approach used in other step definition files.

---

40-41: LGTM! Essential input validation.

The assertion ensures the JSON payload is present before attempting to parse it, preventing confusing JSON parsing errors downstream.

---

59-60: LGTM! Proper precondition validation.

The assertion verifies that request parameters are specified in the table before processing, providing clear feedback when test data is missing.

---

127-127: LGTM! Clear error messaging for missing schema.

The assertion ensures the response schema is provided before validation, with a descriptive error message.

---

147-147: LGTM! Consistent validation pattern.

The assertion follows the established pattern of validating payload presence before JSON processing.

---

159-159: LGTM! Defensive programming for response validation.

The assertion ensures the expected response body is specified before comparison, maintaining consistency with other validation functions.

---

227-227: LGTM! Input validation for POST requests.

The assertion ensures the payload is present before sending POST requests, preventing requests with undefined data.

✨ Finishing Touches

• 📝 Docstrings were successfully generated. (🔄 Check again to generate docstrings again)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Note

Generated docstrings for this pull request at #229