Added With for better readability where parameter values are not important (closes #209)

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

@@ -726,6 +726,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 +850,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>()

src/MyWebApi.Tests/BuildersTests/AttributesTests/ControllerAttributesTestBuilderTests.cs

@@ -39,7 +39,7 @@ public void ChangingRouteToShouldNotThrowExceptionWithControllerWithTheAttribute
             MyWebApi
                 .Controller<AttributesController>()
                 .ShouldHave()
-                .Attributes(attributes => attributes.ChangingRouteTo("/api/test"));
+                .Attributes(attributes => attributes.ChangingRouteTo("api/test"));
         }
 
         [Test]
@@ -48,19 +48,19 @@ public void ChangingRouteToShouldNotThrowExceptionWithControllerWithTheAttribute
             MyWebApi
                 .Controller<AttributesController>()
                 .ShouldHave()
-                .Attributes(attributes => attributes.ChangingRouteTo("/api/Test"));
+                .Attributes(attributes => attributes.ChangingRouteTo("api/Test"));
         }
 
         [Test]
         [ExpectedException(
             typeof(AttributeAssertionException),
-            ExpectedMessage = "When testing AttributesController was expected to have RouteAttribute with '/api/another' template, but in fact found '/api/test'.")]
+            ExpectedMessage = "When testing AttributesController was expected to have RouteAttribute with 'api/another' template, but in fact found 'api/test'.")]
         public void ChangingRouteToShouldThrowExceptionWithControllerWithTheAttributeAndWrongTemplate()
         {
             MyWebApi
                 .Controller<AttributesController>()
                 .ShouldHave()
-                .Attributes(attributes => attributes.ChangingRouteTo("/api/another"));
+                .Attributes(attributes => attributes.ChangingRouteTo("api/another"));
         }
 
         [Test]
@@ -69,19 +69,19 @@ public void ChangingRouteToShouldNotThrowExceptionWithControllerWithTheAttribute
             MyWebApi
                 .Controller<AttributesController>()
                 .ShouldHave()
-                .Attributes(attributes => attributes.ChangingRouteTo("/api/test", withName: "TestRoute"));
+                .Attributes(attributes => attributes.ChangingRouteTo("api/test", withName: "TestRouteAttributes"));
         }
 
         [Test]
         [ExpectedException(
             typeof(AttributeAssertionException),
-            ExpectedMessage = "When testing AttributesController was expected to have RouteAttribute with 'AnotherRoute' name, but in fact found 'TestRoute'.")]
+            ExpectedMessage = "When testing AttributesController was expected to have RouteAttribute with 'AnotherRoute' name, but in fact found 'TestRouteAttributes'.")]
         public void ChangingRouteToShouldThrowExceptionWithActionWithTheAttributeAndWrongName()
         {
             MyWebApi
                 .Controller<AttributesController>()
                 .ShouldHave()
-                .Attributes(attributes => attributes.ChangingRouteTo("/api/test", withName: "AnotherRoute"));
+                .Attributes(attributes => attributes.ChangingRouteTo("api/test", withName: "AnotherRoute"));
         }
 
         [Test]
@@ -90,7 +90,7 @@ public void ChangingRouteToShouldNotThrowExceptionWithActionWithTheAttributeAndC
             MyWebApi
                 .Controller<AttributesController>()
                 .ShouldHave()
-                .Attributes(attributes => attributes.ChangingRouteTo("/api/test", withOrder: 1));
+                .Attributes(attributes => attributes.ChangingRouteTo("api/test", withOrder: 1));
         }
 
         [Test]
@@ -102,7 +102,7 @@ public void ChangingRouteToShouldThrowExceptionWithActionWithTheAttributeAndWron
             MyWebApi
                 .Controller<AttributesController>()
                 .ShouldHave()
-                .Attributes(attributes => attributes.ChangingRouteTo("/api/test", withOrder: 2));
+                .Attributes(attributes => attributes.ChangingRouteTo("api/test", withOrder: 2));
         }
 
         [Test]
@@ -114,7 +114,7 @@ public void ChangingRouteToShouldThrowExceptionWithActionWithoutTheAttribute()
             MyWebApi
                 .Controller<WebApiController>()
                 .ShouldHave()
-                .Attributes(attributes => attributes.ChangingRouteTo("/api/test"));
+                .Attributes(attributes => attributes.ChangingRouteTo("api/test"));
         }
 
         [Test]
@@ -253,7 +253,7 @@ public void AndAlsoShouldWorkCorrectly()
                     => attributes
                         .AllowingAnonymousRequests()
                         .AndAlso()
-                        .ChangingRouteTo("/api/test"));
+                        .ChangingRouteTo("api/test"));
         }
     }
 }

src/MyWebApi.Tests/MyWebApi.Tests.csproj

@@ -168,6 +168,7 @@
     <Compile Include="UtilitiesTests\ValidatorsTests\MediaTypeFormatterValidatorTests.cs" />
     <Compile Include="UtilitiesTests\ValidatorsTests\RuntimeBinderValidatorTests.cs" />
     <Compile Include="UtilitiesTests\ValidatorsTests\VersionValidatorTests.cs" />
+    <Compile Include="WithTests.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="app.config" />

src/MyWebApi.Tests/Setups/Controllers/AttributesController.cs

@@ -7,8 +7,13 @@ namespace MyTested.WebApi.Tests.Setups.Controllers
     using System.Web.Http;
 
     [AllowAnonymous]
-    [Route("/api/test", Name = "TestRoute", Order = 1)]
+    [Route("api/test", Name = "TestRouteAttributes", Order = 1)]
     public class AttributesController : ApiController
     {
+        [AllowAnonymous]
+        public IHttpActionResult WithAttributesAndParameters(int id)
+        {
+            return this.Ok(id);
+        }
     }
 }

src/MyWebApi.Tests/WithTests.cs

@@ -0,0 +1,24 @@
+// 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.Tests
+{
+    using NUnit.Framework;
+    using Setups.Controllers;
+
+    [TestFixture]
+    public class WithTests
+    {
+        [Test]
+        public void WithAnyShouldWorkCorrectlyWhereTheValueOfActionParametersAreNotImportant()
+        {
+            MyWebApi
+                .Controller<AttributesController>()
+                .Calling(c => c.WithAttributesAndParameters(With.Any<int>()))
+                .ShouldHave()
+                .ActionAttributes(attrs => attrs.AllowingAnonymousRequests());
+        }
+    }
+}

src/MyWebApi/Common/Servers/OwinTestServer.cs

@@ -14,7 +14,7 @@ namespace MyTested.WebApi.Common.Servers
     public static class OwinTestServer
     {
         /// <summary>
-        /// Default host on which the OWIN server will listen - http://localhost.
+        /// Default host on which the OWIN server will listen - local host.
         /// </summary>
         public const string DefaultHost = "http://localhost";
 

src/MyWebApi/MyWebApi.csproj

@@ -279,6 +279,7 @@
     <Compile Include="Utilities\Validators\RouteValidator.cs" />
     <Compile Include="Utilities\Validators\RuntimeBinderValidator.cs" />
     <Compile Include="Utilities\Validators\VersionValidator.cs" />
+    <Compile Include="With.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="MyWebApi.licenseheader" />

src/MyWebApi/With.cs

@@ -0,0 +1,23 @@
+// 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>
+    /// Provides easier parameter selection in lambda expression where the value of the parameter does not matter.
+    /// </summary>
+    public class With
+    {
+        /// <summary>
+        /// Provides any parameter to lambda expression where the value of the parameter does not matter.
+        /// </summary>
+        /// <typeparam name="TParameter">Type of parameter.</typeparam>
+        /// <returns>Default value of TParameter.</returns>
+        public static TParameter Any<TParameter>()
+        {
+            return default(TParameter);
+        }
+    }
+}