源碼見Github：https://github.com/F1And/api4code

公司新來兩個(gè)妹子一直吐槽奄容，這個(gè)接口測試用例用excel維護(hù)起來十分費(fèi)腦費(fèi)事踊东，而且比較low（內(nèi)心十分贊同但是不能推翻自己)，妹子希望只在編輯器中就能完成所有工作胞四，包括用例編輯恬汁、場景設(shè)計(jì)、數(shù)據(jù)處理辜伟、一鍵自動(dòng)化測試氓侧、報(bào)告生成，于是偷偷的進(jìn)行了二次改版导狡。

變更內(nèi)容如下：

• 1.代碼結(jié)構(gòu)

image.png

• 2.新增測試報(bào)告網(wǎng)頁版和版本管理

• 3.新增用例代碼化

一约巷、封裝一個(gè)獲取用例的模塊

image.png

用例的寫法可以按照yml文件的寫法，后綴的文件都可為.conf旱捧、.config独郎、.ini。[]中的是測試用例場景廊佩，下面的參數(shù)內(nèi)容對應(yīng)接口用例參數(shù)囚聚。

簡單介紹下python內(nèi)置模塊ConfigParser：

• ConfigParser 是用來讀取配置文件的包。配置文件的格式如下：中括號“[ ]”內(nèi)包含的為section标锄。section 下面為類似于key:value 的配置內(nèi)容顽铸。(key = value也可以具體方法這次不詳細(xì)展開，之后寫一遍關(guān)于ConfigParser的用法料皇，懂原理會(huì)讓工作更輕松谓松。)

• 這里講講為什么配置寫在最外層星压，如果寫到文件夾中，怎么都無法讀取配置鬼譬。python執(zhí)行run命令的時(shí)候需要.ini文件跟run 文件在同個(gè)文件夾下娜膘。所以應(yīng)該是路徑問題導(dǎo)致，之后嘗試修復(fù)這個(gè)BUG优质。

（通過操作絕對路徑的方法修復(fù)此BUG上圖已經(jīng)修復(fù)）

這次變更代碼實(shí)現(xiàn)如下：

#!/usr/bin/python
# -*- coding: UTF-8 -*-
# 基礎(chǔ)包：配置服務(wù)

import ConfigParser

config = ConfigParser.ConfigParser()


def get_config(filename):
    """
    獲取文件配置
    :param filename: 配置文件名
    :return: None
    """
    global config
    try:
        config.read(filename)
        return True
    except Exception, e:
        print ("讀取配置失敗 %s" % e)


def get_data(title, key):
    """
    參數(shù)配置
    :param title: 配置文件的頭信息
    :param key: 配置文件的key值
    :return: 配置文件的value
    """
    try:
        value = config.get(title, key)
        return value
    except Exception, e:
        print ("獲取參數(shù)失敗 %s" % e)


def get_title_list():
    """
    獲取所有title
    :return: title list
    """
    try:
        title = config.sections()
        return str(title).decode("string_escape")
    except Exception, e:
        print ("獲取title信息失敗 %s", e)

二竣贪、封裝一個(gè)日志的模塊

這次日志進(jìn)行了一次更改：會(huì)將測試用例返回結(jié)果文件內(nèi)容寫入，文件通過mkdocs生成測試報(bào)告巩螃。

公司用的微服務(wù)演怎，作為testOps所以需要對Docker有一定涉獵，docker.hub官方提供了mkdocs的鏡像避乏。拉取官網(wǎng)鏡像爷耀，將數(shù)據(jù)卷掛載到搭載測試報(bào)告的宿主機(jī)上，就可以訪問了拍皮。你只要維護(hù)代碼的測試用例歹叮，自動(dòng)更新測試報(bào)告。

看下展示效果：

image.png

代碼如下：

#!/usr/bin/python
# -*- coding: UTF-8 -*-
# 基礎(chǔ)包：日志服務(wù)

import logging
import constants as cs
import logging.handlers


def get_logger(name='report'):
    FORMAT = '%(message)s'
    filename = cs.REPORT_PATH + name + cs.NOW
    logging.basicConfig(level=logging.WARNING, format=FORMAT,
                       filename=filename, filemode='w')
    return logging

三铆帽、調(diào)用接口的requests

代碼如下：

#!/usr/bin/python
# -*- coding: UTF-8 -*-
# 基礎(chǔ)包：接口測試的封裝

import requests
import json


def change_type(value):
    """
    對dict類型進(jìn)行中文識(shí)別
    :param value: 傳的數(shù)據(jù)值
    :return: 轉(zhuǎn)碼后的值
    """
    result = eval(json.dumps(value, ensure_ascii=False, encoding="UTF-8"))
    return result


def api(method, url, data, headers):
    """
    定義一個(gè)請求接口的方法和需要的參數(shù)
    :param method: 請求類型
    :param url: 請求地址
    :param data: 請求參數(shù)
    :param headers: 請求headers
    :return: code碼
    """
    global results
    try:
        if method == ("post" or "POST"):
            results = requests.post(url, data, headers=headers)
        if method == ("get" or "GET"):
            results = requests.get(url, data, headers=headers)
        response = results.json()
        code = response.get("code")
        return code
    except Exception, e:
        print ("請求失敗 %s" % e)

四咆耿、業(yè)務(wù)包調(diào)用封裝包(common.py)

#!/usr/bin/python
# -*- coding: UTF-8 -*-
# 業(yè)務(wù)包：通用函數(shù)


import lib.tezMysql as mysql
import lib.tezLog as log
import lib.tezRequest as request
import lib.tezConfig as conf
import constants as cs
import os

def prepare_data(host, user, password, db, sql):
    """
    數(shù)據(jù)準(zhǔn)備，添加測試數(shù)據(jù)
    :param host: 服務(wù)地址
    :param user: 用戶
    :param password: 密碼
    :param db: 數(shù)據(jù)庫名
    :param sql: 執(zhí)行的SQL
    :return: 
    """
    mysql.connect(host, user, password, db)
    res = mysql.execute(sql)
    mysql.close()
    print ("Run sql: the row number affected is %s" % res)
    return res


def get_prepare_sql(filename, key):
    """
    獲取預(yù)備執(zhí)行的SQL
    :param title: 配置文件頭信息
    :param key: 配置文件值
    :return: Value 
    """
    try:
        conf.get_config(filename)
        value = conf.get_data(title=cs.TITLE, key=key)
        return value
    except Exception, e:
        print ("獲取用例參數(shù)值失敗 %s" % e)


def reset_report(filename):
    try:
        result = os.path.exists(cs.REPORT_PATH)
        if result == True:
            conf.get_config(filename)
            reportName = eval(conf.get_data(title=cs.REPORT_NAME, key=cs.REPORT))
            report_name = eval(conf.get_data(title=cs.REPORT_NAME, key=cs.R_NAME))
            file = open(cs.YML_REPORT, 'r')
            list_con = file.readlines()
            content = str(list_con).decode("string_escape")
            fileContent = "- [%s, %s]"
            row = "\n"
            con = row + fileContent % (reportName + cs.NOW, report_name)

            if fileContent % (reportName + cs.NOW, report_name) not in content:
                f = open(cs.YML_REPORT, 'a+')
                f.write(con)
            else:
                print ("內(nèi)容已經(jīng)存在 %s" % con)
    except Exception, e:
        print ("文件路徑不存在 %s", e)


def run_test(filename):
    conf.get_config(filename)
    list = eval(conf.get_title_list())
    reportName = eval(conf.get_data(cs.REPORT_NAME, key=cs.REPORT))
    logging = log.get_logger(reportName)
    for i in range(2, len(list)):
        title = list[i]
        number = eval(conf.get_data(title, key=cs.NUMBER))
        name = str(conf.get_data(title, key=cs.NAME))
        method = str(conf.get_data(title, key=cs.METHOD))
        url = str(conf.get_data(title, key=cs.URL))
        data = request.change_type(conf.get_data(title, key=cs.DATA))
        headers = eval(conf.get_data(title, key=cs.HEADERS))
        testUrl = cs.TEST_URL + url
        actualCode = request.api(method, testUrl, data, headers)
        expectCode = conf.get_data(title, key=cs.CODE)


        if actualCode != expectCode:
            print "FailInfo"
            print number
            logging.warning("- <font color=#FFB5C5 size=3>FailCase : %s", name)
            logging.warning("    - <font color=#FFB5C5 size=3>Number : %s", number)
            logging.warning("    - <font color=#FFB5C5 size=3>Method : %s", method)
            logging.warning("    - <font color=#FFB5C5 size=3>Url : %s", testUrl)
            logging.warning("    - Data : </br> ``` %s ```", data)
            logging.warning("    - Headers : </br> ``` %s ```", headers)
            logging.warning("    - <font color=#FFB5C5 size=3>期望值 : %s", expectCode)
            logging.warning("    - <font color=#FFB5C5 size=3>實(shí)際值 : %s", str(actualCode))
            logging.warning("*****************")
        else:
            print number
            print "TrueInfo"
            logging.warning("- <font color=#3cc8b4 size=3> TrueCase %s", name)
            logging.warning("*****************")

五锄贼、執(zhí)行包(run.py)

import util.common as common
import sys

# FILENAME = sys.argv[1]

FILENAME = "proUser.ini"

"""1.新建測試報(bào)告目錄"""
common.reset_report(filename=FILENAME)

"""2.執(zhí)行測試用例"""
common.run_test(filename=FILENAME)

PS:有個(gè)全局變量包c(diǎn)onstant.py票灰，里面看到是參數(shù)目錄文件相關(guān)的。