Pytest learning notes (13) -allure of allure Description () and @allure title()

allure.description() and @allure.title()

Preface

Previously, I introduced allure Of step and attach function , Let's take a look this time allure The other two features of ：

• @allure.description(）
• @allure.title()

@allure.description()

• Add a detailed description for the test case , And show it in the test report , It can improve the readability of the test report , Make the report more intuitive , Easy to understand

grammar

There are three main grammars , as follows ：

• Use under test cases ""“xxxx”"" Add description （ Add a general description - Method 1）
• Use @allure.description(） Decorator （ Add a general description - Method 2）
• Use @allure.description_html() Decorator , add to HTML describe （ add to HTML Description and attach The decorator is used in the same way ）

Code

#!/usr/bin/env python3
# -*- coding:utf-8 -*-

""" __File__ = test_03.py __Project__= _JAuto-Interface __Time__ = 2022-02-15 18:37:36 __Author__ =  Li Sheng  """
import allure

@allure.description_html(""" <h1> Some features of test cases HTML describe </h1> <table style="width:100%"> <tr> <th>Firstname</th> <th>Lastname</th> <th>Age</th> </tr> <tr align="center"> <td>William</td> <td>Smith</td> <td>50</td> </tr> <tr align="center"> <td>Vasya</td> <td>Jackson</td> <td>94</td> </tr> </table> """)
def test_html_description():
    assert True

@allure.description("""  Multi line test instructions   Use  allure.description  Decorator .  Nothing special  """)
def test_description_from_decorator():
    assert 42 == int(6 * 7)


def test_unicode_in_docstring_description():
    """Unicode  describe . Этот тест проверяет юникод.  Hello, man . """
    assert 42 == int(6 * 7)

The results are as follows ：

@allure.title()

• It can make the test case title more readable （ Can be Chinese characters ）
• You can talk to Parameterize Parameterization and fixture Use a combination of
• usage ：@allure.title(“msg”)

Code

#!/usr/bin/env python3
# -*- coding:utf-8 -*-

""" __File__ = test_04.py __Project__= _JAuto-Interface __Time__ = 2022-02-15 19:37:59 __Author__ =  Li Sheng  """

import allure
import pytest


@allure.title(" Custom title ")
def test_with_a_title():
    assert 2 + 2 == 4


@allure.title(" This test has a with  unicode  Custom title ：Привет！")
def test_with_unicode_title():
    assert 3 + 3 == 6
    

@allure.title(" Titles used in conjunction with parameterization : adding {param1} with {param2}")
@pytest.mark.parametrize('param1,param2,expected', [
    (2, 2, 4),
    (1, 2, 5)
])
def test_with_parameterized_title(param1, param2, expected):
    assert param1 + param2 == expected

The results are as follows

Summarize and contrast

Don't use allure.title() Decorator , By default, the report shows the use case function name , Poor readability , So I suggest you use more when writing use cases title Such small features , Make the test report more intuitive , It is convenient for collaborative students such as R & D to consult