allure-framework / allure-framework/allure-python
Implement Allure listeners
- 主要语言
- Python
- 星标
- 814
- 派生
- 260
- PR 合并指标
- 30 天内没有已合并 PR
描述
### Context
People often need to somehow post-process Allure results according to their needs. Examples would be:
- filtering data they don't want in the report (parameters/labels/fixtures)
- customizing the default names, existing parameters, etc
- sending the results somewhere on the fly
Many such requirements are user-specific, and there is no point in implementing them here. Often, it's not even possible because many such requirements contradict each other.
Instead, it would be reasonable to have an easy-to-use extension mechanism that users may utilize for their purposes.
### Existing solution
Currently, users can register custom plugins in `allure_commons.plugin_manager`. For example:
```python
from allure_commons import hookimpl
from allure_commons import plugin_manager
class MyListener:
@hookimpl(tryfirst=True)
def report_result(self, result):
# post-process the result here
...
def pytest_configure(config):
def cleanup():
name = plugin_manager.get_name(listener)
plugin_manager.unregister(name=name)
listener = MyListener()
plugin_manager.register(listener)
config.add_cleanup(cleanup)
```
While covering many cases, the solution has some drawbacks:
- Verbose API:
- `tryfirst` is necessary to make sure the hook implementation is called after the default logger's one.
- The cleanup needs to be added separately.
- Limited hook spec:
- No steps and fixtures post-processing (only at the test result level, which complicates the processing).
- Limited support for attachments post-processing.
- No hooks for pre-processing.
### Implementation
Lifecycle listeners can be implemented with [pluggy](https://pluggy.readthedocs.io/en/stable/) as a plugin manager + hook specs + user-friendly API on top of this. We already use pluggy to implement the Allure API, so it's just a matter of defining one or more hook specs, calling them via the existing `allure_commons.plugin_manager` or a separate one.
贡献指南
调研方向
首先检查现有的 allure_commons.plugin_manager 和基于 pluggy 的 Allure API 实现。围绕此处描述的 hook specs 和面向用户的 API,定义 listener 的作用范围和生命周期;当用户无需手动排序或清理即可注册 listener,并能在处理之前或之后处理结果、步骤、fixture 和附件时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- testing, tooling
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100