Python+request+unittest實現(xiàn)接口測試框架集成實例

更新時間：2018年03月16日 10:13:35 作者：Andrea-Pirlo

這篇文章主要介紹了Python+request+unittest實現(xiàn)接口測試框架集成實例，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

1、為什么要寫代碼實現(xiàn)接口自動化

大家知道很多接口測試工具可以實現(xiàn)對接口的測試，如postman、jmeter、fiddler等等，而且使用方便，那么為什么還要寫代碼實現(xiàn)接口自動化呢？工具雖然方便，但也不足之處：

測試數(shù)據(jù)不可控制

接口測試本質(zhì)是對數(shù)據(jù)的測試，調(diào)用接口，輸入一些數(shù)據(jù)，隨后，接口返回一些數(shù)據(jù)。驗證接口返回數(shù)據(jù)的正確性。在用工具運行測試用例之前不得不手動向數(shù)據(jù)庫中插入測試數(shù)據(jù)。這樣我們的接口測試是不是就沒有那么“自動化了”。

無法測試加密接口

這是接口測試工具的一大硬傷，如我們前面開發(fā)的接口用工具測試完全沒有問題，但遇到需要對接口參數(shù)進行加密/解密的接口，例如 md5、base64、AES 等常見加密方式。本書第十一章會對加密接口進行介紹。又或者接口的參數(shù)需要使用時間戳，也是工具很難模擬的。

擴展能力不足

當我們在享受工具所帶來的便利的同時，往往也會受制于工具所帶來的局限。例如，我想將測試結(jié)果生成 HMTL 格式測試報告，我想將測試報告發(fā)送到指定郵箱。我想對接口測試做定時任務。我想對接口測試做持續(xù)集成。這些需求都是工具難以實現(xiàn)的。

2、接口自動化測試設計

接口測試調(diào)用過程可以用下圖概括，增加了測試數(shù)據(jù)庫

一般的 接口工具 測試過程：

1、接口工具調(diào)用被測系統(tǒng)的接口（傳參 username="zhangsan"）。

2、系統(tǒng)接口根據(jù)傳參（username="zhangsan"）向 正式數(shù)據(jù)庫 中查詢數(shù)據(jù)。

3、將查詢結(jié)果組裝成一定格式的數(shù)據(jù)，并返回給被調(diào)用者。

4、人工或通過工具的斷言功能檢查接口測試的正確性。

接口自動化測試項目，為了使接口測試對數(shù)據(jù)變得可控，測試過程如下：

1、接口測試項目先向 測試數(shù)據(jù)庫 中插入測試數(shù)據(jù)（zhangsan 的個人信息）。

2、調(diào)用被測系統(tǒng)接口（傳參 username="zhangsan"）。

3、系統(tǒng)接口根據(jù)傳參（username="zhangsan"）向測試數(shù)據(jù)庫中進行查詢并得到 zhangsan 個人信息。

4、將查詢結(jié)果組裝成一定格式的數(shù)據(jù)，并返回給被調(diào)用者。

5、通過單元測試框架斷言接口返回的數(shù)據(jù)（zhangsan 的個人信息），并生成測試報告。

為了使正式數(shù)據(jù)庫的數(shù)據(jù)不被污染，建議使用獨立的 測試數(shù)據(jù)庫 。

2、requests庫

Requests 使用的是 urllib3，因此繼承了它的所有特性。Requests 支持 HTTP 連接保持和連接池 ，支持 使用cookie保持會話 ，支持 文件上傳 ，支持 自動確定響應內(nèi)容的編碼。 對request庫的更詳細的介紹可以看我之前接口測試基礎(chǔ)的文章：

http://www.dbjr.com.cn/article/122571.htm?pc

http://www.dbjr.com.cn/article/108168.htm

3、接口測試代碼示例

下面以之前用 python+django 開發(fā)的用戶簽到系統(tǒng)為背景，展示接口測試的代碼。

為什么開發(fā)接口？開發(fā)的接口主要給誰來用？

前端和后端分離是近年來 Web 應用開發(fā)的一個發(fā)展趨勢。這種模式將帶來以下優(yōu)勢：

1、后端可以不用必須精通前端技術(shù)（HTML/JavaScript/CSS），只專注于數(shù)據(jù)的處理，對外提供 API 接口。

2、前端的專業(yè)性越來越高，通過 API 接口獲取數(shù)據(jù)，從而專注于頁面的設計。

3、前后端分離增加接口的應用范圍，開發(fā)的接口可以應用到 Web 頁面上，也可以應用到移動 APP 上。

在這種開發(fā)模式下，接口測試工作就會變得尤為重要了。

開發(fā)實現(xiàn)的接口代碼示例：

# 添加發(fā)布會接口實現(xiàn)
def add_event(request):
  eid = request.POST.get('eid','')         # 發(fā)布會id
  name = request.POST.get('name','')        # 發(fā)布會標題
  limit = request.POST.get('limit','')       # 限制人數(shù)
  status = request.POST.get('status','')      # 狀態(tài)
  address = request.POST.get('address','')     # 地址
  start_time = request.POST.get('start_time','')  # 發(fā)布會時間

  if eid =='' or name == '' or limit == '' or address == '' or start_time == '':
    return JsonResponse({'status':10021,'message':'parameter error'})

  result = Event.objects.filter(id=eid)
  if result:
    return JsonResponse({'status':10022,'message':'event id already exists'})

  result = Event.objects.filter(name=name)
  if result:
    return JsonResponse({'status':10023,'message':'event name already exists'})

  if status == '':
    status = 1

  try:
    Event.objects.create(id=eid,name=name,limit=limit,address=address,status=int(status),start_time=start_time)
  except ValidationError:
    error = 'start_time format error. It must be in YYYY-MM-DD HH:MM:SS format.'
    return JsonResponse({'status':10024,'message':error})

  return JsonResponse({'status':200,'message':'add event success'})

通過POST請求接收發(fā)布會參數(shù)：發(fā)布會id、標題、人數(shù)、狀態(tài)、地址和時間等參數(shù)。

首先，判斷eid、name、limit、address、start_time等字段均不能為空，否則JsonResponse()返回相應的狀態(tài)碼和提示。JsonResponse()是一個非常有用的方法，它可以直接將字典轉(zhuǎn)化成Json格式返回到客戶端。

接下來，判斷發(fā)布會id是否存在，以及發(fā)布會名稱（name）是否存在；如果存在將返回相應的狀態(tài)碼和提示信息。

再接下來，判斷發(fā)布會狀態(tài)是否為空，如果為空，將狀態(tài)設置為1（True）。

最后，將數(shù)據(jù)插入到 Event 表，在插入的過程中如果日期格式錯誤，將拋出 ValidationError 異常，接收該異常并返回相應的狀態(tài)和提示，否則，插入成功，返回狀態(tài)碼200和“add event success”的提示。

# 發(fā)布會查詢接口實現(xiàn)
def get_event_list(request):

  eid = request.GET.get("eid", "")   # 發(fā)布會id
  name = request.GET.get("name", "")  # 發(fā)布會名稱

  if eid == '' and name == '':
    return JsonResponse({'status':10021,'message':'parameter error'})

  if eid != '':
    event = {}
    try:
      result = Event.objects.get(id=eid)
    except ObjectDoesNotExist:
      return JsonResponse({'status':10022, 'message':'query result is empty'})
    else:
      event['eid'] = result.id
      event['name'] = result.name
      event['limit'] = result.limit
      event['status'] = result.status
      event['address'] = result.address
      event['start_time'] = result.start_time
      return JsonResponse({'status':200, 'message':'success', 'data':event})

  if name != '':
    datas = []
    results = Event.objects.filter(name__contains=name)
    if results:
      for r in results:
        event = {}
        event['eid'] = r.id
        event['name'] = r.name
        event['limit'] = r.limit
        event['status'] = r.status
        event['address'] = r.address
        event['start_time'] = r.start_time
        datas.append(event)
      return JsonResponse({'status':200, 'message':'success', 'data':datas})
    else:
      return JsonResponse({'status':10022, 'message':'query result is empty'})

通過GET請求接收發(fā)布會id和name 參數(shù)。兩個參數(shù)都是可選的。首先，判斷當兩個參數(shù)同時為空，接口返回狀態(tài)碼10021，參數(shù)錯誤。

如果發(fā)布會id不為空，優(yōu)先通過id查詢，因為id的唯一性，所以，查詢結(jié)果只會有一條，將查詢結(jié)果以 key:value 對的方式存放到定義的event字典中，并將數(shù)據(jù)字典作為整個返回字典中data對應的值返回。

name查詢?yōu)槟：樵?，查詢?shù)據(jù)可能會有多條，返回的數(shù)據(jù)稍顯復雜；首先將查詢的每一條數(shù)據(jù)放到一個字典event中，再把每一個字典再放到數(shù)組datas中，最后再將整個數(shù)組做為返回字典中data對應的值返回。

接口測試代碼示例

#查詢發(fā)布會接口測試代碼
import requests

url = "http://127.0.0.1:8000/api/get_event_list/"
r = requests.get(url, params={'eid':'1'})
result = r.json()
print(result)
assert result['status'] == 200
assert result['message'] == "success"
assert result['data']['name'] == "xx 產(chǎn)品發(fā)布會"
assert result['data']['address'] == "北京林匹克公園水立方"
assert result['data']['start_time'] == "2016-10-15T18:00:00"

因為“發(fā)布會查詢接口”是GET類型，所以，通過requests庫的get()方法調(diào)用，第一個參數(shù)為調(diào)用接口的URL地址，params設置接口的參數(shù)，參數(shù)以字典形式組織。

json()方法可以將接口返回的json格式的數(shù)據(jù)轉(zhuǎn)化為字典。

接下來就是通過 assert 語句對接字典中的數(shù)據(jù)進行斷言。分別斷言status、message 和data的相關(guān)數(shù)據(jù)等。

使用unittest單元測試框架開發(fā)接口測試用例

#發(fā)布會查詢接口測試代碼 
import unittest
import requests

class GetEventListTest(unittest.TestCase):

  def setUp(self):
    self.base_url = "http://127.0.0.1:8000/api/get_event_list/"

  def test_get_event_list_eid_null(self):
    ''' eid 參數(shù)為空 '''
    r = requests.get(self.base_url, params={'eid':''})
    result = r.json()
    self.assertEqual(result['status'], 10021)
    self.assertEqual(result['message'], 'parameter error')

  def test_get_event_list_eid_error(self):
    ''' eid=901 查詢結(jié)果為空 '''
    r = requests.get(self.base_url, params={'eid':901})
    result = r.json()
    self.assertEqual(result['status'], 10022)
    self.assertEqual(result['message'], 'query result is empty')

  def test_get_event_list_eid_success(self):
    ''' 根據(jù) eid 查詢結(jié)果成功 '''
    r = requests.get(self.base_url, params={'eid':1})
    result = r.json()
    self.assertEqual(result['status'], 200)
    self.assertEqual(result['message'], 'success')
    self.assertEqual(result['data']['name'],u'mx6發(fā)布會')
    self.assertEqual(result['data']['address'],u'北京國家會議中心')

  def test_get_event_list_nam_result_null(self):
    ''' 關(guān)鍵字‘a(chǎn)bc'查詢 '''
    r = requests.get(self.base_url, params={'name':'abc'})
    result = r.json()
    self.assertEqual(result['status'], 10022)
    self.assertEqual(result['message'], 'query result is empty')

  def test_get_event_list_name_find(self):
    ''' 關(guān)鍵字‘發(fā)布會'模糊查詢 '''
    r = requests.get(self.base_url, params={'name':'發(fā)布會'})
    result = r.json()
    self.assertEqual(result['status'], 200)
    self.assertEqual(result['message'], 'success')
    self.assertEqual(result['data'][0]['name'],u'mx6發(fā)布會')
    self.assertEqual(result['data'][0]['address'],u'北京國家會議中心')
49if __name__ == '__main__':
   unittest.main()

unittest單元測試框架可以幫助 組織和運行接口測試用例。

4、接口自動化測試框架實現(xiàn)

關(guān)于接口自動化測試，unittest 已經(jīng)幫我們做了大部分工作，接下來只需要 集成數(shù)據(jù)庫操作 ，以及 HTMLTestRunner測試報告生成 擴展即可。

框架結(jié)構(gòu)如下圖：

pyrequests 框架：

db_fixture/：初始化接口測試數(shù)據(jù)。

interface/：用于編寫接口自動化測試用例。

report/：生成接口自動化測試報告。

db_config.ini ：數(shù)據(jù)庫配置文件。

HTMLTestRunner.py unittest 單元測試框架擴展，生成 HTML 格式的測試報告。

run_tests.py ：執(zhí)行所有接口測試用例。

4.1、數(shù)據(jù)庫配置

首先，需要修改被測系統(tǒng)將數(shù)據(jù)庫指向測試數(shù)據(jù)庫。以 MySQL數(shù)據(jù)庫為例，針對 django 項目而言，修改.../guest/settings.py 文件?？梢栽谙到y(tǒng)測試環(huán)境單獨創(chuàng)建一個測試庫。這樣做的目的是讓接口測試的數(shù)據(jù)不會清空或污染到功能測試庫的數(shù)據(jù)。其他框架開發(fā)的項目與django項目類似，這個工作一般由開發(fā)同學完成，我們測試同學更多關(guān)注的是測試框架的代碼。

4.2、框架代碼實現(xiàn)

4.2.1、首先，創(chuàng) 建數(shù)據(jù)庫配置文件.../db_config.ini

4.2.2、接下來， 簡單封裝數(shù)據(jù)庫操作，數(shù)據(jù)庫表數(shù)據(jù)的插入和清除 ，.../db_fixture/ mysql_db.py

import pymysql.cursors
import os
import configparser as cparser


# ======== Reading db_config.ini setting ===========
base_dir = str(os.path.dirname(os.path.dirname(__file__)))
base_dir = base_dir.replace('\\', '/')
file_path = base_dir + "/db_config.ini"

cf = cparser.ConfigParser()

cf.read(file_path)
host = cf.get("mysqlconf", "host")
port = cf.get("mysqlconf", "port")
db  = cf.get("mysqlconf", "db_name")
user = cf.get("mysqlconf", "user")
password = cf.get("mysqlconf", "password")


# ======== MySql base operating ===================
class DB:

  def __init__(self):
    try:
      # Connect to the database
      self.connection = pymysql.connect(host=host,
                       port=int(port),
                       user=user,
                       password=password,
                       db=db,
                       charset='utf8mb4',
                       cursorclass=pymysql.cursors.DictCursor)
    except pymysql.err.OperationalError as e:
      print("Mysql Error %d: %s" % (e.args[0], e.args[1]))

  # clear table data
  def clear(self, table_name):
    # real_sql = "truncate table " + table_name + ";"
    real_sql = "delete from " + table_name + ";"
    with self.connection.cursor() as cursor:
      cursor.execute("SET FOREIGN_KEY_CHECKS=0;")
      cursor.execute(real_sql)
    self.connection.commit()

  # insert sql statement
  def insert(self, table_name, table_data):
    for key in table_data:
      table_data[key] = "'"+str(table_data[key])+"'"
    key  = ','.join(table_data.keys())
    value = ','.join(table_data.values())
    real_sql = "INSERT INTO " + table_name + " (" + key + ") VALUES (" + value + ")"
    #print(real_sql)

    with self.connection.cursor() as cursor:
      cursor.execute(real_sql)

    self.connection.commit()

  # close database
  def close(self):
    self.connection.close()

  # init data
  def init_data(self, datas):
    for table, data in datas.items():
      self.clear(table)
      for d in data:
        self.insert(table, d)
    self.close()


if __name__ == '__main__':

  db = DB()
  table_name = "sign_event"
  data = {'id':1,'name':'紅米','`limit`':2000,'status':1,'address':'北京會展中心','start_time':'2016-08-20 00:25:42'}
  table_name2 = "sign_guest"
  data2 = {'realname':'alen','phone':12312341234,'email':'alen@mail.com','sign':0,'event_id':1}

  db.clear(table_name)
  db.insert(table_name, data)
  db.close()

首先，讀取 db_config.ini 配置文件。創(chuàng)建 DB 類，__init__()方法初始化，通過 pymysql.connect()連接數(shù)據(jù)庫。

因為這里只用到數(shù)據(jù)庫表的清除和插入，所以只創(chuàng)建 clear()和 insert()兩個方法。其中，insert()方法對數(shù) 據(jù)的插入做了簡單的格式轉(zhuǎn)化，可將字典轉(zhuǎn)化成 SQL 插入語句，這樣格式轉(zhuǎn)化了方便了數(shù)據(jù)庫表數(shù)據(jù)的創(chuàng)建。

最后，通過 close()方法用于關(guān)閉數(shù)據(jù)庫連接。

4.2.3、接下來接下來 創(chuàng)建測試數(shù)據(jù) ，.../db_fixture/ test_data.py

import sys
sys.path.append('../db_fixture')
try:
  from mysql_db import DB
except ImportError:
  from .mysql_db import DB

# create data
datas = {
  'sign_event':[
    {'id':1,'name':'紅米Pro發(fā)布會','`limit`':2000,'status':1,'address':'北京會展中心','start_time':'2017-08-20 14:00:00'},
    {'id':2,'name':'可參加人數(shù)為0','`limit`':0,'status':1,'address':'北京會展中心','start_time':'2017-08-20 14:00:00'},
    {'id':3,'name':'當前狀態(tài)為0關(guān)閉','`limit`':2000,'status':0,'address':'北京會展中心','start_time':'2017-08-20 14:00:00'},
    {'id':4,'name':'發(fā)布會已結(jié)束','`limit`':2000,'status':1,'address':'北京會展中心','start_time':'2001-08-20 14:00:00'},
    {'id':5,'name':'小米5發(fā)布會','`limit`':2000,'status':1,'address':'北京國家會議中心','start_time':'2017-08-20 14:00:00'},
  ],
  'sign_guest':[
    {'id':1,'realname':'alen','phone':13511001100,'email':'alen@mail.com','sign':0,'event_id':1},
    {'id':2,'realname':'has sign','phone':13511001101,'email':'sign@mail.com','sign':1,'event_id':1},
    {'id':3,'realname':'tom','phone':13511001102,'email':'tom@mail.com','sign':0,'event_id':5},
  ],
}

# Inster table datas
def init_data():
  DB().init_data(datas)


if __name__ == '__main__':
  init_data()

init_data()函數(shù)用于讀取 datas 字典中的數(shù)據(jù)，調(diào)用 DB 類中的 clear()方法清除數(shù)據(jù)庫，然后，調(diào)用 insert() 方法插入表數(shù)據(jù)。

4.2.4、編寫 接口測試用例 。創(chuàng)建添加發(fā)布會接口測試文件.../interface/ add_event_test.py

import unittest
import requests
import os, sys
parentdir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.insert(0, parentdir)
from db_fixture import test_data


class AddEventTest(unittest.TestCase):
  ''' 添加發(fā)布會 '''

  def setUp(self):
    self.base_url = "http://127.0.0.1:8000/api/add_event/"

  def tearDown(self):
    print(self.result)

  def test_add_event_all_null(self):
    ''' 所有參數(shù)為空 '''
    payload = {'eid':'','':'','limit':'','address':"",'start_time':''}
    r = requests.post(self.base_url, data=payload)
    self.result = r.json()
    self.assertEqual(self.result['status'], 10021)
    self.assertEqual(self.result['message'], 'parameter error')

  def test_add_event_eid_exist(self):
    ''' id已經(jīng)存在 '''
    payload = {'eid':1,'name':'一加4發(fā)布會','limit':2000,'address':"深圳寶體",'start_time':'2017'}
    r = requests.post(self.base_url, data=payload)
    self.result = r.json()
    self.assertEqual(self.result['status'], 10022)
    self.assertEqual(self.result['message'], 'event id already exists')

  def test_add_event_name_exist(self):
    ''' 名稱已經(jīng)存在 '''
    payload = {'eid':11,'name':'紅米Pro發(fā)布會','limit':2000,'address':"深圳寶體",'start_time':'2017'}
    r = requests.post(self.base_url,data=payload)
    self.result = r.json()
    self.assertEqual(self.result['status'], 10023)
    self.assertEqual(self.result['message'], 'event name already exists')

  def test_add_event_data_type_error(self):
    ''' 日期格式錯誤 '''
    payload = {'eid':11,'name':'一加4手機發(fā)布會','limit':2000,'address':"深圳寶體",'start_time':'2017'}
    r = requests.post(self.base_url,data=payload)
    self.result = r.json()
    self.assertEqual(self.result['status'], 10024)
    self.assertIn('start_time format error.', self.result['message'])

  def test_add_event_success(self):
    ''' 添加成功 '''
    payload = {'eid':11,'name':'一加4手機發(fā)布會','limit':2000,'address':"深圳寶體",'start_time':'2017-05-10 12:00:00'}
    r = requests.post(self.base_url,data=payload)
    self.result = r.json()
    self.assertEqual(self.result['status'], 200)
    self.assertEqual(self.result['message'], 'add event success')


if __name__ == '__main__':
  test_data.init_data() # 初始化接口測試數(shù)據(jù)
  unittest.main()

在測試接口之前，調(diào)用test_data.py文件中的init_data()方法初始化數(shù)據(jù)庫中的測試數(shù)據(jù)。

創(chuàng)建AddEventTest測試類繼承 unittest.TestCase 類，通過創(chuàng)建測試用例，調(diào)用相關(guān)接口，并驗證接口返回的數(shù)據(jù)。

4.2.5、創(chuàng)建 run_tests.py 文件

當開發(fā)的接口達到一定數(shù)量后，就需要考慮 分文件分目錄 的來劃分接口測試用例，如何批量的執(zhí)行不同文件目錄下的用例呢？unittest單元測試框架提供的 discover() 方法可以幫助我們做到這一點。并使用 HTMLTestRunner 擴展生成 HTML 格式的測試報告。

import time, sys
sys.path.append('./interface')
sys.path.append('./db_fixture')
from HTMLTestRunner import HTMLTestRunner
import unittest
from db_fixture import test_data


# 指定測試用例為當前文件夾下的 interface 目錄
test_dir = './interface'
discover = unittest.defaultTestLoader.discover(test_dir, pattern='*_test.py')


if __name__ == "__main__":
  test_data.init_data() # 初始化接口測試數(shù)據(jù)

  now = time.strftime("%Y-%m-%d %H_%M_%S")
  filename = './report/' + now + '_result.html'
  fp = open(filename, 'wb')
  runner = HTMLTestRunner(stream=fp,
              title='Guest Manage System Interface Test Report',
              description='Implementation Example with: ')
  runner.run(discover)
  fp.close()

首先，通過調(diào)用test_data.py文件中的init_data()函數(shù)來初始化接口測試數(shù)據(jù)。

使用unittest框架所提供的discover()方法，查找 interface/ 目錄下，所有匹配*_test.py 的測試文件（*星號匹配任意字符）。

HTMLTestRunner 為unittest單元測試框架的擴展，利用它所提供的HTMLTestRunner()類來替換unittest單元測試框架的TextTestRunner()類，從而生成HTML格式的測試報告。

遺憾的是HTMLTestRunner并不支持Python3.x，大家可以在網(wǎng)上找到適用于Python3.x的HTMLTestRunner.py文件，使用在自己的接口自動化工程中。

通過 time 的 strftime()方法獲取當前時間，并且轉(zhuǎn)化成一定的時間格式。作為測試報告的名稱。這樣做目的是是為了避免因為生成的報告的名稱重名而造成報告的覆蓋。最終，將測試報告存放于report/目錄下面。如下圖，一張完整的接口自動化測試報告。