ASP.Net MVCでコントローラーの要求をモックする方法は？

ASP.Net MVCフレームワークを使用したC＃のコントローラーがあります

public class HomeController:Controller{
  public ActionResult Index()
    {
      if (Request.IsAjaxRequest())
        { 
          //do some ajaxy stuff
        }
      return View("Index");
    }
}

私はモックに関するいくつかのヒントを得て、以下とRhinoMocksでコードをテストしたいと思っていました

var mocks = new MockRepository();
var mockedhttpContext = mocks.DynamicMock<HttpContextBase>();
var mockedHttpRequest = mocks.DynamicMock<HttpRequestBase>();
SetupResult.For(mockedhttpContext.Request).Return(mockedHttpRequest);

var controller = new HomeController();
controller.ControllerContext = new ControllerContext(mockedhttpContext, new RouteData(), controller);
var result = controller.Index() as ViewResult;
Assert.AreEqual("About", result.ViewName);

ただし、このエラーが発生し続けます。

例外System.ArgumentNullException：System.ArgumentNullException：値をnullにすることはできません。パラメーター名：System.Web.Mvc.AjaxRequestExtensions.IsAjaxRequest（HttpRequestBase request）での要求

Requestコントローラ上のオブジェクトにはセッターがないので。以下の回答から推奨されるコードを使用して、このテストを適切に機能させるようにしました。

これは、RhinoMocksの代わりにMoqを使用しました。Moqを使用する場合、同じテストに以下を使用します。

var request = new Mock<HttpRequestBase>();
// Not working - IsAjaxRequest() is static extension method and cannot be mocked
// request.Setup(x => x.IsAjaxRequest()).Returns(true /* or false */);
// use this
request.SetupGet(x => x.Headers["X-Requested-With"]).Returns("XMLHttpRequest");

var context = new Mock<HttpContextBase>();
context.SetupGet(x => x.Request).Returns(request.Object);
var controller = new HomeController(Repository, LoginInfoProvider);
controller.ControllerContext = new ControllerContext(context.Object, new RouteData(), controller);
var result = controller.Index() as ViewResult;
Assert.AreEqual("About", result.ViewName);

しかし、次のエラーが発生します：

例外System.ArgumentException：System.ArgumentException：無効でないメンバーの無効なセットアップ：x => x.Headers ["X-Requested-With"] at Moq.Mock.ThrowIfCantOverride（Expression setup、MethodInfo methodInfo）

繰り返しますが、リクエストヘッダーを設定できないようです。RhinoMocksまたはMoqでこの値を設定するにはどうすればよいですか？

Moqの使用：

var request = new Mock<HttpRequestBase>();
// Not working - IsAjaxRequest() is static extension method and cannot be mocked
// request.Setup(x => x.IsAjaxRequest()).Returns(true /* or false */);
// use this
request.SetupGet(x => x.Headers).Returns(
    new System.Net.WebHeaderCollection {
        {"X-Requested-With", "XMLHttpRequest"}
    });

var context = new Mock<HttpContextBase>();
context.SetupGet(x => x.Request).Returns(request.Object);

var controller = new YourController();
controller.ControllerContext = new ControllerContext(context.Object, new RouteData(), controller);

更新しました：

モックRequest.Headers["X-Requested-With"]またはのRequest["X-Requested-With"]代わりにRequest.IsAjaxRequest()。

NSubstituteを使用している人のために、私は上記の回答を変更して次のようなことをすることができました...（ここで、Detailsはコントローラーのアクションメソッド名です）

 var fakeRequest = Substitute.For<HttpRequestBase>();
        var fakeContext = Substitute.For<HttpContextBase>();
        fakeRequest.Headers.Returns(new WebHeaderCollection { {"X-Requested-With", "XMLHttpRequest"}});
        fakeContext.Request.Returns(fakeRequest);
        controller.ControllerContext = new ControllerContext(fakeContext, new RouteData(), controller);
        var model = new EntityTypeMaintenanceModel();

        var result = controller.Details(model) as PartialViewResult;

        Assert.IsNotNull(result);
        Assert.AreEqual("EntityType", result.ViewName);

RhinoMocksを使用した実用的なソリューションを次に示します。私はhttp://thegrayzone.co.uk/blog/2010/03/mocking-request-isajaxrequest/で見つけたMoqソリューションに基づいています

public static void MakeAjaxRequest(this Controller controller)
{
        MockRepository mocks = new MockRepository();

        // Create mocks
        var mockedhttpContext = mocks.DynamicMock<HttpContextBase>();
        var mockedHttpRequest = mocks.DynamicMock<HttpRequestBase>();

        // Set headers to pretend it's an Ajax request
        SetupResult.For(mockedHttpRequest.Headers)
            .Return(new WebHeaderCollection() {
                {"X-Requested-With", "XMLHttpRequest"}
            });

        // Tell the mocked context to return the mocked request
        SetupResult.For(mockedhttpContext.Request).Return(mockedHttpRequest);

        mocks.ReplayAll();

        // Set controllerContext
        controller.ControllerContext = new ControllerContext(mockedhttpContext, new RouteData(), controller);
}

Is AjaxRequestは拡張メソッドです。したがって、Rhinoを使用して次のように実行できます。

    protected HttpContextBase BuildHttpContextStub(bool isAjaxRequest)
    {
        var httpRequestBase = MockRepository.GenerateStub<HttpRequestBase>();   
        if (isAjaxRequest)
        {
            httpRequestBase.Stub(r => r["X-Requested-With"]).Return("XMLHttpRequest");
        }

        var httpContextBase = MockRepository.GenerateStub<HttpContextBase>();
        httpContextBase.Stub(c => c.Request).Return(httpRequestBase);

        return httpContextBase;
    }

    // Build controller
    ....
    controller.ControllerContext = new ControllerContext(BuildHttpContextStub(true), new RouteData(), controller);

あなたがこれを探しているように見えます、

 var requestMock = new Mock<HttpRequestBase>();
 requestMock.SetupGet(rq => rq["Age"]).Returns("2001");

コントローラーでの使用：

 public ActionResult Index()
 {
        var age = Request["Age"]; //This will return 2001
 }

次のように、HttpContextBaseをモックしてControllerContextプロパティに配置する必要があります。

controller.ControllerContext = 
new ControllerContext(mockedHttpContext, new RouteData(), controller);

IsAjaxRequest()ユニットテスト中にfalseを返すようにするには、以下に示すように、テストメソッドでリクエストヘッダーとリクエストコレクション値の両方を設定する必要があります。

_request.SetupGet(x => x.Headers).Returns(new System.Net.WebHeaderCollection { { "X-Requested-With", "NotAjaxRequest" } });
_request.SetupGet(x=>x["X-Requested-With"]).Returns("NotAjaxRequest");

両方を設定する理由は、以下に示すIsAjaxRequest（）の実装では隠されています。

public static bool IsAjaxRequest(this HttpRequestBase request)<br/>
{ 
    if (request == null)
    {
        throw new ArgumentNullException("request");
    }
    return ((request["X-Requested-With"] == "XMLHttpRequest") || ((request.Headers != null) && (request.Headers["X-Requested-With"] == "XMLHttpRequest")));
}

リクエストコレクションとヘッダーの両方を使用するため、ヘッダーとリクエストコレクションの両方の設定を作成する必要があります。

これは、ajaxリクエストでない場合にfalseを返すリクエストを作成します。これをtrueに戻すには、次のようにします。

_httpContext.SetupGet(x => x.Request["X-Requested-With"]).Returns("XMLHttpRequest");

次のように、Web API中にリクエストにHttpRequestMessageオブジェクトを追加する別の方法を見つけました

[Test]
public void TestMethod()
{
    var controllerContext = new HttpControllerContext();
    var request = new HttpRequestMessage();
    request.Headers.Add("TestHeader", "TestHeader");
    controllerContext.Request = request;
    _controller.ControllerContext = controllerContext;

    var result = _controller.YourAPIMethod();
    //Your assertion
}

（パーティーには少し遅れましたが、別のルートに行ったので、共有したいと思いました）

Httpクラスのモックを作成せずにこれをテストする純粋なコード/モックの方法に進むには、パラメーターとしてリクエストを受け取り、次に必要なプロパティを公開するInitialiseメソッドを持つIControllerHelperを実装しました。例：

    public interface IControllerHelper
    {
        void Initialise(HttpRequest request);
        string HostAddress { get; }
    }

    public class ControllerHelper : IControllerHelper
    {
        private HttpRequest _request;
        
        public void Initialise(HttpRequest request)
        {
            _request = request;
        }

        public string HostAddress =>  _request.GetUri().GetLeftPart(UriPartial.Authority);
    }

次に、コントローラーで、メソッドの開始時に初期化を呼び出します。

        _controllerHelper.Initialise(Request);

そして、私のコードはモック可能な依存関係にのみ依存しています。

        return Created(new Uri($"{_controllerHelper.HostName}/api/MyEndpoint/{result.id}"), result);

機能テストの場合は、構成のiControllerHelperを代わりにオーバーライドするだけです。