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

chore: enhance testing CI/CD #117

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

jjjermiah
Copy link
Contributor

@jjjermiah jjjermiah commented Feb 6, 2025

  • copied over the pytest config from med-imagetools

  • can easily view errors in gha during pytest without going into the action logs

  • small fix to the fixtures that delete temporary paths and are used by multiple tests (can cause errors during parallel runs)

  • also cleanups for each PRs gha caches

Summary by CodeRabbit

  • Tests
    • Enhanced test execution with more detailed feedback and immediate halt on failures for quicker diagnostics.
    • Introduced a comprehensive test summary report for improved visibility of test outcomes.
    • Streamlined test command configurations for simpler and more efficient execution.
    • Improved test fixture management to ensure more robust setup and cleanup during test runs.

Copy link
Contributor

coderabbitai bot commented Feb 6, 2025

Warning

Rate limit exceeded

@jjjermiah has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 36 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8b98d87 and 70e9f32.

📒 Files selected for processing (2)
  • .github/workflows/ci-cd.yml.disabled (0 hunks)
  • .github/workflows/cleanup_caches.yml (1 hunks)

Walkthrough

This pull request updates the testing configuration and workflow across the project. In the CI/CD workflow, the pytest command is enhanced with verbosity flags and now stops on the first failure, with an additional step to generate a JUnit test summary. A new pytest.ini file adds various testing configurations, and the pyproject.toml file has been simplified to run tests using this configuration. Finally, test fixture definitions have been modified to use module-scoped lifecycles and include a conditional cleanup step.

Changes

File(s) Change Summary
.github/workflows/ci-cd.yml Updated the pixi command in the Unit-Tests job to include -s -vv flags; added a new step using test-summary/action@v2 to generate a JUnit test summary.
config/pytest.ini New configuration file setting minimum pytest version, cache directory, console style, extra options (such as verbosity and coverage reporting), test paths, and filters.
pyproject.toml Simplified test task command in [tool.pixi.feature.test.tasks.test] from a multi-line command to a single string using the new pytest configuration.
tests/test_feature_extraction.py Modified fixture decorators to use scope="module" and updated cleanup logic to check for file existence before unlinking.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant CI as CI/CD Pipeline
    participant Executor as Test Executor
    participant Summary as JUnit Summary Step
    participant Uploader as Coverage Uploader

    Dev->>CI: Push commit with changes
    CI->>Executor: Start Unit-Tests job
    Executor->>Executor: Run tests with "pixi run -e ${{ matrix.env }} test -s -vv"
    Executor->>Summary: Always execute test-summary step
    Summary-->>CI: Produce JUnit test report
    CI->>Uploader: Conditionally upload coverage report
    Uploader-->>CI: Coverage artifact processed
Loading

Possibly related PRs

Suggested reviewers

  • strixy16

Poem

I'm a bunny with a curious nose,
Hopping in workflows where the testing grows.
With flags turned up and summaries so neat,
My code now leaps to a rhythmic beat.
Cheers to the changes, quick and bright—
A bunny's joy in code taking flight!


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

🧹 Nitpick comments (2)
config/pytest.ini (1)

63-69: Consider adding more specific warning filters.

While the current warning filters are good, consider being more specific about which DeprecationWarnings to ignore.

 filterwarnings =
-    ignore::DeprecationWarning
+    ignore::DeprecationWarning:pytest.*
+    ignore::DeprecationWarning:_pytest.*
     # Add specific warning messages to ignore here
     ignore::UserWarning:pydicom.*
.github/workflows/ci-cd.yml (1)

44-50: Fix trailing spaces in YAML.

Remove trailing spaces to maintain consistent formatting.

      - name: JUnit Test Summary
        id: pytest-summary
        uses: test-summary/action@v2
-        with: 
+        with:
          paths: .cache/test-results/**/*.xml
          show: "fail,skip"
        if: always()
🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 47-47: trailing spaces

(trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7a11db1 and 8b98d87.

⛔ Files ignored due to path filters (1)
  • pixi.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • .github/workflows/ci-cd.yml (2 hunks)
  • config/pytest.ini (1 hunks)
  • pyproject.toml (1 hunks)
  • tests/test_feature_extraction.py (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/ci-cd.yml

[error] 43-43: trailing spaces

(trailing-spaces)


[error] 47-47: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Unit-Tests (windows-latest, py312)
  • GitHub Check: Unit-Tests (windows-latest, py311)
  • GitHub Check: Unit-Tests (windows-latest, py310)
  • GitHub Check: Unit-Tests (macos-14, py312)
  • GitHub Check: Unit-Tests (macos-14, py311)
  • GitHub Check: Unit-Tests (macos-14, py310)
  • GitHub Check: Unit-Tests (macos-latest, py311)
  • GitHub Check: Unit-Tests (macos-latest, py310)
🔇 Additional comments (7)
tests/test_feature_extraction.py (2)

47-57: LGTM! Improved fixture management with module scope and safer cleanup.

The changes enhance test reliability by:

  • Using module scope to reduce fixture setup/teardown overhead
  • Adding existence check before cleanup to prevent errors during parallel test execution

58-68: LGTM! Consistent fixture improvements applied.

The same improvements have been correctly applied to the lung4DMetadataPath fixture.

config/pytest.ini (3)

1-11: LGTM! Well-structured basic configuration.

The configuration properly sets:

  • Minimum pytest version for compatibility
  • Cache directory for test artifacts
  • Progress-style console output for better visibility

12-45: LGTM! Comprehensive test execution configuration.

The addopts section effectively configures:

  • Detailed test output with --showlocals
  • Coverage reporting in multiple formats
  • Parallel test execution with load grouping
  • JUnit XML reporting for CI integration

51-61: LGTM! Clear test discovery patterns.

Well-defined patterns for:

  • Test paths
  • Excluded directories
  • Test file naming conventions
pyproject.toml (1)

76-78: LGTM! Simplified test execution configuration.

Test command now properly uses the centralized pytest.ini configuration, making it easier to maintain and modify test settings.

.github/workflows/ci-cd.yml (1)

32-34: LGTM! Enhanced test execution visibility.

Added verbosity flags (-s -vv) to improve test output in CI logs.

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.39%. Comparing base (39a6d6b) to head (70e9f32).
Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #117       +/-   ##
===========================================
+ Coverage   48.12%   83.39%   +35.26%     
===========================================
  Files          34       34               
  Lines        1492     1734      +242     
===========================================
+ Hits          718     1446      +728     
+ Misses        774      288      -486     

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

@jjjermiah jjjermiah requested a review from strixy16 February 6, 2025 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

1 participant