如何在PHP中编写单元测试？

时间：2008-11-11 21:09:24

标签： php unit-testing testing tdd

我到处都读到它们有多棒，但由于某种原因，我似乎无法弄清楚我应该如何测试一些东西。有人可能会发布一段示例代码以及如何测试它吗？如果不是太麻烦:)）

11 个答案:

答案 0 :(得分：35)

有一个第三个“框架”，它更容易学习 - 甚至比简单测试更容易，它被称为phpt。

可以在这里找到一本入门书： http://qa.php.net/write-test.php

修改：刚看到您的示例代码请求。

假设您在名为 lib.php 的文件中具有以下功能：

<?php
function foo($bar)
{
  return $bar;
}
?>

非常简单直接，返回您传入的参数。那么让我们来看看这个函数的测试，我们将调用测试文件 foo.phpt ：

--TEST--
foo() function - A basic test to see if it works. :)
--FILE--
<?php
include 'lib.php'; // might need to adjust path if not in the same dir
$bar = 'Hello World';
var_dump(foo($bar));
?>
--EXPECT--
string(11) "Hello World"

简而言之，我们提供的参数$bar的值为"Hello World"，我们var_dump()的函数调用的响应为foo()。

要运行此测试，请使用：pear run-test path/to/foo.phpt

这需要您系统上的a working install of PEAR，这在大多数情况下非常常见。如果您需要安装它，我建议安装最新版本。如果您需要帮助进行设置，请随时询问（但提供操作系统等）。

答案 1 :(得分：27)

您可以使用两个框架进行单元测试。我更喜欢Simpletest和PHPUnit。阅读有关如何在PHPUnit主页上编写和运行测试的教程。这很简单，也很好描述。

答案 2 :(得分：20)

您可以通过更改编码样式来使单元测试更有效。

我建议浏览Google Testing Blog，特别是Writing Testable Code上的帖子。

答案 3 :(得分：10)

我自己动手，因为我没有时间学习别人的做事方式，这需要大约20分钟的时间来写，10个以适应它在这里发布。

单元测试非常对我有用。

这有点长，但它解释了自己，底部有一个例子。

/**
 * Provides Assertions
 **/
class Assert
{
    public static function AreEqual( $a, $b )
    {
        if ( $a != $b )
        {
            throw new Exception( 'Subjects are not equal.' );
        }
    }
}

/**
 * Provides a loggable entity with information on a test and how it executed
 **/
class TestResult
{
    protected $_testableInstance = null;

    protected $_isSuccess = false;
    public function getSuccess()
    {
        return $this->_isSuccess;
    }

    protected $_output = '';
    public function getOutput()
    {
        return $_output;
    }
    public function setOutput( $value )
    {
        $_output = $value;
    }

    protected $_test = null;
    public function getTest()
    {
        return $this->_test;
    }

    public function getName()
    {
        return $this->_test->getName();
    }
    public function getComment()
    {
        return $this->ParseComment( $this->_test->getDocComment() );
    }

    private function ParseComment( $comment )
    {
        $lines = explode( "\n", $comment );
        for( $i = 0; $i < count( $lines ); $i ++ )
        {
            $lines[$i] = trim( $lines[ $i ] );
        }
        return implode( "\n", $lines );
    }

    protected $_exception = null;
    public function getException()
    {
        return $this->_exception;
    }

    static public function CreateFailure( Testable $object, ReflectionMethod $test, Exception $exception )
    {
        $result = new self();
        $result->_isSuccess = false;
        $result->testableInstance = $object;
        $result->_test = $test;
        $result->_exception = $exception;

        return $result;
    }
    static public function CreateSuccess( Testable $object, ReflectionMethod $test )
    {
        $result = new self();
        $result->_isSuccess = true;
        $result->testableInstance = $object;
        $result->_test = $test;

        return $result;
    }
}

/**
 * Provides a base class to derive tests from
 **/
abstract class Testable
{
    protected $test_log = array();

    /**
     * Logs the result of a test. keeps track of results for later inspection, Overridable to log elsewhere.
     **/
    protected function Log( TestResult $result )
    {
        $this->test_log[] = $result;

        printf( "Test: %s was a %s %s\n"
            ,$result->getName()
            ,$result->getSuccess() ? 'success' : 'failure'
            ,$result->getSuccess() ? '' : sprintf( "\n%s (lines:%d-%d; file:%s)"
                ,$result->getComment()
                ,$result->getTest()->getStartLine()
                ,$result->getTest()->getEndLine()
                ,$result->getTest()->getFileName()
                )
            );

    }
    final public function RunTests()
    {
        $class = new ReflectionClass( $this );
        foreach( $class->GetMethods() as $method )
        {
            $methodname = $method->getName();
            if ( strlen( $methodname ) > 4 && substr( $methodname, 0, 4 ) == 'Test' )
            {
                ob_start();
                try
                {
                    $this->$methodname();
                    $result = TestResult::CreateSuccess( $this, $method );
                }
                catch( Exception $ex )
                {
                    $result = TestResult::CreateFailure( $this, $method, $ex );
                }
                $output = ob_get_clean();
                $result->setOutput( $output );
                $this->Log( $result );
            }
        }
    }
}

/**
 * a simple Test suite with two tests
 **/
class MyTest extends Testable
{
    /**
     * This test is designed to fail
     **/
    public function TestOne()
    {
        Assert::AreEqual( 1, 2 );
    }

    /**
     * This test is designed to succeed
     **/
    public function TestTwo()
    {
        Assert::AreEqual( 1, 1 );
    }
}

// this is how to use it.
$test = new MyTest();
$test->RunTests();

输出：

Test: TestOne was a failure 
/**
* This test is designed to fail
**/ (lines:149-152; file:/Users/kris/Desktop/Testable.php)
Test: TestTwo was a success

答案 4 :(得分：6)

获取PHPUnit。它非常易于使用。

然后从非常简单的断言开始。在进入其他任何事情之前，您可以使用AssertEquals进行大量操作。这是让你的脚湿透的好方法。

您可能还想先尝试编写测试（因为您提出了TDD标记问题），然后编写代码。如果你还没有这样做，那么它会令人大开眼界。

require_once 'ClassYouWantToTest';
require_once 'PHPUnit...blah,blah,whatever';

class ClassYouWantToTest extends PHPUnit...blah,blah,whatever
{
    private $ClassYouWantToTest;

   protected function setUp ()
    {
        parent::setUp();
        $this->ClassYouWantToTest = new ClassYouWantToTest(/* parameters */);
    }

    protected function tearDown ()
    {
        $this->ClassYouWantToTest = null;
        parent::tearDown();
    }

    public function __construct ()
    {   
        // not really needed
    }

    /**
     * Tests ClassYouWantToTest->methodFoo()
     */
    public function testMethodFoo ()
    {
        $this->assertEquals(
            $this->ClassYouWantToTest->methodFoo('putValueOfParamHere), 'expectedOutputHere);

    /**
     * Tests ClassYouWantToTest->methodBar()
     */
    public function testMethodFoo ()
    {
        $this->assertEquals(
            $this->ClassYouWantToTest->methodBar('putValueOfParamHere), 'expectedOutputHere);
}

答案 5 :(得分：5)

对于简单的测试和文档，php-doctest非常好，并且这是一种非常简单的入门方式，因为您不必打开单独的文件。想象一下下面的功能：

/**
* Sums 2 numbers
* <code>
* //doctest: add
* echo add(5,2);
* //expects:
* 7
* </code>
*/
function add($a,$b){
    return $a + $b;   
}

如果您现在通过phpdt（php-doctest的命令行运行程序）运行此文件，将运行1个测试。 doctest包含在＆lt;代码＆gt;块。 Doctest起源于python，可以提供有用的功能。关于代码应该如何工作的可运行示例。你不能完全使用它，因为代码本身会乱丢测试用例，但我发现它与更正式的tdd库一起使用 - 我使用phpunit。

这第一个答案here很好地总结了它（它不是单位与doctest）。

答案 6 :(得分：2)

phpunit几乎是php的defacto单元测试框架。还有DocTest（作为PEAR包提供）和其他一些。 php本身通过phpt tests测试回归等，也可以通过pear运行。

答案 7 :(得分：2)

代码测试很像常见的单元测试，但在需要模拟和存根的情况下非常强大。

以下是样本控制器测试。注意如何轻松创建存根。您是否轻松检查方法是否被调用。

<?php
use Codeception\Util\Stub as Stub;

const VALID_USER_ID = 1;
const INVALID_USER_ID = 0;

class UserControllerCest {
public $class = 'UserController';


public function show(CodeGuy $I) {
    // prepare environment
    $I->haveFakeClass($controller = Stub::makeEmptyExcept($this->class, 'show'));
    $I->haveFakeClass($db = Stub::make('DbConnector', array('find' => function($id) { return $id == VALID_USER_ID ? new User() : null ))); };
    $I->setProperty($controller, 'db', $db);

    $I->executeTestedMethodOn($controller, VALID_USER_ID)
        ->seeResultEquals(true)
        ->seeMethodInvoked($controller, 'render');

    $I->expect('it will render 404 page for non existent user')
        ->executeTestedMethodOn($controller, INVALID_USER_ID)
        ->seeResultNotEquals(true)
        ->seeMethodInvoked($controller, 'render404','User not found')
        ->seeMethodNotInvoked($controller, 'render');
}
}

还有其他很酷的东西。您可以测试数据库状态，文件系统等。

答案 8 :(得分：1)

除了已经给出的关于测试框架的优秀建议之外，您是否正在使用内置自动化测试的PHP Web框架构建应用程序，例如Symfony或CakePHP？有时候只需要放入测试方法就可以减少一些人与自动化测试和TDD相关联的启动摩擦。

答案 9 :(得分：1)

重新发布此处的方式太多了，但这里使用 phpt 是great article。它涵盖了 phpt 的许多方面，这些方面经常被忽视，因此除了编写测试之外，还可以阅读扩展您的PHP知识。幸运的是，该文章还讨论了编写测试的问题！

主要讨论点

  1. 了解PHP的边缘记录方面（或几乎任何部分）
  2. 为您自己的PHP代码编写简单的单元测试
  3. 将测试作为扩展的一部分或将潜在的错误传达给内部或QA组

答案 10 :(得分：1)

我知道这里已有很多信息，但由于这仍然显示在Google搜索上，我不妨将 Chinook Test Suite 添加到列表中。它是一个简单而小巧的测试框架。

您可以使用它轻松测试类，还可以创建模拟对象。您可以通过Web浏览器和 （尚未） 通过控制台运行测试。 在浏览器中，您可以指定要运行的测试类甚至测试方法。或者你可以简单地运行所有测试。

github页面的截图：

Chinook Unit Test framework

我喜欢它的是你断言测试的方式。这是通过所谓的“流畅断言”来完成的。例如：

$this->Assert($datetime)->Should()->BeAfter($someDatetime);

创建模拟对象也很轻松（语法流畅）：

$mock = new CFMock::Create(new DummyClass());
$mock->ACallTo('SomeMethod')->Returns('some value');

无论如何，可以在github页面上找到更多信息，并附上代码示例：

https://github.com/w00/Chinook-TestSuite

相关问题
最新问题