allure-codeception-plugin / allure-codeception-plugin
Codeception适配Allure报告的分支。
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
This package is not auto-updated.
Last update: 2024-09-28 18:10:51 UTC
README
这是一个官方Codeception适配器https://github.com/allure-framework/allure-codeception的分支。主要目的是支持多种类型的测试,如BDD和Cest。
这是用来做什么的?
此适配器的主要目的是收集有关您的测试信息并将其写入一组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 部分。