UtilityMethodTestCase::getTargetToken(): throw an exception when delimiter not found #372
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…miter not found PR 273 updated the UtilityMethodTestCase::getTargetToken()``method to fail a test with a descriptive error messages when the test marker/delimiter comment could not be found. This PR is a follow-up to that and instead of outright failing the test, the method will now throw a new, PHPCSUtils native `PHPCSUtils\Exceptions\TestMarkerNotFound` exception, which extends the PHP native `OutOfBoundsException`. Note: the previous change has not been in a tagged release yet. The reason for making this change is as follows: 1. The test run will still be marked as unsuccessful, so in that sense, there is no change. 2. Marking the test as "errored" is semantically more correct as a basic condition for the test to be able to run (precondition for finding the target token) has not been fulfilled. Includes perfunctory tests for the new `TestMarkerNotFound` exception. Includes updating the related test in the `GetTargetTokenTest` class to expect the new exception.
jrfnl
deleted the
testutils/utilitymethodtestcase-gettargettoken-throw-on-missing-marker
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR #273 updated the
UtilityMethodTestCase::getTargetToken()method to fail a test with a descriptive error messages when the test marker/delimiter comment could not be found.This PR is a follow-up to that and instead of outright failing the test, the method will now throw a new, PHPCSUtils native
PHPCSUtils\Exceptions\TestMarkerNotFoundexception, which extends the PHP nativeOutOfBoundsException.Note: the previous change has not been in a tagged release yet.
The reason for making this change is as follows:
Includes perfunctory tests for the new
TestMarkerNotFoundexception. Includes updating the related test in theGetTargetTokenTestclass to expect the new exception.