allure-framework / allure-framework/allure-python

Test docstrings are not rendered in the report in a consistent way

Open
#774 2 comments 1 reaction 0 assignees View on GitHub
task:improvement theme:pytest
Dominant language
Python
Stars
814
Forks
260
PR merge metrics
No merged PRs in 30d

Description

[//]: # (
. 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
)
![Screenshot from 2023-11-09 22-24-51](https://github.com/allure-framework/allure-python/assets/16239820/06aa72bb-6c27-44f5-8177-79cdb5badf3b)
![Screenshot from 2023-11-09 22-26-25](https://github.com/allure-framework/allure-python/assets/16239820/6a1647ee-8401-41c5-9235-f117b34e2f09)

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the issue with the two pytest tests and compare how their docstrings appear in the Allure report. The issue does not name implementation files or tests beyond this example, so trace how allure-pytest passes docstrings into the report. Done means one-line and multiline docstrings render consistently; the issue does not specify which rendering format is expected.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.