Practice_PHPUnit test of STDIN

STDIN 用の PHPUnit テスト サンプル

これは、「STDIN」(標準入力) から値を受け取り、その値を返す以下の関数の機能性をチェックするためのサンプル PHPUnit テストです。

 function getContentsFromStdin ()
{
    $ contents = file_get_contents ( ' php://stdin ' );
    if ( $ contents === false ){
        throw new  RuntimeException ( ' Failed to read contents from STDIN. ' );
    }

    return $ contents ;
}

テスト

PHPUnit を使用してSTDINの機能をテストする方法の 1 つは、 php://ストリームをラッパーとしてオーバーライドし、 STDINの値を置き換えるモックを作成することです。

 final class FunctionGetContentsFromStdinTest extends  PHPUnit  Framework TestCase
{
    public function testRegularInput ()
    {
        $ result_expect = ' World! ' ;

        // Register stream wrapper "MockPhpStream" to "php://" protocol
        $ existed = in_array ( ' php ' , stream_get_wrappers ());
        if ( $ existed ) {
            stream_wrapper_unregister ( " php " );
        }
        stream_wrapper_register ( " php " , '\ KEINOSTestsMockPhpStream ' );

        // Set value to STDIN
        file_put_contents ( ' php://stdin ' , $ result_expect );

        // Get value from function and restore registration
        $ result_actual =  KEINOS  Sample getContentsFromStdin ();
        stream_wrapper_restore ( " php " );

        // Test
        $ this -> assertSame ( $ result_expect , $ result_actual );
    }
}

ラッパー

PHP://ストリームをモックするラッパー スクリプト。

• ./tests/MockPhpStream.php

この便利なラッパーは、Denis のブログ投稿で作成されました。

テスト方法

テストの動作を確認するには、このリポジトリのクローンを作成し、テストを実行します。

ローカルでテストする

$ composer install
...
$ composer test
> ./vendor/bin/phpunit --testdox --bootstrap ./vendor/autoload.php tests
PHPUnit 7.5.20 by Sebastian Bergmann and contributors.

GetContentsFromFunction
  Regular input

Time: 76 ms, Memory: 4.00 MB

OK (1 test, 1 assertion)

Docker経由でテストする

$ docker build -t test:local .
...
$ docker run --rm test:local
> ./vendor/bin/phpunit --testdox --bootstrap ./vendor/autoload.php tests
PHPUnit 9.1.3 by Sebastian Bergmann and contributors.

Get Contents From Function
  Regular input

Time: 00:00.030, Memory: 4.00 MB

OK (1 test, 1 assertion)