Download the PHP package satooshi/php-coveralls without Composer
On this page you can find all versions of the php package satooshi/php-coveralls. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package php-coveralls
php-coveralls
PHP client library for Coveralls.
Prerequisites
- PHP 7+ for 2.7+
- PHP 5.5+ for 2.x
- PHP 5.3+ for 1.x
- On GitHub
- Building on Travis CI, CircleCI, Jenkins, Codeship or GitHub Actions
- Testing by PHPUnit or other testing framework that can generate clover style coverage report
Installation
Download phar file
We started to create a phar file, starting from the version 0.7.0 release. It is available at the URLs like:
Download the file and add exec permissions:
Install by composer
To install php-coveralls with Composer, run the following command:
If you need support for PHP versions older than 5.5, you will need to use a 1.x version:
You can see this library on Packagist.
Composer installs autoloader at ./vendor/autoloader.php
. If you use
php-coveralls in your php script, add:
If you use Symfony2, autoloader has to be detected automatically.
Use it from your git clone
Or you can use git clone command:
Configuration
Currently php-coveralls supports clover style coverage report and collects coverage information from clover.xml
.
PHPUnit
Make sure that phpunit.xml.dist
is configured to generate "coverage-clover" type log named clover.xml
like the following configuration:
You can also use --coverage-clover
CLI option.
phpcov
Above settings are good for most projects if your test suite is executed once a build and is not divided into several parts. But if your test suite is configured as parallel tasks or generates multiple coverage reports through a build, you can use either coverage_clover
configuration in .coveralls.yml
(see below coverage clover configuration section) to specify multiple clover.xml
files or phpcov
for processing coverage reports.
composer.json
phpunit configuration
Make sure that phpunit.xml.dist
is configured to generate "coverage-php" type log:
You can also use --coverage-php
CLI option.
phpcov configuration
And then, execute phpcov.php
to merge coverage.cov
logs.
clover.xml
php-coveralls collects count
attribute in a line
tag from clover.xml
if its type
attribute equals to stmt
. When type
attribute equals to method
, php-coveralls excludes its count
attribute from coverage collection because abstract method in an abstract class is never counted though subclasses implement that method which is executed in test cases.
Travis CI
Add php php-coveralls.phar
or php vendor/bin/php-coveralls
to your .travis.yml
at after_success
.
CircleCI
Enable Xdebug in your circle.yml
at dependencies
section since currently Xdebug extension is not pre-enabled. composer
and phpunit
are pre-installed but you can install them manually in this dependencies section. The following sample uses default ones.
Add COVERALLS_REPO_TOKEN
environment variable with your coveralls repo token on Web UI (Tweaks -> Environment Variable).
Codeship
You can configure CI process for Coveralls by adding the following commands to the textarea on Web UI (Project settings > Test tab).
In the "Modify your Setup Commands" section:
In the "Modify your Test Commands" section:
Next, open Project settings > Environment tab, you can set COVERALLS_REPO_TOKEN
environment variable.
In the "Configure your environment variables" section:
GitHub Actions
Add a new step after phpunit generate coverage report.
From local environment
If you would like to call Coveralls API from your local environment, you can set COVERALLS_RUN_LOCALLY
environment variable. This configuration requires repo_token
to specify which project on Coveralls your project maps to. This can be done by configuring .coveralls.yml
or COVERALLS_REPO_TOKEN
environment variable.
php-coveralls set the following properties to json_file
which is sent to Coveralls API (same behaviour as the Ruby library will do except for the service name).
- service_name: php-coveralls
- service_event_type: manual
Parallel Builds
Coveralls provides the ability to combine coverage result from multiple parallel builds into one. To enable the feature you can set the following in your environment variable.
To distinguish your job name, please set the COVERALLS_FLAG_NAME
environment variable.
Bear in mind that you will need to configure your build to send a webhook after all the parallel builds are done in order for Coveralls to merge the results.
Refer to Parallel Builds Webhook for more information for setup on your environment.
CLI options
You can get help information for coveralls
with the --help (-h)
option.
--config (-c)
: Used to specify the path to.coveralls.yml
. Default is.coveralls.yml
--verbose (-v)
: Used to show logs.--dry-run
: Used not to send json_file to Coveralls Jobs API.--exclude-no-stmt
: Used to exclude source files that have no executable statements.--env (-e)
: Runtime environment name: test, dev, prod (default: "prod")--coverage_clover (-x)
: Coverage clover xml files(allowing multiple values)--json_path
(-o): Used to specify where to output json_file that will be uploaded to Coveralls API. (default:build/logs/coveralls-upload.json
)--root_dir (-r)
: Root directory of the project. (default: ".")
.coveralls.yml
php-coveralls can use optional .coveralls.yml
file to configure options. This configuration file is usually at the root level of your repository, but you can specify other path by --config (or -c)
CLI option. Following options are the same as Ruby library (see reference on coveralls.io).
repo_token
: Used to specify which project on Coveralls your project maps to. This is only needed for repos not using CI and should be kept secretservice_name
: Allows you to specify where Coveralls should look to find additional information about your builds. This can be any string, but usingtravis-ci
ortravis-pro
will allow Coveralls to fetch branch data, comment on pull requests, and more.
Following options can be used for php-coveralls.
entry_point
: Used to specify API endpoint for sending reports. Useful when using self-hosted coveralls or other other, similar service (eg opencov). Default ishttps://coveralls.io
.coverage_clover
: Used to specify the path toclover.xml
. Default isbuild/logs/clover.xml
json_path
: Used to specify where to outputjson_file
that will be uploaded to Coveralls API. Default isbuild/logs/coveralls-upload.json
.
coverage clover configuration
You can specify multiple clover.xml
logs at coverage_clover
. This is useful for a project that has more than two test suites if all of the test results should be merged into one json_file
.
You can also use --coverage_clover
(or -x
) command line option as follows:
root_dir detection and override
This tool assume the current directory is the project root directory by default. You can override it with --root_dir
command line option.
Change log
See changelog
Wiki
All versions of php-coveralls with dependencies
ext-json Version *
ext-simplexml Version *
guzzlehttp/guzzle Version ^6.0
psr/log Version ^1.0
symfony/config Version ^2.1 || ^3.0 || ^4.0 || ^5.0
symfony/console Version ^2.1 || ^3.0 || ^4.0 || ^5.0
symfony/stopwatch Version ^2.0 || ^3.0 || ^4.0 || ^5.0
symfony/yaml Version ^2.0.5 || ^3.0 || ^4.0 || ^5.0