当前位置：网站首页>Pytest learning notes (12) -allure feature · @allure Step () and allure attach

Pytest learning notes (12) -allure feature · @allure Step () and allure attach

2022-07-03 01:29:00 【_ Li Sheng】

allure.step() and allure.attach

Preface

allure In addition to supporting common pytest Function outside （ xfails、fixture、skips and skipif、parametrize）, It also has some powerful and practical functions .

This is mainly about step and attach function , You can set test steps and add attachments to the report .

@allure.step()

Allure The most important aspect of the report is that it allows a very detailed step description of the invocation of each test case
adopt @allure.step Decorator to achieve
It can be stored outside your test , And import only when needed
Step Methods can have nested structures of any depth

demo Code

# __File__ = test_01.py
import allure
from .steps import imported_step

@allure.step("step-1")
def passing_step():
    pass

@allure.step("step-2")
def step_with_nested_steps():
    nested_step()
    
@allure.step("step-3")
def nested_step():
    nested_step_with_arguments(1, 'abc')

@allure.step("step-4")
def nested_step_with_arguments(arg1, arg2):
    pass

def test_with_imported_step():
    passing_step()
    imported_step()

def test_with_nested_steps():
    passing_step()
    step_with_nested_steps()

The results are as follows ：
Insert picture description here

Use summary

Parameters ：title, Express step The name of , It can be directly displayed in the test report
characteristic ： You can nest , It can also be called externally
Use scenarios ： It is mainly used for the organization of scenario use cases , Use multiple function point use case groups to synthesize scenario use cases （ Allow external use cases ）

allure.attach

function ： Test reports can display many different types of attachments , These accessories can supplement the test 、 Step or fixture result

Parameter Introduction

usage 1：allure.attach(body, name, attachment_type, extension), The parameters are as follows ：
- body： To write the original contents of the attachment
- name： The attachment of
- attachment_type：allure.attachment_type One type
- extension： Extension of the file
usage 2：allure.attach.file(source, name, attachment_type, extension), Parameters ：
- source： File path （ character string ）
- （ Other parameters are the same ）

usage 1 Used when there are no ready-made attachments you want to import , Add and display it in the test report
usage 2 It is mainly used for existing corresponding attachments , You can use path import directly , Show it in the test report

Code up

establish test_01.py file , The contents are as follows ：

import allure
import pytest

@pytest.fixture
def attach_file_in_module_scope_fixture_with_finalizer(request):
    allure.attach(' stay fixture Add a txt The attachment ', 'fixture  Front attachment ', allure.attachment_type.TEXT)

    def finalizer_module_scope_fixture():
        allure.attach(' stay fixture Add a txt The attachment ', 'fixture  Rear attachment ',
                      allure.attachment_type.TEXT)

    request.addfinalizer(finalizer_module_scope_fixture)

def test_with_attachments_in_fixture_and_finalizer(attach_file_in_module_scope_fixture_with_finalizer):
    pass

def test_multiple_attachments():
    allure.attach.file('chestnut_1f330.png', attachment_type=allure.attachment_type.PNG)
    allure.attach.file('allure_report.html', attachment_type=allure.attachment_type.HTML)
    allure.attach('<head></head><body>  One HTML page  </body>', 'Attach with HTML type', allure.attachment_type.HTML)