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
)


コントリビューションガイド
調査の方向性
まず、2つのpytestテストで問題を再現し、それぞれのdocstringがAllureレポートにどのように表示されるかを比較します。このissueでは、この例以外の実装ファイルやテストは指定されていないため、allure-pytestがdocstringをどのようにレポートに渡しているかを追跡してください。1行のdocstringと複数行のdocstringが一貫してレンダリングされれば完了です。issueでは、どのレンダリング形式が期待されるかは指定されていません。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- testing-qa
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100