allure-framework / allure-framework/allure-python
Test docstrings are not rendered in the report in a consistent way
- 主要语言
- Python
- 星标
- 814
- 派生
- 260
- PR 合并指标
- 30 天内没有已合并 PR
描述
[//]: # (
. Note: for support questions, please use Stackoverflow or Gitter**.
. This repository's issues are reserved for feature requests and bug reports.
.
. In case of any problems with Allure Jenkins plugin** please use the following repository
. to create an issue: https://github.com/jenkinsci/allure-plugin/issues
.
. Make sure you have a clear name for your issue. The name should start with a capital
. letter and no dot is required in the end of the sentence. An example of good issue names:
.
. - The report is broken in IE11
. - Add an ability to disable default plugins
. - Support emoji in test descriptions
)
#### I'm submitting a ...
- [x] bug report
- [ ] feature request
- [ ] support request => Please do not submit support request here, see note at the top of this template.
#### What is the current behavior?
Execute this pytest code
```
def test_1():
""" First description """
pass
def test_2():
"""
Second description
"""
pass
```
In the Allure report, the descriptions are included as follows:
```
First description
```
```
Second description
```
One-line docstrings are included with the `
` tag.
Multi-line docstrings are included with the `
` tags.
#### If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
Execute the pytest code provided above
#### What is the expected behavior?
Docstrings should be included in the report in a consistent way.
#### What is the motivation / use case for changing the behavior?
It is desirable to have a consistent behavior
#### Please tell us about your environment:
- Allure version: 2.24.1
- Test framework: pytest@4.1.1
- Allure adaptor: allure-pytest@2.13.2
#### Other information
[//]: # (
. e.g. detailed explanation, stacktraces, related issues, suggestions
. how to fix, links for us to have more context, eg. Stackoverflow, Gitter etc
)


贡献指南
调研方向
首先使用两个 pytest 测试复现该问题,并比较它们的 docstring 在 Allure 报告中的显示方式。该 issue 除了这个示例之外没有指定实现文件或测试,因此请追踪 allure-pytest 如何将 docstring 传入报告。单行和多行 docstring 能够一致地渲染即表示完成;该 issue 未指定预期的渲染格式。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- testing-qa
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100