atoum/telemetry-extension

atoum telemetry reports extension

1.0.0 2017-10-02 22:09 UTC

Requires

• php: >=5.4.0
• atoum/atoum: ^2.9 || ^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2

Conflicts

• atoum/reports-extension: <3.0.0

BSD

• jubianchi

• TDD
• atoum
• test
• unit testing
• reports
• telemetry
• atoum-extension

README

Install it

Install extension using composer:

{
    "require-dev": {
        "atoum/telemetry-extension": "^1.0"
    }
}

Or simply run the following command

composer require --dev atoum/telemetry-extension

The extension will then be autoloaded by atoum, the only thing you will have to do is to configure the report.

Use it

The telemetry report allow us to collect metrics from your test suites. If you want to help us improve atoum, please send us your reports.

To enable the telemetry report, add the following code to your configuration file:

<?php

// .atoum.php

use mageekguy\atoum\telemetry;
use mageekguy\atoum\reports\telemetry;
use mageekguy\atoum\writers\std;

$script->addDefaultReport();

$telemetry = new telemetry\report();
$telemetry->addWriter(new std\out());
$runner->addReport($telemetry);

Now, each time your run your test suite, atoum will collect data and send them to the telemetry. By default, everything is sent anonymously: a random project name will be generated and we'll only collect metrics.

If you want to let us know who you are, add the following lines to your configuration file:

<?php 

$telemetry->readProjectNameFromComposerJson(__DIR__ . '/composer.json');

// Or

$telemetry->setProjectName('my/project');

The project name must be composer compliant.

With this configuration, atoum will send us everything about your project: the vendor name and the project name. If you want to keep the latter secret so we only collect the vendor name, you can add the following line:

<?php

$telemetry->sendAnonymousProjectName();