python docker自动化_pytest+requests+Python3.7+yaml+Allure+Jenkins+docker实现接口自动化测试...

接口自动化测试框架(用例自动生成)

项目说明

本框架是一套基于pytest+requests+Python3.7+yaml+Allure+Jenkins+docker而设计的数据驱动接口自动化测试框架，pytest 作为执行器，本框架无需你使用代码编写用例，那你可能会担心万一有接口之间相互依赖，或者说需要登入的token等之类的接口，该如何编写用例呢，在这里告诉你们本框架已经完美解决此问题，所有的一切将在yaml中进行！！本框架实现了在yaml中进行接口用例编写，接口依赖关联，接口断言，自定义测试用例运行顺序，还有很重要的一点，实现了类jmeter函数助手的功能，譬如生成MD5、SHA1、随机定长字符串、时间戳等，只需要你在yaml中使用特殊的写法$Function(arg)$，就能够使用这些函数啦，此外在测试执行过程中，还可以 对失败用例进行多次重试，其重试次数和重试时间间隔可自定义；而且可以根据实际需要扩展接口协议，目前已支持http接口和webservice接口。

技术栈

requests

suds-py3

Allure

pytest

pytest-html

yaml

logging

Jenkins

docker

函数助手

环境部署

命令行窗口执行pip install -r requirements.txt 安装工程所依赖的库文件

解压allure-commandline-2.12.1.zip到任意目录中

打开\allure-2.12.1\bin文件夹，会看到allure.bat文件，将此路径添加到系统环境变量path下，这样cmd任意目录都能执行了

在cmd下执行 allure --version ，返回版本信息，allure即安装成功

进入 \Lib\site-packages\allure 下面的utils文件，修改成以下代码：

for suitable_name in suitable_names:

# markers.append(item.get_marker(suitable_name))

markers.append(item.get_closest_marker(suitable_name))

目的是解决pytest运行产生的以下错误：

_pytest.warning_types.RemovedInPytest4Warning: MarkInfo objects are deprecated as they contain merged marks which are hard to deal with correctly.

框架流程图与目录结构图及相关说明

1、框架流程图如下

2、代码目录结构图如下

目录结构说明

config ===========> 配置文件

common ===========> 公共方法封装，工具类等

pytest.ini ==========> pytest的主配置文件，可以改变pytest的默认行为，如运行方式，默认执行用例路径，用例收集规则，定义标记等

log ==========> 日志文件

report ==========> 测试报告

tests ===========> 待测试相关文件，比如测试用例和用例数据等

conftest.py ============> 存放测试执行的一些fixture配置，实现环境初始化、数据共享以及环境还原等

requirements.txt ============> 相关依赖包文件

Main.py =============> 测试用例总执行器

RunTest_windows.bat ============> 测试启动按钮

conftest.py配置说明

conftest.py文件名字是固定的，不可以做任何修改

不需要import导入conftest.py，pytest用例会自动识别该文件，若conftest.py文件放在根目录下，那么conftest.py作用于整个目录，全局调用

在不同的测试子目录也可以放conftest.py，其作用范围只在该层级以及以下目录生效

所有目录内的测试文件运行前都会先执行该目录下所包含的conftest.py文件

conftest.py文件不能被其他文件导入

conftest.py与fixture结合

conftest文件实际应用中需要结合fixture来使用，如下

conftest中fixture的scope参数为session时，那么整个测试在执行前会只执行一次该fixture

conftest中fixture的scope参数为module时，那么每一个测试文件执行前都会执行一次conftest文件中的fixture

conftest中fixture的scope参数为class时，那么每一个测试文件中的测试类执行前都会执行一次conftest文件中的fixture

conftest中fixture的scope参数为function时，那么所有文件的测试用例执行前都会执行一次conftest文件中的fixture

conftest应用场景

测试中需共用到的token

测试中需共用到的测试用例数据

测试中需共用到的配置信息

结合 yield 语句，进行运行前环境的初始化和运行结束后环境的清理工作，yield前面的语句相当于unitest中的setup动作，yield后面的语句相当于unitest中的teardown动作，不管测试结果如何，yield后面的语句都会被执行。

当fixture超出范围时(即fixture返回值后，仍有后续操作)，通过使用yield语句而不是return，来将值返回(因为return后，说明该函数/方法已结束，return后续的代码不会被执行)，如下：

@pytest.fixture(scope="module")

def smtpConnection():

smtp_connection = smtplib.SMTP("smtp.gmail.com", 587, timeout=5)

yield smtp_connection # 返回 fixture 值smtp_connection

print("teardown smtp")

smtp_connection.close()

无论测试的异常状态如何,print和close()语句将在模块中的最后一个测试完成执行时执行。

可以使用with语句无缝地使用yield语法(with语句会自动释放资源)

@pytest.fixture(scope="module")

def smtpConnection():

with smtplib.SMTP("smtp.gmail.com", 587, timeout=5) as smtp_connection:

yield smtp_connection # 返回smtp_connection对象值

测试结束后, 连接将关闭，因为当with语句结束时，smtp_connection对象会自动关闭。

关联详解

公共关联池：意思就是你可以存储接口的响应值到参数池中，以便后续接口使用；同时也可以在测试执行前，制造一些公共关联值，存储到参数池中，供所有的接口使用；

在yaml测试用例中，可通过填写关联键relevance提取响应字段的键值对到参数池中；当提取单个关联值时，关联键relevance的值为字符串，形如relevance: positon；当提取多个关联值时，关联键relevance的值为列表，同时也可提取响应信息中嵌套字典里的键值对；

引用已经存储的关联值：在下个接口入参中使用形如 ${key}$ 的格式，即可提取参数池中的key对应的value，当然你必须保证关联池中已经存储过该key。

函数助手详解

说明：函数助手是来自Jmeter的一个概念，有了它意味着你能在yaml测试用例或者其他配置文件中使用某些函数动态的生成某些数据，比如随机定长字符、随机定长整型数据、随机浮点型数据、时间戳(10位和13位)、md5加密、SHA1、SHA256、AES加解密等等，引用的格式为 $Function(arg)$

目前支持的函数助手:

$MD5(arg)$ =========》 md5加密字符串，arg为待加密的字符串，可传入多个字符串拼接后加密，多个字符串之间用逗号隔开，形如$MD5(asd, we57hk)$

$SHA1(arg)$ ==========》 SHA1加密字符串，arg为待加密的字符串，可传入多个字符串拼接后加密，多个字符串之间用逗号隔开

$SHA256(arg)$ ==========》 SHA256加密字符串，arg为待加密的字符串，可传入多个字符串拼接后加密，多个字符串之间用逗号隔开

$DES(arg, key)$ ==========》 DES加密字符串，arg为待加密的字符串

$AES(arg, key, vi)$ ==========》 AES加密字符串，arg为待加密的字符串

$RandomString(length)$ =========》 生成定长的随机字符串(含数字或字母)，length为字符串长度

$GetTime(time_type=now,layout=13timestamp,unit=0,0,0,0,0)$ =========》 生成定长的时间戳，time_type=now表示获取当前时间，layout=13timestamp表示时间戳位数为13位，unit为间隔的时间差

代码设计与功能说明

1、定义运行配置文件 runConfig.yml

该文件主要控制测试的执行方式、模块的功能开关、测试用例的筛选、邮件的配置以及日志的配置，具体如下：

runConfig.yml配置信息

# 自动生成测试用例开关，0 -关， 1 -开，根据接口数据自动生成测试用例和单接口执行脚本； 2 -开，根据手工编写的测试用例，自动生成单接口执行脚本

writeCase_switch: 0

# 本次自动生成的测试用例归属的功能模块(项目名称/功能模块)比如： /icmc/pushes ；若不填，则默认不归类

ProjectAndFunction_path: /icmc/pushes

# 扫描用例路径(相对于TestCases的相对路径)，以生成执行脚本；若不填，则默认扫描所有的测试用例(只有自动生成测试用例开关为 2 时，此字段才有效)，如 /icmc/pushes

scan_path:

# 执行接口测试开关，0 -关， 1 -开

runTest_switch: 1

# 从上往下逐级筛选

# 待执行项目 (可用表达式：not、and、or)(项目名最好唯一，若多个项目或测试名的前缀或后缀相同，则也会被检测到；检测规则为“包含”)

Project: tests

# 待执行接口，可运行单独接口(填接口名)，可运行所有接口(None或者空字符串时，即不填)，挑选多接口运行可用表达式：not、and、or ,如 parkinside or GetToken or company

markers:

# 本次测试需排除的产品版本(列表)，不填，则默认不排除

product_version:

# 本次测试执行的用例等级(列表)，不填，则默认执行所有用例等级；可选['blocker', 'critical', 'normal', 'minor', 'trivial']

case_level:

- blocker

- critical

- normal

- minor

# isRun开关，0 -关， 1 -开 ；关闭时，则用例中的is_run字段无效，即会同时执行is_run为 False 的测试用例

isRun_switch: 1

# 用例运行间隔时间(s)

run_interval: 0

# 本轮测试最大允许失败数，达到最大失败数时，则会立即结束当前测试

maxfail: 20

# 测试结束后，显示执行最慢用例数(如：3，表示显示最慢的三条用例及持续时间)

slowestNum: 3

# 失败重试次数，0表示不重试

reruns: 1

# 失败重试间隔时间(s)

reruns_delay: 0.1

#发送测试报告邮件开关， 0 -关， 1 -开

emailSwitch: 0

#邮件配置

#发件邮箱

smtp_server: smtp.126.com

server_username:XXXX@126.com

server_pwd: XXXXX

#收件人(列表)

msg_to:

- XXX@163.com

- XXX@qq.com

#邮件主题

msg_subject: '[XX项目][测试环境-develop][jira号][接口自动化测试报告]'

#日志级别(字典)，由高到低： CRITICAL 、 ERROR 、 WARNING 、 INFO 、 DEBUG

log:

backup: 5

console_level: INFO #控制台日志级别

file_level: DEBUG #文件日志级别

pattern: '%(asctime)s - %(filename)s [line:%(lineno)2d] - %(levelname)s: %(message)s'

2、接口配置文件 apiConfig.ini

[host]

host = 127.0.0.1:12306

MobileCodeWS_host = ws.webxml.com.cn

WeatherWebService_host = www.webxml.com.cn

[header]

header1 = {"Content-Type": "application/json"}

header2 = {"Content-Type": "application/json;charset=UTF-8"}

header3 = {"Content-Type": "application/json", "description": "$RandomString(10)$",

"timestamp": "$GetTime(time_type=now,layout=13timestamp,unit=0,0,0,0,0)$", "sign": "$SHA1(${description}$, ${timestamp}$)$"}

[MySqlDB]

host = localhost

port = 3306

user = root

pwd = root

db = course

charset = utf8

可以针对不同的项目，配置不同的host、header等，通过不同的命名区分，如header1、header2，在yaml测试用例文件中，通过变量名引用即可，比如${host}$，${header1}$

在该接口配置文件里的字段值，可以调用函数助手的功能，引用相关函数，比如header3，在其字段值里即引用了函数RandomString、timestamp产生需要的值，并将值拼接在一起，然后再用加密函数SHA1加密后，传给sign。

3、测试用例的设计

测试用例以yaml格式的文件保存，简洁优雅，表达力又强，用例直接反映了接口的定义、请求的数据以及期望的结果，且将测试用例中的公共部分提取出来，平时只需维护测试数据和期望结果，维护成本低。

yaml测试用例的数据格式如下：

http类型接口

# 用例基本信息

test_info:

# 用例标题，在报告中作为一级目录显示，用接口路径倒数第二个字段名作为标题

title: parkinside

# 用例所属产品版本，不填则为None

product_version: icm_v1.0

# 用例等级，优先级，包含blocker, critical, normal, minor，trivial几个不同的等级

case_level: blocker

# 请求的域名，可写死，也可写成模板关联host配置文件，也可写在用例中

host: ${host}$

# 请求地址 选填(此处不填，每条用例必填)

address: /${api}$

# 请求头 选填(此处不填，每条用例必填，如有的话)

headers: ${header1}$

# 请求协议

http_type: http

# 请求类型

request_type: POST

# 参数类型

parameter_type: json

# 是否需要获取cookie

cookies: False

# 是否为上传文件的接口

file: False

# 超时时间

timeout: 20

# 运行顺序，当前接口在本轮测试中的执行次序，1表示第一个运行，-1表示最后一个运行

run_order: 1

# 前置条件，case之前需关联的接口，与test_case类似，关联接口可写多个

premise:

- test_name: 获取token # 必填

info: 正常获取token值 # 选填

address: /GetToken # 请求接口

http_type: http # 请求协议

request_type: GET # 请求方式

parameter_type: # 参数类型，默认为params类型

headers: {} # 请求头

timeout: 10 # 超时时间

parameter: # 可填实际传递参数，若参数过多，可保存在相应的参数文件中，用test_name作为索引

username: "admin"

password: "123456"

file: False # 是否上传文件，默认false，若上传文件接口，此处为文件相对路径 bool or string

relevance: # 关联的键 list or string ；string时，直接写在后面即可；可提取多个关联值，以列表形式，此处提取的关联值可用于本模块的所有用例

# 测试用例

test_case:

- test_name: parkinside_1

# 用例ID，第一条用例必填，从1开始递增

case_id: 1

# 是否运行用例，不运行为 False ，空值或其它值则运行

is_run:

# 用例描述

info: parkinside test

# 参数保存在单独文件中时，可通过文件路径引入参数

parameter: data_parkinside.json

# 校验列表(期望结果)

check:

expected_result: result_parkinside.json # 期望结果保存在单独文件中时，可通过文件路径引入

check_type: json # 校验类型，这里为json校验

expected_code: 200 # 期望状态码

# 关联作用范围，True表示全局关联，其他值或者为空表示本模块关联

global_relevance:

# 关联键，此处提取的关联值可用于