Using OWIN to test your web api controllers

April 01, 2014 -

During the Microsoft Techdays in Paris, I spoke with Simon Ferquel about the newest features that came with ASP.NET MVC 5 and Web API 2. A big part of our session was about OWIN that is (IMO) one of the most exciting feature that has been released.

Introduction to OWIN middleware programming

In short, OWIN (Open Web Interface for .Net) is a set of specifications that define how a web application runs on a web server. You can find more about these specifications on this page.

OWIN is based on middlewares to add behaviors to an application. For example, you can use OWIN middlewares to do external authentication with providers like Facebook, Google, Microsoft or Windows Azure Active Directory. You can also use OWIN middlewares as simple technical components of your application (logs, for example). Each OWIN middleware is responsible for its business.

Working with OWIN is very easy : first you have to write your OWIN middleware (or not, if you’re using an existing one provided by Microsoft or another third party).

An OWIN middleware is represented by a class that inherits from OwinMiddleware, as it is done for the LogsMiddleware bellow :

public class LogMiddleware : OwinMiddleware
{
    public LogMiddleware(OwinMiddleware next) : base(next)
    {
            
    }

    public async override Task Invoke(IOwinContext context)
    {
        Debug.WriteLine("Request begins: {0} {1}", context.Request.Method, context.Request.Uri);
        await Next.Invoke(context);
        Debug.WriteLine("Request ends : {0} {1}", context.Request.Method, context.Request.Uri);
    }
}

As you can see, an OWIN middleware takes the next middleware to invoke as constructor parameter. You should next override the Invoke method that will do the middleware stuff and invoke the next middleware.

The sample above is very simple : it logs the begin and the end of each request that is made to the server. Once the middleware is ready, you only have to register it in your application and it will be available for all technologies in your app (mvc, web forms, web api, signalR…) : you write one middleware to rule them all ! Winking smile

To register OWIN middlewares in your app, you have to create an OWIN Startup Class. You can use a Visual Studio template to create this class (or you can use the one that has been created at the project creation if it already exists) and all the structure of the class :

image

using Microsoft.Owin;
using Owin;

[assembly: OwinStartupAttribute(typeof(EbookManager.Web.Startup))]
namespace EbookManager.Web
{
    public partial class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            
        }
    }
}

An OWIN startup class is very simple : it contains a method Configuration that returns void and takes an IAppBuilder instance as parameter. To make the class visible from OWIN, you should use the attribute OwinStartupAttribute at the assembly level and reference the type of the startup class. Now, you can register the log middleware and test your first OWIN middleware :

public void Configuration(IAppBuilder app)
{
   app.Use(typeof(LogMiddleware));
}

And that’s all : your application will now use the log middleware via OWIN.

OWIN Self-Hosting

One of the other cool exciting feature of OWIN is the ability to self-host code like Web API or Signal-R :

image 

Microsoft provides different hosts that can run OWIN applications. The first one that everybody knows is IIS server that runs ASP.NET for many years. But Microsoft provides two other hosts : the http listener that allows to self-host a web api or a signal-r hub in a .NET application (for example a windows service or a console application) and the unit test host that allows to unit tests web api controllers without server-deployment.

Using the unit test host

To work with the OWIN Unit Test host, you have to install the NuGet package Microsoft.Owin.Testing in your test project :

image

Once the package is installed, it is possible to create a test server that will host your web api without running IIS. To do that, you have to create an OWIN configuration class in the projet. This class is defined in the same way than an OWIN startup class except that you do not have to register it at the assembly level with the OwinStartupAttribute :

class OwinTestConf
{
    public void Configuration(IAppBuilder app)
    {
        app.Use(typeof (LogMiddleware));
	 HttpConfiguration config = new HttpConfiguration();
        config.Services.Replace(typeof(IAssembliesResolver), new TestWebApiResolver());
        config.MapHttpAttributeRoutes();
        app.UseWebApi(config);
    }
}

Here, the configuration is done in the same way that you are use to configure an api written with Web API 2. The TestWebApiResolver is an assembly resolver that allows Web API to resolve controllers that are defined in another assembly than the one that defines unit tests.

Now, it is possible to create a test server based on the OWIN configuration in your unit test and use it like any Web API, for example with an HttpClient :

using (var server = TestServer.Create<OwinTestConf>())
{
    using (var client = new HttpClient(server.Handler))
    {
        var response = await client.GetAsync("http://testserver/api/values");
        var result = await response.Content.ReadAsAsync<List<string>>();
        Assert.IsTrue(result.Any());
    }
}

As you can see in the sample bellow, the HttpClient takes an custom handler that is provided by the OWIN test server. This is this step that allows us to “bypass” the use of the http protocol and that allows the tests to run without IIS.

Conclusion

I think that the ability to self-host a Web API in a test server to make unit test is a very cool feature because it really simplifies the process.

In my next post, I’ll discuss about testing a Web API that uses OAuth with OWIN.

If you’re interested in reading source code, you’ll find samples of OWIN usages in this project on github (this is the sample application we use at Microsoft Techdays).

Enjoy Winking smile

Comments

Share

Tags


Twitter


A lot of improvements with this new version ! >> Announcing #NuGet 3.1 with Support for UWP http://t.co/3LOAOsIKjG

July 31, 2015 17:17

Universal #Windows apps in .NET http://t.co/A6cbiTtYzK

July 31, 2015 15:01

July update for #Web apps and #AppService environments in the #Azure preview portal http://t.co/zxIqV5Cr12

July 31, 2015 13:54

Already "14 million devices running #Windows10" >> http://t.co/lSvMMZpc5V

July 31, 2015 07:47

@Michael_Alves @arnaudauroux carrément avec plaisir :)

July 31, 2015 07:27

@Michael_Alves il parle de scaling des archi oui, mais apres peut être pas comme tu l'attends pour tes problématiques

July 31, 2015 06:56

@Michael_Alves n'hésite pas !

July 31, 2015 06:50

#DevOps Yourself: Fast-Track Your #Windows Development Environment Setup with #Chocolatey and #Vagrant http://t.co/yczMqktnnW

July 30, 2015 15:01

Building #Microservices : one of the best book I've read ! Thanks @samnewman ! http://t.co/6WFYXJLlxC http://t.co/TloUdIIwkl

July 30, 2015 14:45

The story of #Windows10 from inside #Microsoft http://t.co/WXVdLTVfQ1

July 30, 2015 11:37

Building #Apps for #Windows10 with #VisualStudio 2015 http://t.co/z5ecSbEV3T

July 30, 2015 09:21

Yeah ! >> #Microsoft #Edge review: #Windows finally has a good browser http://t.co/CbqygzikBC

July 30, 2015 08:01

Hybrid Management in #Azure #Automation - http://t.co/605bN5P5xI

July 29, 2015 13:54

That would be great ! >> #Microsoft wants to keep #Android app binaries unchanged when ported to #Windows10 Mobile - http://t.co/kdlJPpF3DF

July 29, 2015 11:37