最新モッキングツールと黒魔術

Challenges to Testing（テストの課題）

メソッド自体を掘り下げる前に、まずこれが静的メソッドであることに注目してください。Java、C＃、C ++（および他の多くの言語）では、静的メソッドは常にコンパイル時（またはリンク時）にバインドされます。これは、静的メソッドを呼び出すコードがそれらのメソッドに直接結合されていることを意味します。メソッドの選択と呼び出しメカニズムは、テストが制御する何かに転送できる環境をテストが簡単に設定できるようにするには早すぎます。Michael Feathers氏が「リンクシーム」と呼ぶものを使用して、実行時に別の静的メソッドを呼び出すことができます。Javaの場合、静的メソッドを持つクラスの別のバージョンがクラスパスで先に利用できるようにすることができます。これについては以下で詳しく説明します。

Map<String, String> symbolToName = currencySymbols();
if (!symbolToName.containsKey(fromCurrency))
    throw new IllegalArgumentException(String.format(
            "Invalid from currency: %s", fromCurrency));
if (!symbolToName.containsKey(toCurrency))
    throw new IllegalArgumentException(String.format(
            "Invalid to currency: %s", toCurrency));

HttpClient httpclient = new DefaultHttpClient();
HttpGet httpget = new HttpGet(url);
HttpResponse response = httpclient.execute(httpget);
HttpEntity entity = response.getEntity();

StringBuffer result = new StringBuffer();
if (entity != null) {
    InputStream instream = entity.getContent();
    InputStreamReader irs = new InputStreamReader(instream);
    BufferedReader br = new BufferedReader(irs);
    String l;
    while ((l = br.readLine()) != null) {
        result.append(l);
    }
}
String theWholeThing = result.toString();

int start = theWholeThing.lastIndexOf("<div id=\"converter_results\"><ul><li>");
String substring = result.substring(start);
int startOfInterestingStuff = substring.indexOf("<b>") + 3;
int endOfIntererestingStuff = substring.indexOf("</b>",
        startOfInterestingStuff);
String interestingStuff = substring.substring(
        startOfInterestingStuff, endOfIntererestingStuff);
String[] parts = interestingStuff.split("=");
String value = parts[1].trim().split(" ")[0];

Getting setup - exercise the code（セットアップ - コードを実行する）

開始する1つの場所は、単にnull引数または「妥当な」値を使用して、問題のコードを実行してみることです。ドメインは通貨換算であり、メソッドは2つの通貨を受け入れるため、妥当な開始点のようです。

これは、コードを実行するための自動単体テストの始まりです。私の目標は、メソッドを最後まで実行することです。注意点は、このコードはライブインターネット接続で実行されますが、テストの記述中に接続をオフにして、テストの動作にライブインターネット接続が必要ないことを確認しました。

@Test
public void returnExpectedConversion_v1() {
    CurrencyConversion.convertFromTo("USD", "EUR");
}

これはネットワークが有効になっている場合は機能しますが、そうでない場合は、コードはjava.net.UnknownHostExceptionを生成します。ただし、実際に発生する場所は、CurrencyConversion.currencySymbolsメソッドであり、私たちが気にするメソッドではありません。古いツールを使用すると、これは少し手間がかかりますが、この記事で選択したツールであるJMockItではそうではありません。

Getting past validation（検証を乗り越える）

これは、最初の例外を回避するテストの2番目のバージョンです。

@Test
public void returnExpectedConversion_v2() {
    new NonStrictExpectations(CurrencyConversion.class) {
        {
            CurrencyConversion.currencySymbols();
            result = mapFrom("USD", "EUR");
        }
    };
    CurrencyConversion.convertFromTo("USD", "EUR");
}

private Map<String, String> mapFrom(String... keyValuePairs) {
    Map<String, String> result = new ConcurrentHashMap<String, String>();
    for (int i = 0; i < keyValuePairs.length; ++i)
        result.put(keyValuePairs[i], keyValuePairs[i]);
    return result;
}

これを実行すると、同じ例外UnknownHostExceptionがスローされますが、例外は呼び出されたメソッドではなく、テスト中のメソッドにあります。それは改善です。これにより、コードは検証をパスできますが、どのようにでしょうか？

new NonStrictExpectations(CurrencyConversion.class) {
    {
        CurrencyConversion.currencySymbols();
        result = mapFrom("USD", "EUR");
    }
};

NonStrictExpectationsを使用して匿名内部クラスを作成していることに注意してください。この形式は、JMockItにCurrencyConversionクラスで何かを行うように指示します（この場合は静的メソッドを置き換えます）。内部の{}内のコードは、標準のJavaインスタンス初期化子です。そのインスタンス初期化子で実行されるコードは、実行されるメソッドであるcurrencySymbolsを置き換えるようにJMockItに指示します。これは、クラスの部分的なモッキングの例です。クラスのメソッドの1つを置き換えるため、呼び出されるたびに、継承されたフィールド「result」に割り当てられたものが返されます。

これには、いくつかのブラックマジックが含まれます。JMockItは、Javaバイトコードマジックを実行しており、このコードはJMockIt DSLを使用してこれを実現しています。これを機能させるには、JMockIt jarファイルをクラスパスに追加する必要があります。JUnitのjarファイルの前にリストされていることを確認すれば、それで十分です。JMockItは、MANIFEST.MFファイルに登録されているJavaAgentを使用して、これをすべて自動的に行います。

Dealing with the client（クライアントへの対処）

これで、コードはWebページを読み取ろうとする部分で失敗しています。

HttpClient httpclient = new DefaultHttpClient();
HttpGet httpget = new HttpGet(url);
HttpResponse response = httpclient.execute(httpget);
HttpEntity entity = response.getEntity();

このコードはメソッドに埋め込まれているため少し複雑ですが、この問題を回避できます。ただし、そのためにはもう少し作業が必要です。

• 最初の2行はnewを呼び出します。new演算子のこれらの使用を制御下のクラスを返すようにする必要があります。
• 次の行は、HttpClientでexecuteメソッドを呼び出すため、それを制御する必要があります。
• 最後の行は、HttpResponseでgetEntityメソッドを呼び出します。これは前の行の戻り値であったため、全体的にかなり複雑です。

これは、これら3つの問題を一度に解決する方法の1つです。

new NonStrictExpectations() {
    DefaultHttpClient httpclient;
    HttpResponse response;
    HttpEntity entity;

    {
        httpclient.execute((HttpUriRequest) any);
        result = response;
        response.getEntity();
        result = entity;
        entity.getContent();
        result = bais;
    }
};

このNonStrictExpectationsの使用では、最初の行にパラメーターが渡されません。つまり、静的なものではなく、何らかの方法でインスタンスを操作しています。この匿名内部クラスには、DefaultHttpClient、HttpResponse、HttpEntityの3つのフィールドがあります。これらのクラスは、このテスト専用のJavaクラスローダーで完全に置き換えられます。これは、たとえば、new DefaultHttpClientを呼び出すと、HttpClient jarにあるバージョンではなく、JMockItによって作成されたクラスのインスタンスが返されることを意味します。

これは、私が動的リンクシームと呼ぶものの例です。これは、Michael Feathersが彼の著書で説明しているリンクシームのようなもので、通常はビルドスクリプト/ファイルマジックで実現されます。ただし、ビルドスクリプトを使用するのと異なり、これはライブラリを使用しているため、言語の外部ではなく、言語「内」のJavaコードで使用できます。

このコードは、これら3つのクラスを置き換えますが、何で置き換えますか？

• HttpClient.executeメソッドは常にresponseを返します。これは、JMockItによって作成されたHttpResponseサブクラスのインスタンスです。
• HttpResponse.getEntityメソッドは常にentityを返します。これは、JMockItによって作成されたHttpEntityサブクラスのインスタンスです。
• HttpEntity.getContentメソッドは常に「bais」を返します。これは次のセクションで説明します。

これは強力なものです。実際、私には個人的な経験則があります。何かがクールだと思うなら、それは実際の開発には適していないかもしれません。JMockItは、私の「クールなスパイダーセンス」を overdriveに刺激します。

Handling File I/O（ファイルI/Oの処理）

基礎となるコードはストリームの内容を必要とします。これを作成するために、テストは標準のJavaマジックを使用してメモリ内ストリームを作成します。

final ByteArrayInputStream bais = new ByteArrayInputStream(
        "<div id=\"converter_results\"><ul><li><b>1 USD = 0.98 EUR</b>"
                .getBytes());

これは、文字列からメモリ内ByteArrayInputStreamを作成します。文字列に何を入れるべきか、どうやって知りましたか？基礎となるコードをリバースエンジニアリングする必要がありました。それでも、これによりコードが実行されます。

Putting it together（まとめ）

これまでのように分割されておらず、単一のメソッドとしてのテストを以下に示します。

@Test
public void returnExpectedConversion_v3() throws Exception {
    final ByteArrayInputStream bais = new ByteArrayInputStream(
            "<div id=\"converter_results\"><ul><li><b>1 USD = 0.98 EUR</b>"
                    .getBytes());

    new NonStrictExpectations() {
        DefaultHttpClient httpclient;
        HttpResponse response;
        HttpEntity entity;

        {
            httpclient.execute((HttpUriRequest) any);
            result = response;
            response.getEntity();
            result = entity;
            entity.getContent();
            result = bais;
        }
    };

    new NonStrictExpectations(CurrencyConversion.class) {
        {
            CurrencyConversion.currencySymbols();
            result = mapFrom("USD", "EUR");
        }
    };
    BigDecimal result = CurrencyConversion.convertFromTo("USD", "EUR");
    assertThat(result.subtract(new BigDecimal(2)), is(lessThanOrEqualTo(new BigDecimal(0.001))));
}

一方では、これは非常に印象的です。コードに触れることなく、エンドツーエンドでコードを実行することができました。このクラスを使用する何かを記述したい場合は、その方法がわかりました。多くの場合、コードに触れる前に、変更を加えた後に何かを壊したかどうかを知るために、テストを行う必要があります。これは、特性テストと呼ばれます。このような記述の悪いコードは、通常、非常に困難になります。それでも難しいですが、少なくとも本番コードに触れることなく実行できます。コードの周りに特性テストがあると、リファクタリングがより安全になります。

これで完了ですね？

違います。

We've addressed the symptom, not the cause（症状に対処したが、原因には対処していない）

JMockItは、ほぼブラックマジックを実現することを可能にしましたが、もっとうまくできますか？試してみると、費やした時間は努力する価値がありますか？このセクションでは、同じメソッドから始めて、コードにいわゆるレガシーリファクタリングをいくつか行い、より従来のツール、この場合は手動で作成されたテストダブルを使用してテストできるようにします。次に、比較、観察を行い、何が可能になるかを見ていきます。

Introduce instance delegator（インスタンスデリゲーターを導入する）

静的メソッドの典型的な問題は、オーバーライドできないことです。これを修正するために、クラスですべてのインスタンスメソッドを使用するようにすることができます。ただし、この例では、下位互換性を維持する必要があるため、静的メソッドをそのままにしておく必要があると仮定しましょう（私の経験では、これは不自然ではありません）。

テストファーストでこれを行おうとするかもしれませんが、実際には既存のJMockItテストがあるため、必要な変更を加えるだけです。これを行うには、CurrencyConversionをv2という名前が追加された新しいパッケージにコピーします（このブログのソースはソースコードから生成されるため、元のバージョンを保持する必要があります）。

インスタンスデリゲーターを導入するには

• クラスの静的インスタンスを導入します。
• 静的メソッドをインスタンスメソッドにコピーします（静的メソッドとインスタンスメソッドの名前とシグネチャが同じにできないため、新しいメソッド名を作成する必要があります）。
• 静的メソッドを変更して、内部静的インスタンスでインスタンスメソッドを呼び出します。

これを行う方法の1つは次のとおりです（内部インスタンスの遅延初期化は意図的なものであり、スレッドの問題が懸念される場合は、二重チェックロックを使用するか、メソッドを同期させることができます）。

private static CurrencyConversion instance;

private static CurrencyConversion getInstance() {
    if (instance == null) {
        instance = new CurrencyConversion();
    }

    return instance;
}

public static BigDecimal convertFromTo(String fromCurrency, String toCurrency) {
    return getInstance().convert(fromCurrency, toCurrency);
}

public static Map<String, String> currencySymbols() {
    return getInstance().getAllCurrencySymbols();
}

Extract a few methods（いくつかのメソッドを抽出する）

メソッドを抽出する機会がいくつかあるため、いくつかのメソッド抽出後のv2 / CurrencyConversionのバージョンを以下に示します。

public BigDecimal convert(String fromCurrency, String toCurrency) {
    validateCurrencies(fromCurrency, toCurrency);

    try {
        String result = getPage(fromCurrency, toCurrency);
        String value = extractToValue(result);
        return new BigDecimal(value);
    } catch (Exception e) {
        throw new RuntimeException(e);
    }
}

protected void validateCurrencies(String fromCurrency, String toCurrency) {
    Map<String, String> symbolToName = currencySymbols();
    if (!symbolToName.containsKey(fromCurrency))
        throw new IllegalArgumentException(String.format(
                "Invalid from currency: %s", fromCurrency));
    if (!symbolToName.containsKey(toCurrency))
        throw new IllegalArgumentException(String.format(
                "Invalid to currency: %s", toCurrency));
}

protected String extractToValue(String result) {
    String theWholeThing = result;
    int start = theWholeThing.lastIndexOf("<div id=\"converter_results\"><ul><li>");
    String substring = result.substring(start);
    int startOfInterestingStuff = substring.indexOf("<b>") + 3;
    int endOfIntererestingStuff = substring.indexOf("</b>",
            startOfInterestingStuff);
    String interestingStuff = substring.substring(
            startOfInterestingStuff, endOfIntererestingStuff);
    String[] parts = interestingStuff.split("=");
    return parts[1].trim().split(" ")[0];
}

protected String getPage(String fromCurrency, String toCurrency) throws URISyntaxException, IOException, HttpException {
    String url = String.format("http://www.gocurrency.com/v2/dorate.php?inV=1&from=%s&to=%s&Calculate=Convert", toCurrency, fromCurrency);
    HttpClient httpclient = new DefaultHttpClient();
    HttpGet httpget = new HttpGet(url);
    HttpResponse response = httpclient.execute(httpget);
    HttpEntity entity = response.getEntity();
    StringBuffer result = new StringBuffer();
    if (entity != null) {
        InputStream instream = entity.getContent();
        InputStreamReader irs = new InputStreamReader(instream);
        BufferedReader br = new BufferedReader(irs);
        String l;
        while ((l = br.readLine()) != null) {
            result.append(l);
        }
    }
    return result.toString();
}

このクラス（v2パッケージにあるクラス）を対象とした最後のテストのバージョンを以下に示します。このテストは合格します。

@Test
public void returnExpectedConversion_v4() throws Exception {
    final ByteArrayInputStream bais = new ByteArrayInputStream(
            "<div id=\"converter_results\"><ul><li><b>1 USD = 0.98 EUR</b>"
                    .getBytes());

    new NonStrictExpectations() {
        DefaultHttpClient httpclient;
        HttpResponse response;
        HttpEntity entity;

        {
            httpclient.execute((HttpUriRequest) any);
            result = response;
            response.getEntity();
            result = entity;
            entity.getContent();
            result = bais;
        }
    };

    new NonStrictExpectations(CurrencyConversion.class) {
        {
            CurrencyConversion.currencySymbols();
            result = mapFrom("USD", "EUR");
        }
    };
    BigDecimal result = CurrencyConversion.convertFromTo("USD", "EUR");
    assertThat(result.subtract(new BigDecimal(2)), is(lessThanOrEqualTo(new BigDecimal(0.001))));
}

Testing subclass（サブクラスのテスト）

次に、JMockItの代わりに手書きのテストダブルを使用して、このテストを書き直します。すべての中間手順を表示するのではなく、最終結果のみを表示します。

class CurrencyConversion2_testingSubclass extends CurrencyConversion {
    @Override
    public void validateCurrencies(String fromCurrency, String toCurrency) {
    }

    @Override
    public Map<String, String> getAllCurrencySymbols() {
        return mapFrom("USD", "EUR");
    }

    @Override
    public String getPage(String fromCurrency, String toCurrency) {
        return "<div id=\"converter_results\"><ul><li><b>1 USD = 0.98 EUR</b>";
    }
}

@Test
public void returnExpectedConversion_v5() throws Exception {
    CurrencyConversion original = CurrencyConversion.reset(new CurrencyConversion2_testingSubclass());

    BigDecimal result = CurrencyConversion.convertFromTo("USD", "EUR");

    assertThat(result.subtract(new BigDecimal(2)), is(lessThanOrEqualTo(new BigDecimal(0.001))));

    CurrencyConversion.reset(original);
}

このテストは、多くの作業を手動で行うJMockItテストと同じ結果を生成します。

注意：これを可能にするには、新しく作成されたシングルトンクラスを設定およびリセットできるようにする必要があります。

public static CurrencyConversion reset(CurrencyConversion other) {
    CurrencyConversion original = instance;
    instance = other;
    return original;
}

Actual amount of time to do this（これを実行する実際の時間）

オーバーライド可能な静的シングルトンと、抽出されたメソッドをいくつか使用してインスタンスデリゲーターを導入するというこの手法は、かなり多くの作業のように思えるかもしれません。実際には、この種の変更は迅速です。どれくらい速いですか？この例では、IntelliJを使用して3分かかりました。Eclipseでも同じ時間がかかっています。viでは、おそらく1分です（まあ、そうではないかもしれませんが、Eclipse、IntelliJ、さらにはVisual Studioでもviプラグインを使用しています）。いずれにせよ、一度練習すれば、すぐにできます。クラスが最初からすべての静的メソッドを使用していなければ、これを much of this を回避できたかもしれませんが、それは一般的な問題であるため、その対処方法を知ることは、知っておくべき一般的なテクニックです。

Yes, but...（しかし...）

提起される一般的な懸念は、抽出されたすべてのメソッドを保護することについてです。テスト可能性は設計よりも重要だと考えているため、それは私を悩ませません。それは実際には誤った二分法ですが、物議を醸すように聞こえるので、とにかく私はそれを言うのが好きです。実際、これらの「保護されたメソッド」の多くは、個々のクラスを保証するのに十分複雑です。次に、依存関係の逆転を導入すると、突然、制御下にある依存オブジェクトを配線し、オーバーライド可能なメソッドを使用して、この全体的なフローの個々の部分をチェックすることがスナップになります。分割して征服する。

First test versus second test（最初のテストと2番目のテスト）

比較のために、2つのテストをもう一度示します。

JMockItを使用する

@Test
public void returnExpectedConversion_v4() throws Exception {
    final ByteArrayInputStream bais = new ByteArrayInputStream(
            "<div id=\"converter_results\"><ul><li><b>1 USD = 0.98 EUR</b>"
                    .getBytes());

    new NonStrictExpectations() {
        DefaultHttpClient httpclient;
        HttpResponse response;
        HttpEntity entity;

        {
            httpclient.execute((HttpUriRequest) any);
            result = response;
            response.getEntity();
            result = entity;
            entity.getContent();
            result = bais;
        }
    };

    new NonStrictExpectations(CurrencyConversion.class) {
        {
            CurrencyConversion.currencySymbols();
            result = mapFrom("USD", "EUR");
        }
    };
    BigDecimal result = CurrencyConversion.convertFromTo("USD", "EUR");
    assertThat(result.subtract(new BigDecimal(2)), is(lessThanOrEqualTo(new BigDecimal(0.001))));
}

手動で作成されたモックとリファクタリングを使用する

class CurrencyConversion2_testingSubclass extends CurrencyConversion {
    @Override
    public void validateCurrencies(String fromCurrency, String toCurrency) {
    }

    @Override
    public Map<String, String> getAllCurrencySymbols() {
        return mapFrom("USD", "EUR");
    }

    @Override
    public String getPage(String fromCurrency, String toCurrency) {
        return "<div id=\"converter_results\"><ul><li><b>1 USD = 0.98 EUR</b>";
    }
}

@Test
public void returnExpectedConversion_v5() throws Exception {
    CurrencyConversion original = CurrencyConversion.reset(new CurrencyConversion2_testingSubclass());

    BigDecimal result = CurrencyConversion.convertFromTo("USD", "EUR");

    assertThat(result.subtract(new BigDecimal(2)), is(lessThanOrEqualTo(new BigDecimal(0.001))));

    CurrencyConversion.reset(original);
}

テストコードをサポートする必要がある場合、どちらのバージョンを選択しますか？ちょっと待って、まだ答えないでください。

First test still passes（最初のテストはまだ合格する）

プロダクションコードに何度か変更を加えたにもかかわらず、JMockItテストが依然としてパスすることに改めて注目したいと思います。これは私にとって非常に興味深いことです。実際、JMockItがクラスローダーをどのように操作するかという観点から考えると、理にかなっています。それでも、やはり非常にクールです。

What if we try with JMockIt again（JMockItでもう一度試してみるとどうなるか）

ここで立ち止まる必要はありません。プロダクションコードに加えられた変更を考慮して、JMockItテストを書き直してみるとどうなるでしょうか？

@Test
public void returnExpectedConversion_final() throws Exception {
    new NonStrictExpectations(CurrencyConversion.class) {
        CurrencyConversion c;
        {
            c.validateCurrencies(anyString, anyString);
            c.getPage(anyString, anyString);
            result = "<div id=\"converter_results\"><ul><li><b>1 USD = 0.98 EUR</b>";
        }
    };
    BigDecimal result = CurrencyConversion.convertFromTo("USD", "EUR");
    assertThat(result.subtract(new BigDecimal(2)), is(lessThanOrEqualTo(new BigDecimal(0.001))));
}

さて、あなたはどちらをメンテナンスしたいですか？

少しのリファクタリングを行うことで、最終的なJMockItテストが大幅に改善されることに注目してください。実際、このバージョンのテストを作成するために必要なリファクタリングの量は、私が実際に行ったリファクタリングの量よりも少なくなっています。メソッドを抽出するだけで、JMockItテストを大幅に改善できたはずです。ただし、JMockItはこれを強制しなかったことに注意してください。モッキングツールを使用しない場合、またはMockitoのようなツールを使用する場合は、このクラスをテスト対象にするために、ある程度のリファクタリングを行う必要がありました。