-
-
Notifications
You must be signed in to change notification settings - Fork 77
Tests: Add unit tests for Common::prepareForOutput() #663
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| <?php | ||
| /** | ||
| * Tests for the \PHP_CodeSniffer\Util\Common::prepareForOutput() method. | ||
| * | ||
| * @copyright 2024 PHPCSStandards and contributors | ||
| * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence | ||
| */ | ||
|
|
||
| namespace PHP_CodeSniffer\Tests\Core\Util\Common; | ||
|
|
||
| use PHP_CodeSniffer\Util\Common; | ||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| /** | ||
| * Tests for the \PHP_CodeSniffer\Util\Common::prepareForOutput() method. | ||
| * | ||
| * @covers \PHP_CodeSniffer\Util\Common::prepareForOutput | ||
| * @group Windows | ||
| */ | ||
| final class PrepareForOutputTest extends TestCase | ||
| { | ||
|
|
||
|
|
||
| /** | ||
| * Test formatting whitespace characters, on anything other than Windows. | ||
| * | ||
| * @param string $content The content to prepare. | ||
| * @param string[] $exclude A list of characters to leave invisible. | ||
| * @param string $expected Expected function output. | ||
| * @param string $expectedWin Expected function output on Windows (unused in this test). | ||
| * | ||
| * @requires OS ^(?!WIN).* | ||
| * @dataProvider dataPrepareForOutput | ||
| * | ||
| * @return void | ||
| */ | ||
| public function testPrepareForOutput($content, $exclude, $expected, $expectedWin) | ||
| { | ||
| $this->assertSame($expected, Common::prepareForOutput($content, $exclude)); | ||
|
|
||
| }//end testPrepareForOutput() | ||
|
|
||
|
|
||
| /** | ||
| * Test formatting whitespace characters, on Windows. | ||
| * | ||
| * @param string $content The content to prepare. | ||
| * @param string[] $exclude A list of characters to leave invisible. | ||
| * @param string $expected Expected function output (unused in this test). | ||
| * @param string $expectedWin Expected function output on Windows. | ||
| * | ||
| * @requires OS ^WIN.*. | ||
| * @dataProvider dataPrepareForOutput | ||
| * | ||
| * @return void | ||
| */ | ||
| public function testPrepareForOutputWindows($content, $exclude, $expected, $expectedWin) | ||
| { | ||
| $this->assertSame($expectedWin, Common::prepareForOutput($content, $exclude)); | ||
|
|
||
| }//end testPrepareForOutputWindows() | ||
|
|
||
|
|
||
| /** | ||
| * Data provider. | ||
| * | ||
| * @see testPrepareForOutput() | ||
| * @see testPrepareForOutputWindows() | ||
| * | ||
| * @return array<string, array<string, mixed>> | ||
| */ | ||
| public static function dataPrepareForOutput() | ||
| { | ||
| return [ | ||
| 'Special characters are replaced with their escapes' => [ | ||
| 'content' => "\r\n\t", | ||
| 'exclude' => [], | ||
| 'expected' => "\033[30;1m\\r\033[0m\033[30;1m\\n\033[0m\033[30;1m\\t\033[0m", | ||
| 'expectedWin' => "\\r\\n\\t", | ||
| ], | ||
| 'Spaces are replaced with a unique mark' => [ | ||
| 'content' => " ", | ||
| 'exclude' => [], | ||
| 'expected' => "\033[30;1m·\033[0m\033[30;1m·\033[0m\033[30;1m·\033[0m\033[30;1m·\033[0m", | ||
| 'expectedWin' => " ", | ||
| ], | ||
| 'Other characters are unaffected' => [ | ||
| 'content' => "{echo 1;}", | ||
| 'exclude' => [], | ||
| 'expected' => "{echo\033[30;1m·\033[0m1;}", | ||
| 'expectedWin' => "{echo 1;}", | ||
| ], | ||
| 'No replacements' => [ | ||
| 'content' => 'nothing-should-be-replaced', | ||
| 'exclude' => [], | ||
| 'expected' => 'nothing-should-be-replaced', | ||
| 'expectedWin' => 'nothing-should-be-replaced', | ||
| ], | ||
| 'Excluded whitespace characters are unaffected' => [ | ||
| 'content' => "\r\n\t ", | ||
| 'exclude' => [ | ||
| "\r", | ||
| "\n", | ||
| ], | ||
| 'expected' => "\r\n\033[30;1m\\t\033[0m\033[30;1m·\033[0m", | ||
| 'expectedWin' => "\r\n\\t ", | ||
| ], | ||
| ]; | ||
|
|
||
| }//end dataPrepareForOutput() | ||
|
|
||
|
|
||
| }//end class | ||
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.
Uh oh!
There was an error while loading. Please reload this page.