Skip to main content

How to test a static dependency used inside a class...

This is a question that keeps coming up and I know if you're practicing it's a no brainer but I keep getting asked this by devs (I'm no testing God!).

The long answer is to read this book and pay attention when talking about 'inserting a seam'.

The short answer is carry on reading...

Now several people (read Jimmy Bogard) have already answered this but here is my take on this looking at my current client, they have a lots of deeply nested static dependencies - these are implicit dependencies and what you really want to is explicit dependencies because they are easily testable.

So I see a lot of classes like this nested deeply in some object graphs.

 public class Foo
{
private string _url;
private string _connectionString;

private string _user;

public Foo()
{
_url = System.Configuration.ConfigurationManager.AppSettings["SomeUrl"];
_connectionString = System.Configuration.ConfigurationManager.ConnectionStrings["SomeConnectionString"].ConnectionString;

_user = System.Security.Principal.WindowsIdentity.GetCurrent().Name;
}

public void Bar()
{
// Do something...
}
}
So this has 2 static dependencies that are hidden and hard to test...

How do I make this easier to test and remove the hidden dependency?

The answer is I insert a seam for each static dependency - this involves pushing the static dependency behind an interface and expose the properties & methods

So instead of using the ConfigurationManager and WindowsIdentity directly in the code we use an interface that's injected via the constructor.

 public class Foo
{
private readonly IProvideConfiguration _configuration;
private readonly IProvideUserInfo _userInfo;

public Foo(IProvideConfiguration configuration, IProvideUserInfo userInfo)
{
_configuration = configuration;
_userInfo = userInfo;
}

public void Bar()
{
// Do something...
var user = _userInfo.UserName;

var url = _configuration.Url;
var connectionString = _configuration.ConnectionString;
}
}

public interface IProvideUserInfo
{
string UserName { get; }
}

public interface IProvideConfiguration
{
string Url { get; }
string ConnectionString { get; }
}


Now because I've created two seams - IProvideUserInfo & IProvideConfiguration these can easily be mocked out and testing becomes a lot easier!

So the implementation of these interface would probably look like this:

public class ApplicationConfiguration : IProvideConfiguration
{
public string Url
{
get { return System.Configuration.ConfigurationManager.AppSettings["SomeUrl"]; }
}

public string ConnectionString
{
get { return System.Configuration.ConfigurationManager.ConnectionStrings["SomeConnectionString"].ConnectionString; }
}
}

public class WindowsIdentity : IProvideUserInfo
{
public string UserName
{
get { return System.Security.Principal.WindowsIdentity.GetCurrent().Name; }
}
}

So hopefully some people will find this helpful....

Awkward Coder

Comments

Popular posts from this blog

Implementing a busy indicator using a visual overlay in MVVM

This is a technique we use at work to lock the UI whilst some long running process is happening - preventing the user clicking on stuff whilst it's retrieving or rendering data. Now we could have done this by launching a child dialog window but that feels rather out of date and clumsy, we wanted a more modern pattern similar to the way <div> overlays are done on the web. Imagine we have the following simple WPF app and when 'Click' is pressed a busy waiting overlay is shown for the duration entered into the text box. What I'm interested in here is not the actual UI element of the busy indicator but how I go about getting this to show & hide from when using MVVM. The actual UI elements are the standard Busy Indicator coming from the WPF Toolkit : The XAML behind this window is very simple, the important part is the ViewHost. As you can see the ViewHost uses a ContentPresenter element which is bound to the view model, IMainViewModel, it contains 3 child v

Showing a message box from a ViewModel in MVVM

I was doing a code review with a client last week for a WPF app using MVVM and they asked ' How can I show a message from the ViewModel? '. What follows is how I would (and have) solved the problem in the past. When I hear the words ' show a message... ' I instantly think you mean show a transient modal message box that requires the user input before continuing ' with something else ' - once the user has interacted with the message box it will disappear. The following solution only applies to this scenario. The first solution is the easiest but is very wrong from a separation perspective. It violates the ideas behind the Model-View-Controller pattern because it places View concerns inside the ViewModel - the ViewModel now knows about the type of the View and specifically it knows how to show a message box window: The second approach addresses this concern by introducing the idea of messaging\events between the ViewModel and the View. In the example below

Custom AuthorizationHandler for SignalR Hubs

How to implement IAuthorizationRequirement for SignalR in Asp.Net Core v5.0 Been battling this for a couple of days, and eventually ended up raising an issue on Asp.Net Core gitHub  to find the answer. Wanting to do some custom authorization on a SignalR Hub when the client makes a connection (Hub is created) and when an endpoint (Hub method) is called:  I was assuming I could use the same Policy for both class & method attributes, but it ain't so - not because you can't, because you need the signatures to be different. Method implementation has a resource type of HubInnovationContext: I assumed class implementation would have a resource type of HubConnectionContext - client connects etc... This isn't the case, it's infact of type DefaultHttpContext . For me I don't even need that, it can be removed completely  from the inheritence signature and override implementation. Only other thing to note, and this could be a biggy, is the ordering of the statements in th