Skip to main content

Tricky continuous testing and self hosting WebAPI issue...

When using WebAPI inside a test fixture make sure you shutdown the HttpSelfHostServer instance correctly or your tests will more than likely fail when run from a continuous testing framework like nCrunch.

See this post for info about using the self hosting version of WebAPI inside a test fixture.

So my tests were running successfully when run inside Visual Studio from either the inbuilt runner or via Reshaper, but were failing when run from nCrunch:
The failing tests weren't consistent either, sometimes none would fail, sometimes a couple, sometimes all...

What the tests had in common was they were using a shared resource setup inside the test fixture setup method - this is like the setup method for a test but scoped at the class (test fixture) level. The setup was failing randomly were it was setting up the WebAPI self host - see highlighted yellow area, you can see the failing icon for nCrunch at the side:
The exception was telling me it was trying to create an instance of the service on a port already assigned:
So my first thought was because the tests for the fixture are being run in parallel then multiple instances of the fixture are trying to be created at the same time and therefore multiple registration attempts for the same port...

But after debugging the code with breakpoints for the SetUp & TearDown it appears this was wrong, these methods were only called once per run. This meant the service wasn't shutting down correctly when test execution had completed.

The TestService class is shown below. I thought I was shutting down the WebAPI host correctly by calling Dispose in the class Dispose method:

   1:  public class TestService : IDisposable
   2:  {
   3:      private readonly string _baseUrl;
   5:      private HttpSelfHostServer _server;
   7:      public IList<Employee> Employees;
   8:      public IList<Report> Reports;
   9:      public TimeSpan Delay;
  11:      public TestService(string baseUrl)
  12:      {
  13:          _baseUrl = baseUrl;
  15:          SetUpControllers();
  16:          SetUpHost();
  17:      }
  19:      public void Dispose()
  20:      {
  21:          _server.Dispose();
  22:      }
  24:      private void SetUpHost()
  25:      {
  26:          var config = new HttpSelfHostConfiguration(_baseUrl);
  28:          config.Routes.MapHttpRoute("DefaultAPI", "api/{controller}/{id}", new { id = RouteParameter.Optional });
  30:          _server = new HttpSelfHostServer(config);
  31:          _server.OpenAsync().Wait();
  32:      }
  34:      private void SetUpControllers()
  35:      {
  36:          Employees = new List<Employee>
  37:          {  
  38:              new Employee { Id = 1, FirstName = "Ollie", LastName = "Riches" },
  39:              new Employee { Id = 2, FirstName = "Steve", LastName = "Austin" },
  40:          };
  42:          EmployeesController.Employees = Employees;
  44:          Delay = TimeSpan.FromSeconds(3);
  45:          Reports = new List<Report>
  46:          {  
  47:              new Report { Id = 1, Name = "SlowReport" }
  48:          };
  50:          ReportsController.Delay = Delay;
  51:          ReportsController.Reports = Reports;
  52:      }
  53:  }

But this wasn't the case, after changing to the following all tests were passing as expected:

   1:  public void Dispose()
   2:  {
   3:      _server.CloseAsync().Wait();
   4:      _server.Dispose();
   5:  }

I had to re-initialising nCrunch to force any remaining service instances to shutdown:
I would have thought calling Dispose on HttpSelfHostServer would have meant it blocked until the server had shutdown but it appears not. Looking into the implementation it appears it doesn't close the server unless a task completion source had already been defined (also shown is the implementation for CloseAsync()):
I hope this helps if you run into this issue :)


Post a Comment

Popular posts from this blog

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

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

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