C#でのテスト駆動開発 (TDD) 入門ガイド

システム開発
2023.10.09

テスト駆動開発 (TDD: Test-Driven Development)

テスト駆動開発 (TDD) は、ソフトウェア開発の手法の一つであり、その名の通り、テストが開発の中心に位置する方法論です。TDDを行う際には、コードの実装を始める前に、そのコードの動作を検証するためのテストを先に書きます。

TDDの基本的な流れ
  1. 必要な新しい機能についてのテストを書く。
  2. すべてのテストを実行して、新しいテストが失敗することを確認する。
  3. 新しいコードを書いてテストを通す。
  4. コードをリファクタリングする。
  5. 上記のステップを繰り返す。
TDDのメリット
  1. 品質の向上:
    最初にテストを書くことで、失敗しないプログラムができます。
    テストを書くとは、つまり「このプログラムがちゃんと動くための条件」を先に考えるということです。それを元にプログラムを書くので、要件をしっかりと理解して、それに合ったコードを書くことができます。想像してみてください。旅行前にしっかりとリストを作って準備すると、忘れ物がなくなるのと似ています。
  2. リファクタリングの容易さ:
    テストがあるので、後からプログラムを改良しやすい。
    プログラムを書いた後、より良くしたり、整理したりすることを「リファクタリング」と言います。でも、変更するたびに何かが壊れるかも…と心配になることも。でも、最初にテストを書いておけば、変更後もテストを実行することで、「ちゃんと動くか」を確認できます。これは、レシピを変えても、味見をすれば美味しさを確認できるようなものですね。。
  3. 設計の向上:
    TDDをすると、自然にきれいなプログラムが書けるようになる。
    TDDの方法を使ってプログラムを書くと、自然と部品ごとにわかりやすく、組み合わせやすい形になります。これは、レゴブロックを組むようなもの。一つ一つのブロックがしっかりと設計されているから、どんな形にも組み上げることができるのです。
TDDのデメリット
  1. 開発初期のコスト:
    最初は時間がかかります。
    プログラムを書き始める前に、テスト（プログラムが正しく動いているか確かめるためのミニプログラム）を書く必要があります。初めての経験であれば、「いつものようにさっとプログラムを書く」よりも、最初は時間がかかるかもしれません。想像してみてください。新しいレシピで料理を作るとき、最初はレシピをチェックしながらゆっくりと調理するのと同じです。
  2. 実践の難しさ:
    「正しいやり方」を覚えるのは少し難しいです。
    TDDはただテストを書くだけではありません。テストの「良い書き方」や、後でコードをきれいに整える（リファクタリングと呼ぶ）技術も必要です。これは、新しい楽器を学ぶのに、ただ音を出すだけではなく、きれいな音を出すためのテクニックも学ぶようなものです。最初はちょっと大変かもしれませんが、慣れてくれば自然と身につくスキルです。
TDDのベストプラクティス
  • 小さなステップで進める:
    一つの変更や機能追加ごとにテストを書き、そのテストを通るようにコードを書く。
  • テストの可読性を保つ:
    テストは他の開発者がコードの意図を理解するためのドキュメントとしても機能するため、可読性を高めることが重要。
  • 外部依存のモック化:
    外部システムやサービスへの依存を持つコードをテストする場合、その依存を模倣するモックオブジェクトを使用して、テストの迅速性と独立性を保つ。

TDDは、ソフトウェアの品質を向上させるための強力なツールですが、効果を最大化するためには正しい実践と経験が必要です。

テスト駆動開発 (TDD) の例

タスク: 整数のリストを取得し、その合計を返す関数を作成する。

Microsoft.VisualStudio.TestTools.UnitTesting は、.NETフレームワークにおいて、ユニットテストをサポートするための名前空間（namespace）です。これは、MicrosoftのVisual Studio IDEに組み込まれているユニットテストフレームワークに属しています。

以下は、この名前空間に関連する主なコンセプトと要素です。

  1. [TestClass]:
    • この属性は、クラスがテストクラスであることを示すために使用されます。
    • テストクラスは、一つ以上のテストメソッドを含むことができます。
  2. [TestMethod]:
    • この属性は、メソッドがテストメソッドであることを示すために使用されます。
    • このメソッドは、テストランナーによって実行される際に、特定のコードや機能の動作を検証します。
  3. Assert クラス:
    • このクラスは、様々なアサーションメソッドを提供しており、これを使用してテストの結果を検証します。例えば、Assert.AreEqual、Assert.IsTrue など。
  4. [TestInitialize] と [TestCleanup]:
    • [TestInitialize] 属性がついたメソッドは、各テストメソッドが実行される前に毎回実行されます。
    • [TestCleanup] 属性がついたメソッドは、各テストメソッドが実行された後に毎回実行されます。

1. テストケースを先に書く

using System.Collections.Generic;
using Microsoft.VisualStudio.TestTools.UnitTesting;

[TestClass]
public class CalculatorTests
{
    [TestMethod]
    public void TestSumOfList()
    {
        var calculator = new Calculator();
        var numbers = new List { 1, 2, 3, 4, 5 };
        
        var result = calculator.Sum(numbers);
        
        Assert.AreEqual(15, result);
    }
}

この段階では、Calculator クラスや Sum メソッドはまだ存在しないため、コンパイルエラーが発生します。

2. 仮の関数を作成する

using System.Collections.Generic;

public class Calculator
{
    public int Sum(List numbers)
    {
        return 0;  // 仮実装
    }
}

3. テストを実行する

テストを実行すると、当然ながらテストは失敗します。

4. 実際の機能を実装する

using System.Collections.Generic;

public class Calculator
{
    public int Sum(List numbers)
    {
        int total = 0;
        foreach(var num in numbers)
        {
            total += num;
        }
        return total;
    }
}

5. テストを再実行する

今度はテストが成功するはずです。

6. 必要であればリファクタリングを行う

この場合、LINQを使用してコードをよりシンプルにすることができます。

using System.Collections.Generic;
using System.Linq;

public class Calculator
{
    public int Sum(List numbers)
    {
        return numbers.Sum();
    }
}

テストを再度実行して、リファクタリング後も正しく動作することを確認します。

このサンプルは非常に単純なものですが、TDDの基本的なステップを示しています。実際の開発では、もちろんもっと複雑なテストケースや実装が必要となるでしょう。

コメント

タイトルとURLをコピーしました