Update the test suite #15
Merged
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
The test file did not reflect the name of the class within it.
It is recommended to use the `phpunit.xml.dist` file name for the PHPUnit configuration file to allow individual developers to overload it with a `phpunit.xml` file. To this end, I've: * Renamed the PHPUnit configuration file. * Adjusted the corresponding `export-ignore` in `.gitattributes`. * Added `phpunit.xml` to the `.gitignore` file so overload files from individual developers do not get committed. * Adjusted the references to the file in the Ant `build.xml` file. As for the config file itself: * Added a name for the testsuite as is required in later PHPUnit versions. * Changed the coverage `filter` directive to be more precise. * Minor other tweaks.
`assertEquals()` is to `assertSame()` as `==` is to `===`, so always use `assertSame()` unless you _need_ a loose comparison.
The tests would fail on non-*nix systems as the "expected output" contains hard-coded `\n` line endings, while the code in the `Highlighter` class uses `PHP_EOL`. This allows the tests to run (and pass) on non-*nix platforms.
Tested & found the unit tests working on PHPUnit 4.x - 7.x, so allow for those versions.
…PUnit 9.x As of PHPUnit 8.x, the method signature for the `setUpBeforeClass()`, `setUp()`, `tearDown()` and `tearDownAfterClass()` fixture methods has changed to require the `void` return type. As the `void` return type isn't available until PHP 7.1, this cannot be implemented. Anntations to the rescue. By renaming the `setUp()` method to another, descriptive name and using the `@before` annotation, the tests can be made cross-version compatible up to PHPUnit 9.x. With this change, the unit tests can now be run on PHPUnit 4 - 9. As PHPUnit has a caching feature build in as of PHPUnit 8, we need to add the `.phpunit.result.cache` file to `.gitignore`.
jrfnl
force-pushed
the
feature/update-test-suite
branch
from
03f65d6
to
bbdcaf8
Compare
|
I've removed the last commit (Travis) as PHPUnit 9.3 has been released last week which is the first PHPUnit version which officially supports PHP 8, so |
|
Also: the build failure on PHP 8 is unrelated to this PR and would be solved via php-parallel-lint/PHP-Var-Dump-Check#7 (and a new tagged release of the Var Dump Check tool). |
|
Thank you :-) |
|
I added parts from this PR to changelog. Your PR did more great maintenance work, thank you 👍 |
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.
Commit Details
PHPUnit: fix file name
The test file did not reflect the name of the class within it.
PHPUnit setup: rename and update the config file
It is recommended to use the
phpunit.xml.distfile name for the PHPUnit configuration file to allow individual developers to overload it with aphpunit.xmlfile.To this end, I've:
export-ignorein.gitattributes.phpunit.xmlto the.gitignorefile so overload files from individual developers do not get committed.build.xmlfile.As for the config file itself:
filterdirective to be more precise.PHPUnit: use a type-safe assertion
assertEquals()is toassertSame()as==is to===, so always useassertSame()unless you need a loose comparison.PHPUnit: make the tests platform independent
The tests would fail on non-*nix systems as the "expected output" contains hard-coded
\nline endings, while the code in theHighlighterclass usesPHP_EOL.This allows the tests to run (and pass) on non-*nix platforms.
PHPUnit: widen the version requirements
Tested & found the unit tests working on PHPUnit 4.x - 7.x, so allow for those versions.
PHPUnit: use annotations for fixtures / cross-version compat up to PHPUnit 9.x
As of PHPUnit 8.x, the method signature for the
setUpBeforeClass(),setUp(),tearDown()andtearDownAfterClass()fixture methods has changed to require thevoidreturn type.As the
voidreturn type isn't available until PHP 7.1, this cannot be implemented.Anntations to the rescue.
By renaming the
setUp()method to another, descriptive name and using the@beforeannotation, the tests can be made cross-version compatible up to PHPUnit 9.x.With this change, the unit tests can now be run on PHPUnit 4 - 9.
As PHPUnit has a caching feature build in as of PHPUnit 8, we need to add the
.phpunit.result.cachefile to.gitignore.Ant: fail the build on unit test failures
Travis: allow for installing PHPUnit on PHP 8