13 Star 96 Fork 47

阿正 / ApiAutomationTest

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

ApiAutomationTest

star fork Python Version License standard-readme compliant

接口自动化测试平台ApiAutomationTest

  • 使用她可以像PostMan一样进行单个或多个接口调试,或像JMeter一样使用逻辑控制器组件对案例步骤进行流程控制。
  • 测试案例当然少不了期望断言的设置,她可以方便的为请求接口设置期望断言和脚本断言。
  • 她同时也提供了例如定时器、变量定义、脚本等工具组件,您可以使用不同类型的组件编写出丰富测试案例场景。
  • 您还可以为项目配置定时任务来周期或定时触发执行。
  • 案例执行完毕后查看报告,支持执行结果钉钉通知。

Demo示例 (用户名/密码 admin/admin)

内容列表

背景

我和大多数测试人员一样,手工接口测试常用PostMan来完成。 接口自动化会使用JMeter+Ant+Jenkins作为解决方案,实现自动化执行、输出报告 以及定时构建和通知。
而对于初次接触JMeter+Ant+Jenkins自动化解决方案的人来说,搭建跑起来还是有点上手难度的。
本项目借鉴各个工具特点初步形成了目前主要功能(支持接口手工调试、项目级模块级执行、报告输出、钉钉通知、定时构建)

软件架构

  • 前端 Bootstrap4 + JS&JQuery
  • 后端 Python + Flask
  • 依赖库(后端核心第三方库)
    • Flask
    • Flask-SQLAlchemy
    • Flask-Migrate
    • Flask-SocketIO
    • requests
    • PyMySQL
    • paramiko
    • APScheduler

安装

开发环境和生产环境使用的是Python3.6版本,理论上>=py3.6都可以,建议大家使用Python3.6版本。
支持WindowsLinux部署

  • 第一步:创建项目虚拟环境
    进入项目目录ApiAutomationTest,在ApiAutomationTest目录中执行如下命令创建初始虚拟环境venv

    python -m venv ./venv

    重点强调: 后面步骤需使用venv中的执行文件来执行

    win
    ./venv/Scripts/pip.exe
    ./venv/Scripts/python.exe
    ./venv/Scripts/flask.exe
    linux
    ./venv/bin/pip
    ./venv/bin/python
    ./venv/bin/flask
  • 第二步: 安装Python第三方库
    使用pip工具安装

    pip install -r requirements.txt

    国内可以使用douban的镜像源快速下载

    pip install -r requirements.txt -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com
  • 第三步: 初始化数据库
    执行命令

    flask init
  • 第四步: 启动服务
    执行命令

    python webserver.py

使用说明

页面介绍

  • 登录页面
    初始化数据库后使用默认用户名admin, 密码admin登录

  • 总览页面
    查看构建信息

  • 项目页面
    查看并管理所有项目

  • 模块页面
    查看并管理单个项目中所有模块

  • 案例场景页面
    编写/调试测试用例(后面重点介绍: 跳转查看)

  • 报告页面(后面重点介绍: 跳转查看)
    查看所有报告

    查看报告详细数据

  • 设置页面
    设置钉钉通知

    配置钉钉机器人时安全设置必须勾选加签,并将生成的密钥填入钉钉通知设置项中

案例编写

项目(Project) -> 模块(Module) -> 场景(Scene) -> 组件(Element): 项目往下分为4个层级,案例由不同组件组合而成

  • 进入场景页面
    点击进入模块下的场景页面

  • 添加一个HTTP请求
    空的测试场景,点击左下角按钮添加测试场景

    在场景内添加请求组件,这里添加一个HTTP请求

    填写HTTP相关参数,点击发送按钮测试当前接口。在组件下方可以添加期望断言、预处理脚本、后处理脚本。

    预处理脚本(解释: 请求组件执行前执行预处理脚本)
    后处理脚本(解释: 请求组件执行后执行后处理脚本)

  • 执行模块级用例 编写完一个或多个场景后,执行整个模块。

  • 查看报告 报告页面实时查看运行日志和结果

构建执行

共有三种执行方式

  1. 请求组件点击发送按钮,如下图。

  2. 场景页面点击执行测试按钮,如下图。

    场景页面包含了一个模块下所有场景,因此这里执行的是一个模块所有案例。

  3. 模块页面点击执行测试按钮,如下图。

    模块页面包含了一个项目下所有模块,因此这里执行的是一个项目所有用例。

查看报告

执行请求组件是不会生成测试报告,而是在当前页面中展示请求应答数据和期望断言结果。
执行模块项目级执行时,会生成对应的测试报告。

  • 查看最近5个报告

  • 测试报告支持实时查看执行结果和日志。
    查看该案例请求和应答数据,以及设置的期望和断言结果。

组件说明

组件类型 组件名 说明
请求组件 HTTP 支持HTTP/HTTPS协议
支持常用方法: GET POST DELETE PUT PATCH HEAD OPTIONS
请求组件 SSH 远程执行命令
请求组件 SQL 支持MySQL数据库
请求组件 Debug 获取执行时上下文中所有定义的变量和值
工具组件 HTTPHeaderManager 设置HTTP请求头数据
工具组件 HTTPCookieManager 设置HTTPCookie数据
工具组件 VariableDefinition 定义变量
工具组件 Timer 定时器, 暂停一段时间后继续执行
工具组件 Script 支持编写Python脚本, 灵活处理复杂逻辑和数据
逻辑组件 SIMPLE 简单控制器, 可用于对组件进行分组管理
逻辑组件 IF IF控制器, 填写表达式做是非判断, 只有为True才执行控制器内的组件
逻辑组件 WHILE WHILE控制器, 满足条件时持续循环, 否则跳出循环
逻辑组件 LOOP LOOP控制器, 设置循环次数, 循环执行控制器中的组件

维护者

@azhengzz

鸣谢

如何贡献

非常欢迎你的加入!提一个 Issue 或者提交一个 Pull Request。

项目遵循 Contributor Covenant 行为规范。

使用许可

本项目使用 Apache License 2.0 许可。

其他

作者联系方式

相关项目

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

接口自动化测试平台: 支持HTTP/SSH/SQL接口请求,支持单接口调试、也可多接口多组件组合满足复杂场景编写需求,支持定时触发、报告输出、邮件和钉钉通知。 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Python
1
https://gitee.com/azhengzz/api-automation-test.git
git@gitee.com:azhengzz/api-automation-test.git
azhengzz
api-automation-test
ApiAutomationTest
master

搜索帮助