Unit Testing in SharePoint 2010

Unit Testing in
SharePoint 2010
Chris Weldon
Dallas TechFest 2011

Before We Begin

http://slidesha.re/ http://spkr8.com/t/8140

git://github.com/neraath/testing-in-sp2010.git

Your Guide: Chris Weldon

• Fightin’ Texas Aggie

• .Net and PHP Developer

• UNIX and Windows Sysadmin

• Sr. Consultant at Improving Enterprises

• chris@chrisweldon.net

Agile, Microsoft, Open Technologies, UX
Applied Training, Coaching, Mentoring
Certiﬁed Consulting
Rural Sourcing
Recruiting Services

Assumptions

• You develop software
• You unit test
• You know the SharePoint API (or can follow along)

Standard Testing Practices
A Common Problem
namespace SharePointLogic
{
public class ClassWithDependencies
{
private IDataRepository repository;

public ClassWithDependencies(IDataRepository repo)
{
this.repository = repo;
}

public INode GetNodeByName(string name)
{
return this.repository.Where(x => x.Name.Equals(name))
.Select();
}
}
}

public IList<SPUser> GetUsersInSiteCollection(string siteUrl) {
using (SPSite site = new SPSite(siteUrl) {
site.CatchAccessDeinedError = false;

using (SPWeb web = site.RootWeb) {
try {
if (web.DoesUserHavePermissions(SPBasePermissions.ManageWeb)) {
SPUsercollection users = web.Users;
List<SPUser> usersWithAccess = new List<SPUser>();
foreach (SPUser user in users) {
if (web.DoesUserHavePermissions(
user.LoginName, SPBasePermissions.ManageWeb)) {
usersWithAccess.Add(user);
}
}

return usersWithAccess;
}
} catch (UnauthorizedAccessException e) {
return new List<SPUser>();
}
}
}
}

A Common Problem

• What if no database locally?
• Did you write test logic to rebuild the database
before each test run?

• What if this dependency is a physical piece of
hardware?

How to Solve
namespace SharePointLogicTests
{
[TestClass]
public class ClassWithDependenciesTests
{
[TestMethod]
public void TestGetNodesByName()
{
// Arrange.
INode node = new SharePointNode();
IDataRepository repository =
(IDataRepository)MockRepository.Stub<IDataRepository>();
repository.Stub(x => x.Where).Returns(repository);
repository.Stub(x => x.Select).Returns(node);
repository.Replay();

// ...

How to Solve

// Act.
ClassWithDependencies testClass = new ClassWithDependencies(repository);
INode testNode = testClass.GetNodeByName("Test");

// Assert.
Assert.AreEqual(node, testNode);
}
}
}

What about SharePoint?

• Most of SharePoint object model has NO interfaces
• Worse, most also are Sealed classes, meaning no
extending and overriding the SharePoint behavior

• Most SharePoint objects require active connection
and instance of SharePoint on local server

• Unlike database projects, resetting and recreating
state in SharePoint is way more difﬁcult

A SharePoint Common Problem

public string GetNameOfSharePointWebSite(string url)
{
using (SPSite site = new SPSite(url))
{
using (SPWeb web = site.OpenWeb())
{
return web.Name;
}
}
}

Pex and Moles
• What is it?
• Pex discovers boundary conditions of your tests
and automates test creation

• Visual Studio Add In
• Developed by Microsoft Research
• Available for Academic or for MSDN subscribers

Pex and Moles

• Moles is, simply put, a mocking and stubbing
framework

• Different than other traditional mocking
frameworks

• Uses detours to custom delegates via runtime
instrumentation

Pex and Moles

• Pex and Moles are not mutually exclusive
• Neither are dependent upon one another

DEMO

SharePoint & Moles
Example

Pex and Moles
• As your dependency on SharePoint Object Model
grows, more detours required for testing

• In most cases, more tedious than beneﬁcial
• If only could have most of the basic SharePoint
behaviors pre-generated

• Solution:
Microsoft.SharePoint.Behaviors

DEMO

SharePoint Mole
Behaviors

Observations
• Even behaviors are not complete

Observations
• A lot of mocking activity may get repeated

Observations
• Unit test setup logic gets refactored into common
assemblies

Observations
assemblies

• Save time: create scenarios

Observations
assemblies

• Save time: create scenarios
• Use BDD-style approach for testing

Gotchas
• More moles unit tests = much longer test execution
time

Gotchas
time

• Continuous Integration

Gotchas
time

• This will take time to learn, research, and debug

Gotchas
time

• Pay attention when it stops adding value

Gotchas
time

• Pay attention when it stops adding value
• The GAC

Recommendations

• If you can do it, build a facade in front of SharePoint

Recommendations

• Make sure you are producing consistent behaviors

Recommendations

• Make sure you are producing consistent behaviors
• If you don’t know what SharePoint does,
disassemble it

Thank You!

http://slidesha.re/ http://spkr8.com/t/8140

git://github.com/neraath/testing-in-sp2010.git

Unit Testing in SharePoint 2010

More Related Content

What's hot (20)

Viewers also liked (11)

Similar to Unit Testing in SharePoint 2010 (20)

More from Chris Weldon (7)

Recently uploaded (20)

Unit Testing in SharePoint 2010

Editor's Notes