Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: enable syncing robot test cases with qase #2200

Merged
merged 2 commits into from
Dec 18, 2024

Conversation

yangchiu
Copy link
Member

@yangchiu yangchiu commented Dec 17, 2024

Which issue(s) this PR fixes:

Issue longhorn/longhorn#8853

What this PR does / why we need it:

enable syncing robot test cases with qase

Special notes for your reviewer:

Additional documentation or context

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling of test suite identification for robot reports, preventing exceptions for unsupported test types.
    • Assigned a default suite ID for missing robot suites to ensure proper categorization.
  • Documentation

    • Updated comments to reflect changes in logic regarding test suite handling.

@yangchiu yangchiu self-assigned this Dec 17, 2024
@yangchiu yangchiu requested a review from a team as a code owner December 17, 2024 08:40
Copy link

coderabbitai bot commented Dec 17, 2024

Walkthrough

The pull request modifies the junit_to_qase.py script to improve handling of robot test suite identification. The change specifically updates the parent_suite_id assignment for robot test types, replacing the previous exception-raising behavior with a default suite ID of 89 for "e2e-robot" suites. This modification allows for more flexible processing of robot test reports by providing a fallback suite ID when the test type is identified as "robot".

Changes

File Change Summary
pipelines/utilities/junit_to_qase.py Updated handling of parent_suite_id for robot test types, assigning suite ID 89 instead of raising an exception

Assessment against linked issues

Objective Addressed Explanation
Post result of e2e and other pipeline in Qase [#8853]
Create test run with job name and timestamp Changes do not directly address test run creation mechanism
Default option to post results Changes do not modify job configuration or default settings

Poem

🐰 A rabbit's tale of test suite grace,
Where robot reports find their place,
No more exceptions to embrace,
Suite 89 now sets the pace,
In Qase's digital test space! 🤖

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
pipelines/utilities/junit_to_qase.py (1)

Line range hint 242-251: Consider improving error handling and configuration management.

While the changes work as intended, here are some suggestions to enhance the code:

  1. Add explicit error handling for unknown test types
  2. Consider moving suite IDs to configuration
  3. Add validation for the suite existence before use

Here's a suggested improvement:

+# At the top of the file with other constants
+SUITE_IDS = {
+    "pytest": 58,  # e2e-pytest
+    "robot": 89,   # e2e-robot
+}

 # decide it's a pytest or robot report
 test_suites = soup.find_all("testsuite")
 if test_suites[0].get("name") == "pytest":
     test_type = "pytest"
-    # if it's a pytest report, missing suites will be added under
-    # parent suite e2e-pytest (id=58)
-    parent_suite_id = 58 # e2e-pytest
 else:
     test_type = "robot"
-    # if it's a robot report, missing suites will be added under
-    # parent suite e2e-robot (id=89)
-    parent_suite_id = 89 # e2e-robot
+
+if test_type not in SUITE_IDS:
+    raise ValueError(f"Unsupported test type: {test_type}")
+
+parent_suite_id = SUITE_IDS[test_type]
+print(f"Using parent suite ID {parent_suite_id} for {test_type}")
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5c4ab15 and 2523902.

📒 Files selected for processing (1)
  • pipelines/utilities/junit_to_qase.py (1 hunks)
🔇 Additional comments (1)
pipelines/utilities/junit_to_qase.py (1)

249-251: LGTM! The changes enable robot test case syncing as intended.

The implementation correctly assigns robot test cases to the "e2e-robot" suite (ID: 89), which aligns with the PR objective of enabling robot test case syncing with Qase.

Let's verify the Qase suite ID:

@khushboo-rancher khushboo-rancher enabled auto-merge (rebase) December 18, 2024 19:37
@khushboo-rancher khushboo-rancher merged commit f6dddde into longhorn:master Dec 18, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants