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

Throw AssertionError instead of Error in case of approval failure #595

Closed
wants to merge 1 commit into from

Conversation

nicerloop
Copy link

@nicerloop nicerloop commented Nov 29, 2024

Approval failures currently throw Error, but should throw AssertionError to actually distinguish functional failure (AssertionError) from technical failure (everything else).

Summary by Sourcery

Bug Fixes:

  • Throw AssertionError instead of Error in case of approval failure to distinguish functional failures from technical failures.

Copy link

sourcery-ai bot commented Nov 29, 2024

Reviewer's Guide by Sourcery

The PR changes the exception type thrown during approval failures from Error to AssertionError to better distinguish between functional failures (AssertionError) and technical failures (other Error types). This is implemented by modifying the fail() method in the FileApprover class.

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

File-Level Changes

Change Details Files
Changed exception type for approval failures
  • Replaced Error with AssertionError in the fail() method while maintaining the same error message format
  • Error message still includes both approved and received file paths
approvaltests/src/main/java/org/approvaltests/approvers/FileApprover.java

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

@nicerloop nicerloop force-pushed the throw-assertionerror branch from 1ab8664 to 4f42a56 Compare December 4, 2024 16:59
@LarsEckart LarsEckart closed this Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants