Allure 在 Python 中的安装与使用

2024-05-12 17:20
文章标签 python 安装 使用 allure

本文主要是介绍Allure 在 Python 中的安装与使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Allure 是一个灵活轻量级的测试报告工具,它能够生成详细且富有洞察力的测试报告。在 Python 中,Allure 通常与 Pytest 结合使用,以提供更加丰富的测试结果展示。下面我将介绍关于如何在 Python 中使用 Allure 的详细操作。

一、环境准备

在开始之前,确保你的环境中已经安装了 Python 和 Pytest。接下来,你需要安装 Allure 的命令行工具和 Python 库。

安装 Allure 命令行工具:

pip install allure-cmdline

安装 Allure Python 库:

pip install allure-pytest

二、编写测试用例

创建一个 Python 文件,比如 test_example.py,并编写以下代码:

import pytest
import allure# 定义一个测试函数,使用 allure 的 feature 来标记测试的特性
@allure.feature("加法运算测试")
class TestAddition:# 使用 allure 的 story 来标记具体的测试场景@allure.story("测试两个正数相加")def test_add_positive_numbers(self):# 一个简单的断言assert 3 + 4 == 7# 使用 pytest 的 parametrize 来实现参数化测试 @pytest.mark.parametrize("x,y,expected", [(1, 2, 3), (3, 4, 7)])@allure.story("测试加法的参数化场景")def test_add_with_parameters(self, x, y, expected):# 参数化测试的断言assert x + y == expected# 使用 allure 的 step 来记录测试步骤
@allure.step("执行加法操作")
def add_and_print_result(x, y):result = x + yprint(f"The result of {x} + {y} is {result}")return result# 测试用例中使用 allure step
def test_add_step(self):with allure.step("步骤1:输入两个参数"):x = 2y = 3result = add_and_print_result(x, y)with allure.step("步骤2:验证结果"):assert result == 5

三、运行测试用例

使用 Pytest 运行测试,并生成 Allure 报告:

pytest test_example.py --alluredir=allure-results

这条命令会执行 test_example.py 中的测试用例,并将 Allure 报告的生成结果存放在 allure-results 目录中。

四、生成 Allure 报告

在命令行中使用 Allure 命令行工具生成报告:

allure serve allure-results

执行该命令后,Allure 会启动一个本地服务器,并在默认的 Web 浏览器中打开生成的 Allure 报告。

五、Allure 报告的定制化

Allure 报告支持定制化,你可以通过添加不同的注解来丰富报告的内容。

自定义描述

使用 allure.description 来为测试用例添加描述:

@allure.description("""
这是一个复杂的测试用例,它执行多个步骤来验证登录流程。
""")
def test_complex_login(self):# ...

附件

你可以在测试用例中添加附件,比如截图或文本日志:

def test_with_attachment(self):with allure.step("生成报告并附加日志"):allure.attach("这是日志文件的内容", body="文本内容", attachment_type=allure.attachment_type.TEXT)

六、总结

Allure 是一个功能强大的测试报告工具,它能够提供清晰、易于理解的测试结果。通过上述步骤,你可以在 Python 中轻松地使用 Allure 来增强你的测试报告。

七、附录

  • Allure 官方文档:Allure GitHub
  • Pytest 插件:allure-pytest 安装和使用说明。

这篇关于Allure 在 Python 中的安装与使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/983250

相关文章

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流(parallelStream)的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS

Linux join命令的使用及说明

《Linuxjoin命令的使用及说明》`join`命令用于在Linux中按字段将两个文件进行连接,类似于SQL的JOIN,它需要两个文件按用于匹配的字段排序,并且第一个文件的换行符必须是LF,`jo... 目录一. 基本语法二. 数据准备三. 指定文件的连接key四.-a输出指定文件的所有行五.-o指定输出

Linux jq命令的使用解读

《Linuxjq命令的使用解读》jq是一个强大的命令行工具,用于处理JSON数据,它可以用来查看、过滤、修改、格式化JSON数据,通过使用各种选项和过滤器,可以实现复杂的JSON处理任务... 目录一. 简介二. 选项2.1.2.2-c2.3-r2.4-R三. 字段提取3.1 普通字段3.2 数组字段四.

Linux kill正在执行的后台任务 kill进程组使用详解

《Linuxkill正在执行的后台任务kill进程组使用详解》文章介绍了两个脚本的功能和区别,以及执行这些脚本时遇到的进程管理问题,通过查看进程树、使用`kill`命令和`lsof`命令,分析了子... 目录零. 用到的命令一. 待执行的脚本二. 执行含子进程的脚本,并kill2.1 进程查看2.2 遇到的

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储:配置灵活性:编码示例引入依赖:配置ehcache.XML文件:配置

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程?1.2 为什么需要虚拟线程?二、虚拟线程与平台线程对比代码对比示例:三

k8s按需创建PV和使用PVC详解

《k8s按需创建PV和使用PVC详解》Kubernetes中,PV和PVC用于管理持久存储,StorageClass实现动态PV分配,PVC声明存储需求并绑定PV,通过kubectl验证状态,注意回收... 目录1.按需创建 PV(使用 StorageClass)创建 StorageClass2.创建 PV

Python版本信息获取方法详解与实战

《Python版本信息获取方法详解与实战》在Python开发中,获取Python版本号是调试、兼容性检查和版本控制的重要基础操作,本文详细介绍了如何使用sys和platform模块获取Python的主... 目录1. python版本号获取基础2. 使用sys模块获取版本信息2.1 sys模块概述2.1.1

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,:本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D

Python函数作用域与闭包举例深度解析

《Python函数作用域与闭包举例深度解析》Python函数的作用域规则和闭包是编程中的关键概念,它们决定了变量的访问和生命周期,:本文主要介绍Python函数作用域与闭包的相关资料,文中通过代码... 目录1. 基础作用域访问示例1:访问全局变量示例2:访问外层函数变量2. 闭包基础示例3:简单闭包示例4