克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

Interface

前言

简单讲述框架的使用

本框架主要基于:Python+Pytest+Yaml(Yaml+CSV)+Allure+Log+Mysql,实现接口自动化框架

Git地址:https://gitee.com/make_a_summer/interface.git

项目作者:唐松(挽一夏)

个人邮箱:tasng@foxmail.com (欢迎探讨学习进步)

实现功能

  • 测试数据隔离,实现数据驱动。使用yaml文件,或者yaml-csv文件实现单接口多组数据
  • 支持多接口数据依赖:如A接口需要同时依赖B、C接口的响应数据作为参数。提取接口单个值,提取接口返回列表
  • 数据库断言:直接在测试用例中写入查询的sql即可断言,无需编写代码
  • 动态多断言: 如接口需要同时校验响应数据和sql校验,支持多场景断言
  • 日志模块: 打印每个接口的日志信息
  • 统计接口的运行时长
  • 自定义拓展字段: 如用例中需要生成的随机数据,可直接调用

目录架构

|-common				        	// 辅助类,用于整个测试框架
|	|-debugtalk.py					// 自定义函数供测试脚本调用。生成随机数、日期时间戳等常用的功能
|-config							// 配置
|	|-config.py			        	// 读取项目配置文件-config.yaml		
|	|-config.yaml		  			// 项目配置文件
|	|-extract.yaml		 			// 存储接口数据关联
|	|-setting.py					// 项目基础路径
|-data								// CSV测试文件
|-files								// 上传文件
|-logs								// 日志
|-reports				       		// 测试报告		
|-testcase			                // 测试用例
|-util_tools						// 工具库文件
|	└──db_connector					// 数据库模块
|		└──connectMysql.py			// MySQL工具类
|	└── headle_data			        // 测试文件操作模块
|		└── csv_anlaysis_params.py  // Yaml文件使用CSV格式,进行数据处理
|		└── csv_handler.py			// 读取CSV文件
|		└── yaml_handler.py			// 读取Yaml文件
|	└── other_util					// 其他工具类
|		└── allure_type.py			// Allure报告步骤中,数据格式处理
|		└── genrate_id.py			// 测试用例ID
|	└── yaml_process		        // Yaml文件处理
|		└── yaml_analysis.py	    // Yaml数据规范、替换、发送请求、数据提取、执行断言
|		└── yaml_extract.py			// 处理数据提取
|		└── yaml_replace.py			// 处理数据替换
|	└── assertion_util.py		    // 封装断言
|	└── logger_util.py				// 封装日志
|	└── requests_util.py		    // 封装发送请求
|-conftest.py				        // 运行前之前操作,清空extract.yaml文件
|-pytest.ini				
|-environment.xml					// allure报告中环境配置
|-run.py				       		// 运行入口

接口文档

微信公众号-标签管理: https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_access_token.html

  1. 登录
  2. 查询标签
  3. 创建标签
  4. 修改标签
  5. 删除标签
  6. 文件上传

B站博主学习资料,且配套测试接口(强烈推荐)

https://b23.tv/0Qlxedq

创建测试用例

需要创建两个文件

1、创建YAML测试文件,编写接口数据

2、创建执行YAML的Py文件,进行读取YAML文件,发送接口请求

如何创建测试用例

1、testcase目录下,创建YAML测试文件,编写接口数据,其中有严格的关键字层级,编写时需遵守(开发者根据实际要求自定义)

-
  name:           # 用例名称
  base_url:       # 用例基础URL
  request: 
    headers:      # 请求头   (可选)
    cookies:      # cookies (可选)
    method:       # 请求方式
    path:         # 接口请求路径
    data:         # 请求参数  (可选)
  extract:        # 提取参数  (可选)
  #extract_list:     # 提取参数列表
  validation:     # 断言

YAML测试文件中,需要包含 4 个一级关键字:name、base_url、request、validation

  		  	`2` 个二级关键字:method、path

提取参数:extract或者extract_list,根据接口返回值实例使用,提取单个还是提取列表。

2、testcase目录下,创建Py文件,进行读取并执行发送接口

@allure.feature(next(m_id) + "XXX模块")
class TestXXX:
    """XXX模块"""
    @allure.story(next(c_id) + "XXX接口")
    @allure.description("描述信息: XXX接口测试")
    @pytest.mark.parametrize('caseinfo', read_testcase_file('testcase/XXX/XXX.yaml'))
    def casetest_login(self, caseinfo):
        allure.dynamic.title(caseinfo['name'])
        YamlAnalysis().yaml_analysis_execution(caseinfo)

使用YAML管理用例

一个YAML文件管理,能管理一组或者多组数据

-
  name: 登录成功
  base_url: http://127.0.0.1:8787
  request:
    headers:
      Content-Type: application/x-www-form-urlencoded;charset=UTF-8
    method: post
    path: /dar/user/login
    data:
      user_name: test01
      passwd: admin123
  extract:
    token: $.token
    userid: $.userId
  validation:
    - contain: {'msg': '登录成功'}
    - code: 200
    
-
  name: 登录失败
  base_url: http://127.0.0.1:8787
  request:
    headers:
      Content-Type: application/x-www-form-urlencoded;charset=UTF-8
    method: post
    path: /dar/user/login
    data:
      user_name: test01111
      passwd: admin123
  extract:
    msg: $.msg
  validation:
    - contain: {'msg': '登录失败'}

严格控制YAML文件的层级格式即可

使用YAML+CSV关管理用例

看上方发现,在YAML文件中管理多组测试数据,一组两组还好,多了之后YAML中数据就过多,不好查看与管理。

所有就引入了CSV管理,对可变的参数进行处理

1、CSV文件存储在data目录下

2、使用CSV方式,在YAML文件中新增关键字parameters,与对应的读取数据格式$csv{XXX}

下面使用同一个接口,展示CSV管理用例

1、data目录下,新建CSV文件,有四个字段需要被替换使用

name,user_name,passwd,validation
正常登录01,test01,admin123,登录成功
账号错误02,test111,admin123,登录失败
账号错误03,test222,admin123,登录失败
账号错误04,test333,admin123,登录失败
密码错误05,test01,admin111,登录失败
密码错误06,test01,admin222,登录失败
密码错误07,test01,admin333,登录失败

2、testcase,YAML测试文件,要被替换的字段用$csv{XXX},且parameters中要一一对应

-
  name: $csv{name}
  base_url: http://127.0.0.1:8787
  parameters:
    name-user_name-passwd-validation: data/user_login.csv            # parameters关键字下,需要替换的字段-CSV文件路径
  request:
    headers:
      Content-Type: application/x-www-form-urlencoded;charset=UTF-8
    method: post
    path: /dar/user/login
    data:
      user_name: $csv{user_name}
      passwd: $csv{passwd}
  extract:
    token: $.token
    userid: $.userId
  validation:
    - contain: $csv{validation}

Py文件依旧不变,运行成功后效果

用例中提取参数

提取参数有两个方式,根据接口实际结果使用,支持使用jsonpath、正则表达式。提取的接口关联参数存储到:extract.yaml文件中

extract_list : 提取的数据是列表

extract :提取单个数据

示例:

# 正则提取列表
extract_list:
  goodIds: '"goodsId":\s*"(\d+)"'

# jsonpath提取列表
extract_list:
  materIds: $.material[*]

# jsonpath提取单个数据
extract:
  token: $.token
  userid: $.userId

用例中依赖token如何设计

1、通过上个接口发送请求,得到token请求值,存储到extract.yaml文件中

2、YAML文件中,通过debugtalk.py文件中,使用get_extract_data方法,获取extract.yaml文件数据

读取extract.yaml值,因为提取的有单个数据、列表数据,所以提取的方式略有不同

单个参数,如上述token值,在YAML文件中,使用${get_extract_data(token)}

列表参数,如上述goodIds第1个值,在YAML文件中,使用${get_extract_data(goodIds,0)}

params:
  token: ${get_extract_data(token)}
  
json:
  pro_id: ${get_extract_data(goodIds,0)}

用例中需要cookie

有的接口发送时需要携带cookie信息。

首先是获取cookie存储到extract.yaml文件中,在使用get_extract_data进行数据获取

-
  name: 获取物料信息
  base_url: ${get_base_url(base_url)}
  request:
    headers:
      ${get_headers(data)}
    cookies:
      ${get_extract_data(Cookie)}
    method: get
    path: /api/order/customer/orderPlan/getMaterial
  validation:
    - eq: { 'message': '操作成功' }
    - code: 200
  extract_list:
    materIds: $.material[*]

用例中使用其他参数

在使用的过程中,发现yaml文件中,有 ${get_base_url()}、${get_headers()}、 ${get_extract_data(Cookie)}

这些方法均在debugtalk.py文件中

class DebugTalk:
    
	@classmethod
    def get_base_url(cls, node_name):
        """
        :param node_name: base_url
        :return:
        """
        return read_config_file('base', node_name)

    @classmethod
    def get_mysql_config(cls, node_name):
        """
        :param node_name: mysql
        :param node_name:
        :return:
        """
        return read_config_file('mysql', node_name)

    @classmethod
    def get_headers(cls, params_type):
        headers_mapping = {
            'data': {'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8'},
            'json': {'Content-Type': 'application/json;charset=UTF-8 '}
        }
        header = headers_mapping.get(params_type)
        if header is None:
            raise ValueError('不支持其他类型的请求头设置')
        return header

    @classmethod
    def get_random_number(cls, min, max):
        return random.randint(int(min), int(max))
    XXXXXX

断言类型

本框架只实现了五种类型断言

状态码断言、包含模式断言、相等断言、不相等断言、数据库断言

  validation:
    - contain: {'msg': '登录成功'}  	# 包含模式 
    - code: 200                        # 接口的响应状态码断言
    - eq: {'msg': '登录成功'}			# 相等断言
    - ne: {'msg': '登录失败'}			# 不相等断言
    - db: SELECT name, fee FROM testcase.`user` WHERE id=4; # 数据库断言

allure报告

执行run.py文件,在reports文件allures文件下,打开index.html文件,即可查看

运行流程详解

  1. 运行run.py文件,读取pytest.ini配置,到指定文件下,读取指定类下的指定测试方法

  2. 调用read_testcase_file方法,读取yaml文件,检查yaml文件是否存在字段:parameters,如果就是yaml+csv参数化。没有就是yaml测试文件。 读取的yaml有多少组数据,就传多少组,一组就是一条case。

    csv参数化,在调用read_testcase_file方法,读取yaml文件,检查存在字段:parameters,读取时候就调用csv_analysis_params方法,对yaml文件中$csv{XX}做替换

    • 1、yaml文件中parameters关键字下是要替换csv文件下对应的字段,要被替换的字段书写格式:$csv{xxx}
    • 2、csv_analysis_params方法组合读取csv文件 read_csv_file方法,对csv文件做处理。将yaml文件中$csv{xxx},替换为csv文件中对应值
    • 3、csv文件中有几行数据,就对几行数据做处理,最终处理后就是几组数据就被替换,相当于yaml文件的几组数据
  3. 通过conftest.py文件,先调用clear_extract方法,清除extract.yaml文件-存在数据关联文件

  4. 测试文件开始执行YamlAnalysis类中,yaml_analysis_execution方法,对整体yaml文件做处理

  • 对yaml文件格式做校验,4个一级关键字,2个二级关键字
  • 关键字存在引用格式,如${get_base_url(base_url)},调用替换的方法parse_replace,调用DebugTalk类中的相应方法,并获取返回值替换。 关键字引用是配置参数(url/mysql/等),就通过read_config_file方法读取。 关键字引用是extract.yaml文件中参数(接口关联,上个接口返回值,本接口使用),就通过get_extract_data方法来读取。支持直接读取键,也支持键+位置值
  • 执行发送接口请求,execute_request方法,然后输出台打印日志、allure报告body内容。
  • yaml文件中存在关键字:extract或extract_list字段,就调用extract_data/extract_data_list方法,进行参数提取,支持jsonpath、正则表达式,将提取的参数通过write_extract_yaml方法写入extract.yaml文件
  • 处理断言,调用assert_result方法进行断言处理。5种断言方式,yaml文件中断言字段使用那种断言,就调用对应的断言方法
木兰宽松许可证,第2版 木兰宽松许可证,第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件” 是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献” 是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者” 是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体” 是指提交贡献的机构及其“关联实体”。 “关联实体” 是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是 指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可 以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定 撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡 献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软 件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“ 关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或 其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权 行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定 的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“ 本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对 任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于 何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文 版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i. Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii. Create a file named "LICENSE" which contains the whole context of this License in the first directory of your software package; iii. Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

接口自动化框架:Python+Pytest+Yaml+Allure+Log+Mysql 兼容Yaml+CSV,实现单接口CSV用例参数化 展开 收起
Python 等 4 种语言
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化