Debugging Windows Service Without Deploying It

Code available on Code Project: http://www.codeproject.com/KB/tips/EasyDebugWindowsServices.aspx

Introduction

At the beginning, there was no easy way to build a Windows service using Visual Studio and .NET Framework. Now that Microsoft has integrated this functionality as a template and a class library, it's much more easy to do that. This is good, but to test your newly created service you have to deploy it. That means you must add an installer and build a whole MSI file and run it in your environment. Once deployed, you can start it with Windows Service controller and attach a debugger to it.

I don't know how this sounds to you, but to me it is too much unneeded work to do a quick test. This article describes a much more easy way to do that.

Using the Code

You will find a sample application using this concept. Here is how it works.

First you need a working Windows service. (For more information, refer to this.)

In Visual Studio, building a Web service is easy. Create a new project and select Windows Service template.

Then add ServiceDebuggerHelper project to your solution and a reference to it. You can find it in the sample code.

By default, when you create a Windows service project, Visual Studio will create two classes: a Program class and a Service1 class. Here is what the program class looks like:

static class Program 
{ 
    /// <summary>
    /// The main entry point for the application. 
    /// </summary>
    static void Main() 
    { 
        ServiceBase[] ServicesToRun = new ServiceBase[] { new Service1() }; 
        ServiceBase.Run(ServicesToRun); 
    } 
}

The first thing we have to do is to surround that code with a conditional statement to let us control if we want to run as a real service or just in debugging mode.

 static class Program 
{ 
    /// <summary>
    /// The main entry point for the application. 
    /// </summary>
    static void Main() 
    { 
        if (args.Length > 0 && args[0].ToLower().Equals("/debug")) 
        { 
            Application.Run(new ServiceRunner(new Service1())); 
        } 
        else 
        {        
            ServiceBase[] ServicesToRun = new ServiceBase[] { new Service1() }; 
            ServiceBase.Run(ServicesToRun); 
        }
    } 
}

In this new Program class, ServiceRunner will be acting as a service host. To make it work, you have to add the "/debug" command line option in your project properties.

Go to Project -> ... Properties -> Debug and type /debug in the command line arguments field.

From there, you have two options to make your service debuggable. Either you implement IDebuggableService or inherit from DebuggableService base class.

Implementing IDebuggableService Interface

If you already subclass ServiceBase and use that subclass for all your services or if you just want to have full control over the implementation, you should implement theIDebuggableService interface. Here is its definition:

public interface IDebuggableService
{
    void Start(string[] args);
    void StopService();
    void Pause();
    void Continue();
}

Notice that the stop method is called StopService to avoid conflict with the existing Stop method of the ServiceBase class.

Here is a sample implementation of this interface:

public partial class Service1 : ServiceBase, IDebuggableService        
{
    //
    // Your existing service code
    //
    // ...
    //
    
    #region IDebuggableService Members

    public void Start(string[] args)
    {
        OnStart(args);
    }

    public void StopService()
    {
        OnStop();
    }

    public void Pause()
    {
        OnPause();
    }

    public void Continue()
    {
        OnContinue();
    }

    #endregion
}

Subclassing DebuggableService

Subclassing your service from DebuggableService is even more simple. All you have to do is change the base class from ServiceBase to DebuggableService.

public partial class Service1 : DebuggableService        
{
    //
    // Your existing service code
    //
    // ...
    //
}

All the control methods are already implemented by DebuggableService.

Points of Interest

In my sample code, I added a Windows Form class to let you start, stop and pause your service. You can use it as is, build your own controller interface or just call the methods in your program class. It is up to you.

Of course you should still deploy your service to give it the final test run. One good reason to do this is to test the actual security context in which your service will run. It will not have the same permission as when you run it in Visual Studio, but this technique can speed up the development process.

Code available on Code Project: http://www.codeproject.com/KB/tips/EasyDebugWindowsServices.aspx