使用 Python Mock 类进行单元测试

数据类型、模型或节点——这些都只是mock对象可承担的角色。但mock在单元测试中扮演一个什么角色呢？

有时，你需要为单元测试的初始设置准备一些“其他”的代码资源。但这些资源兴许会不可用，不稳定，或者是使用起来太笨重。你可以试着找一些其他的资源替代；或者你可以通过创建一个被称为mock的东西来模拟它。Mocks能够让我们模拟那些在单元测试中不可用或太笨重的资源。

在Python中创建mock是通过Mock模块完成的。你可以通过每次一个属性（one-attribute-at-a-time）或一个健全的字典对象或是一个类接口来创建mock。你还可以定义mock的行为并且在测试过程中检查它的使用。让我们继续探讨。

测试准备#

典型的测试准备最少有两个部分。首先是测试对象（红色），这是测试的关注点。它可以是一个方法、模块或者类。它可以返回一个结果，也可以不返回结果，但是它可以根据数据数据或者内部状态产生错误或者异常（图1）。

图1

第二测试用例（灰色），它可以单独运行也可以作为套件的一部分。它是为测试对象准备的，也可以是测试对象需要的任意数据或资源。运行一个或多个测试事务，在每个测试中检查测试对象的行为。收集测试结果并用一个简洁、易读的格式呈现测试结果。

现在，为了发挥作用，一些测试对象需要一个或多个资源（绿色）。这些资源可以是其他的类或者模块，甚至是一个非独立的进程。不论其性质，测试资源是功能性的代码。他们的角色是支持测试对象，但是他们不是测试的关注点。

使用Mock的理由#

但是有些时候，测试资源不可用，或者不适合。也许这个资源正在和测试对象并行开发中，或者并不完整或者是太不稳定以至于不可靠。

测试资源太昂贵，如果测试资源是第三方的产品，其高昂的价格不适用于测试。测试资源的建立过于复杂，占用的硬件和时间可以用于别的地方。如果测试资源是一个数据源，建立它的数据集模仿真实世界是乏味的。

测试资源是不可预知的。一个好的单元测试是可重复的，允许你分离和识别故障。但是测试资源可能给出随机的结果，或者它会有不同的响应时间。而作为这样的结果，测试资源最终可能成为一个潜在的搅局者。

 这些都是你可能想要用mock代替测试资源的原因。mock向测试对象提供一套和测试资源相同的方法接口。但是mock是更容易创建和管理。它能向测试对象提供和真实的测试资源相同的方法接口。它能提供确定的结果，并可以自定义以适用于特定的测试。能够容易的更新，以反映实际资源的变化。

当然，mocks不是没有问题的。设计一个精确的mock是困难的,特别是如果你没有测试资源的可靠信息。你可以尝试找到一个开源的接口，或者你能对测试资源的方法接口进行猜测。无论你如何选择，你都可以在以后轻松的更新mock,你可以在首选资源中得到更详细的信息。

太多的mock会使测试过于复杂，让你跟踪错误变得更困难。最好的实践是每个测试用例限制使用一到两个mock，或者为每个mock/对象对使用独立的测试用例。

Mocks对Stubs对Fakes#

Mock不是模仿测试资源的唯一方式。其他的解决方案如stub和fake也能提供相同的服务。因此，mock和其他两种解决方案怎样比较？为什么选择mock而不是选择stub或者fake?

认识stub:stub为测试对象提供了一套方法接口，和真实的测试资源提供给测试对象的接口是相同的。当测试对象调用stub方法时，stub响应预定的结果。也可以产生一个预定的错误或者异常。stub可以跟踪和测试对象的交互，但是它不处理输入的数据。

fake也提供了一套方法接口并且也可以跟踪和测试对象的交互。但是和stub不同，fake真正的处理了从测试对象输入的数据产生的结果是基于这些数据的。简而言之，fake是功能性的，它是真实测试资源的非生产版。它缺乏资源的相互制衡，使用了更简单的算法，而且它很少存储和传输数据。

使用fake和stub,你可以输入正确的数据调用了正确的方法对测试对象进行测试。你能测试对象是如何处理数据并产生结果，当出现错误或者异常时是怎样反应的。这些测试被称为状态验证。但是你是否想知道测试对象调用了两次相同的方法？你是否想知道测试对象是否按照正确的顺序调用了几个方法？这种测试被称为行为验证，而要做到这些，你需要mocks。

使用Python Mock#

在Python中Mock模块是用来创建和管理mock对象的。该模块是Michael Foord的心血结晶，它是Python3.0的标准模块。因此在Python2.4~2.7中，你不得不自己安装这个模块。你可以 Python Package Index website从获得Mock模块最新的版本。

基于你的mock对象，Mock模块提供了少量的类。为了改变运行中的mock甚至提供了补丁机制。但是现在，我们关注一个类：Mock类。

图2中显示了Mock类（绿色）的基本结构。它继承于两个父类：NonCallableMock和CallableMixin（灰色）。NonCallableMock定义了mock对象所需的例程。它重载了几个魔法方法，给他们定义了缺省的行为。为了跟踪mock的行为，它提供了断言例程。CallableMixin更新了mock对象回调的魔法方法。反过来，两个父类继承于Base类（红色），声明了mock对象所需的属性。

图2

准备Mock#

 

Mock类有四套方法（图3）。第一套方法是类的构造器，它有六个可选和已标记的参数。图中显示了4个经常用到的参数。

图3

构造器的第一个参数是name，它定义了mock对象的唯一标示符。Listing one显示了怎么创建一个标示符为Foo的mock对象mockFoo。请注意当我打印mock对象（6-9行）时，标示符后紧跟的是mock对象的唯一ID。

构造器的第一个参数是name，它定义了mock对象的唯一标示符。Listing one显示了怎么创建一个标示符为Foo的mock对象mockFoo。请注意当我打印mock对象（6-9行）时，标示符后紧跟的是mock对象的唯一ID。

Listing One

1 from mock import Mock
2 
3 #create the mock object
4 mockFoo = Mock(name = "Foo")
5 
6 print mockFoo
7 
8 print repr(mockFoo)

构造器的第二个参数是spec。它设置mock对象的属性，可以是property或者方法。属性可以是一个列表字符串或者是其他的Python类。

为了演示，在Listing Two中，我有一个带三个项目的列表对象fooSpec(第4行)：property属性_fooValue,方法属性callFoo和doFoo。当我把fooSpec带入类构造器时（第7行），mockFoo获得了三个属性，我能用点操作符访问它们（10~15行）。当我访问了一个未声明的属性时，mockFoo引发AttributeError和"faulty"属性（21~14行）。

Listing Two

 1 from mock import Mock
 2  
 3 # prepare the spec list
 4 fooSpec = ["_fooValue", "callFoo", "doFoo"]
 5  
 6 # create the mock object
 7 mockFoo = Mock(spec = fooSpec)
 8  
 9 # accessing the mocked attributes
10 print mockFoo
11 # <Mock id='427280'>
12 print mockFoo._fooValue
13 # returns <Mock name='mock._fooValue' id='2788112'>
14 print mockFoo.callFoo()
15 # returns: <Mock name='mock.callFoo()' id='2815376'>
16  
17 mockFoo.callFoo()
18 # nothing happens, which is fine
19  
20 # accessing the missing attributes
21 print mockFoo._fooBar
22 # raises: AttributeError: Mock object has no attribute '_fooBar'
23 mockFoo.callFoobar()
24 # raises: AttributeError: Mock object has no attribute 'callFoobar'

Listing Three显示了spec参数的另一种用法。这次，有带三个属性的类Foo(4~12行)。把类名传入构造器中，这样就产生了一个和Foo有相同属性的mock对象（18~23行）。再次，访问一个未声明的属性引发了AttributeError（29~32行）。也就是说，在两个例子中，方法属性时没有功能的。甚至在方法有功能代码时，调用mock的方法也什么都不做。

Listing Three

 1 from mock import Mock
 2  
 3 # The class interfaces
 4 class Foo(object):
 5     # instance properties
 6     _fooValue = 123
 7      
 8     def callFoo(self):
 9         print "Foo:callFoo_"
10      
11     def doFoo(self, argValue):
12         print "Foo:doFoo:input = ", argValue    
13  
14 # create the mock object
15 mockFoo = Mock(spec = Foo)
16  
17 # accessing the mocked attributes
18 print mockFoo
19 # returns <Mock spec='Foo' id='507120'>
20 print mockFoo._fooValue
21 # returns <Mock name='mock._fooValue' id='2788112'>
22 print mockFoo.callFoo()
23 # returns: <Mock name='mock.callFoo()' id='2815376'>
24  
25 mockFoo.callFoo()
26 # nothing happens, which is fine
27  
28 # accessing the missing attributes
29 print mockFoo._fooBar
30 # raises: AttributeError: Mock object has no attribute '_fooBar'
31 mockFoo.callFoobar()
32 # raises: AttributeError: Mock object has no attribute 'callFoobar'

 下一个构造器参数是return_value。这将设置mock对象的响应当它被直接调用的时候。我用这个参数模拟一个工厂调用。 

为了演示，在Listing Four中，设置return_value为456（第4行）。当调用mockFoo时，将返回456的结果（9~11行）。在Listing Five中，我给return_value传入了一个类Foo的实例fooObj（15~19行）。现在，当我调用mockFoo时，我获得了fooObj的实例（显示为mockObj）(第24行)。和Listing Two和Three不一样，mockObj的方法是带有功能的。

Listing Four

 1 from mock import Mock
 2  
 3 # create the mock object
 4 mockFoo = Mock(return_value = 456)
 5  
 6 print mockFoo
 7 # <Mock id='2787568'>
 8  
 9 mockObj = mockFoo()
10 print mockObj
11 # returns: 456

Listing Five

 1 from mock import Mock
 2  
 3 # The mock object
 4 class Foo(object):
 5     # instance properties
 6     _fooValue = 123
 7      
 8     def callFoo(self):
 9         print "Foo:callFoo_"
10      
11     def doFoo(self, argValue):
12         print "Foo:doFoo:input = ", argValue
13  
14 # creating the mock object
15 fooObj = Foo()
16 print fooObj
17 # returns: <__main__.Foo object at 0x68550>
18  
19 mockFoo = Mock(return_value = fooObj)
20 print mockFoo
21 # returns: <Mock id='2788144'>
22  
23 # creating an "instance"
24 mockObj = mockFoo()
25 print mockObj
26 # returns: <__main__.Foo object at 0x68550>
27  
28 # working with the mocked instance
29 print mockObj._fooValue
30 # returns: 123
31 mockObj.callFoo()
32 # returns: Foo:callFoo_
33 mockObj.doFoo("narf")
34 # returns: Foo:doFoo:input =  narf
35 <Mock id='428560'>

side_effect参数和return_value是相反的。它给mock分配了可替换的结果，覆盖了return_value。简单的说，一个模拟工厂调用将返回side_effect值，而不是return_value。 

Listing Six演示了side_effect参数的影响。首先，创建类Foo的实例fooObj，把它传入return_value参数（第17行）。这个结果和Listing Five是类似的。当它被调用的时候，mockFoo返回fooObj(第22行)。然后我重复同样的步骤，给side_effect参数传入StandardError（第28行），现在，调用mockFoo引发了StandardError，不再返回fooObj(29~30行)。

Listing Six

 1 from mock import Mock
 2  
 3 # Th