repo_zf1/documentation/manual/ja/module_specs/Zend_Test-PHPUnit-Assertions.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<!-- EN-Revision: 17227 -->
<sect2 id="zend.test.phpunit.assertions">
    <title>アサーション</title>

    <para>
        アサーションは、ユニットテストの肝となるものです。
        この機能を使うことで、期待する結果と実際の結果が一致することを確かめるのです。
        <classname>Zend_Test_PHPUnit_ControllerTestCase</classname>
        では数多くのアサーションを用意しており、
        <acronym>MVC</acronym> アプリケーションやコントローラのテストをよりシンプルにできるようにしています。
    </para>

    <sect3 id="zend.test.phpunit.assertions.query">
        <title>CSS セレクタアサーション</title>

        <para>
            <acronym>CSS</acronym> セレクタを使うと、
            レスポンスの中身に何らかの結果が入っていることを簡単に検証することができます。
            また、Javascript の UI や <acronym>AJAX</acronym> との統合も簡単に行えます。
            大半の JS ツールキットは、
            <acronym>CSS</acronym> セレクタ形式で DOM 要素を取得するための仕組みを持っています。
            それと同じ構文で使用できるのです。
        </para>

        <para>
            この機能は <link
                linkend="zend.dom.query">Zend_Dom_Query</link>
            を用いて実装されており、'Query' アサーションに統合されています。
            個々のアサーションの最初の引数に <acronym>CSS</acronym> セレクタを指定し、
            アサーションの型に応じてオプション引数やエラーメッセージも指定します。
            <acronym>CSS</acronym> セレクタの書き方の規則については、<link
                linkend="zend.dom.query.operation">Zend_Dom_Query
                の操作方法の章</link>
            を参照ください。Query アサーションには次のようなものがあります。
        </para>

        <itemizedlist>
            <listitem><para>
                <methodname>assertQuery($path, $message = '')</methodname>:
                指定した <acronym>CSS</acronym> セレクタにマッチするひとつあるいは複数の DOM
                要素が存在することを表明します。
                <code>$message</code> を指定すると、
                存在しなかった場合のメッセージの先頭にそれが追加されます。
            </para></listitem>

            <listitem><para>
                <code>assertQueryContentContains($path, $match, $message =
                    '')</code>:
                指定した <acronym>CSS</acronym> セレクタにマッチするひとつあるいは複数の DOM
                要素が存在し、そのすくなくともひとつに <code>$match</code>
                で指定した内容が含まれることを表明します。
                <code>$message</code> を指定すると、
                存在しなかった場合のメッセージの先頭にそれが追加されます。
            </para></listitem>

            <listitem><para>
                <code>assertQueryContentRegex($path, $pattern, $message =
                    '')</code>:
                指定した <acronym>CSS</acronym> セレクタにマッチするひとつあるいは複数の DOM
                要素が存在し、そのすくなくともひとつに正規表現
                <code>$pattern</code> にマッチする内容が含まれることを表明します。
                <code>$message</code> を指定すると、
                存在しなかった場合のメッセージの先頭にそれが追加されます。
            </para></listitem>

            <listitem><para>
                <code>assertQueryCount($path, $count, $message =
                    '')</code>:
                指定した <acronym>CSS</acronym> セレクタにマッチする DOM 要素が、ちょうど
                <code>$count</code> 個存在することを表明します。
                <code>$message</code> を指定すると、
                存在しなかった場合のメッセージの先頭にそれが追加されます。
            </para></listitem>

            <listitem><para>
                <code>assertQueryCountMin($path, $count, $message =
                    '')</code>:
                指定した <acronym>CSS</acronym> セレクタにマッチする DOM 要素が、少なくとも
                <code>$count</code> 個以上存在することを表明します。
                <code>$message</code> を指定すると、
                存在しなかった場合のメッセージの先頭にそれが追加されます。
                <emphasis>注意:</emphasis>
                <code>$count</code> に 1 を指定した場合は、単に
                <methodname>assertQuery()</methodname> を使うのと同じ意味となります。
            </para></listitem>

            <listitem><para>
                <code>assertQueryCountMax($path, $count, $message =
                    '')</code>:
                指定した <acronym>CSS</acronym> セレクタにマッチする DOM 要素が、最大でも
                <code>$count</code> 個以下しか存在しないことを表明します。
                <code>$message</code> を指定すると、
                存在しなかった場合のメッセージの先頭にそれが追加されます。
                <emphasis>注意:</emphasis>
                <code>$count</code> に 1 を指定した場合は、単に
                <methodname>assertQuery()</methodname> を使うのと同じ意味となります。
            </para></listitem>
        </itemizedlist>

        <para>
            さらに、上であげたそれぞれに対する否定のアサーションを行う
            'Not' 系のメソッドが存在します。
            <methodname>assertNotQuery()</methodname>、
            <methodname>assertNotQueryContentContains()</methodname>、
            <methodname>assertNotQueryContentRegex()</methodname> そして
            <methodname>assertNotQueryCount()</methodname> です
            (min および max については対応するメソッドは存在しませんが、
            それは自明なことだからです)。
        </para>
    </sect3>

    <sect3 id="zend.test.phpunit.assertions.xpath">
        <title>XPath アサーション</title>

        <para>
            <acronym>CSS</acronym> セレクタよりも XPath のほうが使いやすいという開発者もいることでしょう。
            そこで、 <link
                linkend="zend.test.phpunit.assertions.query">Query
                アサーション</link>
            のすべてのメソッドに対して、同等の動作をする XPath
            版のメソッドを用意しています。
        </para>

        <itemizedlist>
            <listitem><para>
                <methodname>assertXpath($path, $message = '')</methodname>
            </para></listitem>
            <listitem><para>
                <methodname>assertNotXpath($path, $message = '')</methodname>
            </para></listitem>
            <listitem><para>
                <methodname>assertXpathContentContains($path, $match, $message = '')</methodname>
            </para></listitem>
            <listitem><para>
                <methodname>assertNotXpathContentContains($path, $match, $message = '')</methodname>
            </para></listitem>
            <listitem><para>
                <methodname>assertXpathContentRegex($path, $pattern, $message = '')</methodname>
            </para></listitem>
            <listitem><para>
                <methodname>assertNotXpathContentRegex($path, $pattern, $message = '')</methodname>
            </para></listitem>
            <listitem><para>
                <methodname>assertXpathCount($path, $count, $message = '')</methodname>
            </para></listitem>
            <listitem><para>
                <methodname>assertNotXpathCount($path, $count, $message = '')</methodname>
            </para></listitem>
            <listitem><para>
                <methodname>assertXpathCountMin($path, $count, $message = '')</methodname>
            </para></listitem>
            <listitem><para>
                <methodname>assertNotXpathCountMax($path, $count, $message = '')</methodname>
            </para></listitem>
        </itemizedlist>
    </sect3>

    <sect3 id="zend.test.phpunit.assertions.redirect">
        <title>リダイレクトアサーション</title>

        <para>
            アクションがリダイレクトを行うこともよくあります。
            リダイレクト先をたどらなくても、
            <classname>Zend_Test_PHPUnit_ControllerTestCase</classname>
            のさまざまなアサーションでそれをテストすることができます。
        </para>

        <itemizedlist>
            <listitem><para>
                <methodname>assertRedirect($message = '')</methodname>:
                リダイレクトが発生することを表明します。
            </para></listitem>

            <listitem><para>
                <methodname>assertNotRedirect($message = '')</methodname>:
                リダイレクトが発生しないことを表明します。
            </para></listitem>

            <listitem><para>
                <methodname>assertRedirectTo($url, $message = '')</methodname>:
                リダイレクトが発生し、Location ヘッダの値が
                <code>$url</code> で指定したものであることを表明します。
            </para></listitem>

            <listitem><para>
                <methodname>assertNotRedirectTo($url, $message = '')</methodname>:
                「リダイレクトが発生しない」あるいは「リダイレクト先の Location
                ヘッダの値が <code>$url</code> で指定したものではない」
                のいずれかであることを表明します。
            </para></listitem>

            <listitem><para>
                <methodname>assertRedirectRegex($pattern, $message = '')</methodname>:
                リダイレクトが発生し、Location ヘッダの値が
                <code>$pattern</code> で指定した正規表現にマッチするものであることを表明します。
            </para></listitem>

            <listitem><para>
                <methodname>assertNotRedirectRegex($pattern, $message = '')</methodname>:
                「リダイレクトが発生しない」あるいは「リダイレクト先の Location
                ヘッダの値が <code>$pattern</code>
                で指定した正規表現にマッチしない」のいずれかであることを表明します。
            </para></listitem>
        </itemizedlist>
    </sect3>

    <sect3 id="zend.test.phpunit.assertions.header">
        <title>レスポンスヘッダアサーション</title>

        <para>
            リダイレクトヘッダのチェックだけでなく、
            特定の <acronym>HTTP</acronym> のレスポンスコードやヘッダのチェックが必要になることもあります。
            たとえば「アクションの結果のレスポンスが 404 か 500 のいずれかであること」
            「<acronym>JSON</acronym> レスポンスに適切な Content-Type ヘッダが設定されていること」
            などです。次のようなアサーションが使用できます。
        </para>

        <itemizedlist>
            <listitem><para>
                <methodname>assertResponseCode($code, $message = '')</methodname>:
                指定した <acronym>HTTP</acronym> レスポンスコードが返されることを表明します。
            </para></listitem>

            <listitem><para>
                <methodname>assertHeader($header, $message = '')</methodname>:
                レスポンスに指定したヘッダが含まれることを表明します。
            </para></listitem>

            <listitem><para>
                <methodname>assertHeaderContains($header, $match, $message =
                '')</methodname>:
                レスポンスに指定したヘッダが含まれ、
                指定した文字列がその中に含まれることを表明します。
            </para></listitem>

            <listitem><para>
                <methodname>assertHeaderRegex($header, $pattern, $message =
                '')</methodname>:
                レスポンスに指定したヘッダが含まれ、
                その値が指定した正規表現にマッチすることを表明します。
            </para></listitem>
        </itemizedlist>

        <para>
            さらに、上であげたそれぞれに対する否定のアサーションを行う
            'Not' 系のメソッドが存在します。
        </para>
    </sect3>

    <sect3 id="zend.test.phpunit.assertions.request">
        <title>リクエストアサーション</title>

        <para>
            最後に実行されたアクションやコントローラ、
            そしてモジュールについてのアサーションを行えると便利です。
            さらに、どのルートにマッチしたのかを確認したいこともあるでしょう。
            以下のアサーションが、その手助けとなります。
        </para>

        <itemizedlist>
            <listitem><para>
                <methodname>assertModule($module, $message = '')</methodname>:
                指定したモジュールが、
                最後にディスパッチされたアクションで用いられたことを表明します。
            </para></listitem>
            <listitem><para>
                <methodname>assertController($controller, $message = '')</methodname>:
                指定したコントローラが、
                最後にディスパッチされたアクションで選択されたことを表明します。
            </para></listitem>
            <listitem><para>
                <methodname>assertAction($action, $message = '')</methodname>:
                指定したアクションが、直近にディスパッチされたことを表明します。
            </para></listitem>
            <listitem><para>
                <methodname>assertRoute($route, $message = '')</methodname>:
                指定した名前のルートが、ルータでマッチしたことを表明します。
            </para></listitem>
        </itemizedlist>

        <para>
            そして、それぞれについて否定を表す
            'Not' 系のメソッドが存在します。
        </para>
    </sect3>
</sect2>
<!--
vim:se ts=4 sw=4 et:
-->