README

此扩展允许您使用 YAML 文件和/或环境变量配置 atoum。

示例

使用此扩展时，您可以在存储库根目录中放置一个 .atoum.yml 文件来配置 atoum。以下是如何告诉 atoum 在 tests/units/classes 文件夹中查找单元测试的示例。

# .atoum.yml

atoum:
    directories:
        - ./tests/units/classes

安装它

使用 composer 安装扩展

composer require --dev atoum/config-extension

使用 atoum 配置文件启用扩展

<?php

// .atoum.php

require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';

use mageekguy\atoum\config;

$runner->addExtension(new config\extension($script));

// Or

new config\extension($script);

使用它

# .atoum.yml

atoum:
    directories:
        - ./tests/units/classes

    fields:
        report.default:
            - field.logo
            - field.logo.result
            - field.coverage

    reports:
        - report.default
        - report.coverage.clover

配置参考

atoum.loop

boolean : 启用/禁用 atoum 的循环模式。默认为 ATOUM_LOOP 环境变量。

示例

atoum:
  loop: true

atoum.debug

boolean : 启用/禁用 atoum 的调试模式。默认为 ATOUM_DEBUG 环境变量。

示例

atoum:
  debug: true

atoum.verbosity

integer : 值在 1 到 3 之间，用于确定 atoum 的详细程度。默认为 ATOUM_VERBOSITY 环境变量。

示例

atoum:
  verbosity: 2

atoum.directories

array : atoum 将查找单元测试的目录列表。默认为 ATOUM_DIRECTORIES 环境变量（以逗号分隔的目录列表）。

atoum:
    directories:
        - ./tests/units/classes

atoum.reports

array : 报告列表。默认为 ATOUM_REPORTS 环境变量（以逗号分隔的报告列表）。

示例

atoum:
    reports:
        - report.default
        - report.coverage.clover

可能的值

report.default

添加 atoum 的默认报告器（当 reports 键被定义时，不再使用 atoum 的默认报告器）。

report.coverage.clover

添加 clover 覆盖率报告器。

报告将写入的路径可以使用 coverage.clover.filename 参数进行配置。

report.xunit

添加 xUnit 报告器。

报告将写入的路径可以使用 xunit.filename 参数进行配置。

report.tap

添加 TAP 报告器。

report.vim

添加 vim 报告器。

report.nyancat

添加显示 nyancat 的报告器。

report.santa

添加 santa 报告器。

atoum.fields

字段允许您自定义报告。您可以为每个报告添加字段。

您需要添加报告名称作为键，然后添加字段数组。

此示例将 logo 字段添加到默认报告中

atoum:
    reports:
        - report.default

    fields:
        report.default:
            - field.logo

field.logo

在报告开始时显示 atoum 的标志。仅在 cli 报告上生效。

field.logo.result

在报告结束时显示 atoum 的标志。仅在 cli 报告上生效。

field.coverage.html

生成HTML覆盖率报告。需要安装xdebug PHP扩展。

生成的报告中的项目名称和报告生成的文件夹可以通过project.name和coverage.html.directory参数进行配置。

参数

您可以通过在.atoum.yml文件中的parameters部分自定义报告或字段的生成方式。

以下是一个示例，它更改了xunit报告生成的路径

atoum:
    reports:
        - report.xml
parameters:
    xunit.filename: "mylogs/file.xml"

xunit.filename

默认值：xunit.xml。

该路径将在report.xunit报告中写入xUnit报告。

生成的文件所在的目录必须存在，Atoum不会创建它。

coverage.html.directory

默认值：./coverage。

HTML覆盖率文件的文件夹路径。请参阅field.coverage.html字段。

project.name

默认值：atoum。

当生成field.coverage.html字段时将被使用。

coverage.clover.filename

默认值：clover.xml。

在report.clover报告中写入clover报告的路径。

链接

许可证

config-extension在BSD-3-Clause许可证下发布。请参阅捆绑的LICENSE文件以获取详细信息。

atoum / config-extension

维护者

详细信息