Merge pull request #218 from ivaylokenov/development

Version 1.1.5

Author: ivaylokenov

README.md

@@ -11,7 +11,7 @@ Please see the [documentation](https://github.com/ivaylokenov/MyWebApi/tree/mast
 
 ## Installation
 
-You can install this library using NuGet into your Test class project. It will automatically reference the needed dependencies of Microsoft.AspNet.WebApi.Core (≥ 5.1.0), Microsoft.Owin.Testing (≥ 3.0.1) and Microsoft.Owin.Host.HttpListener (≥ 3.0.1) for you. .NET 4.5+ is needed. Make sure your solution has the same versions of the mentioned dependencies in all projects where you are using them. For example, if you are using Microsoft.AspNet.WebApi.Core 5.2.3 in your Web project, the same version should be used after installing MyWebApi in your Tests project.
+You can install this library using NuGet into your Test class project. It will automatically reference the needed dependencies of Microsoft.AspNet.WebApi.Core (≥ 5.1.0) and Microsoft.Owin.Testing (≥ 3.0.1) for you. .NET 4.5+ is needed. Make sure your solution has the same versions of the mentioned dependencies in all projects where you are using them. For example, if you are using Microsoft.AspNet.WebApi.Core 5.2.3 in your Web project, the same version should be used after installing MyWebApi in your Tests project.
 
     Install-Package MyWebApi
 

documentation/README.md

@@ -44,7 +44,8 @@
  - Integration testing of the full server pipeline
   - [HTTP server](#http-server)
   - [OWIN pipeline](#owin-pipeline)
- - Additional methods
+ - Additional classes and methods
+  - [Helper classes](#helper-classes)
   - [AndProvide... methods](#andprovide-methods)
 
 ### Using custom HttpConfiguration
@@ -63,6 +64,13 @@ MyWebApi.IsRegisteredWith(WebApiConfig.Register);
 // * it is useful if you want to reset the global
 // * configuration used in other tests
 MyWebApi.IsUsingDefaultHttpConfiguration();
+
+// the three options provide a way to set
+// the error detail policy for the testing
+// * default is 'Always' for easier debugging
+MyWebApi
+	.IsRegisteredWith(WebApiConfig.Register)
+	.WithErrorDetailPolicy(IncludeErrorDetailPolicy.LocalOnly);
 ```
 
 [To top](#table-of-contents)
@@ -565,7 +573,7 @@ MyWebApi
 MyWebApi
 	.Controller<WebApiController>()
 	.WithHttpRequestMessage(request => request
-		.WithHeader("SomeHeader", "SomeHeaderValue"));
+		.WithHeader(HttpHeader.Accept, MediaType.TextHtml));
 
 // adding custom header with multiple values to the request message
 MyWebApi
@@ -584,7 +592,7 @@ MyWebApi
 MyWebApi
 	.Controller<WebApiController>()
 	.WithHttpRequestMessage(request => request
-		.WithContentHeader("SomeContentHeader", "SomeContentHeaderValue"));
+		.WithContentHeader(HttpContentHeader.ContentType, MediaType.ApplicationJson));
 
 // adding custom content header with multiple values to the request message
 // * adding content headers requires content to be initialized and set
@@ -726,6 +734,12 @@ MyWebApi
 MyWebApi
 	.Controller<WebApiController>()
 	.CallingAsync(c => c.SomeActionAsync());
+	
+// if action has non-important parameters, instead of adding dummy values
+// use With.Any<TParameter> for better readability
+MyWebApi
+	.Controller<WebApiController>()
+	.Calling(c => c.SomeAction(With.Any<int>()));
 ```
 [To top](#table-of-contents)
 
@@ -844,6 +858,15 @@ MyWebApi
 	.ShouldHave()
 	.ActionAttributes();
 
+// since testing for attributes does not require valid parameters,
+// instead of adding dummy values
+// use With.Any<TParameter> for better readability
+MyWebApi
+	.Controller<WebApiController>()
+	.Calling(c => c.SomeAction(With.Any<int>()))
+	.ShouldHave()
+	.ActionAttributes();
+	
 // tests whether action has specific number of attributes
 MyWebApi
 	.Controller<WebApiController>()
@@ -2526,9 +2549,8 @@ MyWebApi.Server().Stops();
 You can test over the full pipeline by providing OWIN start up class and optional network host and post. You can start global HTTP server in your test/class/assembly initialize method and set test cases with different requests or just instantiate separate server for each test:
 
 ```c#
-// starts OWIN web server with the provided host and port. If such are not provided, default is "http://localhost:1234"
+// starts OWIN web server with the provided host and port. If such are not provided, default is "http://localhost:80"
 // * the server is disposed after the test
-// * some hosts and ports may require administrator rights
 // * HTTP request can be set just like in the controller unit tests
 // * HTTP response can be tested just like in the controller unit tests
 MyWebApi
@@ -2544,7 +2566,7 @@ MyWebApi
 // starts OWIN server with specific 
 // for the test Startup class 
 // * the server is disposed after the test
-// * since host and port are not provided, the default "http://localhost:1234" is used
+// * since host and port are not provided, the default "http://localhost:80" is used
 MyWebApi
 	.Server()
 	.Working<Startup>() // working will instantiate new OWIN server with the specified Startup class
@@ -2568,13 +2590,77 @@ MyWebApi
 // more test cases on the same global server
 
 // stops the global OWIN server
+MyWebApi.Server().Stops();
+
+// saving the server builder instance for later usage
+// * can be done with the normal HTTP server too
+var server = MyWebApi.Server().Starts<Startup>();
+
+server
+	.WithHttpRequestMessage(httpRequestMessage)
+	.ShouldReturnHttpResponseMessage()
+	.WithStatusCode(HttpStatusCode.OK);
+	
+// more test cases on the same global server
+	
 MyWebApi.Server().Stops();
 ```
 
 Summary - the **".Working()"** method without parameters will check if the global OWIN server is started. If not, it will check whether a global HTTP server is started. If not, it will instantiate new HTTP server using the global HTTP configuration. The first match will process the request and test over the response. If no server can be started, exception will be thrown. Using **".Working(config)"** will start new HTTP server with the provided configuration and dispose it after the test. Using **".Working<Startup>()"** will start new OWIN server with the provided start up class and dispose it after the test. Global server can be started with **"MyWebApi.Server().Starts()"** and it will be HTTP or OWIN dependending on the parameters. Global servers can be stopped with **"MyWebApi.Server().Stops()"**, no matter HTTP or OWIN.
 
 [To top](#table-of-contents)
 
+### Helper classes
+
+The library gives you helper classes for common magic strings and non-important action call parameters:
+
+```c#
+// With.Any<TParameter> is helpful where action call parameter values are not important
+MyWebApi
+	.Controller<WebApiController>()
+	.Calling(c => c.SomeAction(With.Any<int>()))
+	.ShouldHave()
+	.ActionAttributes();
+	
+// MediaType class contains common media type strings
+MyWebApi
+	.Controller<WebApiController>()
+	.Calling(c => c.SomeAction())
+	.ShouldReturn()
+	.Content()
+	.WithMediaType(MediaType.ApplicationJson); // represents "application/json"
+	
+// HttpHeader class contains common HTTP header names
+MyWebApi
+	.Controller<WebApiController>()
+	.WithHttpRequestMessage(
+		request => request
+			.WithHeader(HttpHeader.Accept, MediaType.ApplicationJson)) // represents "Accept" HTTP header
+	.Calling(c => c.SomeAction())
+	.ShouldReturn()
+	.Ok();
+	
+// HttpContentHeader class contains common HTTP content header names
+MyWebApi
+	.Controller<WebApiController>()
+	.WithHttpRequestMessage(
+		request => request
+			.WithContentHeader(HttpContentHeader.ContentType, MediaType.ApplicationJson)) // represents "ContentType" HTTP header
+	.Calling(c => c.SomeAction())
+	.ShouldReturn()
+	.Ok();
+	
+// AuthenticationScheme class containing common authentication schemes
+MyWebApi
+	.Controller<WebApiController>()
+	.Calling(c => c.UnauthorizedActionWithChallenges())
+	.ShouldReturn()
+	.Unauthorized()
+	.ContainingAuthenticationHeaderChallenge(AuthenticationScheme.Basic); // represents Basic authentication scheme
+```
+
+[To top](#table-of-contents)
+
 ### AndProvide... methods
 
 You can get different Web API specific objects used in the test case where applicable by using AndProvide... methods.

samples/Books Web API/Books.Api/App_Start/IdentityConfig.cs

@@ -9,6 +9,7 @@ namespace Books.Api
 {
     using Books.Models;
     using Data;
+    using Infrastructure;
 
     // Configure the application user manager used in this application. UserManager is defined in ASP.NET Identity and is used by the application.
 
@@ -21,7 +22,9 @@ public ApplicationUserManager(IUserStore<Author> store)
 
         public static ApplicationUserManager Create(IdentityFactoryOptions<ApplicationUserManager> options, IOwinContext context)
         {
-            var manager = new ApplicationUserManager(new UserStore<Author>(context.Get<BooksDbContext>()));
+            var manager = ObjectFactory.TryGetInstance<ApplicationUserManager>() ??
+                          new ApplicationUserManager(new UserStore<Author>(context.Get<BooksDbContext>()));
+
             // Configure validation logic for usernames
             manager.UserValidator = new UserValidator<Author>(manager)
             {
@@ -32,10 +35,10 @@ public static ApplicationUserManager Create(IdentityFactoryOptions<ApplicationUs
             manager.PasswordValidator = new PasswordValidator
             {
                 RequiredLength = 6,
-                RequireNonLetterOrDigit = true,
-                RequireDigit = true,
-                RequireLowercase = true,
-                RequireUppercase = true,
+                RequireNonLetterOrDigit = false,
+                RequireDigit = false,
+                RequireLowercase = false,
+                RequireUppercase = false,
             };
             var dataProtectionProvider = options.DataProtectionProvider;
             if (dataProtectionProvider != null)

samples/Books Web API/Books.Api/App_Start/NinjectConfig.cs

@@ -6,6 +6,7 @@ namespace Books.Api
     using System;
     using System.Web;
     using Data;
+    using Infrastructure;
     using Microsoft.Web.Infrastructure.DynamicModuleHelper;
 
     using Ninject;
@@ -15,7 +16,7 @@ public static class NinjectConfig
     {
         private static readonly Bootstrapper bootstrapper = new Bootstrapper();
 
-        public static Action<IKernel> RebindAction { get; set; } 
+        public static Action<IKernel> RebindAction { get; set; } // should be used only in integration testing scenarios
 
         /// <summary>
         /// Starts the application
@@ -53,6 +54,7 @@ public static IKernel CreateKernel()
                     RebindAction(kernel);
                 }
 
+                ObjectFactory.Initialize(kernel);
                 return kernel;
             }
             catch

samples/Books Web API/Books.Api/Books.Api.csproj

@@ -245,6 +245,7 @@
     <Compile Include="Global.asax.cs">
       <DependentUpon>Global.asax</DependentUpon>
     </Compile>
+    <Compile Include="Infrastructure\ObjectFactory.cs" />
     <Compile Include="Mappings\IHaveCustomMappings.cs" />
     <Compile Include="Mappings\IMapFrom.cs" />
     <Compile Include="Models\AccountBindingModels.cs" />

samples/Books Web API/Books.Api/Controllers/AccountController.cs

@@ -32,11 +32,9 @@ public AccountController()
         {
         }
 
-        public AccountController(ApplicationUserManager userManager,
-            ISecureDataFormat<AuthenticationTicket> accessTokenFormat)
+        public AccountController(ApplicationUserManager userManager)
         {
             UserManager = userManager;
-            AccessTokenFormat = accessTokenFormat;
         }
 
         public ApplicationUserManager UserManager

samples/Books Web API/Books.Api/Infrastructure/ObjectFactory.cs

@@ -0,0 +1,19 @@
+namespace Books.Api.Infrastructure
+{
+    using Ninject;
+
+    public static class ObjectFactory
+    {
+        public static IKernel standartKernel;
+
+        public static void Initialize(IKernel kernel)
+        {
+            standartKernel = kernel;
+        }
+
+        public static T TryGetInstance<T>()
+        {
+            return standartKernel.TryGet<T>();
+        }
+    }
+}

samples/Books Web API/Books.Api/Startup.cs

@@ -16,15 +16,15 @@ public void Configuration(IAppBuilder app)
         {
             AutoMapperConfig.RegisterMappings(Assembly.GetExecutingAssembly());
 
+            app.UseNinjectMiddleware(NinjectConfig.CreateKernel);
+
             ConfigureAuth(app);
 
             var config = new HttpConfiguration();
 
             WebApiConfig.Register(config);
 
-            app
-                .UseNinjectMiddleware(NinjectConfig.CreateKernel)
-                .UseNinjectWebApi(config);
+            app.UseNinjectWebApi(config);
         }
     }
 }

samples/Books Web API/Books.Api/Web.config

@@ -9,7 +9,7 @@
     <section name="entityFramework" type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
   </configSections>
   <connectionStrings>
-    <add name="DefaultConnection" connectionString="Data Source=(LocalDb)\v11.0;AttachDbFilename=|DataDirectory|\aspnet-Books.Api-20150901121637.mdf;Initial Catalog=aspnet-Books.Api-20150901121637;Integrated Security=True" providerName="System.Data.SqlClient" />
+    <add name="DefaultConnection" connectionString="Data Source=.;Initial Catalog=BooksTestingApp;Integrated Security=True" providerName="System.Data.SqlClient" />
   </connectionStrings>
   <appSettings></appSettings>
   <system.web>

samples/Books Web API/Books.Tests/ApiTests/IntegrationTests/BooksControllerIntegrationTests.cs

@@ -6,16 +6,19 @@
     using Api;
     using Api.Models.ResponseModels;
     using Data;
+    using Microsoft.Owin.Security;
     using Mocks;
     using Models;
     using MyTested.WebApi;
     using MyTested.WebApi.Builders.Contracts.Servers;
+    using Newtonsoft.Json.Linq;
     using NUnit.Framework;
 
     [TestFixture]
     public class BooksControllerIntegrationTests
     {
         private IServerBuilder server;
+        private string accessToken;
 
         [TestFixtureSetUp]
         public void Init()
@@ -24,10 +27,13 @@ public void Init()
             {
                 kernel.Rebind<IRepository<Book>>().ToConstant(MocksFactory.BooksRepository);
                 kernel.Rebind<IRepository<Author>>().ToConstant(MocksFactory.AuthorsRepository);
+                kernel.Rebind<ApplicationUserManager>().ToConstant(MocksFactory.ApplicationUserManager);
             };
 
             MyWebApi.Server().Starts<Startup>();
             this.server = MyWebApi.Server().Working();
+
+            this.GetAccessToken();
         }
 
         [Test]
@@ -43,10 +49,38 @@ public void BooksControllerShouldReturnCorrectBooksForUnauthorizedUsers()
                 .Passing(m => m.Count == 3);
         }
 
+        [Test]
+        public void BooksControllerShouldReturnCorrectBooksForAuthorizedUsers()
+        {
+            server
+                .WithHttpRequestMessage(req => req
+                    .WithRequestUri("/api/Books/Get")
+                    .WithMethod(HttpMethod.Get)
+                    .WithHeader(HttpHeader.Authorization, "Bearer " + this.accessToken))
+                .ShouldReturnHttpResponseMessage()
+                .WithStatusCode(HttpStatusCode.OK)
+                .WithResponseModelOfType<List<BookResponseModel>>()
+                .Passing(m => m.Count == 10);
+        }
+
         [TestFixtureTearDown]
         public void TearDown()
         {
             MyWebApi.Server().Stops();
         }
+
+        private void GetAccessToken()
+        {
+            var message = server
+                .WithHttpRequestMessage(req => req
+                    .WithRequestUri("/token")
+                    .WithMethod(HttpMethod.Post)
+                    .WithFormUrlEncodedContent("username=TestAuthor@test.com&password=testpass&grant_type=password"))
+                .ShouldReturnHttpResponseMessage()
+                .AndProvideTheHttpResponseMessage();
+
+            var result = JObject.Parse(message.Content.ReadAsStringAsync().Result);
+            this.accessToken = (string)result["access_token"];
+        }
     }
 }