Skip to content

fix: remove unit_tests directory from coverage report and add handling of tmp files#557

Merged
Christo Grabowski (ChristoGrab) merged 1 commit intomainfrom
christo/fix-pytest-coverage-report
May 19, 2025
Merged

fix: remove unit_tests directory from coverage report and add handling of tmp files#557
Christo Grabowski (ChristoGrab) merged 1 commit intomainfrom
christo/fix-pytest-coverage-report

Conversation

@ChristoGrab
Copy link
Copy Markdown
Collaborator

@ChristoGrab Christo Grabowski (ChristoGrab) commented May 19, 2025

What

Trying to address CI failures in #556, where Pytest steps are failing on the coverage report step despite the test suites passing.

Run poetry run coverage report
poetry run coverage report
shell: /usr/bin/bash -e {0}
env:
pythonLocation: /opt/hostedtoolcache/Python/3.10.17/x64
PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.10.17/x64/lib/pkgconfig
Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.10.17/x64
Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.10.17/x64
Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.10.17/x64
LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.10.17/x64/lib
No source for code: '/tmp/tmpguw0ee8u.py'.
Error: Process completed with exit code 1.

Link to failure: https://github.com/airbytehq/airbyte-python-cdk/actions/runs/15118605619/job/42495441682?pr=556

This PR fixes CI coverage report errors by updating the .coveragerc configuration to properly handle temporary files and establish correct path mappings. Also excludes test files from the coverage report.

Summary by CodeRabbit

  • Chores
    • Updated coverage settings to exclude temporary and test files from coverage reports.
    • Adjusted source paths for improved coverage reporting accuracy.

Important

Auto-merge enabled.

This PR is set to merge automatically when all requirements are met.

@github-actions github-actions bot added bug Something isn't working security labels May 19, 2025
@ChristoGrab Christo Grabowski (ChristoGrab) marked this pull request as ready for review May 19, 2025 16:41
Copilot AI review requested due to automatic review settings May 19, 2025 16:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.

Files not reviewed (1)
  • .coveragerc: Language not supported

Comment thread .coveragerc
Comment thread .coveragerc
Copy link
Copy Markdown
Member

@aaronsteers Aaron ("AJ") Steers (aaronsteers) left a comment

Choose a reason for hiding this comment

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

Approved ✅ One question inline.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 19, 2025

📝 Walkthrough

Walkthrough

The .coveragerc configuration file was updated to exclude temporary Python files and the unit_tests/ directory from coverage analysis. Additionally, a new [paths] section was introduced to map source file locations between the current directory and /tmp/ for improved coverage reporting.

Changes

File(s) Change Summary
.coveragerc Updated omit patterns to exclude /tmp/tmp*.py and unit_tests/*; added [paths] section for source mapping between ./ and /tmp/.

Sequence Diagram(s)

sequenceDiagram
    participant CoverageTool
    participant SourceFiles
    participant ExcludedFiles

    CoverageTool->>SourceFiles: Analyze coverage for files in ./ and /tmp/
    CoverageTool->>ExcludedFiles: Omit /tmp/tmp*.py and unit_tests/*
    Note right of CoverageTool: Aggregate coverage using mapped paths
Loading

Would you like to see a more detailed breakdown of how the [paths] section affects multi-environment coverage aggregation, wdyt?

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


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

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Copy link
Copy Markdown
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

♻️ Duplicate comments (1)
.coveragerc (1)

17-21: Could you clarify the /tmp/ entry in the [paths] section?
I saw a previous question about why we include /tmp/ as a source path. Is this mapping strictly needed for coverage of files generated in /tmp/, or could we scope it more narrowly? wdyt?

🧹 Nitpick comments (1)
.coveragerc (1)

12-16: Could we refine the omit patterns for test and temp files?
The patterns /tmp/tmp*.py and unit_tests/* will only catch top-level files in those directories. If we have nested files under unit_tests/, they won’t be excluded. Would you consider switching to something like unit_tests/** (or */unit_tests/**) to recursively omit everything? Also, is unit_tests the exact test directory name in our repo, or should we also exclude other paths like tests/? wdyt?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between fa8d54d and 500ccce.

📒 Files selected for processing (1)
  • .coveragerc (1 hunks)

@ChristoGrab Christo Grabowski (ChristoGrab) merged commit 0d05b2e into main May 19, 2025
34 checks passed
@ChristoGrab Christo Grabowski (ChristoGrab) deleted the christo/fix-pytest-coverage-report branch May 19, 2025 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working security

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants