Skip to content

Add metadata package version mismatch hint#2846

Merged
arkid15r merged 2 commits into
vacanza:devfrom
arkid15r:ark/update-package-tests
Aug 21, 2025
Merged

Add metadata package version mismatch hint#2846
arkid15r merged 2 commits into
vacanza:devfrom
arkid15r:ark/update-package-tests

Conversation

@arkid15r

Copy link
Copy Markdown
Collaborator

Proposed change

Add metadata package version mismatch hint

Type of change

  • New country/market holidays support (thank you!)
  • Supported country/market holidays update (calendar discrepancy fix, localization)
  • Existing code/documentation/test/process quality improvement (best practice, cleanup, refactoring, optimization)
  • Dependency update (version deprecation/pin/upgrade)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (a code change causing existing functionality to break)
  • New feature (new holidays functionality in general)

Checklist

@coderabbitai

coderabbitai Bot commented Aug 21, 2025

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Tests
    • Introduced per-attribute subtests for package metadata checks, delivering clearer, targeted diagnostics for each field.
    • Added a helpful hint when version information appears outdated, improving guidance on how to resolve failures.
    • Enhances test clarity and maintainability without affecting runtime behavior or user-facing features.

Walkthrough

Reworked tests/test_package.py to run per-attribute subTests for metadata checks and to provide a conditional assertion message that suggests running make package when the version attribute mismatches; comparison logic unchanged.

Changes

Cohort / File(s) Summary
Tests
tests/test_package.py
Replaced inline asserts with a with self.subTest(attr=...) block per attribute and changed the assertEqual message to be conditional: show "You may need to run make package to update the metadata." when attr_name == "version", otherwise use the default message. No change to the actual equality checks.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 9a195d0 and 72d92a3.

📒 Files selected for processing (1)
  • tests/test_package.py (1 hunks)
🔇 Additional comments (1)
tests/test_package.py (1)

34-42: Good targeted hint + per-attribute subTests; this tightens failure attribution.

Wrapping each attribute check in subTest and only attaching a custom message for version keeps diffs clean and the intent crisp. Nice.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@github-actions github-actions Bot added the test label Aug 21, 2025
@codecov

codecov Bot commented Aug 21, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (f7155f6) to head (72d92a3).
⚠️ Report is 10 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff            @@
##               dev     #2846   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          286       286           
  Lines        17038     17038           
  Branches      2229      2229           
=========================================
  Hits         17038     17038           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 5203f05 and 9a195d0.

📒 Files selected for processing (1)
  • tests/test_package.py (1 hunks)
⏰ Context from checks skipped due to timeout of 300000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Test build on windows-latest
  • GitHub Check: Test build on ubuntu-latest

Comment thread tests/test_package.py Outdated
@sonarqubecloud

Copy link
Copy Markdown

@arkid15r arkid15r marked this pull request as ready for review August 21, 2025 19:02

@KJhellico KJhellico left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM!

@arkid15r arkid15r added this pull request to the merge queue Aug 21, 2025
Merged via the queue into vacanza:dev with commit e7825ed Aug 21, 2025
36 checks passed
@arkid15r arkid15r deleted the ark/update-package-tests branch August 21, 2025 19:33
@arkid15r arkid15r mentioned this pull request Sep 1, 2025
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