try～catchでの例外処理のテストコード記述について

Question

###前提・実現したいこと
NUnitを利用してテストコードを記述しています。テストしたいクラスの処理内でtry～catchをして、
処理結果をEnumで返却しているのですが、任意の例外を発生させて、処理結果のEnumが正しいかを
テストしたいです。
今回の場合だと、HTTP通信の処理なので、TaskCanceledException（タイムアウト）といった例外が
それになるのですが、何か良い方法はないでしょうか？よろしくお願いします。

###サンプルソース
処理結果（Enum）

public enum ResultType
{
    OK,
    NG,
    Timeout
}

TargetClassTest.cs

[TestCase(ResultType.OK)]
[TestCase(ResultType.NG)]
[TestCase(ResultType.Timeout)]
public async Task ExecuteHttpRequestAsyncTest(ResultType result)
{
    var tagetClass = new TargetClass();
    ResultType resultType = await targetClass.ExecuteHttpRequestAsync();

    // 結果確認
    Assert.AreEqual(result, resultType);
}

TargetClass.cs

public async Task<ResultType> ExecuteHttpRequestAsync()
{
    try
    {
        var client = new HttpCient();
        var reqMessage = new HttpRequestMessage();
        
     // 中略
        
        // HTTPリクエスト送信
        using(HttpResponseMessage response = await client.SendAsync(reqMessage)
        {
            if(response.StatusCode == HttpStatusCode.OK)
            {
                 // リクエスト成功
                 return ResultType.OK;
            }
            else
            {
                 // リクエスト失敗
                 return ResultType.NG;
            }
        }
    }
    catch(TaskCanceledException)
    {
        // タイムアウト
        return ResultType.Timeout;
    }
}

Answer 1

まず質問への回答の前に注意点を一つ。
HttpClientはIDisposableを実装しているのでちゃんとDisposeしましょう。

可能であればTak1waさんの言っているDIを実装した方がいいです。
DIっていうのは、以下みたいに書き換えることです。

public class TargetClass : IDisposable
{
    private readonly HttpClient httpClient;

    // これがDI、依存性注入ということ
    public TargetClass(HttpClient httpClient)
    {
        this.httpClient = httpClient;
    }

    public async Task<ResultType> ExecuteHttpRequestAsync()
    {
        try
        {
            var reqMessage = new HttpRequestMessage();

            // 中略

            // HTTPリクエスト送信
            using (HttpResponseMessage response = await httpClient.SendAsync(reqMessage)
            {
                if (response.StatusCode == HttpStatusCode.OK)
                {
                    // リクエスト成功
                    return ResultType.OK;
                }
                else
                {
                    // リクエスト失敗
                    return ResultType.NG;
                }
            }
        }
        catch (TaskCanceledException)
        {
            // タイムアウト
            return ResultType.Timeout;
        }
    }
}

HttpClientはFakes使わなくてもHttpMessageHandlerを使って挙動が変更できます。
HttpMessageHandlerのメソッド内で常に例外を返すようにしてもいいですし、複雑なシナリオに対応する場合にはこういったモック用のハンドラを使うことができます。

後は、テストコードで期待する挙動のHttpMessageHandler継承クラスを渡してあげればいいです。

[TestCase(ResultType.OK)]
[TestCase(ResultType.NG)]
[TestCase(ResultType.Timeout)]
public async Task ExecuteHttpRequestAsyncTest(ResultType result)
{
    using(var client = new HttpClient(new WillThrowHandler()))
    {
        var tagetClass = new TargetClass(client);
        ResultType resultType = await targetClass.ExecuteHttpRequestAsync();

        // 結果確認
        Assert.AreEqual(result, resultType);
    }
}

ただ、上記のコード、HttpClientがIDisposableを継承するために呼び出しの処理が変わってしまいます。
それも嫌って動作を変えるとなると…HttpClientの挙動をファクトリを変更する感じで実装ですかね。
ただまあ…そのためだけにこんなメソッドがテスト以外でもコンストラクタにつくと気持ち悪いですけどね。。

public class TargetClass : IDisposable
{
    private static readonly Func<HttpClient> DefaultFactory = () => new HttpClient();
    private readonly Func<HttpClient> httpClientFactory;

    public TargetClass()
    {
        this.httpClientFactory = DefaultFactory;
    }
    public TargetClass(Func<HttpClient> httpClientFactory)
    {
        this.httpClientFactory = httpClientFactory;
    }

    public async Task<ResultType> ExecuteHttpRequestAsync()
    {
        try
        {
            using (var client = httpClientFactory())
            {
                var reqMessage = new HttpRequestMessage();

                // 中略

                // HTTPリクエスト送信
                using (HttpResponseMessage response = await client.SendAsync(reqMessage)
                {
                    if (response.StatusCode == HttpStatusCode.OK)
                    {
                        // リクエスト成功
                        return ResultType.OK;
                    }
                    else
                    {
                        // リクエスト失敗
                        return ResultType.NG;
                    }
                }
            }
        }
        catch (TaskCanceledException)
        {
            // タイムアウト
            return ResultType.Timeout;
        }
    }
}

この場合呼び出し方はこうなります。

[TestCase(ResultType.OK)]
[TestCase(ResultType.NG)]
[TestCase(ResultType.Timeout)]
public async Task ExecuteHttpRequestAsyncTest(ResultType result)
{
    var tagetClass = new TargetClass(() => new HttpClient(new WillThrowHandler()));
    ResultType resultType = await targetClass.ExecuteHttpRequestAsync();

    // 結果確認
    Assert.AreEqual(result, resultType);
}

Comments

[退会済みユーザー]

大変遅くなりました。申し訳ありません。
上記の方法でトライしてみます。ありがとうございました。

Answer 2

こんにちは。

簡単なのはDIっぽく、外部からHttpClient差し込めるように設計を見直すことです。
例外吐くテストHttpClientをテストコードから渡しましょう。

---

それが出来ないのであれば、Microsoft FakesでHttpClientの動作を変更しましょう。

Isolating Code Under Test with Microsoft Fakes

ただし、

• Enterprise Edition以上
• NUnitで動くのか自信ない…MSTestならできる

個人的にはHttpClient差し込めるようにするか例外処理を分離したほうが良い気もしますが。

Comments

[退会済みユーザー]

ご回答ありがとうございます。
知識不足で申し訳ありません。「HttpClientを差し込む」というのは
具体的にどういうことを指しているのでしょうか？ご教示ください。

[Tak1wa]

HttpClientの子クラスまたはインターフェースを使おうと思ったのですが、何も挟んでなかったですね…。単純にはできなさそうです。

```
var resultType = await targetClass.ExecuteHttpRequestAsync(new StabHttpClient());
```