atoum/telemetry-extension

atoum 仪表报告扩展

1.0.0 2017-10-02 22:09 UTC

This package is auto-updated.

Last update: 2024-08-29 04:14:43 UTC


README

atoum

安装它

使用 composer 安装扩展

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

或者简单地运行以下命令

composer require --dev atoum/telemetry-extension

然后,扩展将由 atoum 自动加载,您需要做的只是配置报告。

使用它

仪表报告允许我们从您的测试套件中收集指标。如果您想帮助我们改进 atoum,请将您的报告发送给我们。

要启用仪表报告,请将以下代码添加到您的配置文件中

<?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);

现在,每次您运行测试套件时,atoum 都会收集数据并将其发送到仪表。默认情况下,所有内容都是匿名发送的:将生成一个随机的项目名称,我们只会收集指标。

如果您想让我们知道您的身份,请将以下行添加到您的配置文件中

<?php 

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

// Or

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

项目名称 必须 符合 composer 规范。

使用此配置,atoum 会将有关您的项目的所有信息发送给我们:供应商名称和项目名称。如果您想保持后者为秘密,以便我们只收集供应商名称,您可以添加以下行

<?php

$telemetry->sendAnonymousProjectName();