Added HttpContentHeader class containing common content header names (closes #211)

Author: ivaylokenov

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
@@ -572,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
@@ -591,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
@@ -2609,6 +2610,57 @@ Summary - the **".Working()"** method without parameters will check if the globa
 
 [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.Tests/ApiTests/IntegrationTests/BooksControllerIntegrationTests.cs

@@ -56,7 +56,7 @@ public void BooksControllerShouldReturnCorrectBooksForAuthorizedUsers()
                 .WithHttpRequestMessage(req => req
                     .WithRequestUri("/api/Books/Get")
                     .WithMethod(HttpMethod.Get)
-                    .WithHeader("Authorization", "Bearer " + this.accessToken))
+                    .WithHeader(HttpHeader.Authorization, "Bearer " + this.accessToken))
                 .ShouldReturnHttpResponseMessage()
                 .WithStatusCode(HttpStatusCode.OK)
                 .WithResponseModelOfType<List<BookResponseModel>>()

src/MyWebApi/HttpContentHeader.cs

@@ -0,0 +1,68 @@
+// MyWebApi - ASP.NET Web API Fluent Testing Framework
+// Copyright (C) 2015 Ivaylo Kenov.
+// 
+// Dual-licensed under the Apache License, Version 2.0, and the Microsoft Public License (Ms-PL).
+
+namespace MyTested.WebApi
+{
+    /// <summary>
+    /// Contains common HTTP content header names.
+    /// </summary>
+    public class HttpContentHeader
+    {
+        /// <summary>
+        /// Represents Allow content header name.
+        /// </summary>
+        public const string Allow = "Allow";
+
+        /// <summary>
+        /// Represents ContentDisposition content header name.
+        /// </summary>
+        public const string ContentDisposition = "ContentDisposition";
+
+        /// <summary>
+        /// Represents ContentEncoding content header name.
+        /// </summary>
+        public const string ContentEncoding = "ContentEncoding";
+
+        /// <summary>
+        /// Represents ContentLanguage content header name.
+        /// </summary>
+        public const string ContentLanguage = "ContentLanguage";
+
+        /// <summary>
+        /// Represents ContentLength content header name.
+        /// </summary>
+        public const string ContentLength = "ContentLength";
+
+        /// <summary>
+        /// Represents ContentLocation content header name.
+        /// </summary>
+        public const string ContentLocation = "ContentLocation";
+
+        /// <summary>
+        /// Represents ContentMD5 content header name.
+        /// </summary>
+        public const string ContentMD5 = "ContentMD5";
+
+        /// <summary>
+        /// Represents ContentRange content header name.
+        /// </summary>
+        public const string ContentRange = "ContentRange";
+
+        /// <summary>
+        /// Represents ContentType content header name.
+        /// </summary>
+        public const string ContentType = "ContentType";
+
+        /// <summary>
+        /// Represents Expires content header name.
+        /// </summary>
+        public const string Expires = "Expires";
+
+        /// <summary>
+        /// Represents LastModified content header name.
+        /// </summary>
+        public const string LastModified = "LastModified";
+    }
+}

src/MyWebApi/MyWebApi.csproj

@@ -113,6 +113,7 @@
     <Compile Include="Builders\Contracts\ExceptionErrors\IAggregateExceptionTestBuilder.cs" />
     <Compile Include="Builders\Contracts\ExceptionErrors\IAndAggregateExceptionTestBuilder.cs" />
     <Compile Include="Builders\Contracts\ExceptionErrors\IBaseExceptionTestBuilder.cs" />
+    <Compile Include="HttpContentHeader.cs" />
     <Compile Include="IHttpMessageHandlerBuilder.cs" />
     <Compile Include="Builders\Contracts\Handlers\IInnerHttpMessageHandlerBuilder.cs" />
     <Compile Include="Builders\Contracts\HttpActionResults\Ok\IAndOkTestBuilder.cs" />