第二部分
動態生成 pytest 認可的測試用例
首先說明下 pytest 的運行機制，pytest 首先會在當前目錄下找 conftest.py 文件，如果找到了，則先運行它，然後根據命令行參數去指定的目錄下找 test 開頭或結尾的 .py 文件，如果找到了，如果找到了，再分析 fixture，如果有 session 或 module 類型的，並且參數 autotest=True 或標記了 pytest.mark.usefixtures(a…)，則先運行它們；再去依次找類、方法等，規則類似。大概就是這樣一個過程。
可以看出，pytest 測試運行起來的關鍵是，必須有至少一個被 pytest 發現機制認可的testxx.py文件，文件中有TestxxClass類，類中至少有一個def testxx(self)方法。
現在並沒有任何 pytest 認可的測試文件，所以我的想法是先創建一個引導型的測試文件，它負責讓 pytest 動起來。可以用pytest.skip()讓其中的測試方法跳過。然後我們的目標是在 pytest 動起來之後，怎麼動態生成用例，然後發現這些用例，執行這些用例，生成測試報告，一氣呵成。
<code># test_bootstrap.py
import pytest
class TestStarter(object):
def test_start(self):
pytest.skip(' 此為測試啟動方法 , 不執行 ')/<code>
我想到的是通過 fixture，因為 fixture 有 setup 的能力，這樣我通過定義一個 scope 為 session 的 fixture，然後在 TestStarter 上面標記 use，就可以在導入 TestStarter 之前預先處理一些事情，那麼我把生成用例的操作放在這個 fixture 裡就能完成目標了。
<code># test_bootstrap.py
import pytest
@pytest.mark.usefixtures('te', 'test_cases')
class TestStarter(object):
def test_start(self):
pytest.skip(' 此為測試啟動方法 , 不執行 ')/<code>
pytest 有個--rootdir參數，該 fixture 的核心目的就是，通過--rootdir獲取到目標目錄，找出裡面的.yml測試文件，運行後獲得測試數據，然後為每個目錄創建一份testxx.py的測試文件，文件內容就是content變量的內容，然後把這些參數再傳給pytest.main()方法執行測試用例的測試，也就是在 pytest 內部再運行了一個 pytest！最後把生成的測試文件刪除。注意該 fixture 要定義在conftest.py裡面，因為 pytest 對於conftest中定義的內容有自發現能力，不需要額外導入。
<code># conftest.py
@pytest.fixture(scope='session')
def test_cases(request):
"""
測試用例生成處理
:param request:
:return:
"""
var = request.config.getoption("--rootdir")
test_file = request.config.getoption("--tf")
env = request.config.getoption("--te")
cases = []
if test_file:
cases = [test_file]
else:
if os.path.isdir(var):
for root, dirs, files in os.walk(var):
if re.match(r'\\w+', root):
if files:
cases.extend([os.path.join(root, file) for file in files if file.endswith('yml')])
data = main(cases)
content = """
import allure
from conftest import CaseMetaClass
@allure.feature('{}接口測試 ({}項目)')
class Test{}API(object, metaclass=CaseMetaClass):
test_cases_data = {}
"""
test_cases_files = []
if os.path.isdir(var):
for root, dirs, files in os.walk(var):
if not ('.' in root or '__' in root):
if files:
case_name = os.path.basename(root)
project_name = os.path.basename(os.path.dirname(root))
test_case_file = os.path.join(root, 'test_{}.py'.format(case_name))
with open(test_case_file, 'w', encoding='utf-8') as fw:
fw.write(content.format(case_name, project_name, case_name.title(), data.get(root)))
test_cases_files.append(test_case_file)
if test_file:
temp = os.path.dirname(test_file)
py_file = os.path.join(temp, 'test_{}.py'.format(os.path.basename(temp)))
else:
py_file = var
pytest.main([
'-v',
py_file,
'--alluredir',
'report',
'--te',
env,
'--capture',
'no',
'--disable-warnings',
])
for file in test_cases_files:
os.remove(file)
return test_cases_files/<code>
可以看到，測試文件中有一個TestxxAPI的類，它只有一個test_cases_data屬性，並沒有testxx方法，所以還不是被 pytest 認可的測試用例，根本運行不起來。那麼它是怎麼解決這個問題的呢？答案就是CaseMetaClass。
<code>function_express = """
def {}(self, response, validata):
with allure.step(response.pop('case_name')):
validator(response,validata)"""
class CaseMetaClass(type):
"""
根據接口調用的結果自動生成測試用例
"""
def __new__(cls, name, bases, attrs):
test_cases_data = attrs.pop('test_cases_data')
for each in test_cases_data:
api = each.pop('api')
function_name = 'test' + api
test_data = [tuple(x.values()) for x in each.get('responses')]
function = gen_function(function_express.format(function_name),
namespace={'validator': validator, 'allure': allure})
# 集成 allure
story_function = allure.story('{}'.format(api.replace('_', '/')))(function)
attrs[function_name] = pytest.mark.parametrize('response,validata', test_data)(story_function)
return super().__new__(cls, name, bases, attrs)/<code>
CaseMetaClass是一個元類，它讀取 test_cases_data 屬性的內容，然後動態生成方法對象，每一個接口都是單獨一個方法，在相繼被 allure 的細粒度測試報告功能和 pytest 提供的參數化測試功能裝飾後，把該方法對象賦值給test+api的類屬性，也就是說，TestxxAPI在生成之後便有了若干testxx的方法，此時內部再運行起 pytest，pytest 也就能發現這些用例並執行了。
<code>def gen_function(function_express, namespace={}):
"""
動態生成函數對象 , 函數作用域默認設置為 builtins.__dict__，併合並 namespace 的變量
:param function_express: 函數表達式，示例 'def foobar(): return "foobar"'
:return:
"""
builtins.__dict__.update(namespace)
module_code = compile(function_express, '', 'exec')
function_code = [c for c in module_code.co_consts if isinstance(c, types.CodeType)][0]
return types.FunctionType(function_code, builtins.__dict__)/<code>在生成方法對象時要注意 namespace 的問題，最好默認傳builtins.__dict__，然後自定義的方法通過 namespace 參數傳進去。
後續（yml 測試文件自動生成）
至此，框架的核心功能已經完成了，經過幾個項目的實踐，效果完全超過預期，寫起用例來不要太爽，運行起來不要太快，測試報告也整的明明白白漂漂亮亮的，但我發現還是有些累，為什麼呢？
目前做接口測試的流程是，如果項目集成了 swagger，通過 swagger 去獲取接口信息，根據這些接口信息來手工起項目創建用例。這個過程很重複很繁瑣，因為我們的用例模板已經大致固定了，其實用例之間就是一些參數比如目錄、用例名稱、method 等等的區別，那麼這個過程我覺得完全可以自動化。
因為 swagger 有個網頁，我可以去提取關鍵信息來自動創建 .yml 測試文件，就像搭起架子一樣，待項目架子生成後，我再去設計用例填傳參就可以了。
於是我試著去解析請求 swagger 首頁得到的 HTML，然後失望的是並沒有實際數據，後來猜想應該是用了 ajax，打開瀏覽器控制檯的時，我發現了api-docs的請求，一看果然是 json 數據，那麼問題就簡單了，網頁分析都不用了。
<code>import re
import os
import sys
from requests import Session
template ="""
args:
- {method}
- {api}
kwargs:
-
caseName: {caseName}
{data_or_params}:
{data}
validator:
-
json:
successed: True
"""
def auto_gen_cases(swagger_url, project_name):
"""
根據 swagger 返回的 json 數據自動生成 yml 測試用例模板
:param swagger_url:
:param project_name:
:return:
"""
res = Session().request('get', swagger_url).json()
data = res.get('paths')
workspace = os.getcwd()
project_ = os.path.join(workspace, project_name)
if not os.path.exists(project_):
os.mkdir(project_)
for k, v in data.items():
pa_res = re.split(r'[/]+', k)
dir, *file = pa_res[1:]
if file:
file = ''.join([x.title() for x in file])
else:
file = dir
file += '.yml'
dirs = os.path.join(project_, dir)
if not os.path.exists(dirs):
os.mkdir(dirs)
os.chdir(dirs)
if len(v) > 1:
v = {'post': v.get('post')}
for _k, _v in v.items():
method = _k
api = k
caseName = _v.get('description')
data_or_params = 'params' if method == 'get' else 'data'
parameters = _v.get('parameters')
data_s = ''
try:
for each in parameters:
data_s += each.get('name')
data_s += ': \\n'
data_s += ' ' * 8
except TypeError:
data_s += '{}'
file_ = os.path.join(dirs, file)
with open(file_, 'w', encoding='utf-8') as fw:
fw.write(template.format(
method=method,
api=api,
caseName=caseName,
data_or_params=data_or_params,
data=data_s
))
os.chdir(project_)/<code>
現在要開始一個項目的接口測試覆蓋，只要該項目集成了 swagger，就能秒生成項目架子，測試人員只需要專心設計接口測試用例即可，我覺得對於測試團隊的推廣使用是很有意義的，也更方便了我這樣的懶人。以上，歡迎大家一起留言探討。
TesterHome 地址：https://testerhome.com/topics/16206
閱讀更多 霍格沃茲軟件測試學院 的文章
