Skip to content

CI: set --clean-durations for pytest-split #4341

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

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Nov 12, 2024

I noticed that the CI is broken in several PRs. The duration files are not generated correctly and become larger and larger, causing out-of-memory.

Summary by CodeRabbit

  • Chores
    • Updated the workflow configuration for Python testing to enhance test duration management and artifact handling.
    • Improved caching mechanisms for test durations to ensure uniqueness and avoid conflicts.

Signed-off-by: Jinzhe Zeng <[email protected]>
(cherry picked from commit 9af5267)
@njzjz njzjz mentioned this pull request Nov 12, 2024
Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

📝 Walkthrough

Walkthrough

The pull request updates the GitHub Actions workflow for testing Python applications. Key modifications include adding the --clean-durations option to the pytest command, enhancing artifact management in the update_durations job, and refining the caching mechanism for test durations to ensure unique keys. The overall job structure and concurrency settings remain unchanged, maintaining clear dependencies among jobs.

Changes

File Path Change Summary
.github/workflows/test_python.yml - Updated pytest command to include --clean-durations option.
- Added a step in update_durations job to download artifacts matching split-${{ matrix.python }}-*.
- Merged multiple artifacts into a single file.
- Refined caching mechanism for unique keys to avoid conflicts.
- Retained overall structure and concurrency settings of jobs.

Possibly related PRs

Suggested reviewers

  • wanghan-iapcm

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 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
Contributor

@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

🧹 Outside diff range and nitpick comments (1)
.github/workflows/test_python.yml (1)

Line range hint 89-93: Consider adding error handling for the duration file merge

The artifact merging looks good, but consider adding error checking for the jq merge operation to handle cases where some duration files might be missing or malformed.

Consider this more robust approach:

-    - name: Combine test durations
-      run: jq -s add .test_durations_* > .test_durations
+    - name: Combine test durations
+      run: |
+        if ! ls .test_durations_* >/dev/null 2>&1; then
+          echo "No duration files found!"
+          exit 1
+        fi
+        if ! jq -s add .test_durations_* > .test_durations; then
+          echo "Failed to merge duration files!"
+          exit 1
+        fi
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c4a973a and 7b45f06.

📒 Files selected for processing (1)
  • .github/workflows/test_python.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/test_python.yml (1)

57-57: Addition of --clean-durations looks good!

The flag addition aligns well with the PR objective of managing duration file sizes and integrates correctly with the existing pytest-split configuration.

Let's verify the behavior in failure scenarios:

Copy link

codecov bot commented Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.35%. Comparing base (c4a973a) to head (7b45f06).
Report is 119 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4341   +/-   ##
=======================================
  Coverage   84.35%   84.35%           
=======================================
  Files         593      593           
  Lines       55899    55899           
  Branches     3388     3388           
=======================================
  Hits        47154    47154           
  Misses       7635     7635           
  Partials     1110     1110           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@njzjz njzjz requested a review from wanghan-iapcm November 12, 2024 06:22
@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Nov 12, 2024
Merged via the queue into deepmodeling:devel with commit 4793125 Nov 12, 2024
60 checks passed
This was referenced Nov 25, 2024
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