SensoroApiAutoTest

联系方式：

• CSDN博客：https://blog.csdn.net/weixin_65784341?spm=1011.2415.3001.5343

• 对本框架有任何疑问均可加我微信拉你入自动化交流群(记得备注添加原因)： wj1641540482

  实现功能：

• 测试数据隔离, 实现数据驱动

• 环境隔离：执行环境一键切换，解决多环境相互影响问题

• 支持多接口数据依赖: 如A接口需要同时依赖B、C接口的响应数据作为参数

• 对接数据库： 将数据库的查询结果可直接用于断言操作

• 消息通知：支持邮件、企业微信群、钉钉群等通知方式

• 自定义扩展方法： 在用例中使用自定义方法(如：用例中需要生成的随机数据、时间数据等，可直接调用)

• 统计接口的运行时长: 拓展功能，可以直接看到每条case的运行时长

• 多种报告随心选择：框架支持pytest-html以及Allure测试报告，可以动态配置所需报告

• 日志模块: 打印每个接口的日志信息，订制了开关，可以决定是否需要打印日志

• 自动生成用例代码: 测试人员在yaml文件中填写好测试用例, 程序可以直接生成用例代码，纯小白也能使用（待实现）

• 接口录制：录制指定包含url的接口,生成用例数据（待实现）

• 动态多断言: 如接口需要同时校验响应数据和sql校验，支持多场景断言（待实现）

• 支持swagger接口文档转成yaml用例，节省用例编写时间（待实现）

• 集成UI自动化、关键字驱动等（待实现）

环境准备

技术栈：python+pytest+requests+allure+pytest-html

• 选择语言：python>=3.10（如果是3.10以下版本的话，需要删除base_api.py中的函数返回数据格式限制，否则会存在写法不兼容问题）
• 编程工具选型：pycharm
• 测试框架选型：pytest
• 报告可视化方案选型：allure、pytest-html
• 持续集成工具：jenkins
• 仓库服务器选型：gitlab

安装依赖：

• 获取源码后，在pycharm终端运行以下代码，即可一键安装项目依赖：
  • pip3 install -r requirements.txt * 注：如果是window系统报错 UnicodeDecodeError: 'gbk' codec can't decode byte 0xaa in position 65: illegal multibyte sequence ，则需要先在终端执行下方的命令，将终端编码格式改为utf-8，再执行上方install命令，即可解决编码问题
    • chcp 65001
  • 或者直接使用pycharm自带的提示功能安装依赖包，推荐这种！！！

项目结构

├── README.md                                         项目说明文件
├── Temp                        allure报告临时存放目录
├── common                        公共方法类存放目录
│     ├── base_log.py                    日志记录器
│     ├── base_api.py                        基础类，对请求方法进行二次封装
│     ├── models.py                            项目环境枚举
│     ├── exceptions.py                            自定义异常
│     ├── mail_sender.py                发送邮件方法
│     ├── settings.py                    项目配置文件
│     ├── connect_DB.py                        连接数据库方法
│     └── rebot_sender.py                发送群聊通知方法
├── configs                        项目配置信息目录
│     ├── dir_path_config.py                项目各目录路径文件
│     ├── lins_environment.ini                项目全局环境变量配置文件（弃用）
│     └── lins_environment.py                项目全局环境变量
├── conftest.py                        pytest共享文件，设置allure报告及其他报告的环境变量
├── datas                        测试数据存放目录
│     ├── login.yaml                    登录测试的数据demo
├── outFiles                        各种输出文件存放目录
│     ├── logs                        日志存放目录
│     ├── pytest_report                    pytest报告存放目录
│     ├── pytest_result                    pytest-json报告数据存放目录
│     ├── allure_report                    allure报告存放目录
│     └── Temp                            allure报告原始数据存放目录
├── pageApi                        各业务接口对象类
│     ├── alarms.py                    预警相关接口demo
│     └── login.py                    登录相关接口demo
├── pytest.ini                        pytest启动项配置文件
├── requirements.txt                    python项目依赖文件
├── run.py                        执行测试用例主入口
├── testCase                        测试用例存放目录
│     ├── conftest.py                    pytest共享文件，提供各种方法及前后置操作
│     ├── test_alarms.py                预警测试用例demo
│     └── test_login.py                    登录测试用例demo
└── utils                        测试工具存放目录
    ├── config_handle.py                读取config配置文件的方法
    ├── allure_handle.py                allure相关工具
    ├── cache_handle.py                        设置、读取缓存的工具（解决接口数据依赖）
    ├── command_parser.py                设置命令行启动命令工具
    ├── data_handle.py                        数据处理工具
    ├── excel_handle.py                        excel表格处理工具
    ├── faker_utils.py                        造假数据工具
    ├── file_handle.py                        文件处理工具
    ├── get_local_ip.py                        获取本机ip地址的方法
    ├── jenkins_handle.py                获取Jenkins相关数据的工具
    ├── report_data_handle.py                获取测试结果统计的方法
    ├── yaml_handle.py                        yaml文件处理工具
    └──time_utils.py                    时间转换工具类

项目代码工程构建思路：

1.框架设计思路

1.1设计框架的原则：

• 封装基类方法
  • 对于一些较通用的方法可以进行封装，比如发送请求、增、删、改、查。
• 高内聚低耦合
  • 每个模块尽可能独立完成自己的功能，不依赖于模块外部的代码。
  • 模块与模块之间接口的复杂程度尽量低，比如在类内部尽可能减少方法之间的调用，否则一个方法的变动会影响调用它的另一个方法。
• 脚本分离
  • 业务代码、测试数据应该相互剥离、灵活调用。理念参考PO设计模式。代码中应该不出现具体的数据、配置，而是调用对应的数据文件。

1.2设计项目骨架：

• 按照上述原则，采用PO设计模式及pytest测试框架，设计项目结构如下：

- common  #包文件，公共模块，存放一些通用方法
    - base_api.py
        - class BaseApi()#基类
            - 方法1：发送请求
            - 方法2：增
            - 方法3：删
            - 方法4：改
            - 方法5：查
- pageApi  #包文件，存放业务层代码
    - login.py #登陆模块
        - class Login(BaseApi) #继承基类里的BaseApi
            - 方法1：发送登陆请求
            - 方法2：发送登出请求
    - logout.py #登出模块
        - class Logout(BaseApi)
- configs  #包文件，存放配置
    - lins_environment.py 
        - class EntryPoint #用于切换测试环境
            - 方法1：获取项目URL
            - 方法2：获取项目默认headers
            - 方法3：获取项目默认数据库配置 
- datas #文件夹，存放数据/测试用例
    - xxx.xls
    - xxx.yaml
- testCase #包文件，存放测试用例代码,注意符合pytest命名规范
    - test_login.py
        - class Test_login
            - 方法1：test_login01
            - 方法2：test_login02
    - test_logout.py
        - class Test_logout
            - 方法1：test_logout01
            - 方法2：test_logout02
- outFiles #文件夹，输出文件
    - logs #存放项目每次运行产生的log文件
    - report #存放报告
    - screenShot #存放截图
- utils #包文件，工具类
    - handle_data.py 
    - handle_excel.py
    - handle_path.py
    - handle_yaml.py
- run.py #python文件，配置及执行测试入口

2.使用实例

2.1配置项目各环境默认参数

• 在lins_environment.py中进行各个环境相关的基础配置

2.2配置项目运行相关参数

• 在settings.py中配置项目运行的环境、通知方式、通知内容等

2.3接口定义及测试用例准备

• 定义接口，在pageApi目录下设计接口对象

class Login(BaseApi):  # 定义接口对象类，同一个业务的接口放在该类下
    """登录模块"""

    def get_sendSms(self, phone):  # 定义具体的接口及会用到参数
        """获取手机号验证码"""
        address = '/xxx/sendSms'  # 定义接口的路径，从/开始
        json = {  # post接口可能会用到的参数，因为获取验证码接口是固定的，所以把需要的参数直接定义好了
            'mobile': phone,
            'region': 'CN'}

        return self.post(address, json=json)  # 调用基类对应的请求方法，发起具体请求

    def login_app_v2(self, phone, sms_code):  # 定义具体的接口及会用到参数

        """移动端登录V2权限"""
        address = '/xxx/loginByMobile'  # 定义接口的路径，从/开始
        json = {  # post接口可能会用到的参数，因为登录接口是固定的，所以把需要的参数直接定义好了
            'mobile': phone,
            'smsCode': sms_code,
        }

        return self.post(address, json=json)  # 调用基类对应的请求方法，发起具体请求

    # 注：除登录接口外，其他接口最好都定义一个headers=None的参数，防止以后需要传特殊的headers
    def select_merchant(self, params=None, headers=None):  # 定义具体的接口及会用到参数
        """选择项目,切换scom时使用"""
        address = '/xxx/selectMerchant'  # 定义接口的路径，从/开始
        params = params  # get接口可能会用到的参数，因为需要的参数不固定，所以定义params=None，后续可以根据具体的用例来传参
        headers = headers
        return self.get(address=address, params=params, headers=headers)  # 调用基类对应的请求方法，发起具体请求

• 根据接口对象，在testCase目录下设计测试用例

# 注：由于pytest框架规则，所有的测试用例文件名必须以test_开头或者结尾，方法名必须以test_开头，类名以Test开头或结尾

@allure.feature("登录模块测试用例")  # allure报告中展示模块功能分类的标题
class TestLogin:  # 测试类名
    # 通过get_yaml_data方法，获取datas目录下准备好的测试数据
    data_smsCode = get_yaml_data('datas/smsCode.yaml')
    # 将获取的测试数据转换成列表套元组的格式：[(),(),()],每一个元组就是一组测试数据，其实可以不用进行这一步，我这里加了这一步是为了让allure报告的测试用例标题动态化
    params = [(item['case_title'], item['phone'], item['expected']) for item in data_smsCode]

    @allure.story("测试获取验证码")  # allure报告中展示故事分类的标题，比allure.feature低一级
    @allure.title('{case_title}')  # allure报告中展示测试用例的标题，比allure.story低一级
    @allure.severity(allure.severity_level.BLOCKER)  # 设置测试用例的级别，用于在allure报告中展示，BLOCKER为阻塞级别
    @pytest.mark.run(order=1)  # 设置测试用例执行优先级的装饰器，优先级是：由小到大、由正到负、未标记的在正数后、负数前执行
    @pytest.mark.parametrize('case_title,phone, message', params)  # pytest参数化的装饰器，左边字符串内传参数名以“,”隔开，右边传具体数据，结构是[(),()]
    @pytest.mark.dependency(name='get_smsCode')  # 设置这条测试用例为主依赖用例，并且别名为get_smsCode，方便后面需要依赖该用例的用例使用
    # @pytest.mark.flaky(reruns=5, reruns_delay=2)  # 设置用例失败重试次数和重试间隔
    def test_smsCode(self, case_title, phone, message):  # 定义测试用例名称及需要的参数
        """获取验证码"""
        r = Login().get_sendSms(phone)  # 调用pageApi目录下的接口对象，来组成具体的测试用例,并获取返回结果的response
        r_message = BaseApi.get_json(r)['message']  # 调用BaseApi下的get_json()方法，将response转换为json数据，并获取返回体里面message字段的值
        assert r_message == message  # 对获取的返回结果进行断言

    data_login = get_yaml_data('datas/login.yaml')
    params = [(item['case_title'], item['phone'], item['smsCode'], item['expected']) for item in data_login]

    @allure.story("测试登录")
    @allure.title('{case_title}')
    @allure.severity(allure.severity_level.CRITICAL)  # 设置测试用例的级别，用于在allure报告中展示，CRITICAL为严重级别
    @pytest.mark.run(order=2)
    @pytest.mark.parametrize('case_title,phone,smsCode,message', params)
    @pytest.mark.dependency(depends=["get_smsCode"],
                            scope='class')  # 设置该用例依赖的用例，只有当依赖的用例执行成功了，这条用例才会执行，否则会跳过。scope代表查找依赖用例的范围，class代表只在当前类查找
    def test_login(self, case_title, phone, smsCode, message):
        """登录测试"""
        r = Login().login_app_v2(phone, smsCode)
        assert r.json()['message'] == message

• 根据测试用例，在datas目录下准备测试数据

- case_title: '手机号正确，获取验证码成功'       # yaml语法，“-”带表数组，“:”带表键值对
  phone: '13800000000'
  expected: 'SUCCESS'

- case_title: '手机号格式不正确，获取验证码失败'
  phone: '12345678901'
  expected: '手机号码格式不正确'

- case_title: '手机号非平台号码，获取验证码成功'
  phone: '13718395479'
  expected: '账号异常①，请联系管理员'

2.4项目运行

• 方式1：在run.py中配置需要运行的测试用例及对整个测试的一些其他配置，然后直接右键运行该文件
• 方式2：如果在Jenkins上运行，可以通过命令行启动的方式执行（此方式可以指定运行环境，是否发送通知等参数，例如：python3 run.py -env TEST –send-wechat True）

pytest.main([
    '-vs',  # 指定输出用例执行信息，并打印程序中的print/logging输出
    'testCase/',  # 执行用例的目录或文件
    '--alluredir', './Temp', '--clean-alluredir',  # 先清空旧的alluredir目录，再将生成Allure原始报告需要的数据,并存放在 /Temp 目录
    '--html=./outFiles/pytest_report/report.html',  # 指定pytest-html报告的存放位置
    '--self-contained-html',  # 将css样式合并到pytest-html报告文件中，便于发送邮件
    '--capture=sys',  # 仅捕获stderr，将stdout输出到终端，这里是使pytest-html中失败的case展示错误日志，会导致case中的print不打印
    '-p', 'no:logging',  # 表示禁用logging插件，使报告中不显示log信息，只会显示stderr和stdoyt信息,避免log和stderr重复。
    # '-k not test_login.py',  # 不执行该文件里的case
])

• run文件运行后，会根据配置的运行条件去调用testCase下对应的测试用例，也就是我们上面定义的测试用例文件
• 测试用例运行时，如果有参数化配置会去读取datas下对应的数据文件，然后会去调用pageApi里面的具体接口
• pageApi里面封装的就是具体的接口对象，此时定义的接口发起请求时，会去调用common的定制请求方法进行真正的请求，并且common里面二次封装的方法会在请求之前进行环境配置的读取。