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

Don't stop scan on invalid inline property annotation #3916

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion src/Files/File.php
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,7 @@ public function process()
$listenerIgnoreTo = [];
$inTests = defined('PHP_CODESNIFFER_IN_TESTS');
$checkAnnotations = $this->config->annotations;
$annotationErrors = [];

// Foreach of the listeners that have registered to listen for this
// token, get them to process it.
Expand Down Expand Up @@ -411,7 +412,15 @@ public function process()
'scope' => 'sniff',
];
$listenerClass = $this->ruleset->sniffCodes[$listenerCode];
$this->ruleset->setSniffProperty($listenerClass, $propertyCode, $settings);
try {
$this->ruleset->setSniffProperty($listenerClass, $propertyCode, $settings);
} catch (RuntimeException $e) {
// Non-existant property being set via an inline annotation.
// This is typically a PHPCS test case file, but we can't throw an error on the annotation
// line as it would get ignored. We also don't want this error to block
// the scan of the current file, so collect these and throw later.
$annotationErrors[] = 'Line '.$token['line'].': '.str_replace('Ruleset invalid. ', '', $e->getMessage());
}
}
}
}//end if
Expand Down Expand Up @@ -536,6 +545,13 @@ public function process()
}
}

if ($annotationErrors !== []) {
$error = 'Encountered invalid inline phpcs:set annotations. Found:'.PHP_EOL;
$error .= implode(PHP_EOL, $annotationErrors);

$this->addWarning($error, null, 'Internal.PropertyDoesNotExist');
}

if (PHP_CODESNIFFER_VERBOSITY > 2) {
echo "\t*** END TOKEN PROCESSING ***".PHP_EOL;
echo "\t*** START SNIFF PROCESSING REPORT ***".PHP_EOL;
Expand Down
7 changes: 7 additions & 0 deletions src/Standards/Generic/Tests/PHP/BacktickOperatorUnitTest.inc
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
<?php
$output = `ls -al`;

// Testing an invalid phpcs:set annotations.
// This test is unrelated to this sniff, but the issue needs a sniff to be tested.
// phpcs:set Generic.PHP.BacktickOperator unknown 10

// Make sure errors after an incorrect annotation are still being thrown.
$output = `ls -al`;
6 changes: 5 additions & 1 deletion src/Standards/Generic/Tests/PHP/BacktickOperatorUnitTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ class BacktickOperatorUnitTest extends AbstractSniffUnitTest
*/
public function getErrorList()
{
return [2 => 2];
return [
2 => 2,
9 => 2,
];

}//end getErrorList()

Expand All @@ -40,6 +43,7 @@ public function getErrorList()
*/
public function getWarningList()
{
// Warning about incorrect annotation will be shown on line 1 once PR #3915 would be merged.
return [];

}//end getWarningList()
Expand Down
Loading