Skip to main content

WCF Configuration Nightmare, MSBuild, IIS AppCmd

In this post I am going discuss about some of the deployment nightmare that you might have when you design SOA, where you segregate logic into several decoupled services. the post would not really deal with production deployment , but about internal developer releases.

The problem here is that when you have multiple services, and you want to deploy your code in one of the test environments for testing before you release it to the testing team, you have a huge amount of configurations that you need to change.
This typically includes...

1) Changing service addresses, this might include WCF services that your service has referenced. Sometimes it might be the case that one of this service refer not just one service. All the service might not be deployed in one machine, hence, referring localhost will not work.

2) Changing database connections, this might be a cumbersome task, you might have to go into each and every configuration file and change the database serve , database user or database name.

3) Application settings, these might include paths to share folders, etc...

4) Any other configuration sections that might be different from when you are developing in your local machine, for an example, you might not want to give access to meta data after deployment, or you want to change the a few WCF settings like MaxConcurrentConnections.

After deploying all these WCF services you would have to go through these numerous configuration files and change these places to point to the correct changes according to the new environment.

This is cumbersome, and is error prone, you would have to waste a few hours trouble shooting in order to find out which configuration piece was configured wrongly.

A very primitive way of deploying WCF services would be to build your application from Visual Studio and then manually add these services into IIS and if your exposing your services through non HTTP endpoints in IIS7, the you would have to configure binding for the protocol used.
Once this is done, now you would configure service addresses and DB connections. you might have to create a .SVC file for HTTP activation manually or you could use the publish option in Visual Studio to create this automatically.

Next I will outline some of the ways to improve this process.

MSBuild

One this is you can create a MSBuild script that would build your solution and then copy the out put into another location.
MSBuild is powerful enough to do this, this script would be a very small script, you can just instruct MSBuild to build your application pointing to your solution.
If your trying to deploy your web application, then you just need to write a target that would copy the output to a folder called bin and then copy the whole source of the web application without the .cs or ascx files.
You can learn more about MSBuild here

IIS7 AppCmd

Now once this is done , you can use IIS 7 AppCmd that ships with IIS tools to create the web application and WCF application, the app cmd tool is a command line tool that gives administrator the same power that they get with IIS7 GUI, so its just a matter of creating a .BET file to do the task of deploying it in IIS & and call the .Bat file in your MSBuild script as a target.
You can learn more about App Cmd here

MSBuild Extension Pack

MSBuild does not come with any target to change configuration values, however there is a community task library that you use to do this, one such task library is the MSBuild Extension Pack.
This component gives you a set of task to manipulate XML files, like reading, writing and updating.
This is exactly what we want to use to change our configuration files to point to the correct server and change the DB connections.
You can learn more about MSBuild Extension pack here

Automating deployment nightly

Now all you have to do is instruct cruse control or hudsion to execute your build script and you have you your latest build deployed in your environment nightly or weekly.

Comments

Popular posts from this blog

Hosting WCF services on IIS or Windows Services?

There came one of those questions from the client whether to use II7 hosting or windows service hosting for WCF services. I tried recollecting a few points and thought of writing it down.
WCF applications can be hosted in 2 main ways- In a Windows service- On IIS 7 and aboveWhen WCF was first released, IIS 6 did not support hosting WCF applications that support Non-HTTP communication like Net.TCP or Net.MSMQ and developers had to rely on hosting these services on Windows Services.With the release of IIS 7, it was possible to deploy these Non-Http based applications also on IIS 7. Following are the benefits of using IIS 7 to host WCF applications
Less development effort
Hosting on Windows service, mandates the creating of a Windows service installer project on windows service and writing code to instantiate the service, whereas the service could just be hosted on IIS by creating an application on IIS, no further development is needed, just the service implementation is n…

Task based Asynchronous pattern, Async & Await and .NET 4.5

One of the key features in .Net 4.5 is to write asynchronous programs much easier. So if I was to write asynchronous programs in .Net 2.0/3.5, I would either follow the event based model or the callback based model. For an example, a synchronous method that does intensive work (say the DoWork()) can be made asynchronous by using the following patterns
1) Implementing the IAsyncResult pattern. in this implementation, 2 methods are exposed for the DoWork() synchronous method, the BeginDoWork() and the EndDoWork() method. The user will call the BeingDoWork() passing in the required parameters and a callback of the delegate type AsyncCallback(IAsyncResult). The BeginDoWork() will spawn a new thread a return control back to the user. Once work is completed in the spawned method, as a last step, it will call the inform the AsyncResult implementation, which in turns will call the EndDoWork() (which is the callback that was passed in to the BeginDoWork()).
2) Implementing the event pattern. Her…

MEF (Managed Extensibility Framework), .NET 4, Dependency Injection and Plug-in Development

Almost after .Net 4 was released I remember reading about MEF (Managed Extensibility Framework), this was a framework for developers to compose their application with required dependencies. At first this looks like the Unity Container used for dependency injection, but MEF is much more than a dependency container but there is nothing stopping you from using MEF as a dependency injector.I remember around 5 years back when I was in a project that created a framework that allows developers to plug-in there modules as WinForm screens. The developer would create a set of screens with the intended functionalities and the drop this component in the bin folder of the framework and then will move on to do some painful configurations for the framework to pick up the module. Dropping the component into the bin folder and doing a bit of configuration is all that s needed for the framework to pick up display the screens. Typically, the configurations would also contain metadata about the screen.Al…