接口测试学习-python第八课（数据驱动测试）

自动化分为三类，数据驱动即根据数据去进行测试；代码驱动即测试都是通过代码完成的；关键字驱动即依靠一些软件，利用关键字完成测试。本次主要记录数据驱动，自动化框架主要有以下几个部分：
①获取用例
②调用接口
③检验结果
④发送测试报告
⑤异常处理
⑥日志

以前进行接口封装的时候，有过将代码分别放在不同的文件夹下的经历。这次也以这样的模式来完成，主要做到以下几点：首先读取excel文件里面的用例，其次根据用例完成接口测试，然后将测试返回信息和测试结果写入到excel用例文件中，最后发送邮件。同时各个部分关键结果处需要记录日志。

1、setting文件

setting文件一般放在config文件夹下。这个代码因为涉及到发送邮件，读取excel，写日志等。所以基础数据包括邮件的host，账号，密码等；还有文件地址和日志地址等。这些数据在后面的代码中都会使用到。

import os


# 发送邮件的一些固定参数，在sendmail函数中会使用到，可以在此处修改，此处的password是授权码
MAIL_HOST = 'smtp.163.com'
MAIL_USER = '********@163.com'
MAIL_PASSWORD = *****'  # 授权码
MAIL_TO = '352780148@qq.com'

BASE_PATH = os.path.dirname(
    os.path.dirname(os.path.abspath(__file__))
)  # 找到APT这个文件夹的地址
LOG_PATH = os.path.join(BASE_PATH, 'logs')  # 拼接出存放日志的路径
CASE_PATH = os.path.join(BASE_PATH, 'cases')  # 拼接出存放用例的路径

LEVEL = 'debug'  # 日志级别
LOG_NAME = 'apt.log'  # 日志文件名

2、日志模块

这个模块主要内容就是日志记录的功能。构造了一个可实例化的类，实例化后在其他模块可以直接调用生成相应等级的日志。

import logging
import os
from logging import handlers
from config import setting


class MyLogger(object):
    def __init__(self,file_name,level='info',backCount=5,when='D'):
        logger = logging.getLogger()
        logger.setLevel(self.get_level(level))  # 设置日志的级别
        # fl = logging.FileHandler(filename='a.log', mode='a', encoding='utf-8')
        cl = logging.StreamHandler()  # 负责往控制台输出的
        bl = handlers.TimedRotatingFileHandler(filename=file_name, when=when, interval=1,
                                               backupCount=backCount, encoding='utf-8')
        fmt = logging.Formatter('%(asctime)s - %(pathname)s[line:%(lineno)d]-%(levelname)s:%(message)s')
        # 指定日志的格式
        cl.setFormatter(fmt)  # 设置控制台输出的日志格式
        bl.setFormatter(fmt)  # 设置文件里面写入的日志格式
        logger.addHandler(cl)  # 把已经设置好的人放到办公室中
        logger.addHandler(bl)  # 同上
        self.logger = logger

    def get_level(self, sss):
        level = {
            'debug': logging.DEBUG,
            'info': logging.INFO,
            'warn': logging.WARN,
            'error': logging.ERROR
        }
        sss = sss.lower()
        return level.get(sss)

path = os.path.join(setting.LOG_PATH,  setting.LOG_NAME)  # 拼好日志的绝对路径
apt_log = MyLogger(path, setting.LEVEL).logger
# 直接在这边实例化，并.logger，使用时就可以直接apt_log.warning了

3、发送邮件模块

用于记录发送邮件的功能，这里就用到了setting里面记录的那些基础数据，还用到了日志记录功能。

import yagmail
from config import setting
from lib.log import apt_log


def sendemile(title, content, attrs=None):  # 定义发送邮件函数
    m = yagmail.SMTP(host=setting.MAIL_HOST,  # host调用setting文件中设置的固定参数
                     user=setting.MAIL_USER,  # user调用setting文件中设置的固定参数
                     password=setting.MAIL_PASSWORD  # password调用setting文件中设置的固定参数
                     )
    m.send(to=setting.MAIL_TO,
           subject=title,
           contents=content,
           attachments=attrs
           )  # 邮件发送主体内容，收件人使用固定参数，其他内容在调用函数时传入
    apt_log.info('邮件发送成功。')  # 写入发送邮件成功的日志

4、读取用例进行测试并记录测试结果模块

这是一个主体模块，完成了这个文件的主要功能。详细代码如下。

import xlrd
from lib.log import apt_log
import requests
from xlutils import copy


class OpCase(object):
    def get_case(self, file_path):
        cases = []  # 存放所有的测试用例
        if file_path.endswith('.xls') or file_path.endswith('.xlsx'):  # 判断路径是否存在
            try:
                book = xlrd.open_workbook(file_path)
                sheet = book.sheet_by_index(0)  # 打开用例文件
                for i in range(1, sheet.nrows):  # 从第二行开始遍历excel文件内容（第一行是标题）
                    row_data = sheet.row_values(i)  # 获取每行内容
                    cases.append(row_data[4:8])  # 在cases这个list中存每个用例的url,method,req_data,check
                apt_log.info('共读取%s条用例' % (len(cases)))  # 检查cases中的元素个数，日志记录读取了几条用例
                self.file_path = file_path  # 既然读取成功说明这个文件路径是正确的，那么这边定义下面写exccel就可以直接使用了
            except Exception as e:
                apt_log.error('【%s】用例打开失败，错误信息：%s' % (file_path, e))
        else:
            apt_log.error('用例文件不合法，%s' % file_path)
        return cases

    def dataToDict(self, data):  # 将用例中的req_data转为字典格式，可以直接用在request模块
        res = {}
        data = data.split(',')  # 这个地方要求用例中请求参数使用英文逗号分割的
        # 这边分割入参后，入参变为['a=1', 'b=2']这样的格式
        for d in data:
            k, v = d.split('=')
            # 再次分割后变为['a','1']这样的模式分别用k代表a，v代表1
            res[k] = v  # 存入字典中变成'a':1，这样的模式可直接在request模块接口测试中作为入参使用
        return res

    def my_request(self, url, method, data):
        method = method.upper()  # 首先将请求方式变为大写模式，方便后面验证
        data = self.dataToDict(data)  # 把a=1,b=2格式的请求参数变成字典格式
        try:
            if method == 'POST':
                res = requests.post(url, data).text  # 如果请求方式是post按照post模式进行接口测试
            elif method == 'GET':
                res = requests.get(url, data).text  # 按照get方式传入url和data进行接口测试
            else:
                apt_log.warning('暂不支持该请求')  # 其他的请求方式不支持，打印日志并返回提示
                res = '暂不支持该请求'
        except Exception as e:
            msg = '【%s】接口调用失败,%s' % (url, e)  # 请求未成功提示接口调用失败，写入日志并返回提示
            apt_log.error(msg)
            res = msg
        return res

    def check_res(self, res, check):
        res.replace('": "', '=').replace('": ', '=')  # 返回的报文是json格式的，利用字符替换让数据变成"a=1,b=2"的格式
        for c in check.split(','):  # 判断验证数据是否在返回的报文中
            if c not in res:
                apt_log.info('结果校验失败，预期结果：【%s】，实际结果【%s】' % (c, res))  # 不匹配则测试校验失败，打印日志
                return '失败'  # 返回失败的提示
        return '通过'  # 如果存在说明测试通过

    def write_excel(self, cases_res):  # 入参是每个用例的执行结果
        book = xlrd.open_workbook(self.file_path)
        new_book = copy.copy(book)
        sheet = new_book.get_sheet(0)  # 复制测试用例excel文件
        row = 1
        for case_res in cases_res:  # 遍历写入数据
            sheet.write(row, 8, case_res[0])  # 第八列写返回结果
            sheet.write(row, 9, case_res[1])  # 第九列写测试是否通过
            row += 1
        new_book.save(self.file_path.replace('xlsx', 'xls'))  # 保存结果
        

5、start文件

启动文件，用于集成所有的模块完成目标。

import os
import sys
from lib.common import OpCase
from lib.send_emile import sendemile
from config import setting

BASE_PATH = os.path.dirname(
    os.path.dirname(os.path.abspath(__file__))
)  # 找到APT这个文件夹的地址
sys.path.insert(0, BASE_PATH)  # 把ATP目录加到环境变量中，用于在其他不能帮忙加环境变量的时候


class CaseRun(object):
    def find_cases(self):
        op = OpCase()  # 实例化了操作用例这个类
        for f in os.listdir(setting.CASE_PATH):  # 获取到cases文件夹下的文件
            abs_path = os.path.join(setting.CASE_PATH, f)  # 拼接测试用例文件的绝对路径
            case_list = op.get_case(abs_path)  # 利用get_case函数获取到每个用例中的case
            res_list = []  # 创建一个空的list来存放测试返回的报文和测试结果
            pass_count = 0  # 用来计算成功用例个数
            fail_count = 0  # 用来计算失败用例格式
            for case in case_list:
                url, method, req_data, check = case  # get_case函数中提取每行用例的四个元素，分别定义一下
                res = op.my_request(url, method, req_data)  # 调用my_request函数进行测试接口返回结果
                status = op.check_res(res, check)  # 检查测试返回报文是否和预计测试结果相同，如果相同测试通过，否则测试失败
                res_list.append([res, status])  # 为了一次性写入测试结果，先将结果放入list中
                if status == '通过':
                    pass_count += 1
                else:
                    fail_count += 1
            op.write_excel(res_list)  # 写入excel
            msg = '''  # 定义邮件正文
            XX你好：
                本次共运行%s条用例，通过%s条，失败%s条。
                ''' % (len(res_list), pass_count, fail_count)
            sendemile('测试用例运行结果', content=msg, attrs=abs_path)  # 利用sendmail函数发送邮件，入参分别是主题，内容和附件


CaseRun().find_cases()  # 运行find_cases函数