Python 与 Allure：打造卓越的测试报告

三带俩王

于 2024-09-30 11:52:13 发布

阅读量289

点赞数 4

文章标签： python 开发语言

本文链接：https://blog.csdn.net/liuhailong0511/article/details/142653582

版权

在 Python 的测试领域，生成清晰、详细且具有吸引力的测试报告是至关重要的。Allure 就是这样一个强大的工具，它能够与 Python 测试框架（如 Pytest）完美结合，为测试人员提供丰富且易于理解的测试结果展示。本文将深入探讨 Python 中的 Allure，详细阐述其概念、关键要点、安装与配置、在不同测试场景中的使用方式以及它如何提升测试流程的整体效率。

一、Allure 的概念

Allure 是一个开源的、轻量级的且灵活的测试报告框架，旨在为各种测试框架生成美观、交互式的测试报告。它不仅仅是简单地罗列测试结果，而是以一种富有逻辑且易于导航的方式呈现测试执行的整个过程，包括测试步骤、测试数据、测试结果以及可能出现的错误信息等。这使得开发人员、测试人员以及其他利益相关者能够快速理解测试的执行情况，定位问题所在。

二、关键要点

1. 丰富的报告结构

Allure 报告具有清晰的层次结构，包括套件（Suite）、测试用例（Test Case）、步骤（Step）等。

套件：可以将相关的测试用例组织在一起，形成一个逻辑上的测试集合。例如，对于一个 Web 应用的测试，可能会有登录功能套件、注册功能套件等。
测试用例：每个测试用例在报告中都有独立的展示，包括用例名称、描述、执行时间等基本信息。
步骤：在测试用例内部，可以进一步分解为多个测试步骤。这对于复杂的测试逻辑非常有用，例如在测试一个电商下单流程时，可以将选择商品、添加到购物车、结算等步骤分别展示。

2. 多种装饰器的使用

在 Python 中使用 Allure 时，装饰器起到了关键的作用。

@allure.feature：用于标记测试用例所属的功能模块。例如，@allure.feature('用户管理')表明下面的测试用例是与用户管理功能相关的。
@allure.story：进一步细化功能模块下的故事或场景。如@allure.story('用户登录')表示这是用户管理功能中的登录场景相关的测试用例。
@allure.step：用于标记测试用例中的具体步骤。这有助于在报告中清晰地展示测试执行的顺序和每个步骤的结果。例如：

import allure


@allure.feature('数学计算')
@allure.story('加法运算')
def test_addition():
    with allure.step('准备数据'):
        num1 = 1
        num2 = 2
    with allure.step('执行加法运算'):
        result = num1 + num2
    with allure.step('验证结果'):
        assert result == 3

3. 支持多种类型的附件

Allure 允许在测试报告中添加各种类型的附件，这为分析测试结果提供了更多的上下文信息。

文本附件：可以添加测试过程中的日志信息、配置文件内容等作为文本附件。例如，如果在测试过程中记录了详细的调试日志，这些日志可以作为文本附件添加到测试报告中，方便在测试失败时查看详细的运行信息。
图片附件：在进行 UI 测试或者图像处理相关的测试时，图片附件非常有用。例如，在测试一个图像裁剪功能时，可以将原始图像、裁剪后的图像作为图片附件添加到测试报告中，直观地展示测试结果。
HTML 附件：如果测试过程中有一些 HTML 格式的输出（如某些 Web 测试框架可能会生成 HTML 格式的页面元素信息），也可以将其作为 HTML 附件添加到报告中。

4. 动态生成报告内容

Allure 报告不是静态的，它能够根据测试执行的实际情况动态生成内容。

动态描述：测试用例的描述可以根据测试过程中的数据或状态动态生成。例如，在测试一个搜索功能时，可以根据搜索的关键字动态生成测试用例的描述，如@allure.description(f'搜索关键字为 {search_keyword} 的测试')。
动态步骤：测试步骤中的操作和结果也可以根据实际执行情况动态显示。这在处理一些依赖于外部数据或者随机数据的测试场景时非常有用。

三、安装与配置

1. 安装 Allure 命令行工具

首先，需要安装 Allure 命令行工具。根据操作系统的不同，可以通过不同的方式进行安装。
在 Windows 上：可以从 Allure 的官方发布页面下载 Windows 版本的安装包，然后按照安装向导进行安装。
在 Linux 上：可以使用包管理器进行安装。例如，在 Ubuntu 系统上，可以使用sudo apt - get install allure命令进行安装。

2. 在 Python 项目中安装 Allure - Pytest 插件

如果使用 Pytest 作为测试框架，需要安装allure - pytest插件。可以使用pip install allure - pytest命令进行安装。安装完成后，就可以在 Python 测试脚本中使用 Allure 相关的功能了。

四、在不同测试场景中的使用

1. 单元测试

在单元测试中，Allure 可以帮助我们更好地组织和展示测试结果。

测试函数的组织与标记：使用@allure.feature和@allure.story装饰器对单元测试函数进行标记，将不同功能的测试函数归类到不同的功能模块和故事场景下。例如，对于一个数学计算库的单元测试，可以将加法运算、减法运算等测试函数分别标记到对应的功能模块下。
详细的步骤展示：使用@allure.step装饰器在测试函数内部标记具体的计算步骤，清晰地展示每个测试函数的执行流程。

import unittest
import allure


@allure.feature('数学库单元测试')
class TestMathFunctions(unittest.TestCase):

    @allure.story('加法函数测试')
    def test_add(self):
        with allure.step('定义操作数'):
            num1 = 5
            num2 = 3
        with allure.step('调用加法函数'):
            result = num1 + num2
        with allure.step('验证结果'):
            self.assertEqual(result, 8)


if __name__ == '__main__':
    unittest.main()

2. 集成测试

在集成测试场景下，Allure 能够更好地展示不同组件之间的交互以及整个集成流程的测试结果。

组件交互的展示：通过 Allure 的报告结构，可以清晰地展示各个组件之间的调用关系和数据传递过程。例如，在测试一个电商系统的订单处理流程时，涉及到用户组件、商品组件、订单组件等之间的交互，可以将这些组件相关的测试步骤分别展示，并体现出它们之间的交互逻辑。
全局状态的跟踪：对于一些依赖于全局状态的集成测试，可以利用 Allure 的动态报告生成功能，跟踪全局状态的变化情况，并在报告中展示出来。例如，在测试一个多用户并发访问系统资源的场景下，可以将系统资源的使用状态（如数据库连接数、内存占用等）作为动态内容添加到测试报告中。
以下是一个更复杂的集成测试示例，假设我们有一个简单的用户注册与登录系统，包含用户服务、数据库服务和验证服务三个组件：

import unittest
import allure


@allure.feature('用户注册与登录系统集成测试')
class TestRegistrationAndLoginIntegration(unittest.TestCase):

    def setUp(self):
        # 这里可以初始化一些测试所需的资源，比如创建数据库连接等
        pass

    def tearDown(self):
        # 清理测试资源，如关闭数据库连接
        pass

    @allure.story('用户注册流程')
    def test_user_registration(self):
        with allure.step('准备注册信息'):
            username = "new_user"
            password = "new_password"
            email = "new_user@example.com"
        with allure.step('调用用户服务进行注册'):
            user_service_response = user_service.register(username, password, email)
        with allure.step('验证注册结果'):
            self.assertEqual(user_service_response.status_code, 200)
            self.assertEqual(user_service_response.message, "注册成功")
            # 假设注册成功后会在数据库中插入一条用户记录，这里可以检查数据库
            with allure.step('检查数据库中是否存在新用户记录'):
                database_service = DatabaseService()
                user = database_service.get_user_by_email(email)
                self.assertEqual(user.username, username)
                self.assertEqual(user.password, password)
                self.assertEqual(user.email, email)

    @allure.story('用户登录流程')
    def test_user_login(self):
        with allure.step('准备登录信息'):
            username = "existing_user"
            password = "existing_password"
        with allure.step('调用用户服务进行登录'):
            user_service_response = user_service.login(username, password)
        with allure.step('验证登录结果'):
            self.assertEqual(user_service_response.status_code, 200)
            self.assertEqual(user_service_response.message, "登录成功")
            # 假设登录成功后会进行身份验证，这里可以检查验证服务
            with allure.step('检查验证服务是否通过'):
                verification_service = VerificationService()
                is_verified = verification_service.verify_user(user_service_response.session_token)
                self.assertTrue(is_verified)


if __name__ == '__main__':
    unittest.main()

3. 功能测试（特别是 Web 功能测试）

在 Web 功能测试中，Allure 可以与 Selenium 等 Web 测试工具结合使用，提供丰富的测试报告。

页面操作的详细记录：使用@allure.step装饰器记录在 Web 页面上的各种操作，如打开页面、点击按钮、输入文本等操作步骤。例如：

import allure
from selenium import webdriver


@allure.feature('Web登录功能测试')
@allure.story('正常登录')
def test_web_login():
    driver = webdriver.Chrome()
    with allure.step('打开登录页面'):
        driver.get('https://example.com/login')
    with allure.step('输入用户名'):
        username = "testuser"
        driver.find_element_by_id('username').send_keys(username)
    with allure.step('输入密码'):
        password = "testpassword"
        driver.find_element_by_id('password').send_keys(password)
    with allure.step('点击登录按钮'):
        driver.find_element_by_css_selector('button.login - button').click()
    with allure.step('验证登录成功'):
        assert "欢迎回来" in driver.page_source
    driver.quit()

页面截图的添加：在测试过程中，当出现错误或者关键操作时，可以添加页面截图作为附件。例如，当登录失败时，可以添加当前页面的截图，以便快速定位问题是出在用户名输入框、密码输入框还是登录按钮等地方。

以下是一个更完整的 Web 功能测试示例，包含登录、搜索商品和添加到购物车的功能测试：

import allure
from selenium import webdriver
import unittest


@allure.feature('Web购物功能测试')
class TestWebShopping(unittest.TestCase):

    def setUp(self):
        self.driver = webdriver.Chrome()

    def tearDown(self):
        self.driver.quit()

    @allure.story('用户登录')
    def test_login(self):
        with allure.step('打开网站首页'):
            self.driver.get('https://example.com')
            allure.attach(self.driver.get_screenshot_as_png(), name='首页截图', attachment_type=allure.attachment_type.PNG)
        with allure.step('点击登录链接'):
            self.driver.find_element_by_link_text('登录').click()
        with allure.step('输入用户名'):
            username = "testuser"
            self.driver.find_element_by_id('username').send_keys(username)
        with allure.step('输入密码'):
            password = "testpassword"
            self.driver.find_element_by_id('password').send_keys(password)
        with allure.step('点击登录按钮'):
            self.driver.find_element_by_css_selector('button.login - button').click()
        with allure.step('验证登录成功'):
            assert "欢迎回来" in self.driver.page_source

    @allure.story('搜索商品')
    def test_search_product(self):
        with allure.step('登录后进入搜索页面'):
            self.driver.get('https://example.com/search')
        with allure.step('输入搜索关键字'):
            search_keyword = "手机"
            self.driver.find_element_by_id('search - box').send_keys(search_keyword)
        with allure.step('点击搜索按钮'):
            self.driver.find_element_by_css_selector('button.search - button').click()
        with allure.step('验证搜索结果页面显示相关商品'):
            product_titles = self.driver.find_elements_by_css_selector('.product - title')
            for title in product_titles:
                assert search_keyword in title.text

    @allure.story('添加商品到购物车')
    def test_add_to_cart(self):
        with allure.step('搜索商品后选择一个商品'):
            product_link = self.driver.find_element_by_css_selector('.product - link:first - child')
            product_link.click()
        with allure.step('在商品详情页面点击添加到购物车按钮'):
            add_to_cart_button = self.driver.find_element_by_css_selector('button.add - to - cart')
            add_to_cart_button.click()
        with allure.step('验证购物车中商品数量增加'):
            cart_count = self.driver.find_element_by_css_selector('.cart - count').text
            assert int(cart_count) > 0


if __name__ == '__main__':
    unittest.main()

五、Allure 如何提升测试流程的整体效率

1. 快速定位问题

Allure 报告的详细结构和丰富信息使得开发人员和测试人员能够快速定位测试失败的原因。无论是通过查看详细的测试步骤、附件内容还是动态生成的描述信息，都可以在最短的时间内找到问题所在，减少排查问题的时间成本。

2. 增强团队协作

清晰、美观的测试报告有助于不同角色之间的协作。开发人员可以通过测试报告了解测试人员的测试思路和测试场景，测试人员也可以通过报告向开发人员准确地反馈测试结果和问题。这种透明的测试结果展示方式可以避免因信息不对称而导致的沟通障碍，提高团队协作的效率。

3. 测试结果的可视化与可追溯性

Allure 的交互式报告提供了可视化的测试结果展示，使得测试结果易于理解和分享。同时，由于报告中详细记录了测试执行的各个环节，具有良好的可追溯性。这对于回归测试、缺陷跟踪以及质量保证等方面都具有重要的意义。

六、总结

Python 与 Allure 的结合为测试领域带来了一种强大的解决方案。通过 Allure 丰富的报告结构、多种装饰器的使用、支持多种类型的附件以及动态生成报告内容等关键要点，我们能够在不同的测试场景（单元测试、集成测试、功能测试等）中生成高质量的测试报告。并且，Allure 在提升测试流程的整体效率方面表现出色，能够帮助我们快速定位问题、增强团队协作以及提供可视化和可追溯的测试结果。无论是对于小型项目还是大型企业级应用的测试，Allure 都是一个值得推荐的测试报告工具。