mirror of
https://github.com/retailcrm/Fetch.git
synced 2025-02-11 12:39:26 +03:00
Merge pull request #49 from tedivm/more_testing
Use Composer provided phpunit for tests
This commit is contained in:
commit
4de41720dc
54
CONTRIBUTING.md
Normal file
54
CONTRIBUTING.md
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
# Contributions Welcome!
|
||||||
|
|
||||||
|
Pull Requests and Community Contributions are the bread and butter of open source software. Every contribution- from bug
|
||||||
|
reports to feature requests, typos to full new features- are greatly appreciated.
|
||||||
|
|
||||||
|
|
||||||
|
## Important Guidelines
|
||||||
|
|
||||||
|
* One Item Per Pull Request or Issue. This makes it much easier to review code and merge it back in, and prevents issues
|
||||||
|
with one request from blocking another.
|
||||||
|
|
||||||
|
* Code Coverage is extremely important, and pull requests are much more likely to be accepted if testing is also improved.
|
||||||
|
New code should be properly tested, and all tests must pass.
|
||||||
|
|
||||||
|
* Read the LICENSE document and make sure you understand it, because your code is going to be released under it.
|
||||||
|
|
||||||
|
* Be prepared to make revisions. Don't be discouraged if you're asked to make changes, as that is just another step
|
||||||
|
towards refining the code and getting it merged back in.
|
||||||
|
|
||||||
|
* Remember to add the relevant documentation, particular the docblock comments.
|
||||||
|
|
||||||
|
|
||||||
|
## Code Styling
|
||||||
|
|
||||||
|
This project follows the PSR standards set forth by the [PHP Framework Interop Group](http://www.php-fig.org/).
|
||||||
|
|
||||||
|
* [PSR-0: Class and file naming conventions](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md)
|
||||||
|
* [PSR-1: Basic coding standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)
|
||||||
|
* [PSR-2: Coding style guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
|
||||||
|
|
||||||
|
All code most follow these standards to be accepted. The easiest way to accomplish this is to run php-cs-fixer once the
|
||||||
|
new changes are finished. The php-cs-fixer package is installed as a development dependency of this project.
|
||||||
|
|
||||||
|
composer install --dev
|
||||||
|
vendor/bin/php-cs-fixer fix ./ --level="all" -vv
|
||||||
|
|
||||||
|
|
||||||
|
## Running the test suite
|
||||||
|
|
||||||
|
First install dependencies using Composer. It's important to include the dev packages:
|
||||||
|
|
||||||
|
composer install --dev
|
||||||
|
|
||||||
|
The "runTests.sh" script runs the full test suite- phpunit, php-cs-fixer, as well as any environmental setup:
|
||||||
|
|
||||||
|
tests/runTests.sh
|
||||||
|
|
||||||
|
To call phpunit directly:
|
||||||
|
|
||||||
|
vendor/bin/phpunit
|
||||||
|
|
||||||
|
To call php-cs-fixer directly:
|
||||||
|
|
||||||
|
vendor/bin/php-cs-fixer fix ./ --level="all" -vv --dry-run
|
@ -35,6 +35,6 @@ if (!file_exists($filename)) {
|
|||||||
$filename = __DIR__ .'/../autoload.php';
|
$filename = __DIR__ .'/../autoload.php';
|
||||||
require_once $filename;
|
require_once $filename;
|
||||||
} else {
|
} else {
|
||||||
$loader = require_once $filename;
|
$loader = require $filename;
|
||||||
$loader->add('Fetch\\Test', __DIR__);
|
$loader->add('Fetch\\Test', __DIR__);
|
||||||
}
|
}
|
||||||
|
@ -7,11 +7,11 @@ if [ ! -n "$TRAVIS" ]; then
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
echo 'Running unit tests.'
|
echo 'Running unit tests.'
|
||||||
phpunit --verbose --coverage-clover build/logs/clover.xml
|
./vendor/bin/phpunit --verbose --coverage-clover build/logs/clover.xml
|
||||||
|
|
||||||
echo ''
|
echo ''
|
||||||
echo ''
|
echo ''
|
||||||
echo ''
|
echo ''
|
||||||
echo 'Testing for Coding Styling Compliance.'
|
echo 'Testing for Coding Styling Compliance.'
|
||||||
echo 'All code should follow PSR standards.'
|
echo 'All code should follow PSR standards.'
|
||||||
./vendor/fabpot/php-cs-fixer/php-cs-fixer fix ./ --level="all" -vv --dry-run
|
./vendor/bin/php-cs-fixer fix ./ --level="all" -vv --dry-run
|
Loading…
x
Reference in New Issue
Block a user