接口自动化框架设计

一、项目介绍

1.流程图及框架设计

1.1 框架设计

1.2 流程图

2.项目结构

├── README.md                                     	项目说明文件
├── Temp											allure报告临时存放目录						
├── common											公共方法类存放目录										
│     ├── base_log.py								日志记录器								
│     ├── base_api.py								基础类，对请求方法进行二次封装						
│     ├── lins_environment_enums.py					项目环境枚举				
│     ├── mail_sender.py							发送邮件方法						
│     └── settings.py								项目配置文件								
├── configs											项目配置信息目录										
│     ├── dir_path_config.py						项目各目录路径文件					
│     ├── lins_environment.ini						项目全局环境变量配置文件（弃用）					
│     ├── lins_environment.py						项目全局环境变量						
│     └── mail_config.yaml							发送邮件配置信息						
├── conftest.py										pytest共享文件，设置allure报告及其他报告的环境变量									
├── datas											测试数据存放目录										
│     ├── login.yaml								登录测试的数据demo							
├── environment.properties							allure报告环境变量展示文件					
├── outFiles										各种输出文件存放目录									
│     ├── logs										日志存放目录									
│     ├── pytest_report								pytest报告存放目录							
│     ├── report									allure报告存放目录								
│     └── screenShot								截图存放目录							
├── 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											测试工具存放目录										
    ├── get_config.py								读取config配置文件的方法							
    ├── get_dir_path.py								获取项目各个文件路径的类							
    ├── get_yaml_data.py							读取yaml文件的方法
    ├── lock_reset.py								门禁出厂							
    ├── temperature_terminal_reset.py				测温终端出厂
    └── time_utils.py								时间转换工具类							

二、环境准备

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

• 选择语言：python>=3.8
• 编程工具选型：pycharm
• 测试框架选型：pytest
• 报告可视化方案选型：allure、pytest-html
• 持续集成方案：jenkins
• 仓库服务器选型：gitlab

2.安装依赖：

获取源码后，在pycharm终端运行以下代码，即可一键安装项目依赖：

pip3 install -r requirements.txt

三、项目代码工程构建思路：

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接口定义及测试用例准备

• 定义接口，在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报告中展示模块功能分类的标题，详细可参考我的博客：https://blog.csdn.net/weixin_65784341/article/details/128306334
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: '13711195479'
  expected: '账号异常①，请联系管理员'

2.1整体项目运行流程

• 在run.py中配置需要运行的测试用例及对整个测试的一些其他配置，然后右键运行该文件

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里面二次封装的方法会在请求之前进行环境配置的读取。
• 整体运行流程如下图：

四、后续代码编写思路

框架写好后的代码编写思路，大体上为：

1.基类封装，把一些常用的方法比如发送请求、增、删、改、查放到我们的基类里。

2.编写业务层的接口代码

3.编写测试用例代码，过程中发现缺什么就去写什么方法，思考这个方法应该放在具体业务内还是基类还是utils内，这个过程是对代码不断优化的过程。直到我们的用例代码写完。

• 比如，写测试用例代码过程中需要读取yaml文件，就在utils内加一个get_yaml_data的方法。
• 再比如，两个业务模块之间需要关联，需要A方法返回对象给B方法用，则去优化A方法，给出返回值。
• 再再比如，一些关键节点需要截图，则去补充截图的方法。
• 再再再比如，测试完成后需要发送邮件及同步企业微信群聊，就去common里面增加一个mail_sender的方法。

五、额外知识：PO和Pytest

1.初识PO：

1.1什么是PO模式

PO/POM，即Page Object Model的简称。实际上就是按照面向对象的思想，把页面看做对象，把里面的元素进行封装（最开始用于UI自动化测试）。我们可以看下图，更加便于理解：

从图中可以看出PO模式主要分三层：

• 基础层BasePage：封装一些最基础的方法，元素定位，框架跳转等
• PO层：元素定位、获得元素对象，页面动作
• 测试用例层：业务逻辑，数据驱动

三者的关系：PO层继承Base层，测试用例层调用PO层。

进一步理解：

• 页面对象模型(PO)是一种设计模式，用来管理维护一组页面元素的对象库
• 在PO下，应用程序的每一个页面都有一个对应的Page类
• 每一个Page类维护着该页面的元素集和操作这些元素的方法

1.2 PO模式的基本原则

• The public methods represent the services that the page offers
• Try not to expose the internals of the page
• Generally don't make assertions
• Methods return other PageObjects
• Need not represent an entire page
• Different results for the same action are modelled as different methods

简单翻译：

• 用公共方法代表页面提供的功能
• 不要暴露页面元素到外部
• 一般不在方法内加断言
• 方法应该返回其他PO对象（可以是页面或者是断言数据等）
• 不需要封装页面内所有元素
• 同样的行为不同的结果可以封装成不同的方法

2.初识Pytest

2.1什么是pytest

pytest 是 python 的第三方单元测试框架，它支持参数化、fixture（用于测试用例的前置和后置操作）、自动发现测试文件、插件化等特性，比自带 unittest 更简洁和高效，支持315种以上的插件，同时兼容 unittest 框架。

想了解更多的使用方法，可以参考我的博客：pytest的使用简介

2.2pytest的基本原则

• .py 测试文件必须以test_开头（或者以_test结尾）
• 测试类必须以Test开头或结尾，并且不能有 init 方法
• 测试方法必须以test_开头
• 断言必须使用 assert

2.3pytest的注意事项

下载好pytest后，需要在pycharm中将单元测试框架设置为pytest，才能正常识别到pytest测试用例，否则定义好的测试用例会被当成普通函数