Added option to set the error detail policy of the configuration (closes #200)

Author: ivaylokenov

documentation/README.md

@@ -63,6 +63,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)

src/MyWebApi.Tests/BuildersTests/HttpConfigurationBuilderTests.cs

@@ -4,6 +4,7 @@
 // Dual-licensed under the Apache License, Version 2.0, and the Microsoft Public License (Ms-PL).
 namespace MyTested.WebApi.Tests.BuildersTests
 {
+    using System.Web.Http;
     using Common.Servers;
     using NUnit.Framework;
     using Setups;
@@ -26,5 +27,25 @@ public void AndStartsServerShouldStartServerCorrectly()
             Assert.IsNull(HttpTestServer.GlobalClient);
             Assert.IsFalse(HttpTestServer.GlobalIsStarted);
         }
+
+        [Test]
+        public void DefaultErrorDetailPolicyShouldBeAlways()
+        {
+            MyWebApi.IsUsingDefaultHttpConfiguration();
+
+            Assert.AreEqual(IncludeErrorDetailPolicy.Always, MyWebApi.Configuration.IncludeErrorDetailPolicy);
+
+            MyWebApi.IsUsing(TestObjectFactory.GetHttpConfigurationWithRoutes());
+        }
+
+        [Test]
+        public void WithErrorDetailPolicyShouldSetCorrectErrorDetailPolicy()
+        {
+            MyWebApi.IsUsingDefaultHttpConfiguration().WithErrorDetailPolicy(IncludeErrorDetailPolicy.LocalOnly);
+
+            Assert.AreEqual(IncludeErrorDetailPolicy.LocalOnly, MyWebApi.Configuration.IncludeErrorDetailPolicy);
+
+            MyWebApi.IsUsing(TestObjectFactory.GetHttpConfigurationWithRoutes());
+        }
     }
 }

src/MyWebApi/Builders/Contracts/IHttpConfigurationBuilder.cs

@@ -4,6 +4,8 @@
 // Dual-licensed under the Apache License, Version 2.0, and the Microsoft Public License (Ms-PL).
 namespace MyTested.WebApi.Builders.Contracts
 {
+    using System.Web.Http;
+
     /// <summary>
     /// HTTP configuration builder.
     /// </summary>
@@ -14,5 +16,12 @@ public interface IHttpConfigurationBuilder
         /// </summary>
         /// <returns>Server builder.</returns>
         IServerBuilder AndStartsServer();
+
+        /// <summary>
+        /// Sets the error detail policy used in the testing. Default is 'Always'.
+        /// </summary>
+        /// <param name="errorDetailPolicy">Error details policy to use.</param>
+        /// <returns>The same HTTP configuration builder.</returns>
+        IHttpConfigurationBuilder WithErrorDetailPolicy(IncludeErrorDetailPolicy errorDetailPolicy);
     }
 }

src/MyWebApi/Builders/HttpConfigurationBuilder.cs

@@ -22,6 +22,7 @@ public class HttpConfigurationBuilder : IHttpConfigurationBuilder
         public HttpConfigurationBuilder(HttpConfiguration httpConfiguration)
         {
             this.httpConfiguration = httpConfiguration;
+            this.SetErrorDetailPolicy(IncludeErrorDetailPolicy.Always);
         }
 
         /// <summary>
@@ -32,5 +33,24 @@ public IServerBuilder AndStartsServer()
         {
             return new Server().Starts(this.httpConfiguration);
         }
+
+        /// <summary>
+        /// Sets the error detail policy used in the testing. Default is 'Always'.
+        /// </summary>
+        /// <param name="errorDetailPolicy">Error details policy to use.</param>
+        /// <returns>The same HTTP configuration builder.</returns>
+        public IHttpConfigurationBuilder WithErrorDetailPolicy(IncludeErrorDetailPolicy errorDetailPolicy)
+        {
+            this.SetErrorDetailPolicy(errorDetailPolicy);
+            return this;
+        }
+
+        private void SetErrorDetailPolicy(IncludeErrorDetailPolicy errorDetailPolicy)
+        {
+            if (this.httpConfiguration != null)
+            {
+                this.httpConfiguration.IncludeErrorDetailPolicy = errorDetailPolicy;
+            }
+        }
     }
 }