PHPUnit assertStringContainsString アサーションについて

目的

• PHPUnitのアサーションの1つであるassertStringContainsStringについてかんたんにまとめる

すみません

• 本記事は筆者の備忘録的要素が強いためメモ的な簡易的な記事となる。
• 内容が薄い場合は参考文献先などを参考に各自て補填していただければ幸いである。

assertStringContainsString

• 検査対象の中に指定された文字列が含まれているかをチェックするアサーションである。

• 具体例を下記に記載する。

  assertStringContainsString('A', 'B');
  

• 上記のようにテストコードが記載された場合、指定された文字列がAで検査対象がBとなる。

• もう少しざっくりとしたコードを日本語を交えて記載する。

  assertStringContainsString('検査対象に入っていることが期待されている指定された文字列', '検査対象の文字列や変数')
  

• もう少し具体的な例を下記に記載する。

  • $arrayには連想配列が格納されており、キーと値は下記のようになっている。

    $array = [
        'id' => 1,
        'name' => 'Hoge Hoge',
    ]
    

  • $arrayに「Hoge Hoge」という文字列が格納されているかをassertStringContainsStringのアサーションを使ってテストする際は下記のようになる。

    assertStringContainsString('Hoge Hoge', $array);
    

  • 上記のテストコードを実行すると「テストOK」となる。

まとめ

• assertStringContainsStringアサーションは「検査対象の中に指定された文字列が含まれるか」をチェックするものである。

参考文献

• PHPUnitのアサーションについて
• アサーションの使い方
• 1. Assertions#assertStringContainsString()