mkapoor / allure-codeception-custom
这是 Allure 报告的 Codeception 适配器的分支,支持大量测试用例,包括 BDD。
Requires
- php: >=5.6
- allure-framework/allure-php-api: ~1.2.1
- codeception/codeception: ^2.3|^3.0|^4.0
- symfony/filesystem: >=2.6
- symfony/finder: >=2.6
README
这是官方 Codeception 适配器 https://github.com/allure-framework/allure-codeception 的分支。
这用于什么?
此适配器的主要目的是收集关于您的测试信息,并将其写入一组 XML 文件中:每个测试类一个。此适配器仅生成包含测试信息的 XML 文件。有关如何生成报告的说明,请参阅 wiki 部分。
示例项目
示例项目位于: https://github.com/allure-examples/allure-codeception-example
安装和使用
为了使用此适配器,您需要在 composer.json 文件中添加一个新的依赖项
{
"require": {
"php": ">=5.4.0",
"mkapoor/allure-codeception": ">=1.1.0"
}
}
要使 Codeception 测试启用此适配器,只需将其放在 codeception.yml 中的 "enabled" 扩展部分即可
extensions: enabled: - Yandex\Allure\Codeception\AllureCodeception config: Yandex\Allure\Codeception\AllureCodeception: deletePreviousResults: false outputDirectory: allure-results ignoredAnnotations: - env - dataprovider
deletePreviousResults
将清除输出目录中的所有 .xml
文件(此行为可能稍后更改为完全清理)。默认设置为 false
。
outputDirectory
用于存储 Allure 结果,并将相对于 Codeception 输出目录(也称为 codeception.yml 中的 paths: log
)计算,除非您指定了绝对路径。您可以使用 ..
如常向上遍历。outputDirectory
默认为 allure-results
。
ignoredAnnotations
用于定义要忽略的额外自定义注释。默认为空。
要从您最喜欢的终端生成报告,请安装 allure-cli 并运行以下命令(假设您位于项目根目录并使用默认配置)
allure generate --report-version 1.4.5 --report-path tests/_output/allure-report -- tests/_output/allure-results
报告将在 tests/_output/allure-report
中生成。
主要功能
请参阅相应的 PHPUnit 部分。