如何对SharePoint加载项进行单元测试？

Question

I would like to remove the SharePoint dependencies and mock them out. The default Index action loos like the following in the new SharePoint add-in template:

    public ActionResult Index()
    {
        User spUser = null;
        var spContext = SharePointContextProvider.Current.GetSharePointContext(HttpContext);
        using (var clientContext = spContext.CreateUserClientContextForSPHost())
        {
            if (clientContext != null)
            {
                spUser = clientContext.Web.CurrentUser;
                clientContext.Load(spUser, user => user.Title);
                clientContext.ExecuteQuery();
                ViewBag.UserName = spUser.Title;
            }
        }
        return View();
    }

I have tried to package the ClientContext into an adapter, but cannot mock out Web property:

public interface IClientContext
{
    Web Web { get; }
    void Load<T>(T clientObject, params Expression<Func<T, object>>[] retrievals) where T : ClientObject;
    void ExecuteQuery();
}

public class ClientContextAdapter : IClientContext
{
    private readonly ClientContext _wrappedClient;
    public ClientContextAdapter(ClientContext client)
    {
        _wrappedClient = client;
    }

    public Web Web => _wrappedClient.Web;

    public void Load<T>(T clientObject, params Expression<Func<T, object>>[] retrievals) where T : ClientObject
    {
        _wrappedClient.Load(clientObject, retrievals);
    }
    public void ExecuteQuery()
    {
        _wrappedClient.ExecuteQuery();
    }
}

How do you unit test your SharePoint add-ins?

Answer 1

Found a solution, so SharePoint dependency can mocked out in the following way. Web should be packed into an adapter as well:

public interface IWeb
{
    User CurrentUser { get; }
}

public class WebAdapter : IWeb
{
    private readonly Web _wrappedClient;
    public WebAdapter(Web client)
    {
        _wrappedClient = client;
    }

    public User CurrentUser => _wrappedClient.CurrentUser;
}

ClientContext adapter with Web adapter inside:

public interface IClientContext
{
    IWeb Web { get; }
    void Load<T>(T clientObject, params Expression<Func<T, object>>[] retrievals) where T : ClientObject;
    void ExecuteQuery();
}

public class ClientContextAdapter : IClientContext
{
    private readonly ClientContext _wrappedClient;
    public ClientContextAdapter(ClientContext client)
    {
        _wrappedClient = client;
    }

    public IWeb Web => new WebAdapter(_wrappedClient.Web);

    public void Load<T>(T clientObject, params Expression<Func<T, object>>[] retrievals) where T : ClientObject
    {
        _wrappedClient.Load(clientObject, retrievals);
    }

    public void ExecuteQuery()
    {
        _wrappedClient.ExecuteQuery();
    }
}

ClientContext dependency removed from HomeController with poor man's dependency injection:

     IClientContext _clientContext;

    #region Constructors
    public HomeController()
    {
        // Called by MVC
    }

    public HomeController(IClientContext clientContext)
    {
        _clientContext = clientContext;
    }
    #endregion

    [SharePointContextFilter]
    public ActionResult Index()
    {
        if (_clientContext == null)
        {
            var spContext = SharePointContextProvider.Current.GetSharePointContext(HttpContext);
            _clientContext = new ClientContextAdapter(spContext.CreateUserClientContextForSPHost());
        }

        if (_clientContext != null)
        {
            User spUser = _clientContext.Web.CurrentUser;
            _clientContext.Load(spUser, user => user.Title);
            _clientContext.ExecuteQuery();
            ViewBag.UserName = spUser.Title;
        }

        return View();
    }

The unit test of Index action with Moq and FluentAssertions:

[TestClass]
class HomeControllerTests
{
    private HomeController _homeController;

    [TestInitialize]
    public void Init()
    {
        // Arrange
        var user = new User(new ClientContext("http://localhost"), 
            new ObjectPathConstructor(new ClientContext("http://localhost"), string.Empty, null));
        user.Title = "TestUser";
        var mockWeb = new Mock<IWeb>();
        mockWeb.SetupGet(w => w.CurrentUser).Returns(user);
        var mockClient = new Mock<IClientContext>();
        mockClient.SetupGet(c => c.Web).Returns(mockWeb.Object);

        _homeController = new HomeController(mockClient.Object);
    }

    [TestMethod]
    public void Index()
    {
        // Act
        var result = (ViewResult)_homeController.Index();

        // Assert
        result.Should().BeViewResult();
        string userName = result.ViewBag.UserName;
        userName.Should().Be("TestUser");
    }
}