Implement the PHPUnit testing framework on the Team 51 CLI tool to support development.
Approach
This implementation focuses on unit testing. While Symfony includes command level testing, a finer grain approach would produce more valuable outcomes for developers modifying existing and/or creating new commands.
Symfony includes a built-in implementation and integration with PHPUnit to scaffold in the required libraries which was used for this PR.
The intent is to keep testing optional, and as such the tests won't be part of any commit or merge level checks. The tests can be run manually as required.
Changes proposed in this Pull Request:
Add the PHPUnit Testing framework via the built-in Symfony symfony/test-pack package through composer.
Extend the PHPUnit TextCase class to allow custom methods, factories, test doubles, etc to aid in test development.
Include basic sample tests as go-bys for future tests.
Add a custom method in the extended class to allow for easier testing of protected and private methods.
How to Test:
From your team51-cli folder fetch updates and switch to this branch.
Run composer install to install the new packages.
Run all sample tests using the command vendor/bin/phpunit --testsuite tests --testdox.
Adding new tests:
Tests are sorted into to the same folder structure as the commands. Command tests go in tests/commands/<command-class-name>, and Helper tests in tests/helpers/<helper-class-name>.
Test files must be named with the prefix test- to be run automatically via the testsuite.
Tests can be built by extending either the default TestCase or the extended T51TestCase if needed.
Custom methods, assertions, fixtures, etc should be added in the tests/includes folder.
Purpose of this PR:
Implement the PHPUnit testing framework on the Team 51 CLI tool to support development.
Approach
This implementation focuses on unit testing. While Symfony includes command level testing, a finer grain approach would produce more valuable outcomes for developers modifying existing and/or creating new commands.
Symfony includes a built-in implementation and integration with PHPUnit to scaffold in the required libraries which was used for this PR.
The intent is to keep testing optional, and as such the tests won't be part of any commit or merge level checks. The tests can be run manually as required.
Changes proposed in this Pull Request:
symfony/test-packpackage through composer.How to Test:
team51-clifolder fetch updates and switch to this branch.composer installto install the new packages.vendor/bin/phpunit --testsuite tests --testdox.Adding new tests:
tests/commands/<command-class-name>, and Helper tests intests/helpers/<helper-class-name>.test-to be run automatically via the testsuite.TestCaseor the extendedT51TestCaseif needed.tests/includesfolder.