とっとこ駆け出しエンジニアぶろぐ: TDD ランダム性があるルーレットのテスト

継続的インテグレーションするならテストは必須ですよね。
ただテストしにくい仕様もたまにあります。
ランダム性があるテストは、書きにくいものです。
今回は、ランダム性あるルーレットクラスを作ってランダム性をカバレッジしたテストをPHPで書きます。

##### 環境構成
* PHP 5.4
* PHPUnit 4.2
* Phake (モッキングフレームワーク)

##### ルーレットの仕様
#### ルーレット(Rouletteクラス)の仕様

* ルーレットは、1~5等賞を与えること
* 等賞は、ランダムな確率にすること

#### 確率の定義

* 1等　0.1%
* 2等　3%
* 3等　10%
* 4等　30%
* 5等　56.9%

以下、サンプルソースになります。

<pre class="brush: php">
/**
 * ルーレットクラス
 */
class Roulette
{
 const RAND_MIN = 1;
 const RAND_MAX = 1000;
 // 賞
 const PRIZE_1 = 1;
 const PRIZE_2 = 2;
 const PRIZE_3 = 3;
 const PRIZE_4 = 4;
 const PRIZE_5 = 5;

// RAND_MAXあたりの賞を貰える人の割合
  private $_prize_user_nums = [
    self::PRIZE_1 => 1,
    self::PRIZE_2 => 30,
    self::PRIZE_3 => 100,
    self::PRIZE_4 => 300,
  ];

/**
   * ルーレット用の乱数を生成する
   *
   * @return int 乱数
   */
  protected function generateRand()
  {
    return mt_rand(self::RAND_MIN, self::RAND_MAX);
  }

/**
   * ルーレットを回して、賞を返す
   *
   * @return int 賞
   */
  public function elect()
  {
    $rand = $this->generateRand();

if ($rand < 1) {
 return self::PRIZE_5;
 }

$sum_prize_user_num = 0;
    $sumPrizeUserCount = 
        function ($prize_user_num) use (&$sum_prize_user_num){
        $sum_prize_user_num += $prize_user_num;
        return $sum_prize_user_num;
    };

if ($rand <= $sumPrizeUserCount($this->_prize_user_nums[self::PRIZE_1])) {
 return self::PRIZE_1;
 } elseif ($rand <= $sumPrizeUserCount($this->_prize_user_nums[self::PRIZE_2])) {
 return self::PRIZE_2;
 } elseif ($rand <= $sumPrizeUserCount($this->_prize_user_nums[self::PRIZE_3])) {
 return self::PRIZE_3;
 } elseif ($rand <= $sumPrizeUserCount($this->_prize_user_nums[self::PRIZE_4])) {
 return self::PRIZE_4;
 }

return self::PRIZE_5;
 }
}
</pre>

簡単に解説します。 
外部からelectメソッドを呼び出して、等賞を与える。
generateRand関数で乱数を生成(1~1000)します。 
その乱数に応じて等賞を与える実装です。 
1~1000の乱数ですが、定数をいじられて万が一1未満1000より大きい値が返ってきた時は、５等賞を与えています。 
Exceptionを投げる方式でもいいかもしれない。 
 
確率を表現するのに色々やり方はありそうですね。 
もっとエレガントな方法あれば教えて下さい。

##### ランダム性のテスト
ランダム性をカバーするテストって難しいんですよね。 
ランダム性のテスト方針としては、何回かルーレットを回して与えた等賞の散らばりがこの程度に収まることとします。 
なので、10000回ルーレットを回して10000回全部が1等が当たる可能性もなくはないです。(天文学的数値になりますが) 
とはいってもちょくちょく落ちるテストも嫌なので散らばりの誤差を大目にみるようにします。 
10000回ぐらいルーレットを回したら正規分布になるので、標準偏差を出して +-3σに収まる(約99.7%)こととします。 
 
0.3%の可能性で失敗しますが、ランダムなので100%成功するテストはむしろバグです。 
コメントなどにX%の確率で成功するテストと書いてあげればいいかと思います。 
 
Jenkins環境などで自動テストされてる環境の場合は、監視対象から外すなりしてあげたほうが良さそうですね。 
 
以下、サンプルソース。

<pre class="brush: php">
require_once 'Roulette.php';
/**
 * ルーレットテストクラス
 */
class RouletteTest extends PHPUnit_Framework_TestCase
{
 public function providerPrizePattern()
 {
 return [
 [Roulette::PRIZE_1, 1, '1を１等とする'],
 [Roulette::PRIZE_2, 2, '2~31を２等とする'],
 [Roulette::PRIZE_2, 31, '2~31を２等とする'],
 [Roulette::PRIZE_3, 32, '32~131を３等とする'],
 [Roulette::PRIZE_3, 131, '32~131を３等とする'],
 [Roulette::PRIZE_4, 132, '132~431を４等とする'],
 [Roulette::PRIZE_4, 431, '132~431を４等とする'],
 [Roulette::PRIZE_5, 432, '432以上は５等とする'],
 [Roulette::PRIZE_5, 1000, '432以上は５等とする'],
 [Roulette::PRIZE_5, 1001, '1001以上も５等とする'],
 [Roulette::PRIZE_5, 0, '0は５等とする'],
 [Roulette::PRIZE_5, -1, '負数は５等とする'],
 ];
 }

/**
   * @test
   * @dataProvider providerPrizePattern
   */
  public function 確率に応じて等が返ること($expected_prize, $rand)
  {
    $roulette_mock = Phake::partialMock('Roulette');
    Phake::when($roulette_mock)->generateRand()->thenReturn($rand);

$this->assertSame($expected_prize, $roulette_mock->elect());
  }

/**
   * @test
   */
  public function 賞の確率による平均が標準偏差３つ分の誤差の範囲内であること()
  {
    $roulette = new Roulette();
    $prizes = [];

$prizes[$roulette::PRIZE_1] = 0;
    $prizes[$roulette::PRIZE_2] = 0;
    $prizes[$roulette::PRIZE_3] = 0;
    $prizes[$roulette::PRIZE_4] = 0;
    $prizes[$roulette::PRIZE_5] = 0;

$n = 10000;

for ($i = 0;$i < $n; $i++) {
 $prize = $roulette->elect();
 $prizes[$prize]++;
 }
 // 標準偏差の数
 $times = 3;
 // n * p = 平均, x = 計測値, メッセージ, 標準偏差 sqrt($n * $p * (1 - $p))の三倍 99.7%の確率で収まる

// p = 0.001
    $x = $prizes[$roulette::PRIZE_1];
    $this->assertEquals(10, $x, '1等 99.7%の確率で成功するテスト',  $times * 3.1606961258558);

// p = 0.03
    $x = $prizes[$roulette::PRIZE_2];
    $this->assertEquals(300, $x, '2等 99.7%の確率で成功するテスト', $times * 17.058722109232);

// p = 0.1
    $x = $prizes[$roulette::PRIZE_3];
    $this->assertEquals(1000, $x, '3等 99.7%の確率で成功するテスト', $times * 30);

// p = 0.3
    $x = $prizes[$roulette::PRIZE_4];
    $this->assertEquals(3000, $x, '4等 99.7%の確率で成功するテスト', $times * 45.825756949558);

// p = 0.569
 $x = $prizes[$roulette::PRIZE_5];
 $this->assertEquals(5690, $x, '5等 99.7%の確率で成功するテスト', $times * 49.521611443894);
 }
}
</pre>

テストメソッドである、"確率に応じて等が返ること"メソッドは、乱数によって等賞を与える境界値テストです。 
PhakeのpartialMockを使ってRouletteクラスをモックしています。 
generateRandメソッドが、electメソッドから呼ばれるので普通のMockではできないようです。 
generateRandメソッドに騙したい値を入れてテストします。 
 
続いて今回の肝であるランダム性のテストメソッド"賞の確率による平均が標準偏差３つ分の誤差の範囲内であること"です。 
10000(n)回ルーレットを回して$prizes配列に各等が、いくつ与えられたか計測します。 
計測した値から標準偏差３つ分の誤差の範囲内かどうか、判定するにはPHPUnitのassertEqualsの第四引数を使います。 
 
実際に、どのように使うか"1等 99.7%の確率で成功するテスト"のテストケースで説明します。 
期待値(10)は、確率(p)で出します。 10000 × 0.001 = 10。 
10000回ルーレットを回したら、10回は１等賞が当たります。とういことです。 
 
実測値($x)には、実際にルーレットを回して計測した$prizes配列に格納している値です。 
Rouletteクラスの確率の計算が間違っていなければ大体、$xが10前後に散らばっていると思います。 
このままではテストが通らないし、散らばりをある程度、許容したいので標準偏差を出してどの程度散らばるのか算出します。 
 
標準偏差の算出式が、√(n × p × (1 - p))と知らない人からすれば、なんのこっちゃってなると思います。 
僕も今回で覚えたので、使うときに思い出す程度ぐらいでいいと思います。 
１等賞の標準偏差は約3で、大体7~13の範囲でばらつくことになります。 
 
var_dumpなどして確認してみるとそれぐらいですが、標準偏差１つ分だと約70%の確率でこの範囲に収まることになります。 
70%だとコケることが多いので、標準偏差を× 3をします。 
× 3をすると許容する散らばりが1~19になり、99.7%の確率でこの範囲に収まることになります。 
19より大きい値は、テストがこけます。 
99.7%の確率で成功するけど0.3%の可能性で失敗するよ〜とassertEqualsの第三引数にメッセージを残せば他の方に伝わると思います。 
 
今回だと、1~5等賞のテストを行っているので99.7%の５乗で約98.5%の確率でテストが成功する見通しです。

GitHubにソースコード上げたので、よければプルリクお願いします。 
https://github.com/hamuhamu/Roulette 
 
##### 最近読んだ本

とっとこ駆け出しエンジニアぶろぐ

2014年9月6日土曜日

TDD ランダム性があるルーレットのテスト

0 件のコメント :

コメントを投稿