Wednesday, December 08, 2010

Debugging SharePoint Code With a Console Application

 

Here is my SharePoint tip of the day. This is a helpful technique for debugging/testing SharePoint methods without having to fire up IIS. In my SharePoint code, I write my methods as public static methods that take an SPList or SPWeb object as a parameter. This may seem weird since you could just get these from SPContext.Current.Web. The reason for this is that this is a functional style programming technique where we don’t have class level variables. Instead the method takes in everything they need via parameters. The advantage of this is that I can write a console application and reference my SharePoint project and test my EventReceiver method (or Feature Receiver or WebPart or whatever) without having to deploy my SharePoint solutions, fire up IIS, etc. etc. It makes debugging and setting through code much quicker.  Of course once I have tested it in my console app, then I need to test it in the browser.

Sample Console Application. Note that I create my SPWeb object and list object using the non-SPContext way and pass them into my method which is contained in the referenced SharePoint project.

 

static void Main(string[] args)

{

try

{

   SPSite site = new SPSite("http://localdev/en-US/egs/contact/requestinformation");

   SPWeb currentWeb = site.OpenWeb();

   SPList ciList = currentWeb.Lists["CustomerInquiry"];

   SPList cirList = currentWeb.Lists["Customer Inquiry Routing"];

   SPList ciSettingsList = currentWeb.Lists["CustomerInquirySettings"];

   CustomerInquiryBL.Execute(cirList, ciList.Items[0], ciSettingsList, currentWeb);

}

catch (Exception ex)

{

   Console.WriteLine(ex);

}

Console.WriteLine("Press Any Key to Continue.");

Console.ReadKey();

}

2 comments:

colinbo said...

Why not just use PowerShell?

Joseph Fluckiger said...

Good point, using Powershell would be a great solution, which wouldn't require creating a new project etc.

I like your suggestion.