Pytest + Allure2 搭建可视化测试框架

已于 2023-12-11 08:59:47 修改
阅读量292 收藏 3
点赞数
分类专栏： Python 文章标签： pytest python
于 2023-12-08 18:06:43 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fyhju1/article/details/134849356
版权

上文我们刚刚学习了pytest基本详解,这篇文章将结合Allure，搭建自动可视化测试框架

Pytest 基础详解-CSDN博客

T0 全文案例源码

python-pytest-allureicon-default.png?t=N7T8https://gitee.com/nicckco/study-python/tree/master/python-pytest-allure

T1 关于Allure

        Allure Report 是一种灵活的多语言测试报告工具，可向您展示已测试内容的详细表示，并从日常测试执行中提取最大程度的信息。

Allure Report 能够为多个 CI/CD 系统上跨 11 种编程语言的数十种测试工具构建统一的报告。

官网地址：Allure Report — Open-source HTML test automation report tool

官方文档：Allure Report Docs — Documentation Overview

T2 安装Allure

T2-1 下载并配置

        首先保证你已安装java,且运行环境在jdk1.8及以上

        Allure下载地址：https://github.com/allure-framework/allure2/releases

        选择合适的版本，下载解压，并配置path环境变量，路径指引到allure的bin文件夹下

 

T2-2 校验

校验是否安装成功

allure --version

T2-3 安装allure-pytest

        allure-pytest是python的一个第三方库。用于连接pytest和allure，使它们可以配合在一起使用。
        allure-pytest基于pytest的原始执行结果生成适用于allure的json格式结果。该json格式结果可以用于后续适用allure生成html结果。

pip install allure-pytest

T3 项目搭建

       创建一个全新的python项目，T3基本结构如下

       * outputs文件夹是自动生成的报表，先不用管

        

T3.1 根目录

  • 在项目根目录下面新建一个app.py, 作为项目的启动文件
# 使用pytest收集所有的测试用例并运行，输出allure报告
import pytest
import os


# 生成JSON数据,加上--clean-alluredir解决JSON文件生成冗余问题
pytest.main()
# 命令：pytest -v -s --alluredir=outputs/reports/allure --clean-alluredir

# 将JSON文件转换成HTML格式的测试报告（生成JSON文件路径：outputs/reports/allure; 生成HTML报告路径：outputs/reports/html）
os.system("allure generate outputs/reports/allure -o outputs/reports/html --clean")
# 命令：allure generate outputs/reports/allure -o outputs/reports/html --clean
# 打开测试报告
os.system("allure serve outputs/reports/allure")
# 命令：allure serve outputs/reports/allure

  • 在项目根目录下面新建一个pytest.ini, 作为项目的配置文件
#配置pytest命令行运行参数
[pytest]
# 空格分隔，可添加多个命令行参数 -所有参数均为插件包的参数配置测试搜索的路径
addopts=-vs --alluredir=outputs/reports/allure --clean-alluredir

testpaths=testdemos  # 当前目录下的scripts文件夹 -可自定义

# 配置测试搜索的文件名称
# 当前目录下的scripts文件夹下，以test开头，以.py结尾的所有文件 -可自定义
python_files=test*.py

# 测试文件夹下，测试类名称-可自定义
python_classes=Test_*
 
# 测试类下，测试用例名称-可自定义
python_functions=test_*

T3.2 测试案例

        上面的pytest.init已经定义了测试案例需要放在testdemos文件夹下面

  • step1: 在项目根目录，新建testdemos文件夹
  • step2：在testdemos文件夹下面，新建一个测试案例文件：test_case1.py 

testcase1.py

import pytest


@pytest.mark.parametrize("name,age,sex", [('张三',22,'男孩')])
def test_one(name,age,sex):
    print('我的名字叫%s,我今年%d岁了，我是一个%s' %(name,age,sex))
    pass


@pytest.mark.parametrize("a,b", [(22,15),(20,24)])
def test_two(a,b):
    assert a > b

T4 运行展示

        运行app.py，项目启动后会自动打开allure视图页面

T5 allure语法

        allure提供测试案例命名的功能，同时也能对相应的功能场景做出备注等等

        

T5.1 allure.feature 和 allure.epic

        allure.epic 主题，对class 类进行分组管理，相当于总体的描述，

        allure.feature  特性，修饰class类，对其进行描述，如class A ,classB

        * 一般情况，story和title都是对class 类进行修饰

语法：

@allure.feature("类A)
class A():

 

  • 这里，我们在testdemos文件夹下，新建test_case2.py
import pytest
import allure

@allure.epic('会员')
@allure.feature("会员中心")
class Test_MemberCenter():
    
    def test_member(self):
        pass
    

@allure.epic("会员")
@allure.story("会员数据")
class Test_MemberData():
    
    def test_data(self):
        pass
  • 运行app.py,效果如下：（点击behaviors可以看到备注，注：在suites下面是看不到备注的）

        这里我们可以看到

                calss  Test_MemberCenter: 已经被备注为'会员中心'，且在'会员'结构下

                class Test_MemberData: 已经被备注为'会员数据'，且在'会员'结构下

  • 结论：
    • epic 是一级类目； feature则属于是二级类目，位于一级类目下
    • feature修饰class 类，对其进行备注，epic则包含多个class

T5.2 allure.story 和 allure.title

        allure.story 对测试案例进行分组管理，如：登录

        allure.title  对测试案例进行命名备注，如：密码登录 ,手机号登陆

        * 一般情况，story和title都是对测试案例进行修饰

语法：

@allure.story('故事1')
def test_case2(self):
    pass

 

  • 这里，我们在test_case2.py文件夹下进行修改
import pytest
import allure

@allure.epic('会员')
@allure.feature("会员中心")
class Test_MemberCenter():

    @allure.story('登录')
    @allure.title('密码登录')
    def test_login_pwdLogin(self):
        pass

    @allure.story('登录')
    @allure.title('手机号登录')
    def test_login_mobileLogin(self):
        pass


    @allure.story('退出')
    @allure.title('退出登录')
    def test_out_login():
        pass
    

@allure.epic("会员")
@allure.story("会员数据")
class Test_MemberData():
    
    def test_data(self):
        pass
  • 运行app.py,效果如下：（点击behaviors可以看到）

  • 结论：（epic - > feature -> story -> title ）
    • epic：主题，包含class类，属于一级栏目
    • feature：位于epic下，包含story，属于二级栏目
    • story ：故事，包含title，属于三级栏目
    • title : 篇章，位于story下，属于四级栏目

T5.3 allure.step

        allure.step 步骤 ,放置于测试案例之外，用于备注测试案例操作流程

        with allure.step 步骤，放置于测试案例之内，用于备注测试案例操作流程

语法：

with allure.step('第二步'):
    pass

 

  • 这里，我们在test_case2.py文件夹下进行修改
import pytest
import allure

@allure.epic('会员')
@allure.feature("会员中心")
class Test_MemberCenter():

    @allure.story('登录')
    @allure.title('密码登录')
    def test_login_pwdLogin(self):
        with allure.step('校验账户名'):
            pass
        with allure.step("校验密码"):
            pass
        with allure.step('登录成功'):
            pass
        pass

    @allure.story('登录')
    @allure.title('手机号登录')
    def test_login_mobileLogin(self):
        with allure.step('校验手机号'):
            pass
        with allure.step("校验密码"):
            print("密码错误！")
            assert 1 == 2
        with allure.step('登录成功'):
            pass
        pass


    @allure.story('退出')
    @allure.title('退出登录')
    @allure.step('退出步骤')
    def test_out_login(self):
        pass
    

@allure.epic("会员")
@allure.story("会员数据")
class Test_MemberData():
    
    def test_data(self):
        pass
  • 运行app.py,效果如下：（点击behaviors可以看到） 

T5.4 allure跳转链接

        allure 提供 在测试报告中添加链接地址的方式

        allure.link: 跳转链接

        allure.issure：跳转链接，一般特指需求或BUG链接地址

        allure.testcase: 跳转链接，一般特指测试案例的地址

        这三者都是跳转链接，不过涵义不一样（当然你不关心这个涵义，其实都一样，没区别）

@allure.link("http://www.xxx.com", name="跳转xxx")
def test_link_baidu():
    pass

 

  • 这里，在testmodes文件夹下，我们新建test_case3.py文件，写入下列内容
import pytest
import allure

@allure.epic('链接')
@allure.feature('链接中心')
class Test_Link():

    @allure.story("跳转链接")
    @allure.title('跳转百度')
    @allure.link("https://www.baidu.com/", name="百度URL")
    def test_link_go_baidu(self):
        pass

    
    @allure.story("跳转链接")
    @allure.title('跳转阿里云')
    @allure.issue("https://help.aliyun.com/zh/ecs/?spm=0.0.0.0/", name="阿里云帮助中心")
    def test_link_issue_aliyun(self):
        pass

    
    @allure.story("跳转链接")
    @allure.title('跳转京东')
    @allure.testcase("https://jd.com/", name="跳转京东")
    def test_link_testcase_jd(self):
        pass
  • 运行app.py,效果如下：（点击Links #阿里云帮助中心#会跳转到指定链接） 

T5.5 allure标志安全级别

        通常我们进行上线时测试，我们会对重要的功能进行测试，那么那些指定重要的功能，这里allure提供一种方法

语法：

    @allure.severity(allure.severity_level.TRIVIAL)
    def test_one():
        pass
  • allure.severity可以标记案例的安全级别：
    • Trivial级别：不重要
    • Minor级别：不太重要
    • Normal级别：正常
    • Critical级别：严重
    • Blocker级别：阻塞

  • 这里，在testmodes文件夹下，我们新建test_case4.py文件，写入下列内容
import pytest
import allure

@allure.epic('安全')
@allure.feature('安全中心')
class Test_safe():

    @allure.story("安全级别")
    @allure.title('Trivial:不重要')
    @allure.severity(allure.severity_level.TRIVIAL)
    def test_safe_trivial(self):
        pass

    
    @allure.story("安全级别")
    @allure.title('Minor:不太重要')
    @allure.severity(allure.severity_level.MINOR)
    def test_safe_Minor(self):
        pass

    
    @allure.story("安全级别")
    @allure.title('Normal:正常')
    @allure.severity(allure.severity_level.NORMAL)
    def test_safe_Normal(self):
        pass
    
    @allure.story("安全级别")
    @allure.title('Critical:严重')
    @allure.severity(allure.severity_level.CRITICAL)
    def test_safe_Critical(self):
        pass

    @allure.story("安全级别")
    @allure.title('Blocker:严重')
    @allure.severity(allure.severity_level.BLOCKER)
    def test_safe_Blocker(self):
        pass
  • 运行app.py,效果如下：

T5.6 allure.attach

        allure.attach可以帮助你在测试报告中，添加文本，文件，代码

语法：

allure.attach("纯文本", attachment_type=allure.attachment_type.TEXT)

 

  • 这里，在testmodes文件夹下，我们新建test_case5.py文件，写入下列内容
import pytest
import allure

@allure.epic('附加')
@allure.feature('附加中心')
class Test_Catch():
    
    @allure.title('附加文本')
    def test_attach_text(self):
        allure.attach("纯文本", attachment_type=allure.attachment_type.TEXT)
 

    @allure.title('附加html')
    def test_attach_html(self):
        allure.attach("<body>这是一段htmlbody块</body>", "html页面", attachment_type=allure.attachment_type.HTML)
    
    
    @allure.title('附加图片')
    def test_attach_photo(self):
        allure.attach.file("files/catch.jpg", name="图片", attachment_type=allure.attachment_type.JPG)
  • 运行app.py,效果如下：

T6 allure集成selenium

        如果你想在你的测试报告中引入web自动化工具，可以在allure中引入selenium

T6.1 安装selenium

        如果之前未安装selenium，使用下列命令安装：

pip install selenium

T6.2 引入selenium

  • 这里，在testmodes文件夹下，我们新建test_case6.py文件，写入下列内容
import allure
import pytest
from selenium import webdriver
from selenium.webdriver.common.by import By
import time
 


@allure.epic('selenium')
@allure.feature('web中心')
class Test_Web():

    @allure.title("效果展示")
    def test_steps_demo(self):
        driver = webdriver.Chrome()
        driver.get("https://www.baidu.com")
        
        # 程序会找到搜索框，然后自动输入allure文本
        driver.find_element(By.ID,"kw").send_keys('allure')
        
        # 程序自动点击搜索按钮
        driver.find_element(By.ID,"su").click()

        # 等待三秒钟，等查询出结果后再截图保存
        time.sleep(3)
        driver.save_screenshot("./files/catch2.png")

        allure.attach.file("./files/catch2.png", attachment_type=allure.attachment_type.PNG)
        allure.attach('<head></head><body>首页</body>', 'Attach with HTML type', allure.attachment_type.HTML)
  • 运行app.py,效果如下：

        注：这个案例会有几秒等待，中间不需要做任何操作，不要操作打开的chrome，所有操作由存续自动运行，直到测试报告生成为止

fyhju1
关注
专栏目录
allure下载安装zip文件
07-11
直接解压，配置环境变量path到bat文件的目录即可
allure下载及使用
weixin_44968870的博客
10-23 9199
allure安装及使用
allure安装下载
最新发布
qq_42792477的博客
08-18 319
下载地址：https://github.com/allure-framework/allure2/releasesallure环境变量配置。
自动化测试基础——allure下载安装及配置及pytest + allure-pytest插件生成allure企业级测试报告及企业级定制
又菜又爱玩的小熊
03-04 9189
allure是一个java测试报告框架。所以要基于JDK环境bin：命令文件config：配置文件lib：存放jar包plugins：插件。
Allure小白下载安装
angboom的博客
03-07 2171
1、下载官网地址：https://github.com/allure-framework/allure2/releases。5、pycharm安装allure-pytest插件。4、CMD查看安装allure --version。2、下载安装包后需要解压到一个非中文名称路径下。我的电脑右键选择属性，高级系统设置，环境变量。
allure下载、安装、配置
热门推荐
gaomingjian218的博客
10-31 1万+
第一步： allure下载网址： https://github.com/allure-framework/allure2/releases 下载的包可放任意位置，下载allure之后将bin路径配置到环境变量中，重启电脑。 在控制台输入：allure --version 出现版本号说明安装配置成功 第二步： 使用allure allure测试报告python控制台安装命令：pip allure-pytest ...
python+pytest+yaml+ddt+allure的接口自动化测试框架(测)
10-14
本篇文章将详细解析一个基于Python、pytest、yaml、ddt和allure的接口自动化测试框架，帮助你理解和构建自己的测试解决方案。 1. **Python**: Python是一种高级编程语言，因其简洁的语法和丰富的库支持，成为自动化...
Airtest+Pytest+Allure框架demo
04-16
本示例项目"Airtest+Pytest+Allure框架demo"旨在展示如何构建一个强大的自动化测试体系，结合了三个强大的工具：Airtest、Pytest和Allure。下面将详细解释这三个工具及其在自动化测试中的应用。 首先，Airtest是一...
python+pytest+yaml+ddt+allure的接口自动化测试框架
07-15
这些资料，对于做接口测试的朋友来说应该是最正确的选择，这个框架的学习也使我进步了不少，如果你也想要学习自动化接口测试，希望也能帮助到你！凡事要趁早，特别是技术行业，一定要提升技术功底。希望对大家有所...
基于python+pytest+requests+yaml+allure接口自动化测试框架项目源码.zip
03-10
Allure支持多种测试框架，包括pytest，它提供了一种方式来可视化测试结果，包括测试步骤、断言、异常信息等，这对于理解和分析测试结果非常有帮助。 在`api_test-main`目录下，我们可以预期找到以下结构： - 测试...
python+requests+pytest+allure+yaml+DDT+logs 接口自动化框架终极版
06-07
框架代码已封装 小白 3行代码即可实现接口自动化 ...6接口自动化框架封装之规范YAML测试用例&接口关联封装改进&基础路径封装改进 7热加载封装以及断言封装 8数据类型处理以及DDT数据驱动封装 9异常日志与BaseUrl封装
python中pytest收集用例规则与运行指定用例详解
12-26
前言 上篇文章相信大家已经了解了pytest在cmd下结合各种命令行参数如何运行测试用例，并输出我们想要看到的信息。那么今天会讲解一下pytest是如何收集我们写好的用例？我们又有哪些方式来运行单个用例或者批量运行用例呢？下面将为大家一一解答！ pytest收集用例原理分析 首先我们按照如下目录结构新建我们的项目 [pyttest搜索测试用例的规则] |[测试用例目录1] | |__init__.py | |test_测试模块1.py | |test_测试模块2.py |[测试用例目录2] | |__init__.py | |test_测试用例1.py | |测试用例.py |test_
Allure的下载和部署
牧魂的博客
09-15 752
allure的下载和部署
Python——allure安装教程
weixin_45464162的博客
04-02 4231
1、有时会出现allure不是外部命令等类似提示，这时只需要关闭pycharm，重启即可。打开终端命令行，输入allure或者allure --version。在终端命令行中输入pip install allure-pytest。2、生成报告后，在对应的报告路径下无法打开index.html。(2) bat文件内容为：allure open report。将解压后的allure的bin目录配置到系统变量的Path中。(1) 在项目根目录下，创建一个bat文件。(3) 双击运行bat文件，复制URL打开。
Allure的安装及配置
Carlos_Zhf的博客
12-16 4760
解决allure命令在pycharm没有存在的问题
allure安装教程
weixin_40482973的博客
06-27 693
Note: 由于 allure-pytest插件版本2.13.2 与Allure版本2.13.0兼容，所以此处下载安装了。看看环境变量中JAVA_HOME中的内容是否配置正确（我是配置jmeter时这里配错了）Ctr+R ->重新打开一个cmd 窗口 --> allure。选择一个版本（windows下载.zip包就可以）Allure版本2.13.0。
Allure 安装与使用
weixin_57632548的博客
08-04 7318
7.1 pytest执行测试用例并将执行后的每个测试用例的结果存放于指定的文件夹中，生成一个个的json或者xml文件（allure测试报告原始数据）。【其中，生成的报告都以json格式存储，日志以txt后缀名文件存储，附件是以attach后缀名文件存储】执行完成上述命令后，会在当前目录下，report/json 目录下生成 *.json、*.txt、日志、*.attach 后缀的文件；7.2 allure将测试报告的原始数据生成测试报告。
pytest系列—allure安装与环境变量配置(windows+Mac)
DY_CSDN的博客
04-23 7959
3、环境变量 ----》新增环境编辑 ----》添加 D:\software\Python_install\allure-2.19.0\bin ---》保存。可以输出非常精美的测试报告，也可以和pytest进行完美结合，不仅可以渲染页面，还可以控制用例的执行。下面就对allure的使用进行一个详细的介绍和总结。1、复制路径如：D:\software\Python_install\allure-2.19.0\bin。2、电脑底部搜索处输入：path。此时allure安装配置成功！allure用例描述。
怎么从0到1使用 Docker + Jenkins + Git + Pytest + Allure 搭建项目自动化框架
05-30
以下是从0到1使用 Docker + Jenkins + Git + Pytest + Allure 搭建项目自动化框架的步骤： 1. 安装 Docker 并启动 Docker 服务。Docker 是一个容器化平台，可以在容器中部署应用程序和服务。 2. 在 Docker 中安装 Jenkins。Jenkins 是一个开源的自动化工具，可以用于自动化构建、测试和部署软件。 3. 在 Git 上创建一个新的代码仓库，用于存储项目代码。Git 是一个分布式版本控制系统，可以用于管理代码的版本和变更历史记录。 4. 在 Jenkins 中创建一个新的项目，用于自动化构建和测试项目代码。在 Jenkins 中配置 Git 仓库的地址和凭据信息，以便 Jenkins 可以从 Git 仓库中拉取代码。 5. 在 Jenkins 中配置构建步骤，包括在 Docker 中构建应用程序的 Docker 镜像，运行 Pytest 测试套件，生成 Allure 测试报告等。 6. 在 Jenkins 中配置后续步骤，例如将 Docker 镜像推送到 Docker Hub 或者私有的 Docker 仓库中，或者部署应用程序到生产环境中。 7. 在 Docker 中安装 Pytest 和 Allure，用于运行测试套件并生成测试报告。Pytest 是一个 Python 测试框架，可以用于编写和运行测试用例。Allure 是一个测试报告框架，可以用于生成漂亮的测试报告。 8. 在 Docker 中运行 Pytest 测试套件，并使用 Allure 生成测试报告。 9. 在 Jenkins 中配置测试报告的发布步骤，以便 Jenkins 可以将测试报告发布到 Jenkins 服务器中，并将测试报告链接发送给相关人员。 以上是从0到1使用 Docker + Jenkins + Git + Pytest + Allure 搭建项目自动化框架的步骤。需要注意的是，这只是一个基本的框架搭建流程，具体的实现方式和细节需要根据实际情况进行调整和修改。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值