merge-reports

[nirtal85]

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.

Summary by CodeRabbit

• Chores
  • Updated automation workflows to simplify environment management and dependency handling.
• Tests
  • Streamlined nightly testing with improved caching strategies, consistent job naming, and consolidated test result reporting.

[coderabbitai]

Walkthrough

This pull request updates two GitHub workflow files. In the devRun.yml, an explicit virtual environment path is removed, and the test execution is simplified by using Poetry directly. In the nightly.yml, job and step names are standardized, caching identifiers and keys are revised, and several steps related to Allure report generation have been consolidated into a single step using an updated action version. The changes aim to streamline test execution and reporting.

Changes

File(s)	Change Summary
.github/workflows/devRun.yml	Removed the explicit virtual environment path (virtualenvs-path: .venv) to leverage Poetry's default behavior. Replaced manual virtual environment activation (source .venv/bin/activate) with a direct Poetry command: poetry run xvfb-run pytest -m devRun --base-url ${{ vars.BASE_URL }}.
.github/workflows/nightly.yml	Updated job and step names for consistency (e.g., "Nightly regression tests" → "Nightly Regression Tests", "Load cached venv" → "Cache Dependencies", "Upload test results" → "Upload Test Results"). Changed caching identifier from cached-poetry-dependencies to poetry-cache and simplified the cache key format. Replaced several Allure report steps with a new "Merge and Publish Allure Report" step that uses updated action versions.

Sequence Diagram(s)

sequenceDiagram
    participant W as DevRun Workflow
    participant P as Poetry
    participant T as Test Runner
    W ->> P: Execute "poetry run xvfb-run pytest -m devRun --base-url $BASE_URL"
    P ->> T: Invoke tests with devRun flag
    T -->> P: Test results returned

Loading

sequenceDiagram
    participant W as Nightly Workflow
    participant C as Cache Manager
    participant T as Test Runner
    participant A as Allure Publisher
    W ->> C: Retrieve Poetry dependencies (using new cache key)
    W ->> T: Execute tests with "poetry run"
    T -->> W: Return test outcomes
    W ->> A: Merge and Publish Allure Report using updated action

Loading

Suggested reviewers

• elias-shoursoh

Poem

I'm a rabbit in the codey woods,
Hopping high with changes that feel so good,
Virtual paths trimmed, workflows redefined,
With Poetry guiding tests of every kind,
Leaping with joy—ASCII dreams in my mood! 🐰✨
Hop along and celebrate these tweaks in the hood!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 00aa331 and 648ecc3.

📒 Files selected for processing (2)

• .github/workflows/devRun.yml (1 hunks)
• .github/workflows/nightly.yml (2 hunks)

🔇 Additional comments (7)

.github/workflows/devRun.yml (1)

38-38: Streamlined Test Execution Command

The test command now leverages Poetry together with xvfb-run to execute pytest directly, removing the need for manual virtual environment activation and simplifying the workflow.

.github/workflows/nightly.yml (6)

1-1: Consistent Workflow Naming

Renaming the workflow to "Nightly Regression Tests" improves clarity and aligns the capitalization with standard naming conventions.

---

52-57: Simplified Caching Configuration

The "Cache Dependencies" step now uses a clear identifier (poetry-cache) and a simplified cache key (poetry-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}), which removes reliance on the Python version. This update enhances consistency across workflows and avoids potential cache misses due to version mismatches.

---

59-60: Updated Cache Check for Dependency Installation

By referencing steps.poetry-cache.outputs.cache-hit in the conditional check, the installation step now correctly ties to the renamed caching step. This ensures that dependencies are installed only when the cache is not hit.

---

63-67: Enhanced Parallel Test Execution Command

The test execution command has been augmented to use dynamic inputs such as a custom pytest command, the base URL, the number of splits, and the specific group from the test matrix. This flexible configuration supports parallel test execution and ensures tests are distributed appropriately.

---

68-73: Standardized Artifact Upload for Test Results

The "Upload Test Results" step now defines a dynamic artifact name (allure-results-${{ matrix.group }}) and clearly specifies the path allure-results. This update helps in neatly organizing artifacts generated from parallel test executions.

---

80-84: Consolidated Allure Report Publishing

The newly introduced "Merge and Publish Allure Report" step consolidates previous reporting actions by using Valiantsin2021/allure-shard-results-publish@1.0.6 with the add-env: 'true' configuration. This streamlined approach reduces redundancy and enhances maintainability.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @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.