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(test): split each pytest job into 6 separated jobs #3716

Merged
merged 8 commits into from
Apr 29, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Apr 28, 2024

Split each pytest job into 6 separated jobs in GHA.

Currently, each separated job takes:

njzjz added 8 commits April 27, 2024 04:09
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Copy link
Contributor

coderabbitai bot commented Apr 28, 2024

Walkthrough

Walkthrough

The updates involve enhancing the Python testing workflow by configuring test jobs to run in parallel groups, caching test durations, and introducing a new job to combine these durations. Additionally, the test dependency pytest-split is added to manage test splitting. In the test scripts, redundant configurations are removed, streamlining cleanup with a new tearDown method.

Changes

File Summary of Changes
.github/workflows/.../test_python.yml Modified job matrix, introduced caching and splitting of test runs, added job to combine test durations.
pyproject.toml Added pytest-split to test dependencies.
source/tests/tf/.../test_nvnmd_entrypoints.py Removed redundant enablement toggles, added cleanup method.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 981ce44 and 5efb3a7.
Files selected for processing (3)
  • .github/workflows/test_python.yml (2 hunks)
  • pyproject.toml (1 hunks)
  • source/tests/tf/test_nvnmd_entrypoints.py (5 hunks)
Files skipped from review due to trivial changes (2)
  • pyproject.toml
  • source/tests/tf/test_nvnmd_entrypoints.py
Additional comments not posted (6)
.github/workflows/test_python.yml (6)

16-16: Setting fail-fast: false is a strategic choice that allows all test groups to complete even if one fails. This is beneficial for comprehensive testing but could increase the total CI time if many tests fail early.


18-19: The matrix configuration to split tests into six groups across Python versions 3.8 and 3.11 is well-implemented. This should help in parallelizing the tests effectively.


55-55: The use of pytest-split for managing test splitting and duration tracking is correctly implemented. Ensure that the pytest-split plugin is properly installed and configured as per the changes in pyproject.toml.


58-62: The configuration for uploading partial test durations as artifacts is correctly set up. This will facilitate the combination of these durations in the update_durations job.


66-93: The update_durations job is well-configured to combine test durations from multiple groups. The use of caching and artifact downloading steps is appropriate. Ensure that the jq command in line 90 correctly combines the JSON files as intended.


93-93: The pass job correctly depends on both testpython and update_durations jobs. This setup ensures that it only runs after both of the dependent jobs have completed, which is crucial for the workflow's logic.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

Out of diff range and nitpick comments (1)
.github/workflows/test_python.yml (1)

44-55: The caching strategy for test durations is complex but well thought out, ensuring that durations do not get out of sync between groups. However, consider adding more comments to explain the rationale behind the specific key and restore-keys choices to aid future maintainability.

Copy link

codecov bot commented Apr 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.12%. Comparing base (78c6214) to head (5efb3a7).
Report is 1 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #3716   +/-   ##
=======================================
  Coverage   82.12%   82.12%           
=======================================
  Files         511      511           
  Lines       47363    47363           
  Branches     2952     2953    +1     
=======================================
  Hits        38898    38898           
  Misses       7572     7572           
  Partials      893      893           

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

@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Apr 29, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 29, 2024
@njzjz njzjz added this pull request to the merge queue Apr 29, 2024
Merged via the queue into deepmodeling:devel with commit 49f17cc Apr 29, 2024
60 checks passed
@njzjz njzjz deleted the split-pytest branch April 29, 2024 20:44
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
)

Split each pytest job into 6 separated jobs in GHA.

Currently, each separated job takes:
- ~2.5 min for installation, which may need to be optimized in the
future;
- ~2 min for setup, which may be a defect and should be resolved in
deepmodeling#3715;
-  4~5 min for tests (expected).

---------

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants