インターフェイスオートメーションのpython 10-エクセル実際のデザインパターン

序文

I.はじめに

1.準備環境： Pythonのエクセル+ + + + unittestのDDT、次の主な設置環境を要求し、他の一般的に自身をインストールしていません。

• ピップxlrdインストール
• ピップxlutilsをインストール
• ピップDDTインストール
• ピップリクエストをインストール
• HTMLTestRunner

2.機能は現在実装します：

• リクエスト要求をパッケージングする方法
• Excelのリクエストパラメータ読み取りインターフェースは、その結果、支持テーブルの複数をアサート
• （など、Excelが自動的に上下の真ん中の枝を調整するために見るたびに報告しなければならないことは非常に悲しい）Excelで新しい演算結果を書きます
• unittestの+ DDT実行データ駆動モード
• HTMLTestRunner視覚的なレポートを作成するHTML
• 例は、電子メールを使用しないことで（比較的無味、以前にセレンと継承）、すなわち

3.excel、次の形式：

 第二に、カプセル化モジュール

1. Excel読み取りパッケージ

# coding:utf-8
import xlrd
class Excel():
    '''excelPath= excel 的目录路径，sheetName = 自定义table'''
    def __init__(self, excelPath, tableName='Sheet1'):
        self.data = xlrd.open_workbook(excelPath)
        self.table = self.data.sheet_by_name(tableName)
        self.keys = self.table.row_values(0)    # 获取第一行作为key值
        self.rowNum = self.table.nrows          # 获取总行数
        self.colNum = self.table.ncols          # 获取总列数

    def dict_data(self):
        if self.rowNum <= 1:
            print("总行数小于1")
        else:
            r = []
            j = 1
            for i in range(self.rowNum-1):
                s = {}
                values = self.table.row_values(j)   # 从第二行取对应values值
                for x in range(self.colNum):
                    s[self.keys[x]] = values[x]
                r.append(s)
                j += 1
            return r

if __name__ == "__main__":
    data = Excel("G:\\python_study\\study\\excel_demo\\cases\\接口用例.xls", 'MJJ')
    res = data.dict_data()[0]
    print(res)

 2.request封装，和excel写入封装

我这里的‘配置文件’是用例方便切换ip的，看自己的需求。

# coding:utf-8
import json, os, requests,datetime
from xlrd import open_workbook
from xlutils.copy import copy
from study.excel_demo.common.excel import Excel

dir_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))  # 获取模块目录
filename = os.path.join(dir_path, "cases", "接口用例.xls")
host_data = Excel(filename, '配置文件').dict_data()


def send_requests(excel_data,s=requests.session()):
    '''封装requests请求'''
    host = host_data[0]['host']
    excel_data = excel_data
    url = excel_data["url"]
    method = excel_data["method"]
    type = excel_data['type']

    # 请求头部headers
    try:
        headers = eval(excel_data["headers"])
    except:
        headers = None

    print("*******正在执行用例：-----  ID: %s" % int(excel_data['ID']))
    print("请求方式：%s, 请求url:%s" % (method, host+url))

    # post请求body内容
    try:
        bodydata = eval(excel_data["body"])

    except:bodydata = excel_data["body"]

    # 判断传data数据还是json
    if type == "json":
        body = json.dumps(bodydata)
    elif type == "params":
        body = bodydata
    else:
        body = bodydata
    if method == "post":
        print("请求类型为：%s ,body参数为：%s" % (type, body))

    res = {}   # 接受返回数据

    r = s.request(method=method,
                  url=host+url,
                  params=body,
                  headers=headers,
                  data=body,)

    print("响应信息为：%s" % r.content.decode("utf-8"))
    res['ID'] = int(excel_data['ID'])
    res["statuscode"] = str(r.status_code)          # 状态码转成str
    res["text"] = str(r.content.decode("utf-8"))
    res["times"] = str(r.elapsed.total_seconds())   # 接口请求时间转str

    if res["statuscode"] != "200":
        res["error"] = res["text"]
    else:
        res["error"] = ""
    res["msg"] = ""
    if excel_data["checkpoint"] in res["text"]:
        res["result"] = "pass"
        print("用例测试结果:  ID: %s---->%s" % (int(excel_data['ID']), res["result"]))
    else:
        res["result"] = "fail"
        res["error"] = res["text"]
    res['time'] = datetime.datetime.now().strftime("%Y-%m-%d %H:%M")
    return res

def wirte_result(res, report_path, tablename):
    '''
    1.传需要写入的res
    2.report_path:写入的路径
    3.tablename
    '''

    excel = copy(open_workbook(report_path,
                               formatting_info=True))   # 将xlrd的对象转化为xlwt的对象
    row_nub = res['ID']                                 # 返回结果的行数row_nub
    table = excel.get_sheet(tablename)                          # 获取要操作的sheet
    table.write(row_nub, 8, res['statuscode'])         # 写入返回状态码statuscode,第8列
    table.write(row_nub, 9, res['result'])            # 测试结果 pass 还是fail
    table.write(row_nub, 10, res['times'])             # 耗时
    table.write(row_nub, 11, res['error'])             # 状态码非200时的返回信息
    table.write(row_nub, 12, res['msg'])               # 抛异常
    table.write(row_nub, 13, res['time'])               # 抛异常
    excel.save(report_path)                              # 保存并覆盖文件

3.test_api用例，支持多个excel的table，在全局变量修改tablename即可。

import unittest,ddt, os
from study.excel_demo.common import base
from study.excel_demo.common.excel import Excel
from xlrd import open_workbook
from xlutils.copy import copy

dir_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))       # 获取模块路径
report_path = os.path.join(dir_path, "report", "api_excel测试报告.xls")     # 报告生成路径
filename = os.path.join(dir_path, "cases", "接口用例.xls")                   # 获取excel路径
testdata = Excel(filename, 'MJJ').dict_data()                                 # tablename
excel1 = copy(open_workbook(filename, formatting_info=True))                  # 将xlrd的对象转化为xlwt的对象
excel1.save(report_path)                                                       # 每次执行前复制用例

@ddt.ddt
class Test_api(unittest.TestCase):
    @ddt.data(*testdata)
    def test_login_api(self, data):
        res = base.send_requests(data)
        base.wirte_result(res, report_path, 'MJJ')   # res写入保存
        check = data["checkpoint"]
        print("检查点---->：%s" % check)            # 检查点 checkpoint
        res_text = res["text"]                      # 返回结果
        self.assertIn(check, res_text)

if __name__ == "__main__":
    unittest.main()

4.run_cases，执行所有用例（发送邮件需申请QQ邮箱或其他邮箱的授权码）

'''
这个是优化版执行所有用例发送测试报告，四个步骤
第一步加载用例
第二步执行用例
第三步获取最新测试报告
第四步发送邮箱 （这一步不想执行的话，可以注释掉最后面那个函数就行）
'''
# coding=utf-8
import unittest, time, os, HTMLTestRunner       # HTMLTestRunner生成html报告
import smtplib                                  # 负责发送邮件
from email.mime.text import MIMEText            # 负责构造邮件的正文
from email.mime.multipart import MIMEMultipart

report_name = u'API自动化测试报告.html'         # 报告名称
report_title = u'API自动化测试'                  # 报告title名称
report_ename = 'api_report.html'                # 附件名称

# 当前脚本所在文件真实路径zentao
cur_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))


def add_case(caseName='cases', rule='test*.py'):
    '''第一步：加载所有的测试用例'''
    case_path = os.path.join(cur_path, caseName)

    # 如果不存在这个cases文件夹，就自动创建一个
    if not os.path.exists(case_path):os.mkdir(caseName)

    # 定义 discover 方法的参数，返回测试用例列表文件名
    discover = unittest.defaultTestLoader.discover(case_path,
    pattern=rule,
    top_level_dir=None)
    return discover

def run_case(all_case, reportName='report'):
    '''第二步：执行所有的用例, 把结果写入测试报告'''
    report_Folder = os.path.join(cur_path, "report")
    if not os.path.exists(report_Folder):os.mkdir(report_Folder)    # report文件夹，没有的话自动创建一个

    report_path = os.path.join(report_Folder, report_name)  # 测试报告名称
    print('report path:%s' % report_path)

    # 加载所有用例，写入测试报告，生成
    fp = open(report_path, 'wb')
    runner = HTMLTestRunner.HTMLTestRunner(stream=fp, title=report_title, retry=0)
    # 调用 add_case 函数返回值
    runner.run(all_case)    # 执行
    fp.close()

def get_report_html(report_path):
    '''第三步：获取最新的测试报告'''
    lists = os.listdir(report_path)     # 获取report目录下的最新测试报告
    lists.sort(key=lambda fn: os.path.getmtime(os.path.join(report_path, fn)))
    print(u'最新测试生成的报告： '+lists[-1])

    report_file = os.path.join(report_path, lists[-1])  # 找到最新生成的报告文件
    return report_file

def get_report_xls(report_path):
    '''第三步：获取最新的测试报告'''
    lists = os.listdir(report_path)     # 获取report目录下的最新测试报告
    lists.sort(key=lambda fn: os.path.getmtime(os.path.join(report_path, fn)))
    print(u'最新测试生成的报告： '+lists[-2])

    report_file = os.path.join(report_path, lists[-2])  # 找到最新生成的报告文件
    return report_file


def send_mail(sender, pwd, receiver, smtpserver, report_file, port):
    '''发送最新的测试报告内容'''

    with open(report_file, "rb") as f:
        mail_body = f.read()

    # 定义邮件内容
    msg = MIMEMultipart()
    body = MIMEText(mail_body, _subtype='html', _charset='utf-8')
    msg['Subject'] = report_title+u'报告'
    msg["from"] = sender
    if isinstance(receiver, str):
        msg["to"] = receiver
    if isinstance(receiver, list):
        msg["to"] = ','.join(receiver)

    # 加上时间戳，显示报告的内容
    time.strftime('%a, %d %b %Y %H_%M_%S %z')
    msg.attach(body)

    # 邮箱添加附件
    att = MIMEText(open(report_file, "rb").read(), "base64", "utf-8")
    att["Content-Type"] = "application/octet-stream"
    att["Content-Disposition"] = 'attachment; filename= %s' % report_ename
    msg.attach(att)

    try:
        smtp = smtplib.SMTP()       # 登录邮箱
        smtp.connect(smtpserver)    # 连接邮箱服务器
        smtp.login(sender, pwd)     # 用户名密码

    except:
        smtp = smtplib.SMTP_SSL(smtpserver, port)
        smtp.login(sender, pwd)                         # 登录
    smtp.sendmail(sender, receiver, msg.as_string())
    smtp.quit()
    print('测试报告电子邮件已发送！')


if __name__ == "__main__":
    all = add_case()   # 加载用例
    run_case(all)      # 执行用例

    # 获取最新的测试报告文件
    report_path = os.path.join(cur_path, 'report')  # 这个文件夹下
    report_file = get_report_html(report_path)      # 获取最新测试报告路径

    # 邮箱配置
    sender = '[email protected]'
    pwd = 'xxx'  # SSL授权码登录
    smtp_server = 'smtp.qq.com'
    port = 465
    receiver = ['[email protected]']  # 可多个邮箱传list对象

    from selenium import webdriver
    # driver = webdriver.Chrome()        # 浏览器正常模式

    option = webdriver.ChromeOptions()   # 浏览器静默模式
    option.add_argument('headless')
    driver = webdriver.Chrome(chrome_options=option)

    html_path = os.path.join(cur_path, 'report', report_name)  # 获取报告文件目录
    driver.get(html_path)  # 打开html测试报告

    from project_lyl.mjj_app.common.base import Base
    b = Base(driver)
    loc_Failure = ('xpath', '/html/body/div[2]/p[3]/span[2]')
    loc_Error = ('xpath', '/html/body/div[2]/p[3]/span')
    t1 = b.get_text(loc_Failure)
    t2 = b.get_text(loc_Error)

    # 判断 测试报告 是否有Failure、Error、空值
    if (t1 or t2) in ('Failure', 'Error', ''):
        # pass      # 4.最后一步发送报告 注释掉就不发邮件
        send_mail(sender, pwd, receiver, smtp_server, report_file, port)
    else:
        print('用例全部通过，不需要发送邮件')
    driver.quit()

 三、执行结果展示

1.html 测试报告：

 2.失败邮箱接收的报告：

 3.excel 测试报告：

当然也是可以参考Page Object模式，更多的是用在selenium UI 自动化测试上，但是我们的api自动化测试也是可以参照这样的设计模式。

1.api：接口请求，及断言封装模块；

2.cases：用例集合；

3.common：配置文件，如环境，封装sql、读取excel操作等；

4.data：测试数据，如ddt；

5.执行用例，测试报告路径

说了那么多，还不如玩api平台呢？这是给点点点手下人用的，创建桌面快捷编辑写excel稳得一匹。

欢迎来QQ交流群：482713805