Fix tests on Windows #3
Merged
Conversation
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
rhowardiv
referenced
this pull request
in rhowardiv/PHP_CodeSniffer
Jan 10, 2013
Nuke read me to prevent confusion
Astinus-Eberhard
pushed a commit
to Astinus-Eberhard/PHP_CodeSniffer
that referenced
this pull request
Mar 17, 2016
…en files in that during interactive session
Astinus-Eberhard
pushed a commit
to Astinus-Eberhard/PHP_CodeSniffer
that referenced
this pull request
Mar 17, 2016
Astinus-Eberhard
pushed a commit
to Astinus-Eberhard/PHP_CodeSniffer
that referenced
this pull request
Mar 17, 2016
Astinus-Eberhard
pushed a commit
to Astinus-Eberhard/PHP_CodeSniffer
that referenced
this pull request
Mar 18, 2016
Closed
jrfnl
added a commit
to jrfnl/PHP_CodeSniffer
that referenced
this pull request
Nov 6, 2024
This adds another set of dedicated tests to safeguard how XML docs which don't follow the specification are handled.
This initial set of tests for this documents the current behaviour [*]. This behaviour may not always be the desired behaviour, in which case, this will be fixed in follow-up commits.
To get these tests up and running, the following fatal errors needed to be fixed:
* Fatal error when a code comparison only contains a single code element:
```
Fatal error: Uncaught Error: Call to a member function getAttribute() on null in path/to/PHP_CodeSniffer/src/Generators/Markdown.php:253
Stack trace:
#0 path/to/PHP_CodeSniffer/src/Generators/Markdown.php(139): PHP_CodeSniffer\Generators\Markdown->getFormattedCodeComparisonBlock(Object(DOMElement))
#1 path/to/PHP_CodeSniffer/src/Generators/Markdown.php(39): PHP_CodeSniffer\Generators\Markdown->processSniff(Object(DOMElement))
squizlabs#2 path/to/PHP_CodeSniffer/src/Runner.php(99): PHP_CodeSniffer\Generators\Markdown->generate()
squizlabs#3 path/to/PHP_CodeSniffer/bin/phpcs(14): PHP_CodeSniffer\Runner->runPHPCS()
squizlabs#4 {main}
thrown in path/to/PHP_CodeSniffer/src/Generators/Markdown.php on line 253
```
* Fatal error when a code element contains no textual content:
```
Fatal error: Uncaught Error: Call to a member function getAttribute() on null in path/to/PHP_CodeSniffer/src/Generators/Markdown.php:246
Stack trace:
#0 path/to/PHP_CodeSniffer/src/Generators/Markdown.php(139): PHP_CodeSniffer\Generators\Markdown->getFormattedCodeComparisonBlock(Object(DOMElement))
#1 path/to/PHP_CodeSniffer/src/Generators/Markdown.php(39): PHP_CodeSniffer\Generators\Markdown->processSniff(Object(DOMElement))
squizlabs#2 path/to/PHP_CodeSniffer/src/Runner.php(99): PHP_CodeSniffer\Generators\Markdown->generate()
squizlabs#3 path/to/PHP_CodeSniffer/bin/phpcs(14): PHP_CodeSniffer\Runner->runPHPCS()
squizlabs#4 {main}
thrown in path/to/PHP_CodeSniffer/src/Generators/Markdown.php on line 246
```
Both of these fatals are fixed by adding defensive coding validating that there are (at least) two code blocks to the `getFormattedCodeComparisonBlock()` methods for all three generator classes.
jrfnl
added a commit
to jrfnl/PHP_CodeSniffer
that referenced
this pull request
Feb 19, 2025
This adds another set of dedicated tests to safeguard how XML docs which don't follow the specification are handled.
This initial set of tests for this documents the current behaviour [*]. This behaviour may not always be the desired behaviour, in which case, this will be fixed in follow-up commits.
To get these tests up and running, the following fatal errors needed to be fixed:
* Fatal error when a code comparison only contains a single code element:
```
Fatal error: Uncaught Error: Call to a member function getAttribute() on null in path/to/PHP_CodeSniffer/src/Generators/Markdown.php:253
Stack trace:
#0 path/to/PHP_CodeSniffer/src/Generators/Markdown.php(139): PHP_CodeSniffer\Generators\Markdown->getFormattedCodeComparisonBlock(Object(DOMElement))
#1 path/to/PHP_CodeSniffer/src/Generators/Markdown.php(39): PHP_CodeSniffer\Generators\Markdown->processSniff(Object(DOMElement))
squizlabs#2 path/to/PHP_CodeSniffer/src/Runner.php(99): PHP_CodeSniffer\Generators\Markdown->generate()
squizlabs#3 path/to/PHP_CodeSniffer/bin/phpcs(14): PHP_CodeSniffer\Runner->runPHPCS()
squizlabs#4 {main}
thrown in path/to/PHP_CodeSniffer/src/Generators/Markdown.php on line 253
```
* Fatal error when a code element contains no textual content:
```
Fatal error: Uncaught Error: Call to a member function getAttribute() on null in path/to/PHP_CodeSniffer/src/Generators/Markdown.php:246
Stack trace:
#0 path/to/PHP_CodeSniffer/src/Generators/Markdown.php(139): PHP_CodeSniffer\Generators\Markdown->getFormattedCodeComparisonBlock(Object(DOMElement))
#1 path/to/PHP_CodeSniffer/src/Generators/Markdown.php(39): PHP_CodeSniffer\Generators\Markdown->processSniff(Object(DOMElement))
squizlabs#2 path/to/PHP_CodeSniffer/src/Runner.php(99): PHP_CodeSniffer\Generators\Markdown->generate()
squizlabs#3 path/to/PHP_CodeSniffer/bin/phpcs(14): PHP_CodeSniffer\Runner->runPHPCS()
squizlabs#4 {main}
thrown in path/to/PHP_CodeSniffer/src/Generators/Markdown.php on line 246
```
Both of these fatals are fixed by adding defensive coding validating that there are (at least) two code blocks to the `getFormattedCodeComparisonBlock()` methods for all three generator classes.
jrfnl
added a commit
to jrfnl/PHP_CodeSniffer
that referenced
this pull request
Apr 29, 2025
…report Okay, so this is an awkward one. If both the `Code` + the `Diff` report were requested + caching was turned on + the _order_ of the requested reports was `Code,Diff` (i.e. first the code report), the following fatal error which would occur: ``` Fatal error: Uncaught Error: Call to a member function getFixableCount() on null in path/to/PHP_CodeSniffer/src/Fixer.php:144 Stack trace: #0 path/to/PHP_CodeSniffer/src/Reports/Diff.php(73): PHP_CodeSniffer\Fixer->fixFile() #1 path/to/PHP_CodeSniffer/src/Reporter.php(285): PHP_CodeSniffer\Reports\Diff->generateFileReport(Array, Object(PHP_CodeSniffer\Files\LocalFile), true, 150) squizlabs#2 path/to/PHP_CodeSniffer/src/Runner.php(659): PHP_CodeSniffer\Reporter->cacheFileReport(Object(PHP_CodeSniffer\Files\LocalFile)) squizlabs#3 path/to/PHP_CodeSniffer/src/Runner.php(400): PHP_CodeSniffer\Runner->processFile(Object(PHP_CodeSniffer\Files\LocalFile)) squizlabs#4 path/to/PHP_CodeSniffer/src/Runner.php(119): PHP_CodeSniffer\Runner->run() squizlabs#5 path/to/PHP_CodeSniffer/bin/phpcs(30): PHP_CodeSniffer\Runner->runPHPCS() squizlabs#6 {main} thrown in path/to/PHP_CodeSniffer/src/Fixer.php on line 144 ``` To reproduce the issue (on `master`): 1. Create a small test file like: ```php <?php echo 'hello'.callMe( $p ); ``` 2. Run the following command to initialize the cache: ```bash phpcs -ps ./test.php --standard=PSR2 --report=Code,Diff --cache ``` All should be fine. 3. Now run the same command again and see the fatal error. Some investigating later, it turns out that both the `Code` report, as well as the `Diff` report, re-parse the current file, with the `Diff` report initializing the fixer once the file has reparsed, but the `Code` report not doing so (as it doesn't need the fixer). The problem with that is that the `Code` report basically leaves the `Fixer` in an invalid state, leading to the above error. While it is up for debate whether reports should ever (be allowed to) re-parse files, for now, let's fix the fatal. Re-evaluating the report setup should definitely be done, but should probably wait until the Reports classes have test coverage.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.