「PHPUnit」の記事 - Crieit

Github Actions で PHPUnit を走らせる

2021-01-05T22:38:21+09:00

Github Actions で ESLint や Stylelint 、あるいはデプロイのワークフローは走らせたことがありますが、 Jest も行けるはず……と思い至ったところで、ふとそういえば PHPUnit はどうでしょうか、と思い実験。

検証

検索すると、

これらの記事がヒットしました。そこで、この記事を参考に .github/workflows/test.yml として作成。

.github/workflows/test.yml

name: PHPUnit test

on: [push]

jobs:
  test:
    name: Test

    runs-on: ubuntu-latest

    strategy:
      matrix:
        php-version: ['7.4']

    steps:
    - name: Setup PHP ${{ matrix.php-version }}
      uses: shivammathur/setup-php@v2
      with:
        php-version: ${{ matrix.php-version }}
        extension-csv: mbstring, xdebug, dom

    - name: Add Plugin
      run: sudo apt install -y php7.4-xml

    - name: Checkout
      uses: actions/checkout@v2

    - name: Check PHP Version
      run: php -v

    - name: Check Composer Version
      run: composer -V

    - name: Check PHP Extensions
      run: php -m

    - name: Validate composer.json and composer.lock
      run: composer validate

    - name: Install dependencies
      run: composer install --prefer-dist --no-progress --no-suggest

    - name: Run test suite
      run: composer run-script test

試しに Github に push してみます。

走りました。

先人の知恵があればこそですが、 workflows の yml ファイルがあれば PHPUnit のテストも可能ということが分かりました。

参考

Github Actions で PHPUnit

composer

PHPUnit のメモ(設定で特定のファイルを対象除外、 Cannot modify header information - headers already sent by ... のエラーの回避)

2021-01-04T23:43:49+09:00

PHPUnit を使っていて少し躓いた部分のメモ。なお、 PHPUnit のバージョンは 9.5.0 で試しました。

設定で特定のファイルを対象除外

設定の値を返すだけの簡単な設定ファイルを作ってあり、それをテストから除外したい場合。


    
        
            ./tests
        
    
    
      
        ./src
        
          ./tests
          ./template

ディレクトリの除外ならば phpunit.xml.dist で上記の whitelist > exclude > directory で囲んだパスを除外できることは知っていました。

 '/',
    'appname'    => 'Config Sample',
];

今回のケースでは、例えばこんな src/config.php があったとします。また、 src/ ディレクトリには他のコードもあるため、 src/ 自体はテスト対象に含めたいとします。


    
        
            ./tests
        
    
    
      
        ./src
        
          ./tests
          ./template
          ./src/config.php

whitelist > exclude > file にすれば良し。

とあるメソッドの中に header() 関数が記述されていると、テストの際に

Cannot modify header information - headers already sent by (output started at PATH/TO/PROJECT/vendor/phpunit/phpunit/src/Util/Printer.php:104)

のようなエラーが出てしまいました。

これは PHPUnit はテスト中のメッセージを標準出力に吐き出すので、 header() の前に既に出力がされてしまっている状態になるため引っかかってしまうようです。

対策としては、 PHPUnit の @runInSeparateProcess アノテーションを使用することで、そのテストケースを別プロセスとして動作させること。

これにより header() 前に出力がない状態としてテストするため、引っかからなくなります。



こんなイメージです。

参考

設定で特定のファイルを対象除外


3. XML 設定ファイル — PHPUnit latest Manual


Cannot modify header information - headers already sent by ... のエラーの回避


header() 関数を使ったメソッドを PHPUnit でテストする方法 - Qiita
PHPUnitでheader関数を使うメソッドのテスト | Shimabox Blog


余談

今回ほんの些細なプログラムを書いたのですが、あまりにも些細なものだったので「どうせなら PHPUnit の練習にしよう」と思って取り組みました。結果、 PHPUnit で今まであまり触ってこなかったケースに当たったので、良い勉強になったのかな、と思います。

サンプルプログラムを書く際に参考にしたサイト ( PHPUnit とは関係なし)

password_hash


PHP: password_hash - Manual
2018年のパスワードハッシュ - Qiita
PHPのPassword_hash関数をcrypt関数で再現する(メモ) - Qiita


password_hash の salt を指定するのは非推奨。仮に指定する場合、短すぎると警告が発せられる



call_user_func_array


PHP: call_user_func_array - Manual


変数の渡し方が若干疑問。

call_user_func_array + FastRoute


FastRoute を試す - Qiita
Composerでオレオレフレームワークを作った話 │ Webty Staff Blog


str_pad


PHP: str_pad - Manual



LaravelのHTTPテストでoutput buffersが閉じられていないエラー
2018-11-14T20:26:19+09:00
Laravelのテストでいつの間にかRiskyテストが出るようになっていた。失敗ではないのでCIでも何も言われなかったようで、実行時にもエラーが発生していなかったので気づかずにいたらしい。

具体的には下記のようなエラー。

Test code or tested code did not (only) close its own output buffers  


結論としては、下記のようなテンプレートの書き方をしていたために正常にレスポンスが返っていなかったらしい。

@section('additionallTag', $data->tag)  


これは特に記述自体は問題ないと思うが、変数の中に入っているのがHTMLタグだったため今回のエラーが発生しているっぽい。そのため下記のように修正したところ改善した。

@section('additionalTag')  
{!! $data->tag !!}  
@endsection  


同じエラーの改善方法を解説している記事も見つけた。

LaravelのHTTPテストでなぜかresponseが返ってこない件

この場合はsectionが閉じられていないためとのことだが、今回のように変数の指定によってはうまく閉じられなくなってしまうということっぽい。