Httprunner系列（十）：企业级接口自动化测试框架定制

置顶 已于 2022-03-17 18:08:15 修改
阅读量2.8k 收藏 13
点赞数 4
分类专栏： Httprunner 文章标签： python
于 2022-02-17 19:04:42 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_46457203/article/details/122069712
版权

文章目录

前言

Httprunner作者是debugtalk，是一个资深的开发者，目前开发httprunner已有5个版本
Httprunner用法比较简单，并且符合工作中的多种场景：
1、做完接口自动化，要求继续做此接口的性能测试（hrun内置locust模块，可以直接做压测）
2、需要做的接口过多，而且只需要替换部分的参数，接口自动化的工作就会完成（charles录制并导出.har文件，通过hrun命令转成.py文件）
3、request库的每一步的接口响应，都需要加断言，而hrun会自动生成断言方法
4、hrun集成的第三方库：loguru、jmespath、pytest

一、hrun目前的版本

在这里插入图片描述

二、环境准备 & httprunner的基本操作

1.安装python、Httprunner、allure-pytest：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple httprunner
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple allure-pytest

2.环境验证，查看httprunner版本：

httprunner -V

在这里插入图片描述

3.查看httprunner帮助：

httprunner --help

在这里插入图片描述

4.生成脚手架（快速的生成一个hrun框架）：

httprunner startproject  PartsService

在这里插入图片描述
在这里插入图片描述

5.脚手架内的yml文件转换pytest文件（根目录下执行 ）：

 cd  PartsService
 hmake testcases

在这里插入图片描述

6.运行httprunner，单个文件（进入要运行文件的根目录下）

方式一：		pytest [filename]
方式二：		hrun [filename]
方式三：		httprunner run  [filename]

7.批量运行httprunner，运行文件集下的所有用例

方式一：				pytest [dirname]
方式二：				hrun [dirname]
方式三：				 httprunner run  [dirname]

8. 查看.har生成脚本帮助

har2case -h

三、httprunner的二次封装

在这里插入图片描述

1. 框架内的各文件解释

allure：存放allure的报告结果集
api_data：存放接口的请求数据（可以是json文件、xlsx文件、yaml文件）
api_testing：存放api测试用例
api_util：便于api测试的封装方法
common：公共方法，比如读取数据库文件
config：存放全局配置文件
databases：存放数据库文件
login：登录解耦

2. config文件内容

在这里插入图片描述

[base]
# the url domain you wants to use in UI testing
backend_url =https://wwww.baidu.cn/

[report]
###  pytest xxxx --alluredir ./report
###  allure serve report

###   hrun test_post_api.yml --alluredir=allure
###   allure generate ./allure/ -o ./reports --clean

backend_url为项目地址，如果有多套环境，可以放多个url来进行切换

3. common文件内容

在这里插入图片描述

import configparser  
import os


class ConfigReader:
    def __init__(self, file_name):
        self.config = configparser.ConfigParser()
        config_path = os.path.split(os.path.realpath(__file__))[0] + os.sep + file_name
        self.config.read(config_path, "utf-8")

    def get_config(self, config_item):
        sections = self.config.sections()
        for section in sections:
            if self.config.has_option(section, config_item):
                return self.config.get(section, config_item)

    def get_config_by_section(self, config_item, section_name):
        return self.config.get(section_name, config_item)

这里只写了一个读取Config文件方法，便于切换多套数据库环境，后续有需要可以做补充

4.login文件内容

在这里插入图片描述

from httprunner import HttpRunner, Config, Step, RunRequest, RunTestCase  # todo：导入httprunner模块
def get_base_url():  # todo：封装project_host方法，为项目全局的API路径
    from common import config_reader  # todo： config_reader 引用 config_reader方法
    return config_reader.ConfigReader('../config/base_config.cfg').get_config('backend_url')


class TestCaseLogin(HttpRunner): # todo： 定义类名要以Test开头

    config = Config("testcase description")\
        .verify(False)\   # todo：忽略Https证书
        .variables(**{
            "Accept":"application/json, text/plain, */*",
            "Cookie":"SIAM_IMAGE_CODE=762410696575033344; SIAMTGT=TGT-892-4xraUmB3mrsA0MtWv11ENoZmq1t4CiBYgSGPJjG9NQrHpTqczc-SIAM; LtpaToken=AAECAzYxRjBCN0Y5NjFGMTYwQjlDTj1iaWVzb25nbGluL089Zm90b25UaDZzgyb50ZEjaw/jBYfTHXONKQ==",
            "userName": " xxxx",   
            "password": "xxxx",  
            "validCode": "xxx",
            "brandId":"x",
    })  # TODO: 设置全局变量，下面的Step方法都可以使用到。这里设置的Accept、Cookie、userName、password、validCode、brandId

    teststeps = [
        Step(
            RunRequest("登录")
                .post(get_base_url()+"API路径")  #todo:切换自己的api路径
                .with_cookies(**{"aaf875be9aad4feca52ccece8eade2df": "WyIzMTE4NjIwNDQ3Il0"}) # todo：API的cookies
                .with_json({"userName": "$userName", "password": "$password", "validCode": "$validCode"}) # todo： 引用定义好的全局变量
                .extract()
                .with_jmespath('body.data.token', 'token') # todo：从response获取响应值，最外层是固定的body
                .with_jmespath('headers.Server', 'cookies')  # todo： 后面为变量名  取出 body的data下的token，所以前面指定了body，同理，也可以取header的data（有需要的话）
                .validate()
                .assert_equal("status_code", 200)
                .assert_equal('headers."Content-Type"', "application/json")
                .assert_equal("body.code", 200)
                .assert_equal("body.message", "success")
        ),
    ]

if __name__ == "__main__":
    TestCaseLogin().test_start()

写入登录用例，方便后续的hrun文件call，实现login解耦

5.api_util文件内容

import time
from httprunner import HttpRunner,Config,Step,RunTestCase,RunRequest
from login.get_token import TestCaseLogin as GetToken  # todo：引入login文件
def get_base_url():
    from common import config_reader
    return config_reader.ConfigReader('../config/base_config.cfg').get_config('backend_url')

class APIRequestConstructor(HttpRunner):  # todo：创建基础类，便于后面清除hrun的token信息和读取token信息
    config = (
        Config("API测试执行")
            .base_url(get_base_url())
            .verify(False))
    teststeps = [
        Step(
            RunTestCase("通过登录API获取token")
                .call(GetToken)
                .export(*["token",]))]
                
def reset_request_step(token=GetToken): # todo：基于类封装方法，默认不传则使用GetToken
    APIRequestConstructor.teststeps.clear() # todo：属于单元测试框架内的teardown，给每个用例一个干净的执行环境
    APIRequestConstructor.teststeps.append(  # todo：添加step动作
        Step(
            RunTestCase("通过登录API获取token")
                .call(token)
                .export(*["token",])
        ))

headers = {        # todo：根据项目需要，写入headers数据
    "Host": "xxx",
    "Accept": "application/json, text/plain, */*",
    "Content-Type": "application/json;charset=utf-8",
    "brandId": "3",
    "Authorization": "${token}",
    "Cookie": "xxxx",
}
cookies = {"aaf875be9aad4feca52ccece8eade2df": "WyIxNjUxMTM1OTE1Il0"} # todo：根据项目需要，写入cookies数据


def create_run_request(request_name, url, request_json, body="body.data", headers=headers, cookies=cookies):  # todo：封装用例步骤，放置API的名字、请求地址、请求参数
    if request_json is not None: # todo：如果请求参数json格式不为空，则执行post请求
        return RunRequest(request_name).post(url).with_headers(**headers).with_cookies(**cookies).with_json(
            request_json
        ).extract().with_jmespath(body, "res_data")
    else: # todo：如果请求参数json为空，则执行post请求
        return RunRequest(request_name).get(url).with_headers(**headers).with_cookies(**cookies) \
            .extract().with_jmespath(body, "res_data")

def contruct_request_step(run_request_obj):
    return Step(
        run_request_obj
    )

def perform_requests_and_get_last_response(steps):  # todo： 放入用例的执行步骤
    APIRequestConstructor.teststeps.extend(steps)  # todo：读取teststeps的步骤
    obj = APIRequestConstructor()  # todo：实例化对象
    obj.test_start()
    time.sleep(1)
    res = obj.with_export(["res_data", "token"]).get_export_variables()
    return res

对httprunner的二次封装，减少冗余代码

6.databases文件内容

import copy
import configparser
import os
class ConfigReader:
    def __init__(self, file_name):
        self.config = configparser.ConfigParser()
        config_path = os.path.split(os.path.realpath(__file__))[0] + os.sep + file_name
        self.config.read(config_path, "utf-8")

    def get_config(self, config_item):
        sections = self.config.sections()
        for section in sections:
            if self.config.has_option(section, config_item):
                return self.config.get(section, config_item)
class DB():
    def __init__(self, database_name):
        cf = ConfigReader("database_config_dev.cfg")  # todo:连接的哪个数据库，如果有多套环境，记得这里也要切换下数据库配置
        self.host = cf.get_config(database_name + "_host")
        self.port = cf.get_config(database_name + "_port")
        self.user = cf.get_config(database_name + "_user")
        self.password = cf.get_config(database_name + "_password")
        self.database_name = database_name
    def connect(self):  # todo:创建连接数据库方法
        import pymysql
        # 创建数据库连接
        self.db = pymysql.connect(host=self.host, user=self.user, password=
        self.password, database=self.database_name)
        # 创建游标
        self.cursor = self.db.cursor()

    def get_one(self, sql):  # todo:返回一条数据
        result = 0
        try:
            self.connect()
            self.cursor.execute(sql)
            result = self.cursor.fetchone()
            self.close()
        except Exception as e:
            print('select error', e)
        return result

    def get_all(self, sql):  # todo:返回全部符合条件的查询结果
        result = 0
        try:
            self.connect()
            self.cursor.execute(sql)
            result = self.cursor.fetchall()
            self.close()
        except Exception as e:
            print("select error", e)
        return result

    def __edit(self, sql):  # 创建主函数
        result = 1  # 设置结果集，用于调用的时候做判断
        try:  # 这里是使用的try语句来尝试进行操作
            self.connect()
            self.cursor.execute(sql)
            self.db.commit()  # 注意的是，如果是对数据库做了修改、删除、增加的操作，那么一定要commit提交，查询和创建表不需要提交
            self.close()
        except Exception as e:  # 如果操作失败，报出操作异常，且游标进行回滚
            print('error :', e)
            result = 0
            self.db.rollback()
        return result

    def insert(self, sql):
        # 插入语句  ，以下三个都是一样的，只是调用的时候，我们看起来更加清晰而已
        return self.__edit(sql)  # 通过主函数的处理，来去执行sql语句

    def delete(self, sql):  # 删除语句
        return self.__edit(sql)

    def update(self, sql):  # 修改语句
        return self.__edit(sql)

    def close(self):  # 关闭方法
        self.cursor.close()  # 关闭游标
        self.db.close()  # 关闭数据库

7.databases_config_dev.cfg文件内容

在这里插入图片描述

[PMSClaimH3H51]
PMSClaimH3H51_host=xxx
PMSClaimH3H51_port=xxx
PMSClaimH3H51_user=xxx
PMSClaimH3H51_password=xxxx

[PMSCommonH3H5]
PMSCommonH3H5_host=xxx
PMSCommonH3H5_port=xxxx
PMSCommonH3H5_user=xxx
PMSCommonH3H5_password=xx

在这里插入图片描述
像是这里，有两套数据库环境，用这个方法封装就比较好用

8.api_testing文件内容

在这里插入图片描述

import allure,pytest
from loguru import logger
from api_util.util import *

@allure.feature("配件信息管理查询")
class TestSearChParts():
    @pytest.fixture(scope="class", autouse=True)
    @allure.feature("数据清除")
    def teardown_(self):
        yield
        logger.debug("Implementation of the use case will end.")
    @allure.story("分公司：配件信息管理查询")
    def test_Search_Parts_GetToken(self):
        reset_request_step()  # todo: 登录文件引用，默认不传是GetToken
        # todo： 创建请求方法  create_search_parts 可自定义命名。调用create_run_request方法，传入API名称、API地址、request body
        create_search_parts = \
            create_run_request(
                "配件信息管理", "api/common/partsInfo/sparepart/v1/getSparePartByPage", {"status":1,"pageSize":10,"pageNum":1,"loading":"false"}) \
                .with_jmespath("body.data.list[0].id","ids") \
                .validate() \
                .assert_equal("status_code", 200).assert_equal("body.message", "success")
        # todo:   contruct_request_step  放入执行步骤，如果有多个，需要逗号隔开
        create_out_of_warranty_payment_step = contruct_request_step(
            create_search_parts)
        # todo：  perform_requests_and_get_last_response  放入需要执行用例，同样，如果有多个，需要逗号隔开
        res = perform_requests_and_get_last_response(
            [create_out_of_warranty_payment_step])
        id = res['res_data']['list'][0]['id'] # todo: 取出接口response响应值，拿到依赖接口使用。因为封装的方法，response的body外部是res_data，所以这里需要加上
        print(id)
    @allure.story("服务站：配件信息管理查询")
    def test_Search_Parts_Service_Station(self):
        reset_request_step(Service_Station)
        create_out_of_warranty_payment_run_request = \
            create_run_request(
                "配件信息管理", "api/common/partsInfo/sparepart/v1/getSparePartByPage",
                {"status": 1, "pageSize": 10, "pageNum": 1, "loading": "false"}) \
                .validate() \
                .assert_equal("status_code", 200).assert_equal("body.message", "success")
        create_out_of_warranty_payment_step = contruct_request_step(
            create_out_of_warranty_payment_run_request)
        res = perform_requests_and_get_last_response(
            [create_out_of_warranty_payment_step])

四、运行文件方法

1.右击文件来运行

在这里插入图片描述

2.点击方法左侧绿三角来执行单条用例

在这里插入图片描述

3.使用命令运行单个脚本

在这里插入图片描述
pytest [filename]
在这里插入图片描述
也可以使用 hrun [filename]

在这里插入图片描述

4.使用命令运行某个文件集下的所有用例

如果要运行整个文件集下的所有用例，可以直接pytest [dirname]

五、本地生成allure报告

pytest xxxx --alluredir ./report     # todo： xxx为hrun文件名字，也可以是文件夹名字。生成allure结果集

在这里插入图片描述

allure serve report    # todo：本地查看allure报告（控制台会给出url地址）

在这里插入图片描述

allure generate ./report/ -o ./reports --clean  # todo：清除历史allure结果集，在reports文件夹下新增allure报告

在这里插入图片描述

六、jenkins配置pytest+httprunner

1.在jenkins上安装allure插件

Jenkins系统管理——全局工具配置——Allure Commandline添加配置
勾选自动安装，选择from maven central，版本选择最新版本，目前是2.7
在这里插入图片描述

2.配置job

新建任务：自由风格的软件项目
在这里插入图片描述

3.进入job配置

在这里插入图片描述
配置git
Repository URL ： git地址，记得后面加上.git
Credentials ： 拉取git代码凭证

在这里插入图片描述
点击【添加】按钮，进入jenkins添加凭证弹窗内
在这里插入图片描述
**Branches to build:**分支填写 */master，master分支，如果有需要，可以填写其它分支
在这里插入图片描述
cron定时配置
在这里插入图片描述
点问号，看帮助即可。这里设置的是每天凌晨6点构建一次job

shell构建
这里选择Execute shell,使用shell命令执行。这里的因为Jenkins拉取代码会在固定的.jenkins/workspace这个目录，${WORKSPACE}变量指向了这个地址。
最后保存就可以了！
在这里插入图片描述

Post-build Actions：构建后动作，点击add post-build action选项，选择allure，Results的path中填写的名称要和${WORKSPACE}后的名称，不然报告内容为空。

在这里插入图片描述

在这里插入图片描述

4.运行Jenkins

在首页可以查看新的任务，点击最右方小图标就可以构建了。也可以点击name进入任务中，点击开始构建。点击Allure Report就可以查看本次运行的测试结果。
在这里插入图片描述
在这里插入图片描述

5.详细的jenkins配置（转）

https://blog.csdn.net/weixin_42923777/article/details/102551493

小白哪敢接话
关注
专栏目录
企业级，搭建接口自动化测试框架思路分析，8年测试老鸟整理...
分享测试知识
11-08 253
在选择接口测试自动化框架时，需要根据团队的技术栈和项目需求来综合考虑。对于测试团队来说，使用Python相关的测试框架更为便捷。无论选择哪种框架，重要的是确保 框架功能完备，易于维护和扩展，提高测试效率和准确性。1、接口自动化测试项目框架简介搭建接口自动化测试框架的技术栈如下：语言：Python，简洁高效，上手容易，无压力；人生苦短，我用 python；测试框架：Unittest，封装自定义断言方法进行验证，如：eq\lt\lte\gt\gte\neq\str_eq等等；
java grid++report 接口数据实现 对接_接口自动化测试企业级项目实战1
weixin_31956641的博客
12-15 385
手把手教你从0开始实施企业级接口自动化测试项目本篇将收获：搭建项目框架，Python+Pytest+Allure配置host，封装登录接口，md5加密实现用faker类库构建入参测试数据封装读取Excel运用pytest框架生成allure测试报告实现测试用例：验证所有入参是否必填实现测试用例：验证所有入参是否必传01—项目基本结构框架项目基本结构框架(分层)：config配置文件d...
企业级 接口自动化测试框架：Pytest+Allure+Excel
kk_lzvvkpj的博客
01-15 1001
Allure 框架是一个灵活的、轻量级的、支持多语言的测试报告工具，它不仅以 Web 的方式展示了简介的测试结果，而且允许参与开发过程的每个人可以从日常执行的测试中，最大限度地提取有用信息。Allure 是由 Java 语言开发的，支持 Pytest，JaveScript、PHP、Ruby 等。从 DEV/QA 的角度来看，Allure 提供了详尽的测试报告，比如简化了常见缺陷的统计；失败的测试可以分为 bug 和被中断的测试；还可以配置日志、步骤、fixture、附件、计时、执行历史；
接口自动化测试流程、工具及其实践
最新发布
huace3740的博客
08-06 918
总的来说，接口自动化测试可以提高测试效率、质量和覆盖率，减少测试成本和风险，同时提高团队的协作和工作效率。MeterSphere 是一站式的开源持续测试平台，遵循 GPL v3 开源许可协议，涵盖测试管理、接口测试、UI 测试和性能测试、团队协作等功能。在测试过程中，可能会存在接口之间的依赖关系和顺序问题，需要合理安排测试用例的执行顺序，确保测试的准确性和一致性。如果有失败的测试用例，需要进行排查和修复。维护和优化：根据接口的变更和项目需求，及时维护和优化接口自动化测试脚本，以保持测试的准确性和可靠性。
一套接口自动化框架
07-19
一套接口自动化框架，框架搭建：unittest+python+ffmepg，实现功能report+html双报告输出、脚本case，模版case双编写、自定义失败重试，跳过等分级分层定制运行
APIAutoTest(接口测试框架)
12-14
基于excel和request的接口自动化测试框架,使用者只需要按照 excel 中的用例格式编写接口用例并放入指定文件夹下方,程序就能自动识别用例并执行它,亮点功能1.支持设置用例执行顺序;2.支持数据依赖(可配置需要依赖那个用例的那些数据,并根据表达式匹配数据直接赋值给本条用例使用);3.支持测试结果断言(equal,notequal,in,notin);
HTTPRUNNER2.0：接口自动化测试平台操作指南
"HTTPRUNNER2.0框架是一款基于HttpRunner的接口自动化测试平台，集成了项目管理、模块管理、用例管理、场景管理、运行方式、分布执行、环境管理、报告查看、定时任务和持续集成等功能。它支持批量上传标准化的...
HTTPRUNNER接口自动化测试方案
本文档详细阐述了如何在企业级项目中采用HTTPRUNNER框架进行接口自动化测试的实施。HTTPRUNNER是一款基于Python语言开发的测试工具，专注于HTTP(S)协议，支持编写YAML/JSON脚本来实现自动化测试、性能测试、线上监控...
【Python Selenium项目实战】：构建企业级自动化测试框架
[【Python Selenium项目实战】：构建企业级自动化测试框架](https://i.sstatic.net/VyQmR.png) # 1. Python Selenium基础介绍 ## 1.1 Selenium的起源和发展 Selenium是一个用于Web应用程序测试的工具，它允许开发者...
打造全流程接口自动化测试平台：HttpRunner+Python+Django+Vue实现
资源摘要信息:"基于...通过这个平台，用户不仅能够学习到如何构建和管理自动化测试，还能够深入理解软件测试的多个方面，包括但不限于接口测试、自动化脚本编写、持续集成实践和测试报告分析。
自动化测试框架_Test_framework-master.zip
06-28
企业级UI自动化测试框架，测试管理，数据驱动分离、接口自动化、接口性能压测等
大佬谈接口自动化，我是这样做测试框架开发的……
cky8792的博客
09-19 326
当你打开这篇文章就说明你已经对接口测试产生了兴趣~不管你是刚接触还是没接触过，都不妨看一看，希望对你以后的职业生涯有帮助。 同时随着AI的发展，根据2017年数据表明，只会表面点点点的测试工程师即将被取代，掌握接口...
接口自动化测试框架
weixin_39349045的博客
07-20 94
接口自动化测试框架 utp unittest platform 目录解释： cases：存放的case config：存放配置文件 data：测试数据 log：日志文件 report：测试报告 utils：工具包 请求 读取数据 db 日志模块 自定义 发报告 ...
如何从 0 开始搭建一套企业接口自动化
GitChat
03-14 572
众所周知为了适应业务快速迭代，测试人员面临着测试时间不断被压缩，而最近两年大环境因素，测试人员的 HC 也是在缩减的。业务越来越多，测试时间和人力面临着巨大的挑战，如何兜底保证质量，其实是一个很大的挑战，自动化测试的手段变得越来越重要。 按照自动化测试经典理论以及实际工作经验来看，对于测试人员来说，接口自动化会是一个性价比最高的手段，但是实践过程中，我们会发现： 一个 case 好写，超过 10...
如何应对企业级接口自动化测试项目中的挑战与困境【详细讲解】
mashangtt的博客
04-19 249
在企业项目中，接口测试是非常重要的一项工作。接口测试主要是通过请求和响应数据来测试接口的正确性、稳定性以及性能等方面。为了提高测试的效率和质量，我们可以将接口测试自动化，便于快速执行测试、提高测试覆盖率和减少人为出错的概率。本文将介绍如何在企业项目中进行接口自动化测试，包括测试框架和测试用例的编写。本文介绍了在企业项目中进行接口自动化测试的方法和实现。我们可以使用Python和Pytest等工具来编写测试用例和测试框架，以提高测试效率和质量。
初识httprunner之读取mysql配置文件以及连接mysql
weixin_67140608的博客
04-06 907
初识httprunner 封装python连接mysql以及读取配置文件
学会这套HttpRunner(17)：实现参数化传递，测试开发都直呼内行
GDYY3721的博客
11-20 215
也方便你下次能够快速查找。如有不懂还要咨询下方小卡片，博主也希望和志同道合的测试人员一起学习进步在适当的年龄，选择适当的岗位，尽量去发挥好自己的优势。我的自动化测试开发之路，一路走来都离不每个阶段的计划，因为自己喜欢规划和总结，测试开发视频教程、学习笔记领取传送门！！
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值