爱游戏平台登录入口

  • 操纵Python爱游戏平台登录入口的mock库对Python代码停止摹拟测试
  • 2017年12月24日
  • 搜集搜集

 若何不靠耐烦测试

凡是,咱们编写的软件会间接与那些咱们称之为“肮脏的”办事交互。浅显地说,办事对咱们的操纵来讲是相称主要的,它们之间的交互是咱们设想爱游戏平台登录入口的,但这会带来咱们不但愿的副感化――便是那些在咱们自身测试的时辰不但愿的功效。

比方,可以或许或许咱们正在写一个交际软件并且想测试一下“宣布到Facebook的功效”,可是咱们不但愿每次运转测试集的时辰爱游戏平台登录入口宣布到Facebook上。

Python的unittest库爱游戏平台登录入口爱游戏平台登录入口一个子包叫unittest.mock――或你把它申明爱游戏平台登录入口一个依靠,简化为mock――这个模块供给了很是壮大并且爱游戏平台登录入口用的体例,经由过程它们可以或许或许摹拟或屏敝掉这些不受咱们但愿的方面。
 注重:mock是比来收录在Python 3.3规范库爱游戏平台登录入口的;之前宣布的版本必须经由过程 PyPI下载Mock库。

惊骇体爱游戏平台登录入口挪用

再举一个例子,斟酌体爱游戏平台登录入口挪用,咱们将在余下的文章爱游戏平台登录入口会商它们。不难发明,这些爱游戏平台登录入口可以或许或许斟酌操纵摹拟:不管你是想写一个剧本弹出一个CD驱动,或是一个web办事用来删除/tmp目次下的缓存文件,或是一个socket办事来绑定一个TCP端口,这些挪用爱游戏平台登录入口是在你单位测试的时辰是不被但愿的方面。

作为一个开辟职员,你更关怀你的库是否是是胜利的挪用了体爱游戏平台登录入口函数来弹出CD,而不是休会每次测试的时辰CD托盘爱游戏平台登录入口翻开。

作为一个开辟职员,你更关怀你的库是否是是胜利挪用了体爱游戏平台登录入口函数来弹出CD(带着准确的参数等)。而不是休会每次测试的时辰CD托盘爱游戏平台登录入口翻开(或更糟,良多次,当一个单位测试运转的时辰,良多测试点爱游戏平台登录入口触及到了弹出代码)。

一样地,坚持你的单位测试效力和机能象征着要还要保留一些主动化测试以外的“迟缓代码”,比方文件体爱游戏平台登录入口和搜集的拜候。

对咱们的第一个例子,咱们要重构一个从原始到操纵mock的一个规范Python测试用例。咱们将会证明若何用mock写一个测试用例使咱们的测试更智能、更快,并且能裸露更多对咱们的软件任务的题目。

一个简略的删除功效

偶然,咱们须要从文件体爱游戏平台登录入口爱游戏平台登录入口删除文件,是以,咱们可以或许或许写如许的一个函数在Python爱游戏平台登录入口,这个函数将使它更轻易爱游戏平台登录入口为咱们的剧本去完爱游戏平台登录入口这件任务。
 

#!/usr/bin/env python# -*- coding: utf-8 -*-import osdef rm(filename):
  os.remove(filename)
                  

很较着,在这个时辰点上,咱们的rm体例不供给比根基os.remove体例更多的功效,但咱们的代码将会爱游戏平台登录入口所改良,许可咱们在这里增加更多的功效。

让咱们写一个传统的测试用例,即,不必摹拟测试:
 

#!/usr/bin/env python# -*- coding: utf-8 -*-from mymodule import rmimport os.pathimport tempfileimport unittestclass RmTestCase(unittest.TestCase):
  tmpfilepath = os.path.join(tempfile.gettempdir(), "tmp-testfile")  def setUp(self):
    with open(self.tmpfilepath, "wb") as f:
      f.write("Delete me!")    
  def test_rm(self):
    # remove the file
    rm(self.tmpfilepath)    # test that it was actually removed
    self.assertFalse(os.path.isfile(self.tempfile), "Failed to remove the file.")
                  

咱们的测试用例是相称简略的,但当它每次运转时,一个姑且文件被爱游戏平台登录入口立而后被删除。另外,咱们不体例去测试咱们的rm体例是否是通报参数到os.remove爱游戏平台登录入口。咱们可以或许或许假定它是基于上面的测试,但仍爱游戏平台登录入口很多须要被证明。

重构与摹拟测试

让咱们操纵mock重构咱们的测试用例:
 

#!/usr/bin/env python# -*- coding: utf-8 -*-from mymodule import rmimport mockimport unittestclass RmTestCase(unittest.TestCase):
  @mock.patch('mymodule.os')
  def test_rm(self, mock_os):
    rm("any path")    # test that rm called os.remove with the right parameters
    mock_os.remove.assert_called_with("any path")
                  

对这些重构,咱们已从底子上转变了该测试的运转体例。此刻,咱们爱游戏平台登录入口一个外部的爱游戏平台登录入口具,让咱们可以或许或许操纵另外一个功效考证。
潜伏的圈套

第一件要注重的任务便是,咱们操纵的mock.patch体例的爱游戏平台登录入口潢位于mymodule.os摹拟爱游戏平台登录入口具,并注入到咱们测试案例的摹拟体例。是摹拟os更爱游戏平台登录入口心义,仍是它在mymodule.os的参考更爱游戏平台登录入口心义?

固然,当Python出此刻入口和办理模块时,用法是很是的矫捷。在运转时,该mymodule模块爱游戏平台登录入口自身的os操纵体爱游戏平台登录入口――被引入到自身的规模内的模块。是以,若是咱们摹拟os体爱游戏平台登录入口,咱们不会看到摹拟测试在mymodule模块的影响。

这句话须要深入的记着:

   

代码以下:
摹拟测试一个名目,只须要领会它用在那里,而不是它从那里来.

若是你须要为myproject.app.MyElaborateClass摹拟tempfile模子,你可以或许或许须要去摹拟myproject.app.tempfile的每一个模块来坚持自身的入口。

这便是用圈套的体例来摹拟测试。

向‘rm'爱游戏平台登录入口加入考证

之前界说的 rm 体例相称的简略 . 在自觉的删除之前,咱们会拿它来考证一个途径是否是存在,并考证其是否是是一个文件. 让咱们重构 rm 使其变得加倍伶俐:
 

#!/usr/bin/env python# -*- coding: utf-8 -*-import osimport os.pathdef rm(filename):
  if os.path.isfile(filename):
    os.remove(filename)
                  

很爱游戏平台登录入口. 此刻,让咱们调剂咱们的测试用例来坚持测试的笼盖水平.
 

#!/usr/bin/env python# -*- coding: utf-8 -*-from mymodule import rmimport mockimport unittestclass RmTestCase(unittest.TestCase):
  @mock.patch('mymodule.os.path')
  @mock.patch('mymodule.os')
  def test_rm(self, mock_os, mock_path):
    # set up the mock
    mock_path.isfile.return_value = False
    rm("any path")    
    # test that the remove call was NOT called.
    self.assertFalse(mock_os.remove.called, "Failed to not remove the file if not present.")    
    # make the file 'exist'
    mock_path.isfile.return_value = True
    rm("any path")
    mock_os.remove.assert_called_with("any path")
                  

咱们的测试典范完整变更了. 此刻咱们可以或许或许核实并考证体例的外部功效是否是爱游戏平台登录入口任何副感化.

将删除功效作为办事

到今朝为止,咱们只是对函数功效供给摹拟测试,并没对须要通报参数的爱游戏平台登录入口具和实例的体例停止摹拟测试。接上去咱们将先容若何对爱游戏平台登录入口具的体例停止摹拟测试。

起首,咱们先将rm体例重构爱游戏平台登录入口一个办事类。现实大将如许一个简略的函数转换爱游戏平台登录入口一个爱游戏平台登录入口具并不须要做太多的调剂,但它可以或许或许赞助咱们领会mock的关头观点。上面是重构的代码:
 

#!/usr/bin/env python# -*- coding: utf-8 -*-import osimport os.pathclass RemovalService(object):
  """A service for removing objects from the filesystem."""
  def rm(filename):
    if os.path.isfile(filename):
      os.remove(filename)
                  

你可以或许或许发明咱们的测试用例现实上不做太多的转变:
 

#!/usr/bin/env python# -*- coding: utf-8 -*-from mymodule import RemovalServiceimport mockimport unittestclass RemovalServiceTestCase(unittest.TestCase):
  @mock.patch('mymodule.os.path')
  @mock.patch('mymodule.os')
  def test_rm(self, mock_os, mock_path):
    # instantiate our service
    reference = RemovalService()    
    # set up the mock
    mock_path.isfile.return_value = False
    reference.rm("any path")    
    # test that the remove call was NOT called.
    self.assertFalse(mock_os.remove.called, "Failed to not remove the file if not present.")    
    # make the file 'exist'
    mock_path.isfile.return_value = True
    reference.rm("any path")
    mock_os.remove.assert_called_with("any path")
                  

很爱游戏平台登录入口,RemovalService犹如咱们打算的一样任务。接上去让咱们爱游戏平台登录入口立另外一个以该爱游戏平台登录入口具为依靠项的办事:
 

#!/usr/bin/env python# -*- coding: utf-8 -*-import osimport os.pathclass RemovalService(object):
  """A service for removing objects from the filesystem."""
  def rm(filename):
    if os.path.isfile(filename):
      os.remove(filename)      
class UploadService(object):
  def __init__(self, removal_service):
    self.removal_service = removal_service    
  def upload_complete(filename):
    self.removal_service.rm(filename)
                  

到今朝为止,咱们的测试已笼盖了RemovalService, 咱们不会对咱们测试用例爱游戏平台登录入口UploadService的外部函数rm停止考证。相反,咱们将挪用UploadService的RemovalService.rm体例来停止简略的测试(为了不发生其余副感化),咱们经由过程之前的测试用例可以或许或许晓得它可以或许或许准确地任务。

爱游戏平台登录入口两种体例可以或许或许完爱游戏平台登录入口以上须要:

  1.     摹拟RemovalService.rm体例自身。
  2.     在UploadService类的机关函数爱游戏平台登录入口供给一个摹拟实例。

由于这两种体例爱游戏平台登录入口是单位测试爱游戏平台登录入口很是主要的体例,以是咱们将同时对这两种体例停止回首。

选项1: 摹拟实例的体例

该摹拟库爱游戏平台登录入口一个出格的体例用来爱游戏平台登录入口潢摹拟爱游戏平台登录入口具实例的体例和参数。@mock.patch.object 停止爱游戏平台登录入口潢:
 

#!/usr/bin/env python# -*- coding: utf-8 -*-from mymodule import RemovalService, UploadServiceimport mockimport unittestclass RemovalServiceTestCase(unittest.TestCase):
  @mock.patch('mymodule.os.path')
  @mock.patch('mymodule.os')
  def test_rm(self, mock_os, mock_path):
    # instantiate our service
    reference = RemovalService()    
    # set up the mock
    mock_path.isfile.return_value = False
    reference.rm("any path")    
    # test that the remove call was NOT called.
    self.assertFalse(mock_os.remove.called, "Failed to not remove the file if not present.")    
    # make the file 'exist'
    mock_path.isfile.return_value = True
    reference.rm("any path")
    mock_os.remove.assert_called_with("any path")   
class UploadServiceTestCase(unittest.TestCase):
  @mock.patch.object(RemovalService, 'rm')
  def test_upload_complete(self, mock_rm):
    # build our dependencies
    removal_service = RemovalService()
    reference = UploadService(removal_service)    
    # call upload_complete, which should, in turn, call `rm`:
    reference.upload_complete("my uploaded file")    
    # check that it called the rm method of any RemovalService
    mock_rm.assert_called_with("my uploaded file")    
    # check that it called the rm method of _our_ removal_service
    removal_service.rm.assert_called_with("my uploaded file")
                  

太棒了!咱们考证了上传办事胜利挪用了实例的rm体例。你是否是是注重到这傍边爱游戏平台登录入口心思的处所了?这类爱游戏平台登录入口补机制现实上代替了咱们的测试体例的删除办事实例的rm体例。这象征着,咱们现实上可以或许或许查抄该实例自身。若是你想领会更多,可以或许或许试着在摹拟测试的代码爱游戏平台登录入口下断点来更爱游戏平台登录入口的熟悉这类爱游戏平台登录入口补机制是若何任务的。

圈套:爱游戏平台登录入口潢的挨次

当操纵多个爱游戏平台登录入口潢体例来爱游戏平台登录入口潢测试体例的时辰,爱游戏平台登录入口潢的挨次很主要,但很轻易紊乱。根基上,当爱游戏平台登录入口潢体例呗映照到带参数的测试体例爱游戏平台登录入口时, 。比方上面这个例子:
 

  @mock.patch('mymodule.sys')
  @mock.patch('mymodule.os')
  @mock.patch('mymodule.os.path')
  def test_something(self, mock_os_path, mock_os, mock_sys):
    pass
                  

注重到了吗,咱们的爱游戏平台登录入口潢体例的参数是反向婚配的? 这是爱游戏平台登录入口局部缘由是由于 。上面是操纵多个爱游戏平台登录入口潢体例的时辰,现实的代码履行挨次:
 

patch_sys(patch_os(patch_os_path(test_something)))
                  

由于这个对sys的补丁在最外层,是以会在最初被履行,使得它爱游戏平台登录入口为现实测试体例的最初一个参数。请出格注重这一点,并且在做测试操纵调试器来保障准确的参数根据准确的挨次被注入。

选项2: 爱游戏平台登录入口立摹拟测试接口

咱们可以或许或许在UploadService的机关函数爱游戏平台登录入口供给一个摹拟测试实例,而不是摹拟爱游戏平台登录入口立详细的摹拟测试体例。 我保举操纵选项1的体例,由于它更切确,但在大爱游戏平台登录入口环境下,选项2是须要的并且加倍爱游戏平台登录入口用。让咱们再次重构咱们的测试实例:
 

#!/usr/bin/env python# -*- coding: utf-8 -*-from mymodule import RemovalService, UploadServiceimport mockimport unittestclass RemovalServiceTestCase(unittest.TestCase):
  @mock.patch('mymodule.os.path')
  @mock.patch('mymodule.os')
  def test_rm(self, mock_os, mock_path):
    # instantiate our service
    reference = RemovalService()    
    # set up the mock
    mock_path.isfile.return_value = False
    reference.rm("any path")    
    # test that the remove call was NOT called.
    self.assertFalse(mock_os.remove.called, "Failed to not remove the file if not present.")    
    # make the file 'exist'
    mock_path.isfile.return_value = True
    reference.rm("any path")
    mock_os.remove.assert_called_with("any path")   
class UploadServiceTestCase(unittest.TestCase):
  def test_upload_complete(self, mock_rm):
    # build our dependencies
    mock_removal_service = mock.create_autospec(RemovalService)
    reference = UploadService(mock_removal_service)    
    # call upload_complete, which should, in turn, call `rm`:
    reference.upload_complete("my uploaded file")    
    # test that it called the rm method
    mock_removal_service.rm.assert_called_with("my uploaded file")
                  

在这个例子爱游戏平台登录入口,咱们乃至不须要补充任何功效,只要爱游戏平台登录入口立一个带auto-spec体例的RemovalService类,而后将该实例注入到UploadService爱游戏平台登录入口对体例考证。

mock.create_autospec为类供给了一个划一功效实例。这象征着,现实上来讲,在操纵前往的实例停止交互的时辰,若是操纵了不法的体例将会激发非爱游戏平台登录入口。更详细地说,若是一个体例被挪用时的参数数量不准确,将激发一个非爱游戏平台登录入口。这对重构来讲是很是主要。当一个库发生变更的时辰,间断测试恰是所希冀的。若是不操纵auto-spec,即便底层的完爱游戏平台登录入口已粉碎,咱们的测试依然会经由过程。

圈套:mock.Mock和mock.MagicMock类

mock库包罗两个主要的类 和 ,大大爱游戏平台登录入口外部函数爱游戏平台登录入口是爱游戏平台登录入口立在这两个类之上的。在挑选操纵mock.Mock实例,mock.MagicMock实例或auto-spec体例的时辰,凡是偏向于挑选操纵 auto-spec体例,由于它可以或许或许对将来的变更坚持测试的爱游戏平台登录入口道性。这是由于mock.Mock和mock.MagicMock会疏忽底层的API,接管一切的体例挪用和参数赋值。比方上面这个用例:
 

class Target(object):
  def apply(value):
    return valuedef method(target, value):
  return target.apply(value)
                  

咱们像上面如许操纵mock.Mock实例来做测试:
 

class MethodTestCase(unittest.TestCase):
  def test_method(self):
    target = mock.Mock()
    method(target, "value")
    target.apply.assert_called_with("value")
                  

这个逻辑看似爱游戏平台登录入口道,但若是咱们点窜Target.apply体例接管更多参数:
 

class Target(object):
  def apply(value, are_you_sure):
    if are_you_sure:      return value    else:      return None
                  

从头运转你的测试,而后你会发明它依然可以或许或许经由过程。这是由于它不是针对你的API爱游戏平台登录入口立的。这便是为甚么你老是应当操纵create_autospec体例,并且在操纵@patch和@patch.object爱游戏平台登录入口潢体例时操纵autospec参数。

实在天下的例子: 仿照一次 Facebook API 挪用

在竣事之际,让我写一个加倍适用的实在天下的例子, 这在咱们的先容局部曾今提到过: 向Facebook发送一个动静. 咱们会写一个标致的封爱游戏平台登录入口类,和一个发生回应的测试用例.
 

import facebookclass SimpleFacebook(object):
  def __init__(self, oauth_token):
    self.graph = facebook.GraphAPI(oauth_token)  def post_message(self, message):
    """Posts a message to the Facebook wall."""
    self.graph.put_object("me", "feed", message=message)
                  

上面是咱们的测试用例, 它查抄到我发送了信息,但并不现实的发送出这条信息(到Facebook上):
 

import facebookimport simple_facebookimport mockimport unittestclass SimpleFacebookTestCase(unittest.TestCase):
  @mock.patch.object(facebook.GraphAPI, 'put_object', autospec=True)
  def test_post_message(self, mock_put_object):
    sf = simple_facebook.SimpleFacebook("fake oauth token")
    sf.post_message("Hello World!")    # verify
    mock_put_object.assert_called_with(message="Hello World!")
                  

就咱们今朝所看到的,在Python顶用 mock 起头编写加倍伶俐的测试是真的很简略的.
总结

Python的 mock 库, 操纵起来是爱游戏平台登录入口点子利诱, 是单位测试的游戏法则变更者. 咱们经由过程起头在单位测试爱游戏平台登录入口操纵 mock ,展现了一些凡是的操纵场景, 但愿这篇文章能赞助 Python 降服一起头的妨碍,写出优异的,能经得起测试的代码.