学会这些pytest-Allure常用特性allure.attach、allure.step、fixture、environment、categories

于 2024-08-26 20:32:20 发布
阅读量169 收藏 8
点赞数 8
分类专栏： 软件测试 文章标签： pytest 服务器 运维 自动化测试 软件测试 功能测试 程序人生
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lzz718719/article/details/141572547
版权
allure.attach

allure.attach用于在测试报告中添加附件，补充测试结果。附件格式可以是txt、jpg等，附件内容通常是测试数据、截图等。

allure.attach提供了两种方法：allure.attach()，allure.attach.file()

allure.attach()

作用：在测试报告中生成指定内容、名称、类型的附件

语法：allure.attach(body, name=None, attachment_type=None, extension=None)

参数说明：

  1. body，需要显示的内容，也可以理解为写入附件的内容
  2. name，附件名称
  3. attachment_type，附件类型，如csv、jpg、html 等，由allure.attachment_type提供
  4. extension：附件扩展名，不常用

allure.attach.file()

作用：向测试用例中上传附件

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

参数说明：source为文件路径，其他参数与allure.attach()参数一致。

在UI自动化测试中，会经常用到这个方法来上传用例执行的截图。

示例

test_login.py：


import allure

import pytest

import requests

import json


data = [("lilei", "123456"), ("hanmeimei", "888888"), ("xiaoming", "111111")]

ids = ["username:{}-password:{}".format(username, password) for username, password in data]


@allure.epic("xx在线购物平台接口测试")

@allure.feature("登录模块")

class TestLogin:


@allure.story("用户登录")

@allure.title("登录")

@pytest.mark.parametrize("username, password", data, ids=ids)

def test_login(self, username, password):

headers = {"Content-Type": "application/json;charset=utf8"}

url = "http://127.0.0.1:5000/login"

_data = {

"username": username,

"password": password

}

allure.attach(

body="用户名-{}，密码-{}".format(username, password),

name="登录参数",

attachment_type=allure.attachment_type.TEXT

)

res = requests.post(url=url, headers=headers, json=_data).text

res = json.loads(res)

assert res['code'] == 1000


@allure.story("用户退出登录")

@allure.title("退出登录")

def test_logout(self):

'''这条测试用例仅仅只是为了举例说明allure.attach.file的使用'''

print("退出登录，并截图")

# 截图路径

testcase_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

source_path = testcase_path + "/screenshot/logout.jpg"

allure.attach.file(

source=source_path,

name="退出登录后截图",

attachment_type=allure.attachment_type.JPG

)

assert True

上述代码中使用了@pytest.mark.parametrize()，Allure能够很好的支持@pytest.mark.parametrize()进行参数化。

run.py：


if __name__ == '__main__':

pytest.main(['testcase/test_login.py', '-s', '-q', '--alluredir', './result'])

os.system('allure generate ./result -o ./report --clean')

运行run.py，测试报告结果展示如下：

allure.attach()结果：

allure.attach.file()结果：

从结果可以看出来，两种方法都在报告中对应的测试用例中展示了附件内容。

从allure.attach()结果还可以看出来，Allure能够很好的支持@pytest.mark.parametrize()进行参数化。

with allure.step

上一篇文章我们使用了装饰器@allure.step()标记函数使之成为测试步骤，而在测试函数/方法中，我们还可以通过with allure.step()的方式标记测试步骤。

它们之间的区别在于，@allure.step()用于标记通用函数，当这个被标记的函数被调用后，会插入步骤说明并展示在Allure报告中。

而with allure.step()则是将普通的代码标记为测试步骤，执行到这段代码时则会在Allure报告中展示步骤说明。

我们在上面代码的基础上，加入with allure.step()，示例如下：

 


import allure

import pytest

import requests

import json



data = [("lilei", "123456"), ("hanmeimei", "888888"), ("xiaoming", "111111")]

ids = ["username:{}-password:{}".format(username, password) for username, password in data]


@allure.epic("xx在线购物平台接口测试")

@allure.feature("登录模块")

class TestLogin:


@allure.story("用户登录")

@allure.title("登录")

@pytest.mark.parametrize("username, password", data, ids=ids)

def test_login(self, username, password):

headers = {"Content-Type": "application/json;charset=utf8"}

url = "http://127.0.0.1:5000/login"

_data = {

"username": username,

"password": password

}

# 第一步，请求登录接口

with allure.step("请求登录接口"):

allure.attach(

body="用户名-{}，密码-{}".format(username, password),

name="登录参数",

attachment_type=allure.attachment_type.TEXT

)

res = requests.post(url=url, headers=headers, json=_data).text

res = json.loads(res)

# 第二步，获取返回参数进行断言

with allure.step("断言"):

assert res['code'] == 1000
 

测试报告结果展示如下：
 

 

 

代码中插入的测试步骤如上图中的标记所示。
 

fixture
 

pytest的fixture函数可以实现setup、teardown的功能，而Allure会跟踪每个fixture的调用情况，详细显示调用了哪些fixture和参数以及调用顺序。
 

我们在上面代码的基础上，加入fixture函数，示例如下：
 

 


import allure

import pytest

import requests

import json


@pytest.fixture(scope="class", autouse=True)

def fixture_demo(request):

print("连接数据库")

def finalizer():

print("关闭数据库")

request.addfinalizer(finalizer)



data = [("lilei", "123456"), ("hanmeimei", "888888"), ("xiaoming", "111111")]

ids = ["username:{}-password:{}".format(username, password) for username, password in data]


@allure.epic("xx在线购物平台接口测试")

@allure.feature("登录模块")

class TestLogin:


@allure.story("用户登录")

@allure.title("登录")

@pytest.mark.parametrize("username, password", data, ids=ids)

def test_login(self, username, password):

headers = {"Content-Type": "application/json;charset=utf8"}

url = "http://127.0.0.1:5000/login"

_data = {

"username": username,

"password": password

}

# 第一步，请求登录接口

with allure.step("请求登录接口"):

allure.attach(

body="用户名-{}，密码-{}".format(username, password),

name="登录参数",

attachment_type=allure.attachment_type.TEXT

)

res = requests.post(url=url, headers=headers, json=_data).text

res = json.loads(res)

# 第二步，获取返回参数进行断言

with allure.step("断言"):

assert res['code'] == 1000
 

测试报告结果展示如下：
 

 

 

从结果可以看出来，Allure测试报告展示了用例调用的fixture函数信息。多个fixture函数被调用及其执行顺序的展示，这里不做过多说明。
 

environment
 

在Allure报告的首页可以展示此次测试执行的环境信息 (如测试环境、测试人员、被测系统版本号、系统配置环境等)，这需要通过创建environment.properties或environment.xml进行配置，并把文件放置在--alluredir指定的文件夹中 (博主这里即result文件夹)。
 

environment.properties示例如下：
 


system=win

python=3.7.7

version=1.0.1

host=127.0.0.1
 

 或environment.xml
 

 


<environment>

<parameter>

<key>system</key>

<value>win</value>

</parameter>

<parameter>

<key>python</key>

<value>3.7.7</value>

</parameter>

<parameter>

<key>version</key>

<value>1.0.1</value>

</parameter>

<parameter>

<key>host</key>

<value>127.0.0.1</value>

</parameter>

</environment>
 

生成报告后首页展示ENVIRONMENT信息如下：
 

 

 

categories
 

Allure报告中有一栏叫Categories，即分类，用于展示测试结果，默认只显示两类缺陷结果：
 

  1. Product defects 产品缺陷（测试结果：failed）
  2. Test defects 测试缺陷（测试结果：error/broken）
 

 

如下图所示
 

 

 

如果想要缺陷分类显示更丰富，我们可以通过创建categories.json文件进行自定义缺陷分类，并把文件放置在--alluredir指定的文件夹中 (即同environment.properties放在同一目录中)。
 

categories.json示例如下：
 

 


[

{

"name": "Passed tests",

"matchedStatuses": ["passed"]

},

{

"name": "Ignored tests",

"matchedStatuses": ["skipped"]

},

{

"name": "Infrastructure problems",

"matchedStatuses": ["broken", "failed"],

"messageRegex": ".*bye-bye.*"

},

{

"name": "Outdated tests",

"matchedStatuses": ["broken"],

"traceRegex": ".*FileNotFoundException.*"

},

{

"name": "Product defects",

"matchedStatuses": ["failed"]

},

{

"name": "Test defects",

"matchedStatuses": ["broken"]

}

]
 

参数说明：
 

  • name：分类名称
  • matchedStatuses：测试用例的运行状态，默认["failed", "broken", "passed", "skipped", "unknown"]
  • messageRegex：测试用例运行的错误信息，默认是 .* ，通过正则去匹配
  • traceRegex：测试用例运行的错误堆栈信息，默认是 .* ，同样通过正则去匹配
 

执行后会在报告的Categories中展示，首页CATERORIES栏展示如下：
 

 

 

Categories页面展示：
 

 

 

 

总结
 

Allure中常用的特性大致就这些，以上仅为简单示例，大家可根据自身项目的需要按需选择使用。Allure提供的特性当然也不止这些，如果感兴趣大家可以查看Allure官方文档了解更多。
 

最后感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：
 

​
 

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！
 


                

        

        

        

    




    

      

        

            

              
                
                  程序员筱筱
                
              
            

            

                关注
              
            

        

        

          
    
            
  • 
              
                
                
                
                
                    8
                
              
              
    点赞
    
            
    • 
            
  • 
              
                
                
                
              
              
    踩
    
            
    • 
            
  • 
              
                
                
                
                
                    8
                
              
              
    
                
    
                  
                    收藏
                  
                
    
              
    
              
    
                
    
                  觉得还不错?
                  
                    一键收藏
                  
                 
                
    
              
    
            
    • 
          
  • 
            
    
              
              
            
    
              
              
              
                    0
              
            
            
    评论
    
          
    • 
          
  • 
          
    • 
          
  • 
            
              
            
              
    
            
              
                
            
    
          
    • 
        

      

      

            

                专栏目录
          










                



	

		

			

				
					
Pytest集成Allure Report

				
			

			

				

					C'mon的博客
				

				

					06-22
					
					1121
					
				

			

		

		

			
				
这可以通过几种方式实现：您可以添加一个提供描述字符串的@allure.description装饰器，也可以使用@allre.description_html提供一些要在测试用例的“描述”部分中呈现的html。有两个装饰器：@allure.feature和@allure.story，用于根据您项目的功能/故事细分来标记您的测试（有关背景信息，请参阅维基百科上的BDD文章）。Allure报告的第一个可能也是最重要的方面是，它允许获得每个测试调用的非常详细的逐步表示。有时，您希望能够灵活地处理要执行的测试。

			
		

	



                

              
                



	

		

			

				
					
【playwright】pytest-playwright与allure结合，生成报告带有图片和录屏

				
			

			

				

					WEL测试
				

				

					06-17
					
					5255
					
				

			

		

		

			
				
执行pytest  --video=on --screenshot=on --alluredir=./report/xml让allure使用video、screenshot的录屏和截图

			
		

	



                


  
              

                


	

		

			

				
					
学完能涨薪5k的接口自动化测试框架pytest-Allure常用特性allure.attach、allure.step、fixture、environment、categories

				
			

			

				

					MXB1220的博客
				

				

					12-06
					
					186
					
				

			

		

		

			
				
也方便你下次能够快速查找。如有不懂还要咨询下方小卡片，博主也希望和志同道合的测试人员一起学习进步在适当的年龄，选择适当的岗位，尽量去发挥好自己的优势。我的自动化测试开发之路，一路走来都离不每个阶段的计划，因为自己喜欢规划和总结，测试开发视频教程、学习笔记领取传送门！！

			
		

	





	

		

			

				
					
22-pytest-allure.step()测试步骤描述

				
			

			

				

					小白的博客
				

				

					11-27
					
					1128
					
				

			

		

		

			
				
allure.step()测试步骤描述

			
		

	



		

			
		



	

		

			

				
					
Pytest学习笔记（12）-allure特性·@allure.step()和allure.attach

				
			

			

				

					  黎晟 的博客
				

				

					02-14
					
					2875
					
				

			

		

		

			
				
allure.step()和allure.attach
前言
allure除了支持常用的pytest功能外（ xfails、fixture、skips和skipif、parametrize），自身还有一些强大实用的功能。
本次主要介绍step和attach功能，可以设置测试步骤及添加报告中的附件。
@allure.step()

Allure 报告的最重要的方面是它允许对每个测试用例的调用进行非常详细的步骤说明
通过@allure.step装饰器来实现
可以存储在您的测试之外，并在需要时仅导入
Step 方

			
		

	





	

		

			

				
					
Pytest和Allure测试框架-超详细版+实战

					
热门推荐

				
			

			

				

					qq_42610167的博客
				

				

					09-23
					
					10万+
					
				

			

		

		

			
				
文章目录一：pytest的介绍，安装，框架结构，执行方式1，特点2，安装3， pytest的框架结构4，执行方式二：Pytest -断言、跳过及运行1，Pytest -断言、跳过及运行2，mark中的skip(跳过)3，mark中的xfail(失败)4,使用自定义标记mark只执行部分用例5,文件名类名方法执行部分用例6,-k 组合调用执行部分用例三， Pytest -fixture1.　如下： ...

			
		

	





	

		

			

				
					
python-selenium-pytest-allure UI自动化测试

				
			

			

				

					weixin_43997024的博客
				

				

					11-18
					
					641
					
				

			

		

		

			
				
python selenium 自动化

			
		

	





	

		

			

				
					
pytest-allure 生成测试报告

				
			

			

				

					Free355的博客
				

				

					07-19
					
					248
					
				

			

		

		

			
				
在软件测试中，生成清晰、易读的测试报告是非常重要的。pytest-allure是一个流行的测试框架和报告生成工具，它可以帮助测试团队生成美观、详细的测试报告。

			
		

	





	

		

			

				
					
26-pytest-allure描述用例详解

				
			

			

				

					小白的博客
				

				

					03-19
					
					505
					
				

			

		

		

			
				
pytest-allure描述用例详解

			
		

	





	

		

			

				
					
Pytest系列——allure（原理）之allure工具与Pytest测试框架集成

				
			

			

				

					mashang_z111的博客
				

				

					10-26
					
					4384
					
				

			

		

		

			
				
1、Allure Framework是一种灵活的轻量级多语言测试报告工具，不仅可以以简洁的Web报告形式非常简洁地显示已测试的内容，也允许参与开发过程的每个人从日常测试中提取最大程度的有用信息。2、从开发/质量保证的角度来看，Allure报告可以缩短常见缺陷的生命周期：可以将测试失败划分为bug和损坏的测试，还可以配置log，step，fixture，attachments，timings，历史记录以及与TMS的集成以及Bug跟踪系统，因此负责任的开发人员和测试人员将掌握所有信息。

			
		

	





	

		

			

				
					
Allure-pytest功能特性介绍

				
			

			

				

					ifling99的博客
				

				

					07-01
					
					829
					
				

			

		

		

			
				
Allure框架是一个灵活的轻量级多语言测试报告工具，它不仅以web的方式展示了简介的测试结果，而且允许参与开发过程的每个人从日常执行的测试中最大限度的提取有用信息
从dev/qa的角度来看，Allure报告简化了常见缺陷的统计：失败的测试可以分为bug和被中断的测试，还可以配置日志、步骤、fixture、附件、计时、执行历史以及与TMS和BUG管理系统集成，所以，通过以上配置，所有负责的开发人员和测试人员可以尽可能的掌握测试信息。
从管理者的角度来看，Allure提供了一个清晰的“大图”，其中包括已覆盖的

			
		

	





	

		

			

				
					
多进程和多线程基础概念LINUX

				
			

			

				

					2301_79109608的博客
				

				

					08-22
					
					1080
					
				

			

		

		

			
				
直接访问物理地址,会导致地址空间没有隔离,很容易导致数据被修改通过虚拟地址空间可以实现每个进程空间都是独立的，操作系统会映射到不用的物理地址区间，在访问时互不干扰.进程状态分为三个基本状态，即运行态，就绪态，阻塞态。在五态模型中，进程分为新建态、终止态，运行态，就绪态，阻塞态。并发：有限的 cpu 核芯的情况下 ,利用快速交替(时间片轮转)执行来达到宏观上的同时执行。虚拟地址 : 虚拟地址并不代表真实的内存空间,而是一个用于寻址的编号。并行：在 cpu 多核的支持下，实现物理上的同时执行。

			
		

	





	

		

			

				
					
黑神话悟空无法登录服务器怎么办

				
			

			

				

					IDC_USA的博客
				

				

					08-23
					
					518
					
				

			

		

		

			
				
黑神话悟空游戏在登录的时候会遇到无法登录服务器的问题，玩家可以采用一些有效的方法进行解决，其中最主要的措施就是优化网络环境和减少网络干扰。Rak小编为您整理黑神话悟空无法登录服务器如何解决的步骤及注意事项。

			
		

	





	

		

			

				
					
仿Muduo库实现高并发服务器——Acceptor模块

				
			

			

				

					2201_75324712的博客
				

				

					08-22
					
					467
					
				

			

		

		

			
				
Acceptor模块是为了创建套接字，并且接收新到来的客户端套接字，将对应套接字的Channel对象添加到Poller对象中，进行事件监控。

			
		

	





	

		

			

				
					
香港服务器IIS网站怎么实现应用程序初始化和预加载

				
			

			

				

					JttiSEO的博客
				

				

					08-22
					
					448
					
				

			

		

		

			
				
在香港服务器上使用 IIS 来初始化和预加载网站应用程序，可以显著提高网站的响应速度和性能，尤其是在首次访问时。这里的 initializationPage="/" 表示预加载首页，你可以根据需要指定其他页面。在应用程序池设置中，确保 "启动模式"(Start Mode)为 AlwaysRunning。这样配置可以帮助你确保应用程序在用户首次访问前就已经启动，减少首次加载的延迟。在 IIS 中配置站点或应用程序池的 "预加载" 设置。在右侧操作面板中，点击 "高级设置"。勾选 "启用应用程序初始化"。

			
		

	





	

		

			

				
					
Windows Server查看W3SVC IIS服务器中对应的网站日志

				
			

			

				

					滴水石穿
				

				

					08-22
					
					342
					
				

			

		

		

			
				
W3SVC1、W3SVC2、W3SVC3…基本上每个网站存放日志的文件夹名称都是以W3SVC开头，区别在于后面的ID/编号/序号，对应的是网站各自的ID。如果没有自定义站点的日志路径，日志默认的路径是C:\inetpub\logs\LogFiles\。W3SVC日志文件夹中序号的含义，格式就是W3SVC+网站ID。

			
		

	





	

		

			

				
					
Web应用服务器Tomcat

					
最新发布

				
			

			

				

					hotslow的博客
				

				

					08-23
					
					798
					
				

			

		

		

			
				
一般来说，Tomcat虽然和Apache或者Nginx这些Web服务器一样，具有处理HTML页面的功能，然而由于其处理静态HTML的能力远不及Apache或者Nginx，所以Tomcat通常是作为一个Servlet和JSP容器，单独运行在后端。从代价的角度看，就是为了注册的一点点信息，结果返回了整个网页内容，不但浪费了网络带宽，还需要浏览器重新渲染网页，太浪费资源了，影响了用户体验和感受。上面这些请求的过程，就是同步过程，用户发起请求，页面整个刷新，直到服务器端响应的数据到来并重新渲染。

			
		

	





	

		

			

				
					
仿Muduo库实现高并发服务器——Server.hpp框架的简单描述

				
			

			

				

					2201_75324712的博客
				

				

					08-21
					
					1331
					
				

			

		

		

			
				
下面这张图 是channel模块，poller模块，TimerWheel模块，EventLoop模块，LoopThreadPool模块进行组合。便于大家对这个项目的理解，因为代码看起来挺复杂的。下面这个图，加入了Connection模块，Buffer模块，socket模块，Acceptor模块，Tcpserver模块。算是将server.hpp，进行了框架描述。

			
		

	





	

		

			

				
					
pytest selenium allure 失败截图

				
			

			

				

					07-17
				

			

		

		

			
				
要在 pytest 和 Selenium 结合使用时，使用 Allure 进行失败截图，您可以按照以下步骤操作：

1. 确保已安装 `pytest`, `pytest-selenium` 和 `pytest-allure-adaptor`：
   ```shell
   pip install pytest pytest-selenium pytest-allure-adaptor
   ```

2. 创建一个带有 Allure 报告的测试用例文件，例如 `test_example.py`：
   ```python
   import allure
   import pytest
   from selenium import webdriver

   @pytest.fixture(scope="module")
   def setup(request):
       driver = webdriver.Chrome()
       request.cls.driver = driver
       yield
       driver.quit()

   @allure.step("示例测试步骤")
   def test_example(setup):
       with allure.step("打开网页"):
           setup.driver.get("https://www.example.com")
       
       with allure.step("断言标题"):
           assert setup.driver.title == "Example Domain"

       with allure.step("失败截图"):
           if not setup.driver.title == "Example Domain":
               allure.attach(setup.driver.get_screenshot_as_png(), name="失败截图", attachment_type=allure.attachment_type.PNG)
   ```

3. 运行测试用例并生成 Allure 报告：
   ```shell
   pytest --alluredir=./results
   ```

4. 生成 Allure 报告：
   ```shell
   allure serve ./results
   ```

在运行测试用例后，Allure 将会捕获失败的断言，并生成对应的失败截图。您可以在 Allure 报告中查看这些截图，以便更好地分析和调试测试用例的失败原因。

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

                
 1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
 2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

              

            

          

      

      余额充值