本文件介紹如何使用excel管理介面測試用例並一鍵執行的實現方式,其中包括 python 讀寫excel, request庫的基本操作,介面用例的設計

介面用例設計

用例欄位描述

• 被依賴表示式: 示例 (3,headers,data,response,file),第一位填寫被依賴用例id,若依賴多條資料則可在後加(headers,data,response,file),欄位之間使用英文"逗號"隔開,加入 headers 則表示 用例id為 3 的用例需要本條用例的 headers 資料,其它以此類推. 填寫了 被依賴表示式,本條用例執行完成會自動根據 被依賴表示式 組裝本條用例資料寫入到被依賴用例的 需要依賴資料 中

# 組裝本條用例後的資料
data = {
    'data': {'ip': '112.112.11.11', 'key': 'key'},
    'response': {
        'resultcode': '200',
        'reason': '查詢成功',
        'result': {'Country': '中國', 'Province': '雲南省', 'City': '昆明市', 'Isp': '電信'},
        'error_code': 0
    },
    'file': 'timg.txt'}

• 需依賴表示式: 例如取值上方 data 中的 ip 和 key 資料,則表達示例為(var_ip=data.ip,var_key=data.key),var_ip 是變數名稱, data.ip 則是資料所在的路徑, 多層 dict 則通過 英文"點"把key相連,最終取到資料,若需取值多個值,則每個值之間使用英文"逗號"隔開. 取值成功後會自動寫入到本條用例的 需依賴資料取值結果中

# 取值表示式
var_ip=data.ip,var_key=data.key
# 被取值資料
data = {
    'data': {'ip': '112.112.11.11', 'key': 'key'},
    'response': {
        'resultcode': '200',
        'reason': '查詢成功',
        'result': {'Country': '中國', 'Province': '雲南省', 'City': '昆明市', 'Isp': '電信'},
        'error_code': 0
    },
    'file': 'timg.txt'}
# 取值結果
{'var_ip': '112.112.11.11', 'var_key': 'key'}
 

• 檢查表示式: 目前支援 equal,notequal,in,notin 判斷,若需其它判斷可自行新增,此表示式分為(resultcode equal 200) 三個部分, 左側部分為 取值表示式,中間為 判斷方式 ,右側為預期結果,左側填寫的取值表示式會自動去檢查資料中把資料匹配出來, 實際就是 200 == 200,若需多個檢查點則每個檢查點之間使用英文"逗號"隔開.

# 檢查表示式
resultcode equal 200,result.Isp equal 電信
# 檢查資料
{"resultcode":"200","reason":"查詢成功","result":{"Country":"中國","Province":"雲南省","City":"昆明市","Isp":"電信"},"error_code":0}
# 檢查結果
檢查點>實際結果:200等於預期結果:200 pass 
檢查點>實際結果:電信等於預期結果:電信 pass 

介面用例含有欄位及描述
編號 : int(唯一) 用例id
模組 : str 用例所屬模組描述,例如 使用者管理之類的一級功能
標題 : str 用例簡單描述,例如 新增使用者之類的二級功能
測試點 : str 用例測試功能,例如 正確使用者資料正常新增使用者成功
級別 : str 用例重要程度,範圍有(P0,P1,P2,P3),這裡依照公司對用例級別的劃分
執行順序 : int(唯一) 這裡可以設定用例的執行順序, 1 為最優先執行,上不封頂
是否執行 : str 用例是否需要執行,範圍有(Y,y,N,n),大Y小y代表該條用例需要執行,空或者其它都代表不執行
被依賴用例 : str 本條用例是否被其它用例依賴了測試資料
需依賴資料 : str 本條用例需要依賴的資料
依賴資料取值表示式 : str 用例執行會根據此表示式,自動去匹配 需依賴資料中的內容
依賴資料取值結果 : str 根據需依賴資料取值表示式 取值後自動存入,存入示例 {‘var_ip’: ‘112.112.11.11’, ‘var_key’: ‘key’}
介面地址 : str 介面地址
請求頭 : str 請求頭
請求方式 : get,post,若需要其它可自行新增
請求資料 : str 請求資料
檔名稱 : str 此處新增測試框架中 test_data 目錄下的 檔案全名,若是批量檔案上傳介面,則可以錄入多個檔案全名以英文"逗號"隔開
返回結果 : str 用例執行後的返回
檢查點 : str 根據 檢查表示式 自動匹配 返回結果中的資料,並把檢查結果自動寫入 執行結果中
執行結果 : str 檢查點匹配後的結果資訊,包括每個檢查點是否通過 和 若用例中的任何報錯資訊也會 自動錄入
開始時間 : str 用例執行開始時間
結束時間 : str 用例執行結束時間
消耗時間 : str 本條用例執行總共花費時間
執行人 : 用例編寫人,這個值可在 setting 檔案中配置

Excel的操作

封裝關於 python 對excel 的基本操作,包括 返回指定行/每行列印/每列列印/讀指定位置/寫指定位置/按列讀/按列寫/按行讀/按行寫等等,下面放了一些實現操作的類方法

• 替換資料

    # 替換指定位置的值
    def replace_data(self, row, cell, data):
        if self.mode == 1:
            # print(row,cell,data)
            self.handle_sheet.write(int(row), int(cell), data)
            self.handle.save(self.excel_filename)
            return "修改行 %s 列 %s ,修改資料為 %s" % (str(row), str(cell), str(data))
        else:
            print(self.excel_filename + u" 不存在,無法進行操作!!!")

            return 'error: not file.'

    # 替換一行
    def replace_nrows(self, data, nrows_number):
        if self.mode == 1:
            for i, item in enumerate(data):
                self.handle_sheet.write(nrows_number - 1, i, item)
            self.handle.save(self.excel_filename)
            return nrows_number, letter(i + 1)
        else:
            print(self.excel_filename + u" 不存在,無法進行操作!!!")

            return 'error: not file.'

    # 替換一列
    def replace_ncols(self, data, ncols_number):
        if self.mode == 1:
            for i, item in enumerate(data):
                self.handle_sheet.write(i, ncols_number - 1, item)
            self.handle.save(self.excel_filename)
            return i + 1, letter(ncols_number)
        else:
            print(self.excel_filename + u" 不存在,無法進行操作!!!")

            return 'error: not file.'

• 刪除資料

    # 刪除全部
    def del_alldata(self):
        if self.mode == 1:
            replace_number = 0
            for i in range(self.sheet.ncols):
                for n in range(self.sheet.nrows):
                    self.handle_sheet.write(n, i, '')
                    replace_number += 1
            self.handle.save(self.excel_filename)
            return replace_number
        else:
            print(self.excel_filename + u" 不存在,無法進行操作!!!")

            return 'error: not file.'

    # 刪除行
    def del_nrows(self, nrows_number):
        if self.mode == 1:
            replace_number = 0
            for i in range(self.sheet.ncols):
                self.handle_sheet.write(nrows_number - 1, i, '')
                replace_number += 1
            self.handle.save(self.excel_filename)
            return replace_number
        else:
            print(self.excel_filename + u" 不存在,無法進行操作!!!")

            return 'error: not file.'

    # 刪除列
    def del_ncols(self, ncols_number):
        if self.mode == 1:
            replace_number = 0
            for n in range(self.sheet.nrows):
                self.handle_sheet.write(n, ncols_number - 1, '')
                replace_number += 1
            self.handle.save(self.excel_filename)
            return replace_number
        else:
            print(self.excel_filename + u" 不存在,無法進行操作!!!")

            return 'error: not file.'

    # 刪除某個位置
    def del_data(self, nrows_number, ncols_number):
        if self.mode == 1:
            self.handle_sheet.write(nrows_number + 1, ncols_number + 1, '')
            self.handle.save(self.excel_filename)
            return self.sheet.cell(ncols_number + 1, nrows_number + 1).value
        else:
            print(self.excel_filename + u" 不存在,無法進行操作!!!")

            return 'error: not file.'

    # 刪除指定資料
    def del_value(self, data):
        if self.mode == 1:
            replace_number = 0
            for i in range(self.sheet.ncols):
                for n in range(self.sheet.nrows):
                    if data == self.sheet.cell(n, i).value:
                        self.handle_sheet.write(n, i, '')
                        replace_number += 1
            self.handle.save(self.excel_filename)
            return replace_number
        else:
            print(self.excel_filename + u" 不存在,無法進行操作!!!")

            return 'error: not file.'

• 讀資料

    # 讀取指定位置的資料 return data
    def xlsred(self, nrows_number, ncols_number):
        if self.mode == 1:
            str = self.sheet.cell(nrows_number, ncols_number).value
            print("read data : ", str)

            print("Data-ncols: ", nrows_number)

            print("Data-number: ", ncols_number)

            return str
        else:
            print(self.excel_filename + u" 不存在,無法進行操作!!!")

            return 'error: not file.'
     # 每列列印 return data
    def xlsread_allncols(self):
        if self.mode == 1:
            data_list = []
            for i in range(self.sheet.ncols):
                data = []
                for n in range(self.sheet.nrows):
                    if self.sheet.cell(n, i).value != '':
                        data.append(self.sheet.cell(n, i).value)
                data_list.append(data)
            return data_list
        else:
            print(self.excel_filename + u" 不存在,無法進行操作!!!")

            return 'error: not file.'

介面框架設計

目前框架功能 : 讀寫excel用例並自動執行後把本身測試結果寫入, 後續自行可以 分析測試結果生成 各種版本的測試報告 和 自行推送測試結果至各個平臺,如 Email,企業微信,釘釘,微信,簡訊,平臺機器人檢視相關產品的介面文件

框架目錄

• APIAutoTest
  • config
    • settings.py
  • doc
  • lib
    • opt_excel.py
    • opt_expression.py
    • opt_test_data.py
    • request_client.py
  • result
  • test_case
    • TestCase.xls
  • test_data
  • tool
    • my_time.py
  • main.py

使用說明

1.環境 :python 3.x ,需依賴 xlrd xlwt xlutils
2.依照 TestCase.xls 用例格式完成用例介面用例編寫
3.python main.py 執行測試

程式碼片段

# opt_expression.py
def write_rely_case_data(now_case_id, data_str):
    """
    該條用例會被誰依賴並把需要依賴的內容寫入被依賴用例的 依賴用例資料 中
    :param data_str: 依賴表示式  2,headers,data,response,file
    :param now_case_id: 當前測試用例id
    :return: 把 被依賴的測試資料 寫入 需依賴的用例  依賴用例資料 中
    """
    temp_dict = {}
    # 如果傳入的 依賴用例 為空,則不需要組裝 需依賴資料 並 寫入需依賴的用例中
    if data_str == "":
        return False
    # 組裝 需依賴 的測試資料
    data_list = data_str.split(",")
    temp_dict["rely_case_id"] = data_list[0]
    temp_dict["all_data"] = {}
    for item in range(1, len(data_list)):
        if "headers" == data_list[item]:
            case_headers = opt_test_data.read_headers(now_case_id)
            if case_headers:
                temp_dict["all_data"]["headers"] = eval(case_headers)
        elif "data" == data_list[item]:
            case_data = opt_test_data.read_data(now_case_id)
            if case_data:
                temp_dict["all_data"]["data"] = eval(case_data)
        elif "response" == data_list[item]:
            case_response = opt_test_data.read_response(now_case_id)
            if case_response:
                temp_dict["all_data"]["response"] = eval(case_response)
        elif "file" == data_list[item]:
            case_filename = opt_test_data.read_files_name(now_case_id)
            temp_dict["all_data"]["file"] = case_filename
    # 把組裝好的 需依賴資料 寫入 需依賴用例的 依賴用例資料 中
    opt_test_data.write_rely_on_case_data(int(temp_dict["rely_case_id"]), str(temp_dict["all_data"]))

    return temp_dict


def dict_str(test_data_str):
    """
    將從測試用例中讀取出來的字串轉換成字典
    :param test_data_str: 讀取出來的字串
    :return: 字典
    """
    if test_data_str:
        return eval(test_data_str)
    return None


def get_expression_data(pattern, data_dict):
    """
    根據傳入表示式pattern匹配資料data中的資料
    :param pattern: 表示式
    :param data_dict: 匹配資料
    :return: dict
    {'var1': 'headers', 'var2': 'response'}
    """
    var_dict = {}
    pattern_list = pattern.split(",")
    # print(pattern_list)
    for item in pattern_list:
        temp_list = item.split("=")
        # 獲取變數名稱
        temp_var = temp_list[0]
        # 分析表示式
        var_dict[temp_var] = _dict_path_value(temp_list[1], data_dict)
    return var_dict


def replace_data(var_data, data_str):
    """
    根據傳入的 var_data, 修改 data 中的字串
    :param var_data: 表示式從依賴用例資料中取出的變數字典
    :param data_str: 需要替換的物件字串(從用例中取出的請求頭等)
    :return: 修改過的 請求資料 dict
    """
    for item in var_data:
        data_str = data_str.replace(item, var_data[item])
    return data_str


def assert_data(case_id, assert_str):
    """
    根據assert_str的斷言,判斷 實際結果 和 預期結果 之間的關係
    :param assert_str: 斷言 "headers.key1 equal key1_123"
    :param case_id: 測試用例id
    :return: pass fail
    """
    result_str = ""
    actual = eval(opt_test_data.read_response(case_id))
    assert_list = assert_str.split(",")
    for item in assert_list:
        my_assert = re.findall(r"\s\S+\s", item)[0].strip()
        pattern_left = re.findall(r"\S+\s", item)[0].strip()
        pattern_right = re.findall(r"\s\S+", item)[1].strip()

        if "equal" == my_assert:
            data_left = _dict_path_value(pattern_left, actual)
            data_right = pattern_right
            if data_left == data_right:
                result_str += "檢查點>實際結果:%s等於預期結果:%s pass \n" % (data_left, data_right)
            else:
                result_str += "檢查點>實際結果:%s不等於預期結果:%s fail \n" % (data_left, data_right)
        elif "notequal" == my_assert:
            data_left = _dict_path_value(pattern_left, actual)
            data_right = pattern_right
            if data_left != data_right:
                result_str += "檢查點>實際結果:%s等於預期結果:%s pass \n" % (data_left, data_right)
            else:
                result_str += "檢查點>實際結果:%s不等於預期結果:%s fail \n" % (data_left, data_right)
        elif "in" == my_assert:
            data_left = _dict_path_value(pattern_left, actual)
            data_right = pattern_right
            if data_left in data_right:
                result_str += "檢查點>實際結果:%s等於預期結果:%s pass \n" % (data_left, data_right)
            else:
                result_str += "檢查點>實際結果:%s不等於預期結果:%s fail \n" % (data_left, data_right)
        elif "notin" == my_assert:
            data_left = _dict_path_value(pattern_left, actual)
            data_right = pattern_right
            if data_left not in data_right:
                result_str += "檢查點>實際結果:%s等於預期結果:%s pass \n" % (data_left, data_right)
            else:
                result_str += "檢查點>實際結果:%s不等於預期結果:%s fail \n" % (data_left, data_right)
    return result_str


def _dict_path_value(path, data):
    """
    根據path獲取dict_data裡面的值
    """
    num = 1
    pahts = path.split(".")
    mydict = {}
    for p in pahts:
        if num == 1:
            mydict = data[p + ""]
            num = num + 1
        else:
            mydict = mydict[p + ""]
            num = num + 1
    return mydict

# opt_test_data.py
def read_is_run(case_id):
    """讀取該條用例的 是否執行 資訊"""
    is_run = remove_str_all_break(get_case_row_data(case_id)[6])
    if len(is_run) <= 0:
        return None
    return is_run


def write_is_run(case_id, content):
    """修改該條用例的 是否執行 資訊"""
    case_row_number = get_case_row_number(case_id)
    test_case_data().replace_data(case_row_number, 6, content)


def read_rely_on_case(case_id):
    """讀取該條用例的 被依賴用例/依賴內容 資訊"""
    rely_on_case = remove_str_all_break(get_case_row_data(case_id)[7])
    if len(rely_on_case) <= 0:
        return None
    return rely_on_case


def write_rely_on_case(case_id, content):
    """修改該條用例的 依賴用例 資訊"""
    case_row_number = get_case_row_number(case_id)
    test_case_data().replace_data(case_row_number, 7, content)


def read_rely_on_case_data(case_id):
    """讀取該條用例的 需依賴用例資料 資訊"""
    case_data = remove_str_all_break(get_case_row_data(case_id)[8])
    if len(case_data) <= 0:
        return None
    return case_data


def write_rely_on_case_data(case_id, content):
    """修改該條用例的 需依賴用例資料 資訊"""
    case_row_number = get_case_row_number(case_id)
    test_case_data().replace_data(case_row_number, 8, content)


def read_rely_on_case_expression(case_id):
    """讀取該條用例的 需依賴用例取值表示式 資訊"""
    case_expression = remove_str_all_break(get_case_row_data(case_id)[9])
    if len(case_expression) <= 0:
        return None
    return case_expression


def write_rely_on_case_expression(case_id, content):
    """修改該條用例的 需依賴用例取值表示式 資訊"""
    case_row_number = get_case_row_number(case_id)
    test_case_data().replace_data(case_row_number, 9, content)


def read_rely_on_case_expression_result(case_id):
    """讀取該條用例的 需依賴用例取值表示式取值結果 資訊"""
    expression_result = remove_str_all_break(get_case_row_data(case_id)[10])
    if len(expression_result) <= 0:
        return None
    return expression_result


def write_rely_on_case_expression_result(case_id, content):
    """修改該條用例的 需依賴用例取值表示式取值結果 資訊"""
    case_row_number = get_case_row_number(case_id)
    test_case_data().replace_data(case_row_number, 10, content)


def read_api_path(case_id):
    """讀取該條用例的 api地址 資訊"""
    api_path = remove_str_all_break(get_case_row_data(case_id)[11])
    if len(api_path) <= 0:
        return None
    return api_path


def write_api_path(case_id, content):
    """修改該條用例的 api地址 資訊"""
    case_row_number = get_case_row_number(case_id)
    test_case_data().replace_data(case_row_number, 11, content)


def read_headers(case_id):
    """讀取該條用例的 請求頭 資訊"""
    headers = remove_str_all_break(get_case_row_data(case_id)[12])
    if len(headers) <= 0:
        return None
    return headers


def write_headers(case_id, content):
    """修改該條用例的 請求頭 資訊"""
    case_row_number = get_case_row_number(case_id)
    test_case_data().replace_data(case_row_number, 12, content)


def read_method(case_id):
    """讀取該條用例的 請求方法 資訊"""
    method = remove_str_all_break(get_case_row_data(case_id)[13])
    if len(method) <= 0:
        return None
    return method


def write_method(case_id, content):
    """修改該條用例的 請求方法 資訊"""
    case_row_number = get_case_row_number(case_id)
    test_case_data().replace_data(case_row_number, 13, content)

# request_client.py
    def main(self):
        # 獲取所有需要執行的用例id列表
        all_test_count_list = opt_test_data.get_test_run_order()
        for item in all_test_count_list:
            # 判斷本條用例是否需要被執行
            is_run = opt_test_data.read_is_run(item)
            try:
                if is_run == "Y" or is_run == "y":
                    # 寫入開始執行時間
                    opt_test_data.write_start_time(item, my_time.now_time())
                    # 判斷本條用例是否需要依賴資料
                    # 獲取 需依賴用例的資料 和 需依賴用例的表示式
                    rely_on_case_data = opt_test_data.read_rely_on_case_data(item)
                    rely_on_case_expression = opt_test_data.read_rely_on_case_expression(item)
                    if rely_on_case_data and rely_on_case_expression:
                        # 準備本條需要依賴的資料
                        self.write_rely_data(item, rely_on_case_expression, rely_on_case_data)
                        # 如果 介面地址\請求頭\請求方法\請求資料\檔名稱 中需要依賴資料,則使用依賴資料替換
                        self.replace_request_data(item)
                        # 接下來流程一樣
                        self._send_end(item)
                    # 不需要依賴資料
                    else:
                        # 接下來流程一樣
                        self._send_end(item)

                    # 列印一下本條用例基本情況
                    self.print_now_status(item)
                else:
                    # 本條用例不執行,執行下一條
                    continue
            except Exception as e:
                self.print_now_status(item)
                print(e)
                print(traceback.print_exc())
                opt_test_data.write_status(item, str(traceback.format_exc()))
            finally:
                # 寫入本條用例執行完成時間
                self._end_time(item)
                # 寫入本條用例的執行人
                self._write_executor(item)
                # 計算本條用例總共花費時間並寫入消耗時間中
                self._write_total_time(item)