atoum/standard-edition

0.2.0 2018-03-05 22:08 UTC

This package is auto-updated.

Last update: 2024-08-29 04:31:17 UTC


README

atoum 标准版是一个具有特定观点的 atoum 打包。它包含了在 atoum 核心中不被认为是最佳实践的功能,但这些功能对许多开发者可能是有用且可用的。它还旨在简化 CI 环境的集成,并利用 composer.json 文件提供一些自动配置。

安装它

您只需通过 composer 需求 atoum/standard-edition。您无需手动安装 atoum。

composer require --dev atoum/standard-edition

功能

  • atoum 的 yml 和 php 配置,
  • 内置 IDE 完成您的测试,
  • 内置受保护方法的测试,
  • 简化 CI 环境集成,
  • ...

以下为功能完整列表。

详细功能

由扩展提供的功能

对于这些功能中的每一个,最好阅读它们的文档。只需记住,它们已经准备好使用,因此您不需要在配置文件中进行配置。

  • 覆盖测试方法的方法可见性以测试受保护的方法(请参阅 atoum/visibility-extension
  • 通过 YAML 文件而不是 PHP 文件配置 atoum(请参阅 atoum/config-extension)(但您可以选择继续使用 PHP 文件以获得更可定制的配置)
  • 您的 IDE 将通过 stubs(请参阅 stubs)在编写测试时提供自动完成功能
  • 您可以通过 atoum/reports-extension 配置 atoum 以生成分支和路径覆盖率报告
  • 您可以通过 atoum/telemetry-extension 激活遥测报告

轻松生成 xUnit 报告

要生成 xUnit 报告,请添加环境变量 XUNIT_REPORT_PATH,并将其值设置为要生成的 xUnit 文件的路径。

如果应写入文件的目录不存在,则会创建它。

参与遥测项目

如果您想参与 遥测项目,只需设置环境变量 TELEMETRY_ENABLED 即可。

您可以设置多个值

  • 0:不发送报告(默认值)
  • 1:匿名发送报告
  • 2:发送包含您的供应商名称的报告(从您的 composer.json 文件中获取)
  • 3:发送包含供应商和项目名称的报告(从您的 composer.json 文件中获取)

自动配置 autoloop 扩展

如果已安装 autoloop 扩展,则 composer.json 文件中自动加载部分定义的文件/文件夹将被自动监视。

您必须手动安装 autoloop 扩展(因为其中一些依赖项可能与您的项目发生冲突)。

链接

许可

atoum 标准版在 MIT 许可下发布。有关详细信息,请参阅捆绑的 LICENSE 文件。