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.

Sign up for GitHub

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

Jump to bottom

Enhance Test Coverage for BuilderLogFormatter class #10215

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

Enhance Test Coverage for BuilderLogFormatter class #10215

wants to merge 3 commits into from

Conversation

guillermodotn
Copy link
Contributor

@guillermodotn guillermodotn commented Feb 22, 2025 •
edited by sourcery-ai bot
Loading

Pull Request Check List

Resolves: #10214
Relates-to: #3155

  • Added tests for changed code.
  • Updated documentation for changed code.

This PR improves the test coverage for BuilderLogFormatter in BuilderFormatter.py by adding tests for formatting transformations and edge cases.

Summary by Sourcery

Tests:

  • Adds tests for the BuilderLogFormatter class, covering formatting transformations and edge cases.

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Feb 22, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces tests for the BuilderLogFormatter class, covering various formatting scenarios and edge cases. The tests ensure that the formatter correctly applies styling to specific log messages related to building packages and dependencies.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added tests for the BuilderLogFormatter class to verify its formatting logic.
  • Created a new test file test_builder_formatter.py in the tests/console/logging/formatters/ directory.
  • Implemented a parameterized test function test_builder_log_formatter to cover various input messages and their expected formatted outputs.
  • Included test cases for different message types, such as 'Building package', 'Built package', and 'Adding: dependency', to ensure correct formatting.
  • Added edge case tests for empty strings, whitespace handling, and case sensitivity.
  • Utilized pytest.mark.parametrize to efficiently test multiple scenarios with different inputs and expected outputs.
 tests/console/logging/formatters/test_builder_formatter.py

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Feb 22, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @guillermodotn - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a test case with escape characters to ensure proper handling of special characters in log messages.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@guillermodotn guillermodotn changed the title Tests: BuilderLogFormatter class. Enhance Test Coverage for BuilderLogFormatter class Feb 22, 2025
@Secrus Secrus enabled auto-merge (squash) February 28, 2025 09:35
@guillermodotn guillermodotn requested a review from Secrus February 28, 2025 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@Secrus Secrus Awaiting requested review from Secrus

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve Test Coverage for BuilderLogFormatter in builder_formatter.py
2 participants
@guillermodotn @Secrus