web-dev-qa-db-ja.com

PHPで単体テストを作成するにはどうすればよいですか?

私はそれらがどれほど素晴らしいかについて随所に読んでいますが、何らかの理由で、私が何かを正確にテストすることになっていることが正確に理解できないようです。誰かがサンプルコードを投稿して、それをどのようにテストするのでしょうか?それほど面倒ではない場合:)

93
letgo

3番目の「フレームワーク」があり、これははるかに簡単に学習できます-SimpleTestよりもさらに簡単で、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_を使用します

これには、システムで PEARの正常なインストール が必要です。これはほとんどの状況で非常に一般的です。インストールする必要がある場合は、利用可能な最新バージョンをインストールすることをお勧めします。設定にヘルプが必要な場合は、お気軽にお問い合わせください(ただし、OSなどを提供してください)。

36
Till

単体テストに使用できるフレームワークは2つあります。 Simpletest および PHPUnit 。 PHPUnitのホームページでテストを作成および実行する方法に関するチュートリアルを読んでください。それは非常に簡単で、よく説明されています。

29
okoman

それに対応するようにコーディングスタイルを変更することで、ユニットテストをより効果的にすることができます。

Google Testing Blog 、特に Writing Testable Code の記事を参照することをお勧めします。

21
Preston

他の人の物事のやり方を学ぶ時間がなかったので、私は自分自身をロールバックしました。

ユニットテストはveryに役立ちます。

これは少し長いですが、それ自体を説明し、下部に例があります。

/**
 * 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();

この出力:

テスト:TestOneは失敗しました
/** 
 *このテストは失敗するように設計されています
 ** /(lines:149-152; file:/ Users/kris/Desktop/Testable.php)
 Test:TestTwoは成功しました 
12
Kris

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);
}
6
PartialOrder

簡単なテストとドキュメントの場合、 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は<code>ブロック内に含まれています。 Doctestはpythonに由来し、コードがどのように機能するかについての有用で実行可能な例を提供するのに適しています。 'より正式なtddライブラリと一緒に役立つことがわかりました-phpunitを使用します。

この最初の答え here はうまくまとめています(unit vs doctestではありません)。

5
Sofia

Codeceptionテストは一般的な単体テストに非常に似ていますが、モックやスタブが必要な場合には非常に強力です。

これがサンプルのコントローラーテストです。スタブが簡単に作成されることに注目してください。メソッドが呼び出されたことを確認する方法。

<?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');
}
}

他にもクールなことがあります。データベースの状態、ファイルシステムなどをテストできます。

2
Davert

phpunitは、ほぼphpの事実上の単体テストフレームワークです。 DocTest (PEARパッケージとして利用可能)および他のいくつかもあります。php自体は phpt tests = pear経由でも実行できます。

2
kguest

既に与えられているテストフレームワークに関する優れた提案に加えて、自動テストが組み込まれているPHP Webフレームワーク Symfony または- CakePHP ?テストメソッドをドロップする場所があることで、一部の人が自動テストとTDDに関連する起動時の摩擦を減らすことができます。

1
bradheintz

ここに再投稿するには多すぎるが、phptの使用に関する 素晴らしい記事 がある。しばしば見落とされがちなphptの多くの側面をカバーしているので、テストを書くだけでなくphpの知識を広げて読む価値があります。幸いなことに、この記事ではテストの作成についても説明しています!

議論の主なポイント

  1. PHP=の動作がわずかに文書化されていることを発見してください
  2. 独自のPHPコードの簡単な単体テストを書く
  3. 拡張機能の一部としてテストを作成するか、潜在的なバグを内部またはQAグループに伝える
1
quickshiftin

ここにはすでに多くの情報がありますが、これはまだGoogle検索に表示されるため、Chinook Test Suiteをリストに追加します。シンプルで小さなテストフレームワークです。

それを使用してクラスを簡単にテストし、模擬オブジェクトを作成することもできます。 Webブラウザーを介してテストを実行し、コンソールを介して(まだ)を実行します。ブラウザでは、実行するテストクラスまたはテストメソッドを指定できます。または、単にすべてのテストを実行できます。

Githubページのスクリーンショット:

Chinook Unit Test framework

私がそれについて気に入っているのは、テストをアサートする方法です。これは、いわゆる「流fluentなアサーション」で行われます。例:

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

モックオブジェクトの作成も簡単です(構文のような流likeな)。

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

とにかく、コード例とともにgithubページで詳細情報を見つけることができます:

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

1
Vivendi