之前文章我们学习了pytest-html插件生成html测试报告，本章介绍另一个好用的插件。allure-pytest 是pytest的一个插件，帮助我们再pytest测试框架中集成Allure框架来生成详细的测试报告。

Allure 是一个灵活的轻量级多语言测试报告工具，支持包括 pytest /testng在内的多种测试框架，能够生成易于理解和丰富的测试报告。

allure-pytest能够生成包含测试步骤、日志、标题、优先级、附件等详细信息的测试报告，有助于更好地理解测试用例的执行情况。

自定义功能：支持通过装饰器（比如@allure.epic、@allure.feature、@allure.story、@allure.title、@allure.description 等）来添加额外的测试信息，如功能模块、用例标题、严重程度等，从而生成更加详细和有用的报告。

官方文档：https://allurereport.org/docs/pytest/

allure-pytest插件安装

使用pip命令安装: pip install allure-pytest

(安装在pytest工程所运行的python环境，python的安装目录或者虚拟环境目录，可以参考之前文章查看运行环境pycharm配置pytest运行环境)

安装和配置allure命令行工具（mac系统）

以下以mac电脑举例：

1）下载和配置jdk

下载地址：Java Downloads | Oracle，选择适用于Mac OS的JDK版本，点击下载即可。
下载完之后，双击安装包按照如下页面指导直接安装即可

默认安装目录：/Library/Java/JavaVirtualMachines，打开终端，进入目录可以看到jdk程序。

配置环境变量：使用open ~/.bash_profile打开变量文件，不存在先创建一个该文件。

vi命令打开后，添加如下信息保存退出

export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-22.jdk/Contents/Home

执行source ~/.bash_profile使配置生效，然后执行java --version可以看到java版本了。

2）下载命令行工具

进入以下地址下载allure工具

https://repo.maven.apache.org/maven2/io/qameta/allure/allure-commandline/

最新的版本是2.9.0

3）配置allure命令行工具

将下载的allure包解压，打开终端，配置环境变量执行vi ~/.bash_profile然后添加export PATH="/Users/aaa/Downloads/allure-2.9.0/bin:$PATH"，填写的是allure的目录信息。

执行source ~/.bash_profile使配置生效，然后在任意目录执行allure --version可以看到allure执行成功了。

生成测试报告

测试用例执行后，生成最简易的测试报告，步骤如下：

1）使用时无需导入，直接在用例执行命令中添加参数

执行带上参数--alluredir=./allure-results，参数后面跟着用例结果的目录。

执行后在目标目录中生成的是一堆json文件。

2）将测试结果生成html测试报告

• 可以生成在线测试报告并自动通过浏览器打开

命令：allure serve allure-results

执行后自动打开浏览器，展示测试报告内容。生成的报告位置见日志打印

• 自定义生成测试报告的目录，手动在浏览器打开

命令：allure generate allure-results -o allure-report --clean

-o后面跟着报告的目录

--clean表示先清楚该目录内容再生成测试报告，否则会提示目录已被使用。

测试报告如下，比插件pytest-html生成的报告内容更丰富，页面更好看。

Allure报告提供了丰富的信息和功能，展示测试用例执行结果，用例的层级结构，附件和截图，测试指标和趋势图，还有其他的标记、过滤、定制等，让测试结果更加直观和易于理解。

allure的装饰器功能

使用前先导入 import allure

官方文档：https://allurereport.org/docs/pytest-reference/#metadata

示例1 添加需求层次结构

@allure.epic("epic")
@allure.feature("features")
@allure.story("assert")
def test_1():
 assert 1 == 1

def test_2():
 allure.dynamic.epic("epic")
 allure.dynamic.feature("features")
 allure.dynamic.story("assert")
 assert 1 == 1

测试用例执行后，生成测试报告如下：点击下面的红框地方可以看到定义的层次结构

示例2 定义套件结构

@allure.parent_suite("ParentSuite")
@allure.suite("Suite")
@allure.sub_suite("Suite-1")
def test_3():
 assert 1 == 1

def test_4():
 allure.dynamic.parent_suite("ParentSuite")
 allure.dynamic.suite("Suite")
 allure.dynamic.sub_suite("Suite-1")
 assert 1 == 1

测试用例执行后，生成测试报告如下：点击下面的红框地方可以看到定义的套件结构

示例 3 定义测试用例标题

class Testcase():
 def test_1(self):
   allure.dynamic.title('测试类中的用例1')
   assert 1 == 1
 
 @allure.title('测试类中的用例2')
 def test_2(self):
   assert 1 == 1

测试用例执行后，生成测试报告如下：点击下面的红框地方可以看到用例的标题（没有定义标题显示的是测试函数名）

示例 4 定义测试用例的步骤

class Testcase():
 def test_1(self):
   allure.dynamic.title('测试类中的用例1')
   with allure.step('先定义变量'):
   		value = 1
   with allure.step('开始断言'):
 		  assert value == 1

 @allure.step('先定义变量')
 def set_value(self):
 		return 1
 
 @allure.step('开始断言')
 def assert_value(self,value):
 		assert value ==1

 @allure.title('测试类中的用例2')
 def test_2(self):
 		value = self.set_value()
 		self.assert_value(value)

分别使用装饰器和上下文管理器的方式设置测试用例的步骤，测试用例执行后，生成测试报告如下：点击下面的红框地方可以看到用例的步骤

示例 5 设置用例的的描述信息

@allure.description('用例断言')
def test_3():
 assert 1 == 1

def test_4():
 allure.dynamic.description('用例断言')
 assert 1 == 1

def test_5():
 """
 断言
 :return: None
 """
 assert 1 == 1

测试用例执行后，生成测试报告如下：点击下面的红框地方可以看到用例的描述

示例 6 设置用例的标记

@allure.tag('tag1','tag2','tag3')
def test_6():
 assert 1 == 1

def test_7():
 allure.dynamic.tag('tag1','tag2','tag3')
 assert 1 == 1

测试用例执行后，生成测试报告如下：点击下面的红框地方可以看到用例的标记信息

示例7 设置用例的严重级别

@allure.severity('critical')
def test_7():
 assert 1 == 1

def test_8():
 allure.dynamic.severity('normal')
 assert 1 == 1

测试用例执行后，生成测试报告如下：下面的红框地方可以看到用例的级别

示例 8 设置用例的链接

@allure.link("https://dev.example.com/", name="Website")
@allure.issue("AUTH-123")
@allure.testcase("TMS-456")
def test_11():
 assert 1 == 1

def test_12():
 allure.dynamic.link("https://dev.example.com/", name="Website")
 allure.dynamic.issue("AUTH-123")
 allure.dynamic.testcase("TMS-456")
 assert 1 == 1

测试用例执行后，生成测试报告如下：下面的红框地方可以看到用例的链接，可以点击跳转。

示例 9 展示用例的参数

def test_15():
 allure.dynamic.parameter('name', 'wang', excluded=None, mode=None)

@pytest.mark.parametrize('name',['wang','li'])
def test_16(name):
 print(name)

用例15使用allure的参数功能，用例16使用pytest的参数功能，测试用例执行后，生成测试报告如下：下面的红框地方可以看到用例的参数信息

示例10 展示用例的附件

从变量中附加内容

allure.attach(body,name=None,attachment_type="text/plain", extension="attach")

在给定的name下添加body作为测试结果的附件（默认为唯一的伪随机字符串）。body必须是bytes或str类型。

def test_17():
  allure.attach('pytest',name="附件",
             attachment_type=allure.attachment_type.TEXT
               )

测试用例执行后，生成测试报告如下：下面的红框地方可以看到用例的附件信息

从文件中阅读附件

allure.attach.file(source,name=None, attachment_type=None, extension=None)

def test_18():
   allure.attach.file('/Users/ue/Desktop/1.png',name="附件",
       attachment_type=allure.attachment_type.PNG
        )

测试用例执行后，生成测试报告如下：下面的红框地方可以看到用例的附件信息（大家可以添加多种格式的附件，示例中的allure.attachment_type有很多种类型）

共勉： 东汉·班固《汉书·枚乘传》：“泰山之管穿石，单极之绠断干。水非石之钻，索非木之锯，渐靡使之然也。”

-----指水滴不断地滴，可以滴穿石头；

-----比喻坚持不懈，集细微的力量也能成就难能的功劳。

----感谢读者的阅读和学习，谢谢大家。

---祝愿大家都能够龙腾虎跃，步步高升！！！