cloak/coverallskit

PHP client for coveralls.io

CoverallsKit

, _(*1)

, _(*2)

, _(*3)

CoverallsKit is the library for transmitting the report of code coverage to coveralls.
This library works with PHP5.5 or more., _(*4)

Requirements

• PHP >= 5.5
• Xdebug >= 2.2.2

Installation

Installation that uses the composer., _(*5)

1. Install the composer.

2. Install the package., _(*6)

   composer require cloak/coverallskit --dev

Basic usage

You can generate a json file using the coverallskit/CoverallsReportBuilder.
You just set the code coverage of rows that have been executed.
Code coverage can be obtained easily by using the HHVM and xdebug., _(*7)

$travis = new TravisCI( new Environment($_SERVER) );
$service = new CIService($travis);

$builder = new CoverallsReportBuilder();
$builder->token('your repository token')
    ->service($service)
    ->repository(new GitRepository(__DIR__ . '/../'));

$source = new SourceFile('path/to/file');
$source->addCoverage(CoverageResult::executed(1));  //The first line was executed
$source->addCoverage(CoverageResult::unused(2));    //The second line is not executed
$source->addCoverage(CoverageResult::executed(3));  //The third line is executed

$builder->addSource($source);
$builder->build()->saveAs(__DIR__ . '/tmp/coverage.json');

Using a configuration file

If you use a configuration file, you can send the report more easily., _(*8)

use coverallskit\BuilderConfiguration;
use coverallskit\CoverallsReportBuilder;

$configuration = BuilderConfiguration::loadFromFile('coveralls.toml');
$builder = CoverallsReportBuilder::fromConfiguration($configuration);
$builder->build()->save()->upload();

Configuration file format

It is also possible to use a configuration file.
The file format is toml format., _(*9)

token = "{api-token}"
service = "travis-ci"
repositoryDirectory = "."

[reportFile]
output = "script/coveralls.json"

[reportFile.input]
type = "lcov"
file = "script/report.lcov"

File format

reportFile

imput

output

will specify the json file name to be sent to the coveralls.io.
Will specify a relative path from the directory containing the configuration file., _(*10)

Task for Robo

Support the robo of tasks, so you can easily send a report.
Please look at the robo-coveralls-kit for more information., _(*11)

Detailed documentation

• Work with Travis-CI

Run only unit test

composer test

How to run the example

vendor/bin/robo example:basic