溫馨提示×

溫馨提示×

您好，登錄后才能下訂單哦！

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務(wù)條款》

使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能

發(fā)布時間：2020-11-12 15:20:36 來源：億速云 閱讀：391 作者：Leah 欄目：開發(fā)技術(shù)

今天就跟大家聊聊有關(guān)使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結(jié)了以下內(nèi)容，希望大家根據(jù)這篇文章可以有所收獲。

前言

這是一個使用HttpRunner開發(fā)接口平臺的簡單Demo。

新建Django項目

使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能

安裝依賴包

使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能

pip install httprunner=1.5.6 -i https://pypi.doubanio.com/simple/

模型規(guī)劃

  • 項目Project：包含 名稱、創(chuàng)建時間、修改時間
  • 測試套件TestSuite：對應(yīng)HttpRunner的一個yaml文件，包含所屬項目、name、base_url、request請求配置、variables用戶自定義變量、創(chuàng)建時間、修改時間
  • 測試用例TestCase：對應(yīng)HttpRunner中的一個test段，包含所屬TestSuite、name、skip、request、validate、extract、創(chuàng)建時間、修改時間
  • 測試結(jié)果TestResult：測試套件運行的一次結(jié)果信息，包含所屬TestSuite、HttpRunner運行summary中的時間信息、統(tǒng)計信息、平臺信息、詳情等
     

自定義YamlField

由于TestSuite中的request、variables以及用例中的request我們需要使用Python的字典格式，用例中的validate和extract需要使用Python的列表格式。而Django中這些只能按字符串格式TextField存儲。

我們編寫一個自定義YamlField，存庫時按字符串存，讀取時轉(zhuǎn)為Python字典或列表。

在apitest目錄下新建fields.py，內(nèi)容如下。

串存，讀取時轉(zhuǎn)為Python字典或列表。
在apitest目錄下新建fields.py，內(nèi)容如下。

import yaml
from django.db import models

class YamlField(models.TextField):
  def to_python(self, value): # 將數(shù)據(jù)庫內(nèi)容轉(zhuǎn)為python對象時調(diào)用
    if not value:
      value = {}
    if isinstance(value, (list, dict)):
      return value
    return yaml.safe_load(value)

  def get_prep_value(self, value): # create時插入數(shù)據(jù), 轉(zhuǎn)為字符串存儲
    return value if value is None else yaml.dump(value, default_flow_style=False)

  def from_db_value(self, value, expression, connection): # 從數(shù)據(jù)庫讀取字段是調(diào)用
    return self.to_python(value)

使用抽象模型

由于好幾個項目、測試套件、測試用例都需要名稱、創(chuàng)建時間、修改時間三個屬性。為了簡化代碼，這里創(chuàng)建一個抽象模型ModelWithName，抽象模型用來通過繼承來復(fù)用屬性，并不會創(chuàng)建表。
修改apitest/models.py，添加：

from django.db import models
class ModelWithName(models.Model):
  class Meta:
    abstract = True

  name = models.CharField("名稱", max_length=200)
  created = models.DateTimeField('創(chuàng)建時間', auto_now_add=True)
  modified = models.DateTimeField('最后修改時間', auto_now=True)
  def __str__(self):
    return self.name

編寫模型

修改apitest/models.py，添加：

class Project(ModelWithName):
  class Meta:
    verbose_name_plural = verbose_name = '項目'


class TestSuite(ModelWithName):
  """對應(yīng)httprunner的一個yaml文件"""
  class Meta:
    verbose_name_plural = verbose_name = '測試套件'
  project = models.ForeignKey(Project, verbose_name='項目', related_name='suites', on_delete=models.CASCADE)
  base_url = models.CharField('域名', max_length=500, blank=True, null=True) # 對應(yīng)config/base_url
  request = YamlField('請求默認(rèn)配置', blank=True) # 對應(yīng)config/request
  variables = YamlField('變量', blank=True)

class TestCase(ModelWithName):
  """對應(yīng)httprunner中的一個test"""
  class Meta:
    verbose_name_plural = verbose_name = '測試用例'

  suite = models.ForeignKey(TestSuite, verbose_name='測試套件', related_name='tests', on_delete=models.CASCADE)
  skip = models.BooleanField('跳過', default=False)
  request = YamlField('請求數(shù)據(jù)') # 對應(yīng)config/request
  extract = YamlField('提取請求', blank=True)
  validate = YamlField('斷言', blank=True)

class TestResult(models.Model):
  class Meta:
    verbose_name_plural = verbose_name = '測試結(jié)果'

  suite = models.ForeignKey(TestSuite, verbose_name='測試套件', related_name='results', on_delete=models.CASCADE)
  success = models.BooleanField('成功')
  start_at = models.DateTimeField('開始時間')
  duration = models.DurationField('持續(xù)時間')
  platform = models.TextField('平臺信息')
  test_run = models.SmallIntegerField('運行')
  successes = models.SmallIntegerField('成功')
  skipped = models.SmallIntegerField('跳過')
  failures = models.SmallIntegerField('失敗')
  errors = models.SmallIntegerField('出錯')
  expected_failures = models.SmallIntegerField('預(yù)期失敗')
  unexpected_successes = models.SmallIntegerField('非預(yù)期成功')
  details = models.TextField('詳情')
  created = models.DateTimeField('創(chuàng)建時間', auto_now_add=True)

  def __str__(self):
    return self.suite.name + '-測試結(jié)果'

HttpRunner運行結(jié)果的summary的格式如下：

 {'platform': {'httprunner_version': '1.5.6', 'platform': 'Darwin-19.2.0-x86_64-i386-64bit', 'python_version': 'CPython 3.6.5'},
 'stat': {'errors': 0, 'expectedFailures': 0,'failures': 0,'skipped': 0,'successes': 1,'testsRun': 1,'unexpectedSuccesses': 0},
 'success': True,
 'time': {'duration': 2.2655465602874756, 'start_at': 1587895780.3771362}}
 'details': [  # 每個對應(yīng)一個測試套件
  {'name': '套件名稱',
   'base_url': 'https://httpbin.org',
   'stat': {'errors': 0, 'expectedFailures': 0,'failures': 0,'skipped': 0,'successes': 1,'testsRun': 1,'unexpectedSuccesses': 0},
   'success': True,
   'time': {'duration': 2.2655465602874756, 'start_at': 1587895780.3771362}},
   'output': [],
   'records': [  # 對應(yīng)每一條用例
     {
      'name': '用例名',
      'status': 'success',
      'meta_data': {'request': {'url': ..., 'method': ..., 'start_timestamp': ...}, 
                 'response': {'content': ..., 'text': ..., 'json': ..., 'headers': ..., 'status_code': ..., 'elapsed_ms': ...}}
      'attachment': ['出錯信息']
     }
   ]
 }

這里TestResult模型，對summary結(jié)果的信息做了簡單的拆解。

組裝用例數(shù)據(jù)

對于用例TestCase，我們需要將其name、skip、request、validate、extract組裝成HttpRunner的字典格式。
在apitest/models.py的TestCase類中添加data屬性方法，代碼如下：

class TestCase(ModelWithName):
  ....
  @property
  def data(self):
    return dict(name=self.name,skip=self.skip,request=self.request,extract=self.extract,validate=self.validate)

一個套件最后解析后應(yīng)該是包含name、config、apis、testcases的一個字典，我們需要將TestSuite對象及包含的所有TestCase對象組裝成如下格式。

{"name": "套件名稱"， "config" : {...}, "apis": {}, "testcases": []}

補充：加載debugtalk.py的方法
config中可以指定一個yaml的path路徑，會自動加載該路徑下的debugtalk.py文件
如

- utils
   - config.yaml # 空文件即可
   - debugtalk.py

config的格式可以為：

config: 
   name: ...
   request: ...
   variables: ...
   path: .../config.yaml

這樣可以自動加載debugtalk.py中的函數(shù)以供使用。

在apitest/models.py的TestSuite類中添加data屬性方法，代碼如下：

@property
  def data(self):
    request = self.request
    request['base_url'] = self.base_url
    data = dict(
      name=self.name,
      config=dict(request=self.request, variables=self.variables),
      api={},
      testcases=[test.data for test in self.tests.all()]
    )
    return data

由于TestCase在外聯(lián)TestSuite時設(shè)置了關(guān)聯(lián)名稱tests，因此TestSuite對象可以通過self.tests.all()查詢出所有關(guān)聯(lián)它的用例。

注：HttpRunner-1.5.6版本的base_url是放在config/request中的，這里做了分離，要重新放入config/request中。

編寫套件運行方法

從 httprunner.task模塊中導(dǎo)入HttpRunner類，使用TestSuite數(shù)據(jù)，運行即可。由于運行時是安多個TestSuite模式運行的，因此TestSuite的數(shù)據(jù)要放到一個列表中。

在apitest/models.py的TestSuite類添加run方法。

from httprunner.task import HttpRunner
...

class TestSuite(ModelWithName):
  ...
  def run(self):
    runner = HttpRunner().run([self.data])
    summary = runner.summary
    if summary:
      # 保存結(jié)果到TestResult
      _time = summary['time']
      _stat = summary['stat']
      TestResult.objects.create(
        suite=self, success=summary['success'],
        start_at=datetime.datetime.fromtimestamp(_time['start_at']),
        duration=datetime.timedelta(seconds=_time['duration']),
        test_run=_stat['testsRun'], successes=_stat['successes'], skipped=_stat['skipped'], errors=_stat['errors'],
        failures=_stat['failures'], expected_failures=_stat['expectedFailures'],
        unexpected_successes=_stat['unexpectedSuccesses'],
        platform=json.dumps(summary['platform'], indent=2, ensure_ascii=False),
        details=summary['details']
      )
    return summary

運行后，解析summary并創(chuàng)建TestResult對象保存本次運行結(jié)果。

模型完整代碼

import datetime
import json

from django.db import models
from httprunner.task import HttpRunner

from .fields import YamlField


class ModelWithName(models.Model):
  class Meta:
    abstract = True

  name = models.CharField("名稱", max_length=200)
  created = models.DateTimeField('創(chuàng)建時間', auto_now_add=True)
  modified = models.DateTimeField('最后修改時間', auto_now=True)
  
  def __str__(self):
    return self.name

class Project(ModelWithName):
  class Meta:
    verbose_name_plural = verbose_name = '項目'


class TestSuite(ModelWithName):
  """對應(yīng)httprunner的一個yaml文件"""
  class Meta:
    verbose_name_plural = verbose_name = '測試套件'
  project = models.ForeignKey(Project, verbose_name='項目', related_name='suites', on_delete=models.CASCADE)
  base_url = models.CharField('域名', max_length=500, blank=True, null=True) # 對應(yīng)config/base_url
  request = YamlField('請求默認(rèn)配置', blank=True) # 對應(yīng)config/request
  variables = YamlField('變量', blank=True)

  @property
  def data(self):
    request = self.request
    request['base_url'] = self.base_url
    data = dict(
      name=self.name,
      config=dict(request=self.request, variables=self.variables),
      api={},
      testcases=[test.data for test in self.tests.all()]
    )
    return data

  def run(self):
    runner = HttpRunner().run([self.data])
    summary = runner.summary
    if summary:
      # 保存結(jié)果到TestResult
      _time = summary['time']
      _stat = summary['stat']
      TestResult.objects.create(
        suite=self, success=summary['success'],
        start_at=datetime.datetime.fromtimestamp(_time['start_at']),
        duration=datetime.timedelta(seconds=_time['duration']),
        test_run=_stat['testsRun'], successes=_stat['successes'], skipped=_stat['skipped'], errors=_stat['errors'],
        failures=_stat['failures'], expected_failures=_stat['expectedFailures'],
        unexpected_successes=_stat['unexpectedSuccesses'],
        platform=json.dumps(summary['platform'], indent=2, ensure_ascii=False),
        details=summary['details']
      )
    return summary


class TestCase(ModelWithName):
  """對應(yīng)httprunner中的一個test"""
  class Meta:
    verbose_name_plural = verbose_name = '測試用例'

  suite = models.ForeignKey(TestSuite, verbose_name='測試套件', related_name='tests', on_delete=models.CASCADE)
  skip = models.BooleanField('跳過', default=False)
  request = YamlField('請求數(shù)據(jù)') # 對應(yīng)config/request
  extract = YamlField('提取請求', blank=True)
  validate = YamlField('斷言', blank=True)

  @property
  def data(self):
    return dict(name=self.name,skip=self.skip,request=self.request,extract=self.extract,validate=self.validate)


class TestResult(models.Model):
  class Meta:
    verbose_name_plural = verbose_name = '測試結(jié)果'

  suite = models.ForeignKey(TestSuite, verbose_name='測試套件', related_name='results', on_delete=models.CASCADE)
  success = models.BooleanField('成功')
  start_at = models.DateTimeField('開始時間')
  duration = models.DurationField('持續(xù)時間')
  platform = models.TextField('平臺信息')
  test_run = models.SmallIntegerField('運行')
  successes = models.SmallIntegerField('成功')
  skipped = models.SmallIntegerField('跳過')
  failures = models.SmallIntegerField('失敗')
  errors = models.SmallIntegerField('出錯')
  expected_failures = models.SmallIntegerField('預(yù)期失敗')
  unexpected_successes = models.SmallIntegerField('非預(yù)期成功')
  details = models.TextField('詳情')
  created = models.DateTimeField('創(chuàng)建時間', auto_now_add=True)

  def __str__(self):
    return self.suite.name + '-測試結(jié)果'

使用Django Admin

修改apitest/admin.py，代碼如下：

from django.contrib import admin

from apitest import models


@admin.register(models.Project)
class ProjectAdmin(admin.ModelAdmin):
  list_display = ('name', 'created', 'modified')


class TestCaseInline(admin.StackedInline):
  model = models.TestCase
  extra = 1


@admin.register(models.TestSuite)
class TestSuiteAdmin(admin.ModelAdmin):
  inlines = [TestCaseInline]
  list_display = ('name', 'project', 'base_url', 'created', 'modified')
  list_filter = ('project', )

  actions = ("run", )

  def run(self, request, queryset):
    for suite in queryset:
      suite.run()
  run.short_description = "運行"


@admin.register(models.TestResult)
class TestResultAdmin(admin.ModelAdmin):
  readonly_fields = ('suite', 'success', 'start_at', 'duration', 'platform',
            'test_run', 'successes', 'skipped', 'failures', 'errors',
            'expected_failures', 'unexpected_successes', 'details', 'created')
  fields = (('suite', 'success'),
       ('start_at', 'duration'),
       ('platform',),
       ('test_run', 'successes', 'skipped', 'failures', 'errors', 'expected_failures', 'unexpected_successes'),
       ('details',)
       )
  list_display = ('suite', 'success', 'test_run', 'successes', 'errors', 'failures', 'start_at', 'duration')
  list_filter = ('suite', )

這里將項目、測試套件、測試結(jié)果三個模型注冊到Admin后臺，測試用例則作為內(nèi)聯(lián)模型放到測試套件中進(jìn)行編輯。
在測試套件模型中，自定義了一個“運行”，操作，支持運行選中的用例。

運行并測試項目

打開terminal終端，執(zhí)行數(shù)據(jù)庫變更并創(chuàng)建超級管理員。

python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py createsuperuser

運行開發(fā)服務(wù)器

python3 manage.py runserver

訪問http://127.0.0.1:8000/admin并登錄。

使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能

創(chuàng)建一個項目，測試項目，然后創(chuàng)建一個TestSuite，如下：

使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能

請求默認(rèn)配置：

headers: x-text: abc123

變量：

a: 1b: 2

使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能

請求數(shù)據(jù)：

url: /getmethod: GETparams: a: $a b: $b

提取請求：

- res_url: content.url

斷言：

- eq: [status_code, 200]

點擊保存。

回到TestSuite列表，選中測試套件，動作下拉框中選擇“運行”，點擊Go按鈕。

使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能

返回測試結(jié)果列表、查看測試結(jié)果。

使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能

使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能

看完上述內(nèi)容，你們對使用Django Admin+HttpRunner實現(xiàn)一個接口測試功能有進(jìn)一步的了解嗎？如果還想了解更多知識或者相關(guān)內(nèi)容，請關(guān)注億速云行業(yè)資訊頻道，感謝大家的支持。

向AI問一下細(xì)節(jié)

免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點不代表本網(wǎng)站立場，如果涉及侵權(quán)請聯(lián)系站長郵箱：is@yisu.com進(jìn)行舉報，并提供相關(guān)證據(jù)，一經(jīng)查實，將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI
助
手