テスト駆動開発で使う テストフレームワークの仕組み

Test-Driven Development By Example (Kent Beck)
Kent Beck の Test-Driven Development By Example を Amazon で買う

参考書籍は Test-Driven Development By Example、 日本語版は テスト駆動開発入門です。

Money Example の次は jUnit のようなテストツールを作ってみるお話です。 30以上の言語で使われている xUnit は、 今や巨大な資産ですが、 そういったものは自分で作れるものなんでしょうか。

テストフレームワークの仕組み

読んでみると、実際にやっていることは難しくなさそうです。 肝となるのは 一連のテストの結果 (実行・成功・失敗したテスト数) をどうやって保持するかではないかと思いました。 独自にテストフレームワークを作るときに役に立ちそうです。

社内でも独自にテストフレームワークを作っている人がいます、 かなりシンプルにできるそうです。 その人によると、 PHPUnit などのテストフレームワークは いろんなファンクションや機能をつけているから複雑になっているそうです。 そうじゃないと使ってもらえないからだとも言っていましたが。

JUnit や PHPUnit は TestCase だったかのクラスを継承してテストコードを書いていくので 今回説明されていたやり方と同じですね。 でも rspec だと describe で書き始めたりするし クラス の 定義 で始めるわけでもないので 本書とは別のアプローチかもしれません。

Test-Driven Development By Example (Kent Beck)
Kent Beck の Test-Driven Development By Example を Amazon で買う

テスト駆動開発でテストを書かない場合がある

Test-Driven Development By Example (Kent Beck)
Kent Beck の Test-Driven Development By Example を Amazon で買う

参考書籍は Test-Driven Development By Example、 日本語版は テスト駆動開発入門です。

機能追加の方針

Franc-ly Speaking のところ(29ページ)からです。 Franc を導入して複数通貨に対応させるんですね。 39ページに至るまでの流れを見ていくと次のようになります。

  1. Dollar を複製する。 テストコードも複製する。
  2. 親クラス Money と 継承クラス Dollar, Franc に分ける。
  3. Factory Method PatternMoney クラス に共通のものを集約する。

Dollar から Money へ、 子クラスから親クラスへメソッドを移す手順には要注意ですね。

書かないテスト

途中、 toString() というメソッドを、テストコードを書かずに追加しています。 この判断基準は重要なのでまとめておきます。

次の条件を満たす場合は、テストコードを書かなくてもOKとします。

  • 画面上で(テストの)結果を見ようとするメソッドを追加しようとしている。
  • 追加するコードはデバッグのためのコードで、仮に正常に動かなくなったとしてもダメージが小さい。
  • テストが Red で終了している。 (Red のときは新しいテストコードを書きたくない。)

普遍的にまとめた記述が今のところ出てきていないので toString() 追加の際の説明をまとめたものになっています。

toString() 程度 だったらテストを書いてもよさそうですが、 もっと複雑なものに成った場合には テストを書かずに進めた方がいいんでしょうか。 これは実践あるのみですね。

その後 Money Example の演算の実装と、 全体を俯瞰した傾向、 テストの品質について重要な記述がありますが、 ひとつひとつ紹介すると長くなるので割愛します。 でもひとつだけ気になる記述があるので紹介します。

Easy to read for programmers – Unsynchronized documentation is scarce. The tests will be more valuable if they are readable, giving an interesting second perspective on the messages hidden in the source code.

テストを書けば仕様も理解しやすくなるかもしれないと思いました。

Test-Driven Development By Example (Kent Beck)
Kent Beck の Test-Driven Development By Example を Amazon で買う

キットカット ショコラトリー スペシャル 専門店の味

kitkat_chocolaterie

キットカット ショコラトリー スペシャルを食べました。 市販のいつものキットカットとは味が違います。 とても上品な感じがします。 今回食べたキットカットは、日本を代表する「ル パティシエ タカギ」のオーナーシェフ高木康政氏が開発した大人のキットカットです。

バリエーション

私が手に入れた キットカット は次の 5つ です。

キットカット ショコラトリー スペシャル クリームチーズ

ウエハースとナチュラルチーズを包んだ作品。 チョコレートの甘さと しっかりとしたチーズのコクが楽しめます。 チーズとチョコレートだと打ち消し合うような気がしてしまうんですが、チーズの味も濃厚でチョコレートの甘さも効いています。

キットカット ショコラトリー スペシャル ストロベリーメープル

苺の甘さとホワイトチョコレートの甘さが混ざりあった作品。 素材の味が活きています。 じっくりと味わいながらいただきました。

キットカット ショコラトリー スペシャル 抹茶&きなこ

厳選された宇治抹茶ときなこのコラボレーション。 濃厚な抹茶の旨みとコクに包まれながらも きなこの香りが楽しめます。 とっても上品な味がしました。

キットカット ショコラトリー スペシャル オレンジカクテル

爽やかなオレンジの一品。 濃い感じは一切なく、とても爽やかで また食べたいと思う味です。 チョコレートのイメージがガラッと変わります。 東京エリア店舗限定品だそうです。

キットカット ショコラトリー スペシャル ジンジャー

上品な辛みをミルクチョコレートで包んだ作品。 口に入れた瞬間、ジンジャーの香りが広がります。 ジンジャーだけどまろやかな甘味もあって絶妙な味わいです。

この中で私が一番おいしいと思ったのは、キットカット ショコラトリー スペシャル オレンジカクテルでした。 爽やかな感じが忘れられません。

本当においしいので是非たべてみてください。

テスト駆動開発の始め方

Test-Driven Development By Example (Kent Beck)
Kent Beck の Test-Driven Development By Example を Amazon で買う

約70ページにもわたって MONEY EXAMPLE という事例が書かれています。 あまりに多いので一気に読むのはちょっと辛いですが、テストドリブンを夢見てがんばって読んでいます。 今回は テストドリブンの序盤となる部分をyんでみました。

実装の前にテストをすべて書くのは無理

MONEY EXAMPLE のところを見ると、 Kent Beck ですら最初にすべてのコードを書かないということがわかります。 MONEY EXAMPLE で取り上げられている単純な金額の掛け算でも、コードが徐々に完成していくのにつれてテストコードも変わっていきます。 よく、最初にテストコードを書くなんて無理だからテスト駆動開発は無理だという人がいますが、テスト駆動とはそういうことではないんですね。

MONEY EXAMPLE では、 存在しないクラスを使ってテストを書き始めます。 Red どころか コンパイルすらできないテストを書くところから始めています。 必要なクラスを考えてクラスのテストから書き始めるのかと思いましたがそうではありませんでした。 最後の理想形をテストに書いていました。

テストドリブンの手順

ToDo の整理をしてからテストを始めます。 この ToDo List はコードが完成するまでついて回ります。 載っている事例では、 存在しない Dollar クラス を使ってテストを書くところから始めています。 そして テストを通してできるクラスのメソッドは(最初は)あくまでスタブです。

MONEY EXAMPLE は次のようにして進めていました。

  1. テストを書く。存在しないクラスも使ってよい。
  2. テストをコンパイルできるようにする。
  3. テストを Green にする。
  4. リファクタを行い、重複を取り除く。

テストを Green にする方法

  • 固定値を返すなどして、テストを通るようにする。 (実装コードとしては完成ではない)
  • 明らかにわかるコードを実装する。
  • 複数の側面からのテストを書く。 (Triangulation)

Triangulation というのは、 テストケースを追加することで固定値での返り値を返せないようにするように、複数のパターンのテストを書くことで実装コードを規定していく方法です。 たとえば 1 から n までの総和を求める関数があったとして、 Sum(1) == 1 だけだったら Sum の返り値は 固定の 1 でもいいですが、 Sum(5) == 15 だと実装せざるを得なくなります。 Kent Beck は本当にどのようにリファクタすればよいか迷うようなときに Triangulation を使うそうです。 どうすればいいのかわかっている場合は Triangulation のためのテストコードは書かれません。

MONEY EXAMPLE の中で出てきた Value Object というのも重要だと思うのでまとめておきます。

Value Object

一種のインスタンス変数で、コンストラクタで設定された値はそれ以降変わることがありません。 これにより、ポインタを通じた意図しない値の書き換えの発生を防ぎます。 別の言葉で書くなら 副作用対策です。

Value Object の持つメソッドの戻り値は必ず新しいオブジェクトにします。 下に例を書きました。 Numadd メソッドの戻り値は新しいインスタンスになっています。 これにより add の前後で Num のインスタンスは変更することがありません。 また、 primitive value ではないので、 別途 equal メソッドを実装しておかないとテストコードを書くときに困ることがあります。

Test-Driven Development By Example の JAVA のコードをまねて作ったのですが、 言語が ruby なので実践的には get_amount を書かずに attr_reader :amount と書きますね。

Test-Driven Development By Example (Kent Beck)
Kent Beck の Test-Driven Development By Example を Amazon で買う

Database available in FuelPHP

I wondered what database is available in FuelPHP, and look into FuelPHP code.

Environment

  • FuelPHP 1.8 (GitHub)

Available Database

The following DBMS is theoretically available in FuelPHP. It means that FuelPHP use driver for the following databases.

  • Cubrid
  • FreeTDS
  • Microsoft SQL Server
  • Sybase
  • Firebird
  • IBM DB2
  • IBM Informix Dynamic Server
  • MySQL
  • Oracle Call Interface
  • ODBC v3 (IBM DB2, unixODBC and win32 ODBC)
  • PostgreSQL
  • SQLite 3, 2
  • SQL Azure
  • 4D

How to investigate

First, read manual. At the section Database Introduction, it says Can be mysql, mysqli or pdo. Namely, FuelPHP can handle mysql specific driver and PDO driver.

Then, read PDO section of PHP document. For above all DBMS, PDO is available.

Well, can FuelPHP handle PDO and connect to DB in real? Now, look at the FuelPHP core code, which handle database connection. There are 3 kind of connection.php, each of them handle mysql, mysqli, PDO connection. It’ll be clear PDO is available in FuelPHP.

Take your Attention when you use sqlite

You should be careful when you use sqlite. (FuelPHP version 1.7.2)

Primary Key

Migration doesn’t work when you add Primary Key like MySQL. In sqlite3, we can’t add name to Primary Key. 例えば MySQL なら Primary Key id (id) となるところが、 sqlite3 だと Primary Key (id) というようになります。

So, we should create plain SQL or change FuelPHP core code. It’s a choice not to use Primary Key, but I don’t recommend.

また通常は migration file を php oil を使って作成すると 自動で UNSIGNEDid が作成されて AUTO_INCREMENT が設定されますが、 sqlite ではこれが動きません。 sqlite では AUTO_INCREMENT ではなく AUTOINCREMENT になります。 いまのところ自動生成のスクリプトでは対応していませんので FuelPHP の core のコードを変更する必要があります。 そして自動生成される UNSIGNED は 削除しましょう。 sqlite では UNSIGNED BIT INT というのが使えますが、 使ったところで INTEGER と解釈されます。

Blank Charset

sqlite3 では charset の指定方法が他のデータベースとは異なります。 PRAGMA statement を使います。 (確か sqlite3 では標準文字コードが utf-8 だったと思います。)

If you don’t set charset in db config (config/db.php), php oil migrate occurs an error of SQL, CREATE TABLE, because SQL which contains DEFAULT CHARACTER SET utf8 at last is executed. To prevent that, set empty string to charset, charset => ''. すると、 DEFAULT から始まる文字コード指定部分がなくなり、 sqlite3 でも php oil migrate が動くようになります。

db.php は次のように書きます。

このようにすると、 環境ごとに別の DB が作成されます。 table_prefixphp oil r migration の時には不要ですが、 php oil r migration:down の時に必要になることがあります。

Take your Attention when you use PostgreSQL

Migration doesn’t work. It is because PostgreSQL SQL syntax is somehow different from MySQL one. I recommend you to use FuelPHP Plugin for PostgreSQL.