ASP.NETアプリをVS2010で単体テスト - テスト対象コードにMembership.GetUser() が埋め込まれている場合

単体テストの話。

コードをテスト可能に保っておくことは大事だが、どうしてもそうもいってられないレガシーなコードだって現場にはある。

たとえば、ASP.NET Webアプリのコードで、テスト対象のコード中に Membership.GetUser() が埋め込まれている場合。

MembershipUser インスタンスを引数越しに渡すようにリファクタするのが王道だとは思う。
しかし、その改良に伴う変更コストやデグレートのリスクが高くなる場合も多々ある。
なんせ、レガシーで単体テストがそれまでなかったのだから。
「テストが先か、リファクタが先か」みたいな話になって、リファクタするのも命がけなのである。

ちなみに、VS2010で .aspx.cs 中のメソッド内で右クリック > 単体テストを作成、とやると、Webホスト環境での単体テストができるようにしてくれる。

でも自分的にはこれはちょっと許せない。
だって、Web ホスト環境を構築するのに絶対パスが属性に埋め込まれるじゃないですか。
これでは開発メンバー間や、ソースコードのブランチ間でテストの共有が難しいですよ。

じゃぁ、どうするんだよ? ということで。
TestInitialize のタイミングで、HttpContext を偽装すればよいのだと思う。

実際にやってみた。

実は HttpContext.Current 静的プロパティは、取得(参照、get)だけでなく、設定(set)も可能である。
なので、自前で作り上げた HttpContext オブジェクトを設定可能だ。

また、Membership.GetUser() では、Thread.CurrentPrincipal 静的プロパティを参照して、現在のプリンシパルを取得し、あとはメンバシッププロバイダに問い合わせて MembershipUser インスタンスを生成して返している模様。
この Thread.CurrentPrincipal 静的プロパティも、設定(set)が可能だ。

そこで、まずは、

• ダミーのプリンシパル、
• およびそのプリンシパルが集約するダミーアイデンティティ

を作成する。

こんな感じ。

public class TestIdentity : IIdentity
{
　public string AuthenticationType { get { return "Test"; } }
　public bool IsAuthenticated { get { return true; } }
　public string Name { get; set; }
}

public class TestPrincipal : IPrincipal
{
　public IIdentity Identity { get; set; }
　public bool IsInRole(string role) { return true; }
}

あとはこうして用意した TestPrincipal 型、TestIdentity 型のインスタンスを生成し、組み上げ、ダミーの HttpContext インスタンスを生成して、適宜先述の静的プロパティに設定してやればよい。

var httpContext = new HttpContext(
　new HttpRequest("test.txt", "http://localhost/test.txt", ""),
　new HttpResponse(new StringWriter()));
httpContext.User = new TestPrincipal { Identity = new TestIdentity { Name = "taro" } };
HttpContext.Current = httpContext;
Thread.CurrentPrincipal = httpContext.User;

以上のようなコードを TestInitialize などのタイミングで実行しておく。
これでユーザー名 "taro" で認証済みの状態で、単体テストが動くようになる。

あとは単体テストプロジェクトの App.config (プロジェクトに無ければ、適宜新規追加) にメンバシッププロバイダの設定を行い、ユーザー名 = "taro" で適切な MembershipUser が返るようにしておけばよい。