php插桩,PHP | PHPUnit单元测试利器：PHP Mock的使用方法

最新推荐文章于 2024-05-08 09:38:47 发布
最新推荐文章于 2024-05-08 09:38:47 发布
阅读量407 收藏
点赞数
文章标签： php插桩

5f21b83631127c88fef2639d476b9cf3.png

由于环境依赖关系，或者是特殊环境的构造要求，这就可能导致我们在测试环境下做验证是很困难的。

当我们无法直接使用的真实被依赖模块时，我们可以用 “测试替身”(Test Double)来代替。这个测试替身不需要与真实的被依赖模块有相同的行为，它只需要提供和真实的被依赖模块有相同的API就行了。

PHPUnit提供的getMock($className)方法可以自动生成一个对象，而这个对象就可以作为原来那个类的测试替身。这个测试替身可以用在任何需要它的地方。

默认情况下，原类的所有方法都被一个虚拟的实现替代，这个实现仅仅是返回NULL(不会调用原类中的对应方法)。你可以使用will($this->returnValue())方法来配置其被调用时的返回值，从而将这些虚拟的实现具体化。

限制：final,private及static方法不能被插桩或者模拟，在测试替身中，这些方法会保留其原有的实现。

警告：需要注意的是其参数管理已经被修改了。原先的实现是拷贝所有的参数，这样就无法判断传到函数里的对象是否是相同的了。例10.14显示了新的实现所带来的好处，例10.15显示了如何切换回到以前的行为(见本文最后)。

桩

打桩就是使用测试替身对象来替换原有的对象，而这个测试替身的返回值是可配置的。你可以使用桩来替换测试所依赖的真实模块，这样就可以在测试的间接输入中得到一个控制点，这样就可以让测试流程不要再继续执行下去，因为不这样的话测试可能无法正常执行下去。

例10.2显示如何对方法调用进行打桩以及如何设置该方法的返回值。我们首先使用PHPUnit_Framework_TestCase类所提供的getMock()方法来建立一个stub对象，这个对象就如例10.1中的SomeClass对象一样。 然后，我们使用PHPUnit提供的一系列接口来指定桩的行为。 从本质上讲，这意味着你不需要创建多个临时对象，并把它们绑在一起。 相反，使用示例中所示链式的方法调用将导致代码更易读。

例 10.1: 待插桩的类

class SomeClass {

public function doSomething() {

// Do something.

}

}

?>

例 10.2: 对函数调用进行插桩并指定返回值

require_once "SomeClass.php";

class StubTest extends PHPUnit_Framework_TestCase {

public function testStub() {

// Create a stub for the SomeClass class.

$stub = $this->getMock("SomeClass");

// Configure the stub.

$stub->expects($this->any())

->method("doSomething")

->will($this->returnValue("foo"));

// Calling $stub->doSomething() will now return

// "foo".

$this->assertEquals("foo", $stub->doSomething());

}

}

?>

在以上代码中，当我们调用getMock()方法时，PHPUnit会自动生成一个新的类，并且通过这个类来实现预期的行为。这个测试替身类是可以通过可选参数来配置的。

默认情况下，除非是通过will($this->returnValue())来指定了返回值，否则都是返回NULL。

当第二个参数(可选)被指定时，表明只有array数组里配置的方法才会被替换，其他方法依然保留原有的实现。

第三个参数(可选)可以指定一个参数数组并传给原类的构造函数(构造函数在默认情况下是不会被虚拟实现替换掉的)。

第四个参数(可选)可以为测试替身类指定一个类名。

第五个参数(可选)可用于禁用调用原类的构造函数 。

第六个参数(可选)可用于禁用原类的复制构造函数的调用 。

第七个参数(可选)可以用于禁止测试替身类生成过程中对__autoload()的调用。

另外一个可选择的方法是使用Mock Builder API来配置生成的测试替身类。如例10.3.以下列出Mock Builder提供的接口：

setMethods(array $methods)可以用于Mock Builder对象需要替换的方法，其他方法仍然保留原类的实现。

调用setConstructorArgs(array $args)方法可以指定传入原类的构造函数的参数(原类的构造函数在默认情况下是不会被虚拟化的)。

setMockClassName($name)可用于指定测试替身类的类名。

disableOriginalConstructor()可用于禁调用原类的构造函数。

disableOriginalClone()可以用来禁止原类的复制构造函数的调用。

disableAutoload()可以用于禁止生成测试替身类时__autoload()的调用。

例 10.3: 用 Mock Builder API来配置生成的测试替身类

require_once "SomeClass.php";

class StubTest extends PHPUnit_Framework_TestCase {

public function testStub() {

// Create a stub for the SomeClass class.

$stub = $this->getMockBuilder("SomeClass")->disableOriginalConstructor()->getMock();

// Configure the stub.

$stub->expects($this->any())

->method("doSomething")

->will($this->returnValue("foo"));

// Calling $stub->doSomething() will now return

// "foo".

$this->assertEquals("foo", $stub->doSomething());

}

}

?>

有时你可能希望被打桩的方法的返回值是某个传入的参数，这时可以使用例10.4中所示的通过替换resutnValue()为returnArgument()方法来实现：

例 10.4: 对指定方法打桩，并让其返回指定传入参数

require_once "SomeClass.php";

class StubTest extends PHPUnit_Framework_TestCase {

public function testReturnArgumentStub() {

// Create a stub for the SomeClass class.

$stub = $this->getMock("SomeClass");

// Configure the stub.

$stub->expects($this->any())

->method("doSomething")

->will($this->returnArgument(0));

// $stub->doSomething("foo") returns "foo"

$this->assertEquals("foo", $stub->doSomething("foo"));

// $stub->doSomething("bar") returns "bar"

$this->assertEquals("bar", $stub->doSomething("bar"));

}

}

?>

有时需要被打桩的方法返回被打桩的类的引用，这时可以使用returnSelf()方法来实现，如例10.5所示：

例 10.5: 对指定方法打桩并使其返回打桩对象本身

require_once "SomeClass.php";

class StubTest extends PHPUnit_Framework_TestCase {

public function testReturnSelf() {

// Create a stub for the SomeClass class.

$stub = $this->getMock("SomeClass");

// Configure the stub.

$stub->expects($this->any())

->method("doSomething")

->will($this->returnSelf());

// $stub->doSomething() returns $stub

$this->assertSame($stub, $stub->doSomething());

}

}

?>

有时被打桩的方法需要针对不同的参数返回不同的值，这时可以使用returnValueMap()创建一个map来关联参数和返回值。如例10.6所示：

例 10.6: 对指定方法打桩，并使其返回值为 map里配置的值

require_once "SomeClass.php";

class StubTest extends PHPUnit_Framework_TestCase {

public function testReturnValueMapStub() {

// Create a stub for the SomeClass class.

$stub = $this->getMock("SomeClass");

// Create a map of arguments to return values.

$map = array(

array("a", "b", "c", "d"),

array("e", "f", "g", "h")

);

// Configure the stub.

$stub->expects($this->any())

->method("doSomething")

->will($this->returnValueMap($map));

// $stub->doSomething() returns different values depending on

// the provided arguments.

$this->assertEquals("d", $stub->doSomething("a", "b", "c"));

$this->assertEquals("h", $stub->doSomething("e", "f", "g"));

}

}

?>

当被打桩的方法需要返回一个计算值，而不是固定值(参见returnValue())或者指定参数(参见returnArgument)时，这时可以使用returnCallback()来指定被打桩方法的回调函数。如例10.7：

例 10.7: 对指定方法打桩，并使其返回值为指定函数调用的返回值

require_once "SomeClass.php";

class StubTest extends PHPUnit_Framework_TestCase {

public function testReturnCallbackStub() {

// Create a stub for the SomeClass class.

$stub = $this->getMock("SomeClass");

// Configure the stub.

$stub->expects($this->any())

->method("doSomething")

->will($this->returnCallback("str_rot13"));

// $stub->doSomething($argument) returns str_rot13($argument)

$this->assertEquals("fbzrguvat", $stub->doSomething("something"));

}

}

?>

另外一种更简单的设置回调函数的方法是：设定期望返回值列表。你可以使用onConsecutiveCalls()来实现这个功能，如例10.8所示：

例 10.8: 对指定方法打桩，并使其返回值按指定序列逐次返回

require_once "SomeClass.php";

class StubTest extends PHPUnit_Framework_TestCase {

public function testOnConsecutiveCallsStub() {

// Create a stub for the SomeClass class.

$stub = $this->getMock("SomeClass");

// Configure the stub.

$stub->expects($this->any())

->method("doSomething")

->will($this->onConsecutiveCalls(2, 3, 5, 7));

// $stub->doSomething() returns a different value each time

$this->assertEquals(2, $stub->doSomething());

$this->assertEquals(3, $stub->doSomething());

$this->assertEquals(5, $stub->doSomething());

}

}

?>

抛出异常(略)

Mock对象

Mocking是指使用测试替身来替换原有对象并对期望作检查，例如断言某个方法被调用了。

你可以使用mock对象作为观察点来验证测试过程中的间接输出。通常来说，mock对象包含测试桩的功能，因此它必须要在测试过程中有返回值(如何测试未失败的话)，但更重要的是对于间接输出的验证。因此，mock对象远不止是一个测试桩加一个断言这么简单，它是用完全不同的方式。

注意：要 mock 的类如果不存在的话，phpunit 会生成一个空的同名的类。如果要使用原来的类的话，需要把声明该类的文件包含进来，不然的话就可能会提示 "Fatal error:Call to undefined method XXX::xxx() in xxx.php on line xxx" 这类错误了。

以下是一个例子，假设我们需要测试测试例子中的update()方法，这个方法是被另外一个对象的观察者调用的，如例10.10：

例 10.10: 类 Subject 和 Observer 都是测试系统的一部分

class Subject {

protected $observers = array();

public function attach(Observer $observer) {

$this->observers[] = $observer;

}

public function doSomething() {

// Do something.

// ...

// Notify observers that we did something.

$this->notify("something");

}

public function doSomethingBad() {

foreach ($this->observers as $observer) {

$observer->reportError(42, "Something bad happened", $this);

}

}

protected function notify($argument) {

foreach ($this->observers as $observer) {

$observer->update($argument);

}

}

// Other methods.

}

class Observer {

public function update($argument) {

// Do something.

}

public function reportError($errorCode, $errorMessage, Subject $subject) {

// Do something

}

// Other methods.

}

?>

例10.11显示了如何使用mock对象来测试Subject和Observer对象之间的相互作用：

例 10.11: 测试指定方法，该方法被调用一次，并检查调用时的参数

class SubjectTest extends PHPUnit_Framework_TestCase {

public function testObserversAreUpdated() {

// Create a mock for the Observer class,

// only mock the update() method.

$observer = $this->getMock("Observer", array("update"));

// Set up the expectation for the update() method

// to be called only once and with the string "something"

// as its parameter.

$observer->expects($this->once())

->method("update")

->with($this->equalTo("something"));

// Create a Subject object and attach the mocked

// Observer object to it.

$subject = new Subject();

$subject->attach($observer);

// Call the doSomething() method on the $subject object

// which we expect to call the mocked Observer object"s

// update() method with the string "something".

$subject->doSomething();

}

}

?>

with()方法可以有任意个参数，对应与被mocked的方法的参数个数，你可以对调用参数使用更加高级的的约束，如：

例 10.12: 测试指定方法，并使用不同的方式对该方法调用时的参数进行约束

class SubjectTest extends PHPUnit_Framework_TestCase {

public function testErrorReported() {

// Create a mock for the Observer class, mocking the

// reportError() method

$observer = $this->getMock("Observer", array("reportError"));

$observer->expects($this->once())

->method("reportError")

->with($this->greaterThan(0),

$this->stringContains("Something"),

$this->anything());

$subject = new Subject();

$subject->attach($observer);

// The doSomethingBad() method should report an error to the observer

// via the reportError() method

$subject->doSomethingBad();

}

}

?>

表4.3中所示的方法可以用来约束被mock方法的参数，表10.1中的匹配可以用来指定方法被调用的次数：

表 10.1。 Machers

匹配

含义

PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount any()

返回一个匹配相匹配时，它评估的方法被执行零次或多次。

PHPUnit_Framework_MockObject_Matcher_InvokedCount never()

返回一个匹配，匹配的方法对其进行评估时，将不会被执行。

PHPUnit_Framework_MockObject_Matcher_InvokedAtLeastOnce atLeastOnce()

返回一个匹配，匹配的方法对其进行评估时，至少执行一次。

PHPUnit_Framework_MockObject_Matcher_InvokedCount once()

返回一个匹配，匹配的方法对其进行评估时，被执行一次。

PHPUnit_Framework_MockObject_Matcher_InvokedCount exactly(int $count)

返回一个匹配，匹配的方法对其进行评估时，正确地执行了$count时间。

PHPUnit_Framework_MockObject_Matcher_InvokedAtIndex at(int $index)

返回一个匹配，在给定的$index匹配时调用的方法对其进行评估。注意：mock 对象的任意方法被调用时，index 都会加 1。

getMockForAbstractClass()方法可以为抽象类返回一个mock对象，所有的抽象方法都会被mock，而非抽象方法则不会被mock，这样我们就可以测试一个抽象类的非抽象方法了。如例10.13所示：

例 10.13: 测试抽象类的非抽象方法

abstract class AbstractClass

{

public function concreteMethod ( )

{

return $this -> abstractMethod ( ) ;

}

public abstract function abstractMethod ( ) ;

}

class AbstractClassTest extends PHPUnit_Framework_TestCase

{

public function testConcreteMethod ( )

{

$stub = $this -> getMockForAbstractClass ( "AbstractClass" ) ;

$stub -> expects ( $this -> any ( ) )

-> method ( "abstractMethod" )

-> will ( $this -> returnValue ( TRUE ) ) ;

$this -> assertTrue ( $stub -> concreteMethod ( ) ) ;

}

}

?>

例 10.14: 测试一个方法，其获取到的参数与调用时的参数一致

53a22a72580a82cebd737520d755801b.gif

class FooTest extends PHPUnit_Framework_TestCase {

public function testIdenticalObjectPassed() {

$expectedObject = new stdClass();

$mock = $this->getMock("stdClass", array("foo"));

$mock->expects($this->once())

->method("foo")

->with($this->identicalTo($expectedObject));

$mock->foo($expectedObject);

}

}

?>

例 10.15: 当允许拷贝参数功能开启时，创建 Mock对象

class FooTest extends PHPUnit_Framework_TestCase {

public function testIdenticalObjectPassed() {

$cloneArguments = true;

$mock = $this->getMock("stdClass",

array(),

array(),

"",

FALSE,

TRUE,

TRUE,

$cloneArguments);

// or using the mock builder

$mock = $this->getMockBuilder("stdClass")

->enableArgumentCloning()

->getMock();

// now your mock clones parameters so the identicalTo constraint will fail.

}

}

?>

一种实用的嵌入式软件测试方法研究
03-23
1、引言 　嵌入式计算技术在现代信息技术中的应用越来越广泛,应用所涉及的...介入式方法主要还是采用静态分析和产生可执行代码的插桩式动态分析等方法进行的。而非介入式测试方法则是主动采集被测试系统运行状态数据并
IAST技术进阶系列（一）：关键语言支持
Innocence_0的博客
08-09 329
交互式应用安全测试）是应用程序在进行自动化测试、人工测试等任何与应用程序进行“交互”的同时，能自动分析应用程序安全风险的技术。它可以实时返回结果，因此不会额外增加CI/CD的时间。相比于其他AST技术，IAST只会分析“交互”产生时所影响到相关代码的安全风险，而不是扫描所有代码、配置文件或遍历整个站点。IAST更适合在QA环节使用，让安全团队在相对不影响开发、测试现有流程的情况下，较早地发现应用程序中存在的安全风险。
【PHP】PHPUnit单元测试利器：PHP Mock的使用方法
qq_26249609的博客
01-02 1682
由于环境依赖关系，或者是特殊环境的构造要求，这就可能导致我们在测试环境下做验证是很困难的。 当我们无法直接使用的真实被依赖模块时，我们可以用“测试替身”(Test Double)来代替。这个测试替身不需要与真实的被依赖模块有相同的行为，它只需要提供和真实的被依赖模块有相同的API就行了。 PHPUnit提供的getMock($className)方法可以自动生成一个对象，而这个对象就可以作为原来那...
phpunit骚操作之静态类的部分mock
fangdong88的博客
06-29 525
通过官方文档以及实践得知，含有静态方法的类如果需要mock，就要使用前缀 alias: ，但是随之而来有个问题是后面无法调用这个类本身的方法，所以通过阅读源码可以使用以下方法来实现：1.创建 Helpers 类进行封装 2.创建静态类 3.测试运行............
测试替身
TROUBLE I AM IN
04-18 4970
9 测试替身 PHPUnit 提供的 createMock($type) 和 getMockBuilder($type) 方法可以在测试中用来自动生成对象，此对象可以充当任意指定原版类型（接口或类名）的测试替身。在任何预期或要求使用原版类的实例对象的上下文中都可以使用这个测试替身对象来代替。 createMock($type) 方法直接返回指定类型（接口或类）的测试替身对象实例。此测试替身的创建...
php mock,PHP-Mock - 一个模拟内置PHP函数的库(比如：time(), exec() or rand())
weixin_39786850的博客
03-10 268
PHP-Mock: mocking built-in PHP functionsPHP-Mock is a testing library which mocks non deterministic built-in PHP functions like time() or rand(). This is achieved by PHP's namespace fallback policy:PH...
phpunit mock
weixin_34007020的博客
11-11 146
2019独角兽企业重金招聘Python工程师标准>>> ...
探索PHP-Mock：模拟内置PHP函数的测试神器
最新发布
gitblog_00067的博客
05-08 466
探索PHP-Mock：模拟内置PHP函数的测试神器 php-mockMock built-in PHP functions (e.g. time(), exec() or rand())项目地址:https://gitcode.com/gh_mirrors/ph/php-mock 在进行PHP应用程序的单元测试时，经常会遇到一个问题：如何处理像time()或rand()这类不确定性的内置函数？P...
PHPUnit学习05---Mock使用进阶
weixin_34192993的博客
09-08 142
本文目的 最近使用php开发项目，并用phpunit进行单元测试，使用phpunit的mock机制有一段时间了，决定记录使用经验，方便以后查阅。   mock例子 public function testBit(){ $oClientMock = $this->getMock('SomeClient'); // 创建mock对象 $oClientMock->exp...
php-mock:模拟内置PHP函数（例如time（），exec（）或rand（））
05-12
PHP-Mock：模拟内置PHP函数 PHP-Mock是一个测试库，它模拟不确定的内置PHP函数，例如time()或rand() 。 这是通过： 如果命名空间函数[…]不存在，PHP将退回到全局函数[…]。 PHP-Mock通过提供命名空间功能来使用该功能。 也就是说，您必须处于非全局名称空间上下文中，并调用不合格的函数： namespace foo; $ time = time (); // This call can be mocked, a call to \time() can't. 要求和限制 只能模拟名称空间上下文中的不合格函数调用。 例如，对名称空间foo中的time()的调用是可模拟的，对\time()的调用则不可。 该模拟必须在第一次调用被测类中的不合格函数之前进行定义。 该问题记录在。 在大多数情况下，您可以忽略此限制，但是如果碰巧遇到此问题，则可以在第一次调用
PHPMock一个模拟内置PHP函数的库比如timeexecorrand
08-07
PHP-Mock - 一个模拟内置PHP函数的库(比如：time(), exec() or rand())
PHPUnit学习03---使用Mock对象解决测试依赖
weixin_33767813的博客
06-29 135
本文目的 单元测试过程中经常会遇到被测试函数A依赖另一个函数B，但是B已经完全测试过，没有必要在测试A的时候重复测试B。如何去除这种不必要的测试呢？本文探讨了如何手动解决测试依赖，更进一步地，结合PHPUnit的Mock API，提出更加优雅，高效的解决方案。 一个例子 假设有一个订单管理类OrderManager，它的私有变量中，有一个OrderDao，当插入订单时，首先OrderMana...
php mock 父类,php单元测试进阶（13）- 核心技术 - mock对象 - 同时使用mock和stub
weixin_35741582的博客
03-27 312
php单元测试进阶(13)- 核心技术 - mock对象 - 同时使用mock和stub本系列文章主要代码与文字来源于《单元测试的艺术》，原作者：Roy Osherove。译者：金迎。本系列文章根据php的语法与使用习惯做了改编。所有代码在本机测试通过。如转载请注明出处。假设需求变更，更加复杂一些。如文件名过短，则web服务记录日志，但万一记录过程中发生异常，需发送一封邮件。要求测试发送邮件是成功...
PHPUnit单元测试对桩件（stub）和仿件对象（Mock）的理解
zhibin的程序日记
08-13 4450
一、桩件（stub）和仿件对象（Mock）概念 桩件（stub）： 将对象替换为（可选地）返回配置好的返回值的测试替身的实践方法称为上桩(stubbing)。可以用桩件(stub)来“替换掉被测系统所依赖的实际组件，这样测试就有了对被测系统的间接输入的控制点。这使得测试能强制安排被测系统的执行路径，否则被测系统可能无法执行”。 仿件对象（Mock）： 将对象替换为能验证预期行为（例
php优雅的写法,如何用PHP写个优雅的Mock框架
weixin_30888681的博客
03-10 195
ServerName milfun.comOptions Indexes FollowSymLinksAllowOverride AllRequire all granted复制代码 框架开发 框架目录主要分为两个文件夹，MilFun为框架核心文件，app为项目实际开发目录。图中的Faker就是php的mock插件。入口文件核心函数既然是中间件，我觉得能实现一些基本功能就好——输入与输出基本框架：...
php 单元测试 mock,php单元测试进阶（14）- 核心技术 - 动态mock对象
weixin_31005543的博客
03-12 269
php单元测试进阶(14)- 核心技术 - 动态mock对象使用手工mock对象的方法可能会遇到问题，包括：编写mock对象和桩件需要花费时间。如果类和接口有许多方法，属性和事件，就很难为它编写桩件和mock对象。难以在其他测试中重用mock类和桩件类。一旦接口有超过两三个方法需要实现，代码维护会很麻烦。要保存mock对象被多次调用的状态，需要手工实现。尽管如此，学习手工创建mock对象可以更清楚...
php mock,PHP实现的简单mock json脚本分享
weixin_34430676的博客
03-10 229
现在有太多方法去mock，不过当还是要连接到远程服务器上测试真正的返回的时候，如果机器上没有跑node而且有php的话，用这货来临时mock一下，或许更轻松。/*** Mock Json for Javascript** @author soulteary* @date 2014-06-15*//*** 请求接口字段：字符集*/define('charset','charset');/*** 请求...
php mockery单元测试,php 单元测试 phpunit ，如何mock类调用自身的方法？
weixin_39618730的博客
03-11 437
...pan>{"fzaninotto/faker": "~1.4","mockery/mockery": "0.9.*","phpunit/phpunit": "~4.0","phpspec/phpspec": "~2.1"},"autoload": {"classmap": [...phpunit单元测试phplaravel5 使用laravel5做单元测试时，...
使用Parasoft C++test进行Qt单元测试与静态扫描
在MyClass中，有一个Add方法用于演示单元测试，还有一个getNewNum方法用于插桩测试。在编写好代码并编译运行后，需要找到Qt工程的Debug目录下的Makefile.Debug文件，编辑该文件，将cc和cxx后面添加`cpptestscan`，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值