用phpUnit入门TDD
假设你已经 安装了phpunit.
我们从一个简单的银行账户的例子开始了解tdd(test-driven-development)的思想。
在工程目录下建立两个目录, src和test,在src下建立文件 bankaccount.php,在test目录下建立文件bankaccounttest.php。
按照tdd的思想,我们先写测试,再写生产代码,因此bankaccount.php留空,我们先写bankaccounttest.php。
<?php
class bankaccounttest extends phpunit_framework_testcase
{
}
?>
现在我们运行一下,看看结果。运行phpunit的命令行如下:
phpunit --bootstrap src/bankaccount.php test/bankaccounttest.php
--bootstrap src/bankaccount.php是说在运行测试代码之前先加载 src/bankaccount.php,要运行的测试代码是test/bankaccounttest.php。
如果不指定具体的测试文件,只给出目录,phpunit则会运行目录下所有文件名匹配 *test.php 的文件。因为test目录下只有bankaccounttest.php一个文件,所以执行
phpunit --bootstrap src/bankaccount.php test
会得到一样的结果。
there was 1 failure:
1) warning
no tests found in class "bankaccounttest".
failures!
tests: 1, assertions: 0, failures: 1.
一个警告错误,因为没有任何测试。
账户实例化
下面我们添加一个测试。注意,tdd是一种设计方法,可以帮助你自底向上地设计一个模块的功能。我们写测试的时候,要从用户的角度出发。如果用户使用我们的bankaccount类,他首先做什么事呢?一定是新建一个bankaccount的实例。那么我们第一个测试就是对于 实例化 的测试。
public function testnewaccount(){
$account1 = new bankaccount();
}
运行phpunit,意料之中地失败。
php fatal error: class 'bankaccount' not found in /home/wuchen/projects/jolly-code-snippets/php/phpunit/test/bankaccounttest.php on line 5
没有发现bankaccount类的定义,下面我们就要写生产代码。使测试通过。在src/bankaccount.php(后面称之为源文件)中输入以下内容:
<?php
class bankaccount {
}
?>
运行phpunit,测试通过。
ok (1 test, 0 assertions)
接下来,我们要增加测试,使得测试失败。如果新建一个账户,账户的余额应该是0。于是我们添加了一个assert语句:
public function testnewaccount(){
$account1 = new bankaccount();
$this->assertequals(0, $account1->value());
}
注意value()是bankaccount的一个成员函数,当然这个函数还没有定义,作为使用者我们希望bankaccount提供这个函数。
运行phpunit,结果如下:
php fatal error: call to undefined method bankaccount::value() in /home/wuchen/projects/jolly-code-snippets/php/phpunit/test/bankaccounttest.php on line 6
结果告诉我们bankaccount并没有value()这个成员函数。添加生产代码:
class bankaccount {
public function value(){
return 0;
}
}
为什么要让value()直接返回0,因为测试代码中希望value()返回0。tdd的原则就是不写多余的生产代码,刚好让测试通过即可。
账户的存取
运行phpunit通过后,我们先假设bankaccount的实例化已经满足要求了,接下来,用户希望怎么使用bankaccount呢?一定希望往里面存钱,嗯,希望bankaccount有一个deposit函数,通过调用该函数,可以增加账户余额。于是我们增加下一个测试。
public function testdeposit(){
$account = new bankaccount();
$account->deposit(10);
$this->assertequals(10, $account->value());
}
账户初始余额是0,我们往里面存10元,其账户余额当然应该为10。运行phpunit,测试失败,因为deposit函数还没有定义:
.php fatal error: call to undefined method bankaccount::deposit() in /home/wuchen/projects/jolly-code-snippets/php/phpunit/test/bankaccounttest.php on line 11
接下来在源文件中增加deposit函数:
public function deposit($ammount) {
}
再运行phpunit,得如下结果:
1) bankaccounttest::testdeposit
failed asserting that 0 matches expected 10.
这时因为我们在deposit函数中并没有操作账户余额,余额初始值为0,deposit函数执行之后依然是0,不是用户期望的行为。我们应该往余额上增加用户存入的数值。
为了操作余额,余额应该是bankaccount的一个成员变量。这个变量不允许外界随便更改,因此定义为私有变量。下面我们在生产代码中加入私有变量$value,那么value函数应该返回$value的值。
class bankaccount {
private $value;
public function value(){
return $this->value;
}
public function deposit($ammount) {
$this->value = 10;
}
}
运行 phpunit,测试通过。接下来,我们想,用户还需要什么?对,取钱。当取钱时,账户余额要扣除这个值。如果给 deposit函数传递负数,就相当于取钱了。
于是我们在测试代码的testdeposit函数中增加两行代码。
$account->deposit(-5);
$this->assertequals(5, $account->value());
再运行 phpunit,测试失败了。
1) bankaccounttest::testdeposit
failed asserting that 10 matches expected 5.
这时因为在生产代码中我们简单地把$value设成10的结果。改进生产代码。
public function deposit($ammount) {
$this->value += $ammount;
}
再运行phpunit,测试通过。
新的构造函数
接下来,我想到,用户可能需要一个不同的构造函数,当创建bankaccount对象时,可以传入一个值作为账户余额。于是我们在testnewaccount增加这种实例化的测试。
public function testnewaccount(){
$account1 = new bankaccount();
$this->assertequals(0, $account1->value());
$account2 = new bankaccount(10);
$this->assertequals(10, $account2->value());
}
运行phpunit,结果为:
1) bankaccounttest::testnewaccount
failed asserting that null matches expected 10.
这时因为bankaccount没有带参数的构造函数,因此new bankaccount(10)会返回一个空对象,空对象的value()函数自然返回的也是null。为了通过测试,我们在生产代码中增加带参数的构造函数。
public function __construct($n){
$this->value = $n;
}
再运行测试:
1) bankaccounttest::testnewaccount
missing argument 1 for bankaccount::__construct(), called in /home/wuchen/projects/jolly-code-snippets/php/phpunit/test/bankaccounttest.php on line 5 and defined
/home/wuchen/projects/jolly-code-snippets/php/phpunit/src/bankaccount.php:5
/home/wuchen/projects/jolly-code-snippets/php/phpunit/test/bankaccounttest.php:5
2) bankaccounttest::testdeposit
missing argument 1 for bankaccount::__construct(), called in /home/wuchen/projects/jolly-code-snippets/php/phpunit/test/bankaccounttest.php on line 12 and defined
/home/wuchen/projects/jolly-code-snippets/php/phpunit/src/bankaccount.php:5
/home/wuchen/projects/jolly-code-snippets/php/phpunit/test/bankaccounttest.php:12
两个调用new bankaccount()的地方都报告了错误,增加了带参数的构造函数,不带参数的构造函数又不行了。从c++/java过渡来的同学马上想到增加一个默认的构造函数:
public function __construct() {
$this->value = 0;
}
但这样是不行的,因为php不支持函数重载,所以不能有多个构造函数。
怎么办?对了,我们可以为参数增加默认值。修改构造函数为:
public function __construct($n = 0){
$this->value = $n;
}
这样调用 new bankaccount()时,相当于传递了0给构造函数,满足了需求。
phpunit运行以下,测试通过。
这时,我们的生产代码为:
<?php
class bankaccount {
private $value; // default to 0
public function __construct($n = 0){
$this->value = $n;
}
public function value(){
return $this->value;
}
public function deposit($ammount) {
$this->value += $ammount;
}
}
?>
总结
虽然我们的代码并不多,但是每一步都写得很有信心,这就是tdd的好处。即使你对php的语法不是很有把握(比如我),也可以对自己的代码很有信心。
用tdd的方式写程序的另一个好处,就是编码之前不需要对单个模块进行仔细的设计,可以在写测试的时候进行设计。这样开发出来的模块既可以满足用户需要,也不会冗余。
后面将会介绍 phpunit 的更多用法。