自动化测试(三):接口自动化pytest测试框架

文章目录

  • 1. 接口自动化的实现
  • 2. 知识要点及实践
    • 2.1 requests.post传递的参数本质
    • 2.2 pytest单元测试框架
      • 2.2.1 pytest框架简介
      • 2.2.2 pytest装饰器
      • 2.2.3 断言、allure测试报告
      • 2.2.4 接口关联、封装改进
    • 2.3 pytest接口封装(统一请求封装)
  • 参考

1. 接口自动化的实现

API:Application Programming Interface
接口自动化按照自动化的工具可分为

基于接口测试工具的接口自动化

  • eg1:Postman+Newman+git/Svn+Jenkins(基于Javascript语言)接口自动化

Postman:创建和发送 API 请求,并对响应进行断言和验证。
Newman: Postman 的命令行工具,它允许测试人员在没有界面的情况下运行 Postman 集合。常用于在 CI/CD 流程中自动化运行 API 测试。
Git:版本控制工具
Jenkins:CI/CD 流程中用于自动化构建、测试和部署应用程序。可以设置定期或事件触发的构建任务,将 Postman 集合和 Newman 集成到自动化测试流程中。
持续集成(Continuous Integration)和持续交付(Continuous Delivery): CI在每次代码提交时自动触发构建和测试过程,CD自动将构建通过多个环境(如开发、测试、预生产)传递到生产环境以确保软件随时可以被部署到生产环境。

  • eg2:Jmeter+Ant+Git/Svn+Jenkins(基于Java和BeanShell语言)接口自动化

JMeter:性能测试工具,可模拟多种负载和场景,以测试 API 的性能和可靠性。
Ant:用于自动构建和部署 Java 项目的构建工具。它可以用来执行 JMeter 测试计划并生成测试报告。

基于代码的接口自动化(本质是轻量型的框架)

  • Python为主(复杂脚本比Java简单),常用第三方库

Requests:与 API 和网络服务的交互
PyYAML :在 Python 中解析和生成 YAML 数据。YAML 是一种轻量级的数据序列化格式,常用于配置文件和数据交换。

XML&Json&YAML:在作为配置文件的时候,这三种格式都很常用;在数据传输的时候, XML和JSON很常见, 尤其是JSON,在API的开发中现在变得越来越普及;从文件大小上来说, 同样的数据集。YAML文件最小, JSON次之,XML最大。

pytest:pytest 是 Python 中广泛使用的测试框架,使编写测试用例更加便捷。
Allure:allure-pytest 是 pytest 的插件,用于生成详细且吸引人的测试报告,与 Allure 测试报告框架集成。
logging:logging 是 Python 内置的日志模块,用于记录应用程序运行时的消息,方便调试和监控。

基于平台的接口自动化:测试开发。

平台能够跟进产品序列

本接口自动化及pytest测试实践属于代码自动化

2. 知识要点及实践

2.1 requests.post传递的参数本质

body
自动化测试(三):接口自动化pytest测试框架_第1张图片
自动化测试(三):接口自动化pytest测试框架_第2张图片
Response对象:
自动化测试(三):接口自动化pytest测试框架_第3张图片

2.2 pytest单元测试框架

默认测试用例规则:

  1. 模块名(,py文件)以test_开头或者_test结尾
  2. 类名必须Test开头
  3. 用例名必须以test_开头

  采用自动化测试(一)的Google翻译爬虫接口的一个小案例,比如:
  测试库名test_Google_tran
  测试模块名test_Tran_API.py
  测试类名TestAPI
  测试用例名test_post_message
自动化测试(三):接口自动化pytest测试框架_第4张图片

2.2.1 pytest框架简介

框架作用:

  1. 发现用例:根据pytest框架默认的规则去发现并且加载测试用例
  2. 执行用例:将测试用例按照一定的顺序和条件执行并生成结果
  3. 判断结果:通过断言来判断实际结果和预测结果是否相同
  4. 生成报告:统计测试进度、耗时、通过率,生成报告。

PS:可以和很多工具,比如selenium,appium等结合使用,可以使用很多插件,比如allure。

插件举例 (插件本质也是第三方库):

  • allure-pytest:生成allure报告
  • pytest-cov:用于代码覆盖率分析。生成代码覆盖率报告,帮助了解测试覆盖的情况。
  • pytest-html:生成漂亮的 HTML 格式测试报告,包括测试结果、用例名称、时间等信息,方便查看和分享。
  • pytest-xdist:允许并行运行测试,多线程加速测试过程。适用于拥有多个 CPU 核心的机器。
  • pytest-ordering:标记测试用例的执行顺序
  • pytest-selenium:支持使用 Selenium 进行 Web UI 测试。
  • pytest-returnfailers:失败用例重跑
  • pytest-base-url:管理基础路径

框架结构:(命名规则影响到框架检索)
LearningAutoTesting/
   |- common/ --封装库名
   |    |- api.py
   |    |- …
   |- testcase/ --测试库名
   |    |- test_api.py --测试模块名
   |    |- …
   |- run.py --测试用例运行
   |- conftest.py --全局测试配置
   |- requirements.txt --依赖名

用例的执行
可以直接运行run.py:pytest.main([‘–capture=sys’])
可以在LearningAutoTesting路径下用命令行pytest -vs

  注意pytest.ini配置文件,框架会自动检索并用于配置pytest 运行测试时的一些参数和选项。pytest.ini 文件为整个项目设置一致的默认配置,提高了可维护性和可读性。下面是配置文件常用内容举例:
自动化测试(三):接口自动化pytest测试框架_第5张图片

执行测试用例前后的操作:

方法一:同unittest
  在 pytest 中,用于在测试用例执行前后执行操作的关键字是 setup 和 teardown,但是在 pytest 中,更推荐使用 setup 和 teardown 的变种,即 setup_method 和 teardown_method。

setup_method:在每个测试方法(测试用例)执行前都会调用。适用于需要在每个测试之前执行初始化操作的情况。
teardown_method:在每个测试方法执行后都会调用。适用于需要在每个测试之后执行清理操作的情况。
setup_class :在整个测试类的生命周期中只会执行一次,不同于 setup_method。

方法二:采用fixture固件,灵活设置方法的前后操作。

Python 中的装饰器是一种特殊的语法和功能,用于修改或增强函数或类的行为。装饰器可以在不修改原始函数或类代码的情况下,对它们进行功能性的扩展、修改或包装。装饰器通常是函数,它接受一个函数或类作为参数,并返回一个新的函数或类。

def count_calls(func):
    def wrapper(*args, **kwargs):
        wrapper.call_count += 1
        print(f"Function {func.__name__} has been called {wrapper.call_count} times.")
        return func(*args, **kwargs)
    wrapper.call_count = 0
    return wrapper

@count_calls
def my_function():
    print("Hello, world!")

my_function()

输出:

Function my_function has been called 1 times.
Hello, world!
Function my_function has been called 2 times.
Hello, world!

@pytest.fixture:用于定义固件或者叫夹具(fixture),固件是一种可以在测试用例中重复使用的资源或数据,例如数据库连接、临时文件、模拟对象等。它可以用来随心所欲的设置前后置操作。
自动化测试(三):接口自动化pytest测试框架_第6张图片
装饰器用法,调整这5个参数进行使用。作用域一般是函数级别或者会话级别。

fixture的手动调用:在test_case(self,固件名)

自动化测试(三):接口自动化pytest测试框架_第7张图片
其中yeild是一个生成器。可以用来传递返回值

当一个函数中包含了 yield 关键字时,它就变成了一个生成器函数。生成器函数可以被调用,但不会立即执行,而是返回一个生成器对象。每次调用生成器对象的 next() 方法(或使用 next() 函数)时,函数会执行直到遇到 yield,然后产生一个值并暂停。下次调用时,函数从上次暂停的地方继续执行,直到再次遇到 yield 或函数结束。

自动调用: 如果只有autouse参数为true,则同setup_作用域。

固件传参:数据驱动,可以通过参数化来实现一种类似于迭代的行为。当您使用 params 参数来传递多个参数时,fixture 将会为每组参数运行一次测试函数,并在每次测试运行时提供不同的准备工作。
自动化测试(三):接口自动化pytest测试框架_第8张图片

2.2.2 pytest装饰器

@pytest.fixture:用于定义夹具(fixture),夹具是一种可以在测试用例中重复使用的资源或数据,例如数据库连接、临时文件、模拟对象等。

对固件驱动。1. 主要用于准备测试所需的数据、对象、环境等,并在测试结束后进行清理操作,以确保测试之间不会相互影响。2. 通过将常见的测试准备和清理逻辑封装到 fixture 中,您可以在多个测试用例中重复使用,从而避免重复编写相同的代码。3. fixture 可以用于管理外部资源,如数据库连接、文件句柄等,以确保资源在测试完成后被释放。

@pytest.mark.parametrize:用于参数化测试,允许你通过多个参数组合运行同一个测试用例,以减少重复的测试代码。

对数据驱动:@pytest.mark.parametrize(参数名,参数值-列表或者元组),数据中有多少值就会执行多少次。用于在一个测试用例中多次运行,每次使用不同的参数,即使用不同的输入数据运行相同的测试逻辑

自动化测试(三):接口自动化pytest测试框架_第9张图片

@pytest.mark.skip@pytest.mark.skipif:用于跳过指定的测试用例,前者是无条件跳过,后者可以根据条件来决定是否跳过。

@pytest.mark.xfail:用于标记预期失败的测试用例,即使测试用例失败了,也不会导致整个测试过程失败。

@pytest.mark.parametrize:用于参数化测试,让你可以为测试用例指定多组参数,使得同一个测试用例可以多次运行。

@pytest.mark.timeout:用于为测试用例设置最大运行时间,如果测试用例运行时间超过指定时间,将会被中断。

@pytest.mark.parametrize:用于将标记应用于测试用例,例如自定义标记,用于组织测试用例。

@pytest.mark.usefixtures:用于在测试函数中自动使用指定的夹具,不需要在参数列表中指定。

@pytest.mark.filterwarnings:用于过滤特定类型的警告,以便在测试运行期间不显示特定的警告信息。

@pytest.mark.raises:用于断言某个异常被正确地引发,用于测试代码中是否抛出了预期的异常。

2.2.3 断言、allure测试报告

  还需要安装allure,才能通过os模块调用,这里仅放一个基础使用例子,在该系列的后续文章**自动化测试(四)**中细讲。

2.2.4 接口关联、封装改进

接口关联场景:在测试中,一个系统通常会被分解成多个子系统或模块,这些子系统之间需要通过接口进行数据传递和交互。比如test1中验证了能够获得tokens,test2需要使用test1的tokens。

方法一:对于流水线测试,中间数据传输比较少的话,可以在 pytest 的 fixture 中使用 yield 语句来在 fixture 的生命周期内传递参数,并确保 yield 生成的数据被另外一个测试用例以函数名称传输的方式捕获。
方法二:用文件、数据库保存,常用yaml文件。用文件或者数据库统一管理中间变量。
common\yaml_uitl.py文件

# 提前构建一个yaml文件
import yaml
import os


def read_yaml(key):
    # 使用 with 会自动管理文件的打开和关闭
    with open(os.getcwd() + "/extract.yaml", encoding="utf-8") as f:
        value = yaml.load(stream=f, Loader=yaml.FullLoader)  # 自动将yaml结构体
        print(value)
        return value[key]


def write_yaml(data):
    # 理论上还需要检测yaml中是否已经存在对应的数据,如果存在需要改mode
    with open(os.getcwd() + "/extract.yaml", encoding="utf-8", mode='a') as f:
        yaml.dump(data, stream=f, allow_unicode=True)


if __name__ == "__main__":
    print(read_yaml("employee"))
    write_yaml({"employer": {"name": "Jerry"}})
    print(read_yaml("employer"))

在这里插入图片描述
一般在conftest文件中设置clear_yaml函数。接口关联时使用yaml_util直接写入、读取json数据即可。

YAML 文件人类易读性比Json好,可以和json之间灵活转换(load后就是json格式)

  1. 编写配置文件
  2. 测试用例接口关联
# 特殊字符可以使用单引号或双引号括起来

employee:
  name: Mark
  age: 28
  status: null  # 空值可以表示为 null 或 ~
  projects:
    - Project A  # - 表示列表中的元素
    - Project B
  contact: # 联系方式
    email: [email protected]
    phone: 123-456-7890
  description: |   # | 表示多行字符串
    This is a multiline
    string with preserved line breaks.employer:
employer:
  name: Jerry

2.3 pytest接口封装(统一请求封装)

 将数量很多的用例封装为一个方法。场景:

  1. 统计数据
  2. 异常处理
  3. 日志监控

eg1:以处理数据为例,将待翻译的内容封装成GoogleTranslate.py中的google_translator类。

eg2:以日志监控为例,封装后在SendRequest类方法中打印日志即可,因为所有的用例中都会调用SendRequest类方法。同时自建的类只初始化一次session对象(能够自动关联cookie,所有请求都在一个通话里面),而google_translator类with requests.Session() as s,或者request方法源码也是先from . import sessions然后with sessions.Session() as session,cookie都只用了一次

为什么可以requests.Session(),而不需要requests.sessions.Session()?
  requests 库在设计时采用了适当的模块导入机制和命名空间。这样的设计使得库的使用更加便捷和一致。当你使用 import requests 导入 requests 模块时,你实际上导入了 requests 包中的 init.py 模块。然后,requests 包内的各个子模块和类都会在 requests 命名空间下变得可用。

自动化测试(三):接口自动化pytest测试框架_第10张图片

参考

b站2023年课程p1-p9

你可能感兴趣的:(自动化测试,python,单元测试)