Sitecore.Mvc.Presentation.RenderingContextを使用してGlassControllerアクションをテストする方法

Question

私はsitecoreの開発者です。 "EmailArticleController"コントローラのロジックをテストするためのサンプルSitecoreヘリックスユニットテストプロジェクトを作成したいインデックス（）アクションメソッド：

using Sitecore.Mvc.Presentation; 

public class EmailArticleController : GlassController 
{ 
    //logic in below Index() method is what I want to test 
    public override ActionResult Index() 
    { 
     var _emailArticleBusiness = new EmailArticleBusiness(); 
     var model = _emailArticleBusiness.FetchPopulatedModel; 
     var datasourceId = RenderingContext.Current.Rendering.DataSource; 
     _emailArticleBusiness.SetDataSourceID(datasourceId); 

     return View("~/Views/EmailCampaign/EmailArticle.cshtml", model); 
    } 

    //below is alternative code I wrote for mocking and unit testing the logic in above Index() function 
    private readonly IEmailArticleBusiness _businessLogic; 
    private readonly RenderingContext _renderingContext; 

    public EmailArticleController(IEmailArticleBusiness businessLogic, RenderingContext renderingContext) 
    { 
     _businessLogic = businessLogic; 
     _renderingContext = renderingContext; 
    } 

    public ActionResult Index(int forUnitTesting) 
    { 
     var model = _businessLogic.FetchPopulatedModel; 
     // *** do below two lines of logic somehow go into my Unit Testing class? How? 
     var datasourceId = _renderingContext.Rendering.DataSource; 
     _businessLogic.SetDataSourceID(datasourceId); 
     // *** 
     return View("~/Views/EmailCampaign/EmailArticle.cshtml", model); 
    } 
} 

OKこれは私が私のユニットテストクラスに持っているものです。

[TestClass] 
public class UnitTest1 
{ 
    [TestMethod] 
    public void Test_EmailArticleController_With_RenderingContext() 
    { 
     //Arrange 
     var businessLogicFake = new Mock<IEmailArticleBusiness>(); 

     var model = new EmailArticleViewModel() 
     { 
      ArticleControl = new Article_Control() { }, 
      Metadata = new Metadata() { } 
     }; 

     businessLogicFake.Setup(x => x.FetchPopulatedModel).Returns(model); 

     // I'm not sure about the next 3 lines, how do I mock the RenderingContext and send it into the constructor, given that it needs a DataSource value too? 
     var renderingContext = Mock.Of<Sitecore.Mvc.Presentation.RenderingContext>(/*what goes here, if anything?*/) { /*what goes here, if anything?*/ }; 

     EmailArticleController controllerUnderTest = new EmailArticleController(businessLogicFake.Object, renderingContext); 

     var result = controllerUnderTest.Index(3) as ViewResult; 

     Assert.IsNotNull(result); 
    } 
} 

は基本的に私はそれが（文字列）を持っていることを確認し、レンダリングコンテキストをモックとしたいデータソース値は "/ sitecore/home/..."のような値に設定され、私はそれをコントローラのコンストラクタに送信して（適切な方法であれば）、Index（int）メソッドを呼び出すと同時に、_businessLogic（この場合のインタフェースのみ）を確認します？）は、ビューを返す前に同じ値にdataSourceを設定しています。

これを実行するための正確なコードは何ですか？ありがとう！

Answer 1

コードをRenderingContext.Current.Rendering.DataSourceのような静的な依存関係に強く結合すると、コードを孤立してテストするのが難しくなります。

RenderingContextへの静的アクセスをカプセル化するためのラッパーを作成することをお勧めします。あなたは、あなたが今するすべての依存関係を模擬することができます明示的にコンストラクタ・インジェクション

public class EmailArticleController : GlassController { 
    private readonly IEmailArticleBusiness businessLogic; 
    private readonly IRenderingContext renderingContext; 

    public EmailArticleController(IEmailArticleBusiness businessLogic, IRenderingContext renderingContext) { 
     this.businessLogic = businessLogic; 
     this.renderingContext = renderingContext; 
    } 

    public ActionResult Index() { 
     var model = businessLogic.FetchPopulatedModel; 
     var datasourceId = renderingContext.GetDataSource(); 
     businessLogic.SetDataSourceID(datasourceId); 
     return View("~/Views/EmailCampaign/EmailArticle.cshtml", model); 
    } 
} 

を経由してその抽象化に依存するように、あなたのコントローラーを更新してしまうGitHubの

public interface IRenderingContext { 
    string GetDataSource(); 
} 

//... 

using Sitecore.Mvc.Presentation; 

public class RenderingContextWrapper : IRenderingContext { 
    public string GetDataSource(){ 
     return RenderingContext.CurrentOrNull.Rendering.DataSource; 
    } 
} 

上Glass.Mapperリポジトリで見つけたコード例を参照すると、コントローラを単独でテストすることができます。

[TestClass] 
public class UnitTest1 { 
    [TestMethod] 
    public void Test_EmailArticleController_With_RenderingContext() { 
     //Arrange 
     var businessLogicFake = new Mock<IEmailArticleBusiness>(); 

     var model = new EmailArticleViewModel() { 
      ArticleControl = new Article_Control() { }, 
      Metadata = new Metadata() { } 
     }; 

     businessLogicFake.Setup(x => x.FetchPopulatedModel).Returns(model); 

     var datasourceId = "fake_datasourceId"; 
     var renderingContext = Mock.Of<IRenderingContext>(_ => _.GetDataSource() == datasourceId); 

     var controllerUnderTest = new EmailArticleController(businessLogicFake.Object, renderingContext); 

     //Act 
     var result = controllerUnderTest.Index() as ViewResult; 

     //Assert 
     Assert.IsNotNull(result); 
     businessLogicFake.Verify(_ => _.SetDataSourceID(datasourceId), Times.AtLeastOnce()); 
    } 
} 

本番コードは明らかに依存関係の実行時の解像度のためのあなたのDIコンテナと抽象化と実装を登録します。