How to Fake SPFarm.Local & SPFarm.Properties with Typemock

This was a little tricky to figure out, and finding info on typemock is kind of hard sometimes, so here it is.

1. Get a fake SPFarm object
   
   SPFarm fakeFarm = Isolate.Fake.Instance<SPFarm>(Members.ReturnRecursiveFakes);
   
2. Fake SPFarm.Local with the fake farm
   
   Isolate.WhenCalled(() => SPFarm.Local).WillReturn(fakeFarm);
   
3. Fake the fakeFarm.Properties with a Hashtable containing your fake properties
   
   Hashtable farmProps = new Hashtable();
   farmProps.Add("WindwardArrowLicense", testLicense);
   Isolate.WhenCalled(() => fakeFarm.Properties).WillReturn(farmProps);

Here's an example test method.

[Test, Isolated]

public void ReadLicense_RequestExistingLicenseFromLicenseHandler_LicenseReturned()

{

// setup the fake farm

SPFarm fakeFarm = Isolate.Fake.Instance<SPFarm>(Members.ReturnRecursiveFakes);

 

// fake the "SPFarm.Local"

Isolate.WhenCalled(() => SPFarm.Local).WillReturn(fakeFarm);

 

// fake properties

Hashtable farmProps = new Hashtable();

farmProps.Add("WindwardArrowLicense", testLicense);

Isolate.WhenCalled(() => fakeFarm.Properties).WillReturn(farmProps);

 

string readLicense = ArrowLicenseHandler.ReadLicense();

 

Assert.AreEqual(testLicense, readLicense);

 

Isolate.Verify.WasCalledWithAnyArguments(() => fakeFarm.Properties);

}

 

Happy mocking!

Comments

[Andrew Woodward]

Great post and wonderful to see people blogging about this - has been a long time passion of mine to get more people doing good unit testing in SharePoint.

A couple of tweaks for consideration:

Members.ReturnRecursiveFakes is the default, could leave out

Also someone bring really picky (not me :) ) you could suggest the line

Isolate.Verify.WasCalledWithExactArguments

You tests and code are already coupled due to the need for using Isolator.

Congrats on doing Unit Testing with SharePoint :)

[meowkins]

thanks for the info, Andrew