Changes between Version 6 and Version 7 of EC-CUBE標準規約/単体テストガイドライン

Timestamp:

2012/12/09 08:40:08 (11 years ago)

Author:

shift_hiroko.tamagawa

Comment:

--

EC-CUBE標準規約/単体テストガイドライン

@@ -16 +16 @@
 ||build.xml||テストやインスペクションを行うための設定ファイルです。||
 ||tests|| ||
-||├phpunit.xml||PHPUnitで使う各種設定を記載したファイルです。||
+||├phpunit.xml||PHPUnitで使う各種設定を記載したファイルです。[[BR]]SVN上にはphpunit.xml.baseというファイルがありますが、ローカルではこれをコピーしてphpunit.xmlを作成してください。||
 ||├ruleset.xml||PHP_CodeSniffer(インスペクションツール)用の設定ファイルです。||
-||├require.php||テストに必要なファイルをインクルードするためのクラスです。||
+||├require.php||テストに必要なファイルをインクルードするためのクラスです。[[BR]]SVN上にはrequire.php.baseというファイルがありますが、ローカルではこれをコピーしてrequire.phpを作成してください。||
 ||└class||テスト用のクラスを格納するディレクトリです。||
 ||　├Common_TestCase.php||他のテストクラスの基底となるクラスです。||
@@ -27 +27 @@
 
 == 2.   テストの実行方法 ==
+===2.1.　　実行の準備（初回のみ）===
+単体テストを実行するためには、ローカルの環境にPHPUnitをインストールしておく必要があります。[[BR]]
+また、インクルードパス等をローカルの環境に合わせて書き換えるため、SVNに含まれているファイルをコピーしてローカル用の設定ファイルを作成する必要があります。[[BR]]
+手順は下記の通りです。
+ * tests/phpunit.xml.baseをコピーしてtests/phpunit.xmlを作成します。
+ * <filter><blacklist>タグ以下の「/usr/local/lib」の部分を、ローカルで使われる各種ライブラリが含まれているパスと置換します。
+  ** この設定はどのファイルをテストのカバレッジ測定の対象にするかを設定するためのものなので、設定をし直さなくても単体テスト自体は問題なく動作します。
+ * tests/require.php.baseをコピーしてtests/require.phpを作成します。
+ * PHPUnitのモジュールが使用できるように、インクルードパスを設定します。
+tests/phpunit.xml、tests/require.phpはsvn:ignoreに設定されているため、自由に書き換えてもコミットはされません。
+
+===2.2.　　実行===
 全体のテストを行う場合には、phingのtestターゲットを実行します。[[BR]]
 テストの内容はbuild.xmlの中に定義されているため、実際にはphpunitコマンドが発行されます。
@@ -32 +44 @@
 % phing test
 }}}
-
-個々のテストを行う場合には、テスト対象のディレクトリを指定してphpunitコマンドを実行します。
+テストが完了すると、結果がreportsディレクトリ以下に出力されます。
+ * reports/tap.log　TAP形式のテスト結果
+ * reports/unitreport.xml　xUnit形式のテスト結果
+ * reports/coverage/coverage.xml　カバレッジ測定結果のXML（主にJenkinsで処理するためのものなので気にしなくて良いです）
+ * reports/coverage/**.html　カバレッジ測定結果のHTML
+
+個々のテストを行う場合には、テスト対象のディレクトリを指定してphpunitコマンドを実行します。[[BR]]
+標準出力ですぐにテスト結果を確認したい場合にはこちらのやり方のほうが良いでしょう。
 
 {{{
@@ -41 +59 @@
 
 下の例のようにディレクトリを指定した場合には、ディレクトリ以下にあるテストケースが実行されます。
+
+カバレッジを測定したい場合には、専用のオプションを指定します。
+
+{{{
+% phpunit -c tests/phpunit.xml --coverage-html reports/coverage tests/class/pages/LC_Page/LC_Page_InitTest.php
+}}}
 
 == 3.   テストクラスの構成 ==