8時間耐久PHPUnitの教室

8時間耐久
PHPUnitの教室

8時間耐久PHP classのクラス / Yusuke Ando (@yando)
8時間耐久PHPUnitの教室 / Yusuke Ando (@yando)

テキスト


http://tech.a-listers.jp/

http://blog.livedoor.jp/goroyasu/archives/4196098.html


本日の対象者
PHPを使っている
関数やクラスでコーディング
コードの修正が最近辛い
子育てブログころぐの作者


PHPUnitを
使った開発を
実践の基礎知識を
学びます

本日のメニュー

PHPUnitの無い開発
PHPUnitの基礎
テストしづらいコード
より快適な手法


PHPUnitの無い開発

原始的な開発の流れ

1.コードを書く
2.ブラウザで動作確認
3.コードを直す
2に戻る


書いて


動かす



コードの記述と動作確認
のループを繰り返す

ごく自然な行為

しかし


プログラム
は
複雑化する

ライブラリ化
ページ

ライブラリ



修正修正
ページライブラリ
修正
修正修正

動作確認

修正ファイルと確認対象が
一致しなくなる

複数ページから共用
ページ

ライブラリ


きつくなってきた
ページ
動作確認
修正修正
修正
動作確認修正修正

ページ
動作確認

確認対象が増える

ページも複雑化
入力
動作確認
修正修正
確認ライブラリ
修正
動作確認修正修正

登録完了
動作確認

ステップに手間がかかる

ライブラリが複雑化
修正修正
ライブラリ
修正
修正修正

動作確認

直感的でない結びつき

開発中だったら？
修正修正
ライブラリ
修正
修正修正

ページ未完成
動作確認

動作確認できない

複雑化したプログラム

コードの記述と
ブラウザでの動作確認

手間の増大

それなら

動作確認しないで
ひたすら開発？


それは

ヤバイ

テストの種類
•ユニットテスト(単体テスト)
クラスや関数を単体のテスト
•結合テスト
クラスや関数を組み合わせたテスト
•ファンクショナルテスト(機能テスト)
システムの機能の動作のテスト

ブラウザでの動作確認は機能テスト


ユニットテスト

ユニットテストツールを学ぶ事で
複雑なプログラムを快適にテストできる


PHPUnitの基礎

PHPUnit

定番ユニットテストツール
Sebastian Bergman氏作
圧倒的な多機能さ
各種OSSも利用中
PHPならこれで間違い無し


PHPUnitの基礎

インストール
テストケース作成・実行
ケース内でのテクニック


インストール

インストール

PEAR形式で提供
コマンドラインからのイン
ストールが必要

pear config-set auto_discover 1
pear install pear.phpunit.de/PHPUnit


PEAR？
PEAR(PHP Extension and Application Repository)
はPHPで利用する事ができるライブラリ(パッケージ)を
提供しているサービス。 PEARはPHPで書かれたライ
ブラリを提供しているが、C言語で書かれた拡張ライブ
ラリ(extension)を提供するPECLというサービスも存
在する。
インストールが完了すると、pearという同名のコマン
ドが利用できるようになっている。


PEARのインストール先
•通常のインストール
/usr/lib/php/PHPUnit
•個人用 (要Pyrus)
/home/ユーザ名/ 内
•プロジェクト用 (要Pyrus)
プロジェクト内/vendor/ 内

通常のインストールは複数共存に問題

これからはPyrus

pyrus.pharをプロジェクト内に配置
（約10MBあるので時間かかる）


Pyrusでのセットアップ例

適宜変更

通常のインストールは複数共存に問題


準備OK


テストケース作成・実行

テストケース
•テストを行う場合に書くプログラム
•テスト対象のコードを実行
•実行結果をアサートメソッドで確認
•場合分けに応じてアサートを追加
•phpunitコマンドで実行される

PHPUnitを使う＝テストケースを書く


テストケースの例
PHPUnitのクラスを継承

テストはtest○○という名前

テスト対象を実行

結果が想定と等しいかを検査


テストケースの実行

./vendor/bin/phpunit [テストケース名]
又は
./vendor/bin/phpunit [ディレクトリ名]

ディレクトリを指定すると配下のテスト
ケースを全て実行する


テストケースの実行

.が１つのテスト

テスト項目を文字で表示

x がOKの意味（英語的）


エラーがある場合
Fがエラー

失敗した検査の内容


--colors で色つき


PHPUnitのイメージ
テストケース

修正修正
テストケースライブラリ
修正
phpunit 修正修正
テストケース

ライブラリをコマンド１つで
高速にテストを実行可能

練習

•Tankiyoクラスのテスト
•テストケースを作成
tests/TankiyoTest.php
•各メソッドへテストを記述
•テストを実行

補足
各テストケースはテスト対象
のコードをrequireする必要
がある
autoload機構を使わない場
合は適宜 require_once


テストの重要点

•テストケースは幅広く
•テストはこまめに実行
•テスト成功なら
同条件での挙動は同一
•思い切ったコード変更へ！

ケース内でのテクニック

setUp / tearDown

•テストメソッドの前後に実
行される処理を記述できる
•前処理や後始末が必要な場
合に利用する
•各テストの共通部分を統合

setUp / tearDownの例

重複した初期化処理


setUp / tearDownの例

テストメソッドの前後に実
行される処理になる


アサーション

•実行結果を検査する
assertEquals()だけでかな
り生きていける
•他のメソッドは応用的
•種類は増え続けている

超豊富なアサーション
assertArrayHasKey() assertLessThanOrEqual()
assertClassHasAttribute() assertNull()
assertClassHasStaticAttribute() assertObjectHasAttribute()
assertContains() assertRegExp()
assertContainsOnly() assertStringMatchesFormat()
assertCount() assertStringMatchesFormatFile()
assertEmpty() assertSame()
assertEqualXMLStructure() assertSelectCount()
assertEquals() assertSelectEquals()
assertFalse() assertSelectRegExp()
assertFileEquals() assertStringEndsWith()
assertFileExists() assertStringEqualsFile()
assertGreaterThan() assertStringStartsWith()
assertGreaterThanOrEqual() assertTag()
assertInstanceOf() assertThat()
assertInternalType() assertTrue()
assertJsonFileEqualsJsonFile() assertXmlFileEqualsXmlFile()
assertJsonStringEqualsJsonFile() assertXmlStringEqualsXmlFile()
assertJsonStringEqualsJsonString() assertXmlStringEqualsXmlString()
assertLessThan()


assertEquals($a,$b)

•$aがあるべき値
•$bに実際の実行結果
•一致しない場合はエラー
（エラー時のメッセージを
第3引数に渡せる）


assertCount($num,$a)

•$aが$num件かどうかを検
査する
•一致しない場合はエラー
（エラー時のメッセージを
第2引数に渡せる）


assertTrue($a)
assertFalse($a)
assertEmpty($a)
assertNull($a)

•$aがtrue false 空 nullかど
うかを検査する


assertRegExp($reg,$a)

•$aが$regの正規表現に
マッチするかどうかを検査
する


アノテーション

•特殊なコメントを記述
•テストケースの実行時にさ
まざまなオプション設定
•作者、依存、グループ等
•種類は増え続けている

アノテーションの例


テストケース生成

•クラスからケースを生成
•ケースからクラスを生成
•あくまでひな形なのでテス
ト自体は自力で記述する
•既存のコードの移行に便利

SkeletonGenerator
インストール
php pyrus.phar install phpunit/PHPUnit_SkeletonGenerator

対象のクラス名とファイル名を指定
./vendor/bin/phpunit-skelgen --test -- Kid ./lib/Kid.php

テストの出力先やrequireが足り
ない点を補う必要がある

練習 Kid / HtmlKid

•コマンドからケースを生成
•適切な場所にケースを移動
•require を補う
•テストが実行できるか確認


テストファースト

•テストケースを先に記述し
てコードの挙動を決定
•記述したテストケースを通
過できるように開発
•テスト駆動開発の典型例

テストしづらい？

•実際に開発を進めると発生
•テストが書けない例が出る
•テストの実行時間が長い
•結果が不安定
コードをテストしやすく修正しないと
テストできない場合がある

テストしづらい例

処理が外部のWebに依存



•機能が外部に依存している
（各種WebAPI）
•データベースに存在してい
るデータに依存している
•処理に時間がかかる部分

外部に依存
DB
テストケース

テストケースライブラリ
phpunit
テストケース
API

実質、結合テストになっている

モック

•コードの中で外部に依存す
る部分をテスト時に別のもの
に置き換える手法


モックできない

Getterを直接newして使う
必ずGetterのgetを呼んでしまう


モックできる！

処理に使うオブジェクトを注入

渡されたオブジェクトのgetを使う
渡ってくるのはGetterのオブジェクト
とは限らない！


モック用のクラス

•自力でスタブを作成
•PHPUnitの機能で生成も可


モック利用例

スタブの生成

スタブの振る舞いを設定する部分
（すごい記述だが動く）


練習モックの利用

•まずは元の状態のRecent
クラスをテストしてみる
•遅さを確認
•モックを使ったテスト
•実物を使ったテスト

DBUnit

•テスト用のDBを毎回生成
•テスト後に全削除
•データの状態に左右されず
にデータベースを使ったテ
ストを行う


さらに効率良いテスト

phpunit.xml

•phpunitコマンドのオプ
ションを記述しておく事で
テスト実行が簡略化される
•コマンドの引数と併用もで
きる


phpunit.xml


カバレッジレポート

•テストがコードのどの部分
を実行したかをレポート
•xDebug拡張を導入する必
要がある
phpunit --coverage-html=/path/to/report


カバレッジレポート


継続ビルド(CI)

コードをコミットする度に自動でテスト実
行、レポート出力、アラート送信

まとめ

テストとCI

•モダンな開発の定番
•フレームワーク
•Gitによるコード管理
•ユニットテスト
•継続ビルド

PHPUnit

•かなり抽象的なツール
•進化も早いが一度覚えれば
そのまま使い続けられる
•不毛な動作確認とバグから
逃れる希望


8時間耐久PHPUnitの教室

More Related Content

What's hot (20)

Similar to 8時間耐久PHPUnitの教室 (20)

More from Yusuke Ando (20)

Recently uploaded (7)

8時間耐久PHPUnitの教室