テストファースト

(KAB-studioからのおしらせです)

// Sample.java
public class Sample
{
    /**
    *   テスト対象のメソッド。
    *   このplus()メソッドができるまでの、テストファーストの
    *   流れを見てみます。1～4までを追っていってください。
    *   ※当然、本当のメソッド名はplus()とtestPlus()です。
    *   　数字は便宜的に付けているものですから。
    *   →Sample#plus1()メソッドの説明につづく。
    */
    public int plus( int iL, int iR )
    {
        return iL + iR;
    }

    /**
    *   →Sample#plus()メソッドの説明のつづき。
    *   まず、クラスと、メソッドの引数と戻り値を
    *   先に作ります。
    *   また、「契約による設計」に基づいて、渡せる
    *   引数や、返される戻り値を決めます。
    */
    public int plus1( int iL, int iR )
    {
        return 0;
        // 戻り値はコンパイルエラーに
        // ならないよう適当な値を返しておきます。
        // →SampleTest#testPlus2()の説明に続く。
    }

    /**
    *   →SampleTest#testPlus2()メソッドの説明のつづき。
    *   テストを実行して、完成していないことを確認してから、
    *   メソッドを実装します。
    */
    public int plus3( int iL, int iR )
    {
        return iL + iR;
        // というわけで、ちゃんと完成させました。
        // →SampleTest#testPlus4()の説明に続く。
    }
}


// SampleTest.java
import junit.framework.TestCase;

/**
*   Sampleクラスのテストクラスです。
*/
public class SampleTest extends TestCase
{
    /**
    *   コンストラクタ。
    */
    public SampleTest()
    {
        // クラス名をセットします。
        super( SampleTest.class.toString() );
    }

    /**
    *   →Sample#plus1()メソッドの説明の続き。
    *   Sample#plus1()メソッドをテストします。
    */
    public void testPlus2() 
    {
        Sample sample = new Sample();
        // 未完成のメソッドplus()を呼び出します。
        // 未完成なので、当然誤った値が返ってきます。
        int result = sample.plus1( 2, 1 );
        // assertEquals()メソッドで結果をチェックします。
        // 第1引数に「予想される結果」を、
        // 第2引数にテスト対象の変数を渡します。
        assertEquals( 3, result );
        // これは、このメソッドの「仕様」になります。
        // このようにプログラムとして書くことで、
        // 「Sampleクラスのplus()メソッドは、
        // 戻り値に第1引数と第2引数を足した値が
        // 返される」ということを明記しているわけです。
        // これは「契約による設計」に基づいた手法です。
        // メソッドの仕様を「契約」という形で明確に
        // しているわけです。

        // でも、この段階では当然誤った値が返ってくるので
        // 例外が投げられます。

        // junit.framework.AssertionFailedError: expected:<3> but was:<0>
        //     at junit.framework.Assert.fail(Assert.java:47)
        //     at junit.framework.Assert.failNotEquals(Assert.java:282)
        //     at junit.framework.Assert.assertEquals(Assert.java:64)
        //     at junit.framework.Assert.assertEquals(Assert.java:201)
        //     at junit.framework.Assert.assertEquals(Assert.java:207)
        //     at SampleTest.testPlus2(SampleTest.java:31)
        //     at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        //     at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
        //     at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
        //     at java.lang.reflect.Method.invoke(Method.java:324)
        //     at junit.framework.TestCase.runTest(TestCase.java:154)
        //     at junit.framework.TestCase.runBare(TestCase.java:127)
        //     at junit.framework.TestResult$1.protect(TestResult.java:106)
        //     at junit.framework.TestResult.runProtected(TestResult.java:124)
        //     at junit.framework.TestResult.run(TestResult.java:109)
        //     at junit.framework.TestCase.run(TestCase.java:118)
        //     at junit.framework.TestSuite.runTest(TestSuite.java:208)
        //     at junit.framework.TestSuite.run(TestSuite.java:203)
        //     at junit.framework.TestSuite.runTest(TestSuite.java:208)
        //     at junit.framework.TestSuite.run(TestSuite.java:203)
        //     at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:392)
        //     at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.run(RemoteTestRunner.java:276)
        //     at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java:167)

        // 最初の一文の「expected:<3> but was:<0>」は、
        // 「期待した値は3だったけど、実際には0だった」という意味です。

        // 現段階では、この例外は当然投げられます。
        // また、この例外により、EclipseのJUnitビューのゲージは
        // 赤くなっているはずです。
        // つまり、この時点で「まだ完成していない」ことを確認するわけです。
        // そして、この例外が消え、ゲージが緑色になるようにしていくわけです。
        // →Sample#plus3()メソッドの説明につづく。
    }

    /**
    *   →Sample#plus3()メソッドの説明の続き。
    *   Sample#plus3()メソッドをテストします。
    */
    public void testPlus4() 
    {
        Sample sample = new Sample();
        int result = sample.plus3( 2, 1 );
        // 今度はちゃんと実装されているので、
        // 正しい値が返ってくるはずです。
        assertEquals( 3, result );
        // 値が一致しているので例外は投げられません。
        // そして、ゲージが緑色になります。
        // →これで、プログラムが完成しました！
    }
}


// Tester.java
import junit.framework.Test;
import junit.framework.TestSuite;

/**
*   このクラスを使うために、junit.jarに
*   クラスパスを通してください。junit.jarは
*   Junitをダウンロードしてくれば入っているはずです。
*/

/**
*   各テストメソッドを呼び出すクラス。
*
*   コンパイルを通すために、junit.jarにクラスパスを
*   通してください。junit.jarはEclipseに付いていますが、
*   最新版をダウンロードした方がいいでしょう。
*
*   Eclipseで実行する場合、メニューの【実行】-【デバッグ】の
*   【起動構成】から【JUnit】を選び【新規】で新規作成し、
*   【テスト・クラス】でこのクラスを指定してください。
*
*/
public class Tester
{
    /**
    *   JUnitから呼ばれるメソッド。
    *   main()メソッドみたいなものです。
    */
    public static Test suite()
    {
        // テストを登録するためのTestSuiteを作ります。
        TestSuite suite = new TestSuite();

        // テストケースを追加します。
        // このクラスのtestメソッドが呼ばれます。
        suite.addTestSuite( SampleTest.class );

        // TestSuite を返します。
        // この中に登録したテストクラスが実行されます。
        return suite;
    }
}