allure-framework / allure-framework/allure-python
Test docstrings are not rendered in the report in a consistent way
- Ngôn ngữ chính
- Python
- Star
- 814
- Fork
- 260
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
[//]: # (
. 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
)


Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu bằng cách tái hiện vấn đề với hai test pytest và so sánh cách docstring của chúng xuất hiện trong báo cáo Allure. Issue không nêu tên các tệp triển khai hoặc test nào ngoài ví dụ này, vì vậy hãy lần theo cách allure-pytest truyền docstring vào báo cáo. Được xem là hoàn thành khi docstring một dòng và nhiều dòng được render nhất quán; issue không chỉ rõ định dạng render nào được mong đợi.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- testing-qa
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100