Skip to content

Tests/Tokenizer: use markers for the testSwitchDefault() test #904

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

Merged
merged 5 commits into from
Apr 8, 2025
Merged

Tests/Tokenizer: use markers for the testSwitchDefault() test #904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b7d9f2e
Tests/Tokenizer: use markers for the `testSwitchDefault()` test
rodrigoprimo Feb 26, 2025
4eab727
Fix: keys in sub-arrays in data provider methods should match the
rodrigoprimo Mar 31, 2025
c4cfc92
Fix: marker passed to the error message of two assertions
rodrigoprimo Apr 4, 2025
7a19f8a
Include all possible token types when looking for the condition stop
rodrigoprimo Apr 7, 2025
386f8fa
Move list of condition stop tokens to a class property
rodrigoprimo Apr 7, 2025
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
7 changes: 6 additions & 1 deletion tests/Core/Tokenizers/Tokenizer/RecurseScopeMapDefaultKeywordConditionsTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@ function switchWithDefaultAndCurlies($i) {
case 2:
return 2;
/* testSimpleSwitchDefaultWithCurlies */
default: {
default: /* testSimpleSwitchDefaultWithCurliesScopeOpener */ {
/* testSimpleSwitchDefaultWithCurliesConditionStop */
return 'default';
/* testSimpleSwitchDefaultWithCurliesScopeCloser */
}
}
}
Expand Down Expand Up @@ -60,6 +62,7 @@ function matchWithDefaultInSwitch() {
/* testMatchDefaultNestedInSwitchDefault */
default, => 'default',
};
/* testSwitchDefaultCloserMarker */
break;
}
}
Expand Down Expand Up @@ -97,6 +100,7 @@ function switchAndDefaultSharingScopeCloser($i) {
/* testSwitchAndDefaultSharingScopeCloser */
default:
echo 'one';
/* testSwitchAndDefaultSharingScopeCloserScopeCloser */
endswitch;
}

Expand All @@ -111,6 +115,7 @@ function switchDefaultNestedIfWithAndWithoutBraces($i, $foo, $baz) {
else {
echo 'else';
}
/* testSwitchDefaultNestedIfWithAndWithoutBracesScopeCloser */
break;
}
}
Expand Down
102 changes: 58 additions & 44 deletions tests/Core/Tokenizers/Tokenizer/RecurseScopeMapDefaultKeywordConditionsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,20 @@
final class RecurseScopeMapDefaultKeywordConditionsTest extends AbstractTokenizerTestCase
{

/**
* Condition stop tokens when `default` is used with curlies.
*
* @var array<int>
*/
protected $conditionStopTokens = [
T_BREAK,
T_CONTINUE,
T_EXIT,
T_GOTO,
T_RETURN,
T_THROW,
];


/**
* Test that match "default" tokens does not get scope indexes.
Expand Down Expand Up @@ -123,30 +137,30 @@ public static function dataMatchDefault()
* Note: Cases and default structures within a switch control structure *do* get case/default scope
* conditions.
*
* @param string $testMarker The comment prefacing the target token.
* @param int $openerOffset The expected offset of the scope opener in relation to the testMarker.
* @param int $closerOffset The expected offset of the scope closer in relation to the testMarker.
* @param int|null $conditionStop The expected offset in relation to the testMarker, at which tokens stop
* having T_DEFAULT as a scope condition.
* @param string $testContent The token content to look for.
* @param bool $sharedScopeCloser Whether to skip checking for the `scope_condition` of the
* scope closer. Needed when the default and switch
* structures share a scope closer. See
* https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/810.
* @param string $testMarker The comment prefacing the target token.
* @param string $openerMarker The comment prefacing the scope opener token.
* @param string $closerMarker The comment prefacing the scope closer token.
* @param string|null $conditionStopMarker The expected offset in relation to the testMarker, after which tokens stop
* having T_DEFAULT as a scope condition.
* @param string $testContent The token content to look for.
* @param bool $sharedScopeCloser Whether to skip checking for the `scope_condition` of the
* scope closer. Needed when the default and switch
* structures share a scope closer. See
* https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/810.
*
* @dataProvider dataSwitchDefault
* @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap
*
* @return void
*/
public function testSwitchDefault($testMarker, $openerOffset, $closerOffset, $conditionStop=null, $testContent='default', $sharedScopeCloser=false)
public function testSwitchDefault($testMarker, $openerMarker, $closerMarker, $conditionStopMarker=null, $testContent='default', $sharedScopeCloser=false)
{
$tokens = $this->phpcsFile->getTokens();

$token = $this->getTargetToken($testMarker, [T_MATCH_DEFAULT, T_DEFAULT, T_STRING], $testContent);
$tokenArray = $tokens[$token];
$expectedScopeOpener = ($token + $openerOffset);
$expectedScopeCloser = ($token + $closerOffset);
$expectedScopeOpener = $this->getTargetToken($openerMarker, [T_COLON, T_OPEN_CURLY_BRACKET, T_SEMICOLON]);
$expectedScopeCloser = $this->getTargetToken($closerMarker, [T_BREAK, T_CLOSE_CURLY_BRACKET, T_RETURN, T_ENDSWITCH]);

// Make sure we're looking at the right token.
$this->assertSame(
Expand Down Expand Up @@ -190,32 +204,32 @@ public function testSwitchDefault($testMarker, $openerOffset, $closerOffset, $co
$this->assertArrayHasKey(
'scope_condition',
$tokens[$opener],
sprintf('Opener scope condition is not set. Marker: %s.', $testMarker)
sprintf('Opener scope condition is not set. Marker: %s.', $openerMarker)
);
$this->assertArrayHasKey(
'scope_opener',
$tokens[$opener],
sprintf('Opener scope opener is not set. Marker: %s.', $testMarker)
sprintf('Opener scope opener is not set. Marker: %s.', $openerMarker)
);
$this->assertArrayHasKey(
'scope_closer',
$tokens[$opener],
sprintf('Opener scope closer is not set. Marker: %s.', $testMarker)
sprintf('Opener scope closer is not set. Marker: %s.', $openerMarker)
);
$this->assertSame(
$token,
$tokens[$opener]['scope_condition'],
sprintf('Opener scope condition is not the T_DEFAULT token. Marker: %s.', $testMarker)
sprintf('Opener scope condition is not the T_DEFAULT token. Marker: %s.', $openerMarker)
);
$this->assertSame(
$expectedScopeOpener,
$tokens[$opener]['scope_opener'],
sprintf('T_DEFAULT opener scope opener token incorrect. Marker: %s.', $testMarker)
sprintf('T_DEFAULT opener scope opener token incorrect. Marker: %s.', $openerMarker)
);
$this->assertSame(
$expectedScopeCloser,
$tokens[$opener]['scope_closer'],
sprintf('T_DEFAULT opener scope closer token incorrect. Marker: %s.', $testMarker)
sprintf('T_DEFAULT opener scope closer token incorrect. Marker: %s.', $openerMarker)
);

$closer = $expectedScopeCloser;
Expand All @@ -225,39 +239,39 @@ public function testSwitchDefault($testMarker, $openerOffset, $closerOffset, $co
$this->assertArrayHasKey(
'scope_condition',
$tokens[$closer],
sprintf('Closer scope condition is not set. Marker: %s.', $testMarker)
sprintf('Closer scope condition is not set. Marker: %s.', $closerMarker)
);
$this->assertArrayHasKey(
'scope_opener',
$tokens[$closer],
sprintf('Closer scope opener is not set. Marker: %s.', $testMarker)
sprintf('Closer scope opener is not set. Marker: %s.', $closerMarker)
);
$this->assertArrayHasKey(
'scope_closer',
$tokens[$closer],
sprintf('Closer scope closer is not set. Marker: %s.', $testMarker)
sprintf('Closer scope closer is not set. Marker: %s.', $closerMarker)
);
$this->assertSame(
$token,
$tokens[$closer]['scope_condition'],
sprintf('Closer scope condition is not the T_DEFAULT token. Marker: %s.', $testMarker)
sprintf('Closer scope condition is not the T_DEFAULT token. Marker: %s.', $closerMarker)
);
$this->assertSame(
$expectedScopeOpener,
$tokens[$closer]['scope_opener'],
sprintf('T_DEFAULT closer scope opener token incorrect. Marker: %s.', $testMarker)
sprintf('T_DEFAULT closer scope opener token incorrect. Marker: %s.', $closerMarker)
);
$this->assertSame(
$expectedScopeCloser,
$tokens[$closer]['scope_closer'],
sprintf('T_DEFAULT closer scope closer token incorrect. Marker: %s.', $testMarker)
sprintf('T_DEFAULT closer scope closer token incorrect. Marker: %s.', $closerMarker)
);
}//end if

if (($opener + 1) !== $closer) {
$end = $closer;
if (isset($conditionStop) === true) {
$end = ($token + $conditionStop + 1);
if (isset($conditionStopMarker) === true) {
$end = ( $this->getTargetToken($conditionStopMarker, $this->conditionStopTokens) + 1);
}

for ($i = ($opener + 1); $i < $end; $i++) {
Expand All @@ -267,7 +281,7 @@ public function testSwitchDefault($testMarker, $openerOffset, $closerOffset, $co
sprintf('T_DEFAULT condition not added for token belonging to the T_DEFAULT structure. Marker: %s.', $testMarker)
);
}
}
}//end if

}//end testSwitchDefault()

Expand All @@ -284,46 +298,46 @@ public static function dataSwitchDefault()
return [
'simple_switch_default' => [
'testMarker' => '/* testSimpleSwitchDefault */',
'openerOffset' => 1,
'closerOffset' => 4,
'openerMarker' => '/* testSimpleSwitchDefault */',
'closerMarker' => '/* testSimpleSwitchDefault */',
],
'simple_switch_default_with_curlies' => [
// For a default structure with curly braces, the scope opener
// will be the open curly and the closer the close curly.
// However, scope conditions will not be set for open to close,
// but only for the open token up to the "break/return/continue" etc.
'testMarker' => '/* testSimpleSwitchDefaultWithCurlies */',
'openerOffset' => 3,
'closerOffset' => 12,
'conditionStop' => 6,
'testMarker' => '/* testSimpleSwitchDefaultWithCurlies */',
'openerMarker' => '/* testSimpleSwitchDefaultWithCurliesScopeOpener */',
'closerMarker' => '/* testSimpleSwitchDefaultWithCurliesScopeCloser */',
'conditionStopMarker' => '/* testSimpleSwitchDefaultWithCurliesConditionStop */',
],
'switch_default_toplevel' => [
'testMarker' => '/* testSwitchDefault */',
'openerOffset' => 1,
'closerOffset' => 43,
'openerMarker' => '/* testSwitchDefault */',
'closerMarker' => '/* testSwitchDefaultCloserMarker */',
],
'switch_default_nested_in_match_case' => [
'testMarker' => '/* testSwitchDefaultNestedInMatchCase */',
'openerOffset' => 1,
'closerOffset' => 20,
'openerMarker' => '/* testSwitchDefaultNestedInMatchCase */',
'closerMarker' => '/* testSwitchDefaultNestedInMatchCase */',
],
'switch_default_nested_in_match_default' => [
'testMarker' => '/* testSwitchDefaultNestedInMatchDefault */',
'openerOffset' => 1,
'closerOffset' => 18,
'openerMarker' => '/* testSwitchDefaultNestedInMatchDefault */',
'closerMarker' => '/* testSwitchDefaultNestedInMatchDefault */',
],
'switch_and_default_sharing_scope_closer' => [
'testMarker' => '/* testSwitchAndDefaultSharingScopeCloser */',
'openerOffset' => 1,
'closerOffset' => 10,
'openerMarker' => '/* testSwitchAndDefaultSharingScopeCloser */',
'closerMarker' => '/* testSwitchAndDefaultSharingScopeCloserScopeCloser */',
'conditionStop' => null,
'testContent' => 'default',
'sharedScopeCloser' => true,
],
'switch_and_default_with_nested_if_with_and_without_braces' => [
'testMarker' => '/* testSwitchDefaultNestedIfWithAndWithoutBraces */',
'openerOffset' => 1,
'closerOffset' => 48,
'openerMarker' => '/* testSwitchDefaultNestedIfWithAndWithoutBraces */',
'closerMarker' => '/* testSwitchDefaultNestedIfWithAndWithoutBracesScopeCloser */',
],
];

Expand Down