Add acceptance tests for action-level API version declarations

Author: Chris Martinez

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/Basic/BasicAcceptanceTest.cs

@@ -1,6 +1,6 @@
 namespace Microsoft.Web.Http.Basic
 {
-    using Controllers;
+    using Microsoft.Web.Http.Basic.Controllers;
     using Microsoft.Web.Http.Routing;
     using System.Web.Http;
     using System.Web.Http.Routing;
@@ -19,6 +19,7 @@ protected BasicAcceptanceTest()
             FilteredControllerTypes.Add( typeof( HelloWorldController ) );
             FilteredControllerTypes.Add( typeof( PingController ) );
             FilteredControllerTypes.Add( typeof( OverlappingRouteTemplateController ) );
+            FilteredControllerTypes.Add( typeof( OrdersController ) );
             Configuration.AddApiVersioning( options => options.ReportApiVersions = true );
             Configuration.MapHttpAttributeRoutes( constraintResolver );
             Configuration.EnsureInitialized();

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/Basic/Controllers/OrdersController.cs

@@ -0,0 +1,45 @@
+namespace Microsoft.Web.Http.Basic.Controllers
+{
+    using Microsoft.Web.Http;
+    using System.Web.Http;
+    using static System.Net.HttpStatusCode;
+
+    [RoutePrefix( "api/orders" )]
+    public class OrdersController : ApiController
+    {
+        [Route]
+        [ApiVersion( "1.0" )]
+        [ApiVersion( "2.0" )]
+        public IHttpActionResult Get() => Ok();
+
+        [Route( "{id}", Name = "GetOrderById" )]
+        [ApiVersion( "0.9" )]
+        [ApiVersion( "1.0" )]
+        [ApiVersion( "2.0" )]
+        public IHttpActionResult Get( int id ) => Ok();
+
+        [Route]
+        [ApiVersion( "1.0" )]
+        [ApiVersion( "2.0" )]
+        public IHttpActionResult Post( [FromBody] Order order )
+        {
+            order.Id = 42;
+            return CreatedAtRoute( "GetOrderById", new { id = order.Id }, order );
+        }
+
+        [Route( "{id}" )]
+        [ApiVersion( "2.0" )]
+        public IHttpActionResult Put( int id, [FromBody] Order order ) => StatusCode( NoContent );
+
+        [Route( "{id}" )]
+        [ApiVersionNeutral]
+        public IHttpActionResult Delete( int id ) => StatusCode( NoContent );
+    }
+
+    public class Order
+    {
+        public int Id { get; set; }
+
+        public string Customer { get; set; }
+    }
+}

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/Basic/given a versioned ApiController/when using an action.cs

@@ -0,0 +1,73 @@
+namespace given_a_versioned_ApiController
+{
+    using FluentAssertions;
+    using Microsoft.Web.Http.Basic;
+    using System.Threading.Tasks;
+    using Xunit;
+    using static System.Net.HttpStatusCode;
+
+    public class when_using_an_action : BasicAcceptanceTest
+    {
+        [Theory]
+        [InlineData( "api/orders/42?api-version=0.9" )]
+        [InlineData( "api/orders/42?api-version=1.0" )]
+        [InlineData( "api/orders/42?api-version=2.0" )]
+        [InlineData( "api/orders?api-version=1.0" )]
+        [InlineData( "api/orders?api-version=2.0" )]
+        public async Task then_get_should_return_200( string requestUrl )
+        {
+            // arrange
+
+            // act
+            var response = await GetAsync( requestUrl );
+
+            // assert
+            response.StatusCode.Should().Be( OK );
+        }
+
+        [Theory]
+        [InlineData( "api/orders?api-version=1.0" )]
+        [InlineData( "api/orders?api-version=2.0" )]
+        public async Task then_post_should_return_201( string requestUrl )
+        {
+            // arrange
+            var content = new { customer = "Bill Mei" };
+
+            // act
+            var response = await PostAsync( requestUrl, content );
+
+            // assert
+            response.StatusCode.Should().Be( Created );
+        }
+
+        [Fact]
+        public async Task then_put_should_return_204()
+        {
+            // arrange
+            var requestUrl = "api/orders/42?api-version=2.0";
+            var content = new { customer = "Bill Mei" };
+
+            // act
+            var response = await PutAsync( requestUrl, content );
+
+            // assert
+            response.StatusCode.Should().Be( NoContent );
+        }
+
+        [Theory]
+        [InlineData( "api/orders/42" )]
+        [InlineData( "api/orders/42?api-version=0.9" )]
+        [InlineData( "api/orders/42?api-version=1.0" )]
+        [InlineData( "api/orders/42?api-version=2.0" )]
+        public async Task then_delete_should_return_204( string requestUrl )
+        {
+            // arrange
+
+            // act
+            var response = await DeleteAsync( requestUrl );
+
+            // assert
+            response.StatusCode.Should().Be( NoContent );
+        }
+    }
+}

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/ByNamespace/ByNamespaceAcceptanceTest.cs

@@ -12,7 +12,8 @@ protected enum SetupKind
         {
             None,
             HelloWorld,
-            Agreements
+            Agreements,
+            Orders,
         }
 
         protected ByNamespaceAcceptanceTest( SetupKind kind )
@@ -25,6 +26,9 @@ protected ByNamespaceAcceptanceTest( SetupKind kind )
                 case SetupKind.Agreements:
                     ConfigureAgreements();
                     break;
+                case SetupKind.Orders:
+                    ConfigureOrders();
+                    break;
             }
 
             Configuration.EnsureInitialized();
@@ -77,5 +81,25 @@ void ConfigureHelloWorld()
                     options.Conventions.Add( new VersionByNamespaceConvention() );
                 } );
         }
+
+        void ConfigureOrders()
+        {
+            FilteredControllerTypes.Add( typeof( Controllers.V1.OrdersController ) );
+            FilteredControllerTypes.Add( typeof( Controllers.V2.OrdersController ) );
+            FilteredControllerTypes.Add( typeof( Controllers.V3.OrdersController ) );
+
+            var constraintResolver = new DefaultInlineConstraintResolver()
+            {
+                ConstraintMap = { ["apiVersion"] = typeof( ApiVersionRouteConstraint ) }
+            };
+
+            Configuration.MapHttpAttributeRoutes( constraintResolver );
+            Configuration.AddApiVersioning(
+                options =>
+                {
+                    options.ReportApiVersions = true;
+                    options.Conventions.Add( new VersionByNamespaceConvention() );
+                } );
+        }
     }
 }

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/ByNamespace/Controllers/V1/OrdersController.cs

@@ -0,0 +1,27 @@
+namespace Microsoft.Web.Http.ByNamespace.Controllers.V1
+{
+    using Microsoft.Web.Http.ByNamespace.Models;
+    using System.Web.Http;
+    using static System.Net.HttpStatusCode;
+
+    [RoutePrefix( "api/orders" )]
+    public class OrdersController : ApiController
+    {
+        [Route( "{id}", Name = "GetOrderByIdV1" )]
+        public virtual IHttpActionResult Get( int id ) => Ok();
+
+        [Route]
+        public virtual IHttpActionResult Post( [FromBody] Order order )
+        {
+            order.Id = 1;
+            return CreatedAtRoute( "GetOrderByIdV1", new { id = order.Id }, order );
+        }
+
+        [Route( "{id}" )]
+        public virtual IHttpActionResult Put( int id, [FromBody] Order order ) => StatusCode( NoContent );
+
+        [Route( "{id}" )]
+        [ApiVersionNeutral]
+        public IHttpActionResult Delete( int id ) => StatusCode( NoContent );
+    }
+}

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/ByNamespace/Controllers/V2/OrdersController.cs

@@ -0,0 +1,26 @@
+namespace Microsoft.Web.Http.ByNamespace.Controllers.V2
+{
+    using Microsoft.Web.Http.ByNamespace.Models;
+    using System.Web.Http;
+    using static System.Net.HttpStatusCode;
+
+    [RoutePrefix( "api/orders" )]
+    public class OrdersController : V1.OrdersController
+    {
+        [Route]
+        public virtual IHttpActionResult Get() => Ok();
+
+        [Route( "{id}", Name = "GetOrderByIdV2" )]
+        public override IHttpActionResult Get( int id ) => Ok();
+
+        [Route]
+        public override IHttpActionResult Post( [FromBody] Order order )
+        {
+            order.Id = 2;
+            return CreatedAtRoute( "GetOrderByIdV2", new { id = order.Id }, order );
+        }
+
+        [Route( "{id}" )]
+        public override IHttpActionResult Put( int id, [FromBody] Order order ) => StatusCode( NoContent );
+    }
+}

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/ByNamespace/Controllers/V3/OrdersController.cs

@@ -0,0 +1,26 @@
+namespace Microsoft.Web.Http.ByNamespace.Controllers.V3
+{
+    using Microsoft.Web.Http.ByNamespace.Models;
+    using System.Web.Http;
+    using static System.Net.HttpStatusCode;
+
+    [RoutePrefix( "api/orders" )]
+    public class OrdersController : V2.OrdersController
+    {
+        [Route]
+        public override IHttpActionResult Get() => Ok();
+
+        [Route( "{id}", Name = "GetOrderByIdV3" )]
+        public override IHttpActionResult Get( int id ) => Ok();
+
+        [Route]
+        public override IHttpActionResult Post( [FromBody] Order order )
+        {
+            order.Id = 3;
+            return CreatedAtRoute( "GetOrderByIdV3", new { id = order.Id }, order );
+        }
+
+        [Route( "{id}" )]
+        public override IHttpActionResult Put( int id, [FromBody] Order order ) => StatusCode( NoContent );
+    }
+}

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/ByNamespace/Models/Order.cs

@@ -0,0 +1,11 @@
+namespace Microsoft.Web.Http.ByNamespace.Models
+{
+    using System;
+
+    public class Order
+    {
+        public int Id { get; set; }
+
+        public string Customer { get; set; }
+    }
+}

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/ByNamespace/given a versioned ApiController per namespace/when using an action.cs

@@ -0,0 +1,72 @@
+namespace given_a_versioned_ApiController_per_namespace
+{
+    using FluentAssertions;
+    using Microsoft.Web.Http.ByNamespace;
+    using System.Threading.Tasks;
+    using Xunit;
+    using static System.Net.HttpStatusCode;
+
+    public class when_using_an_action : ByNamespaceAcceptanceTest
+    {
+        public when_using_an_action() : base( SetupKind.Orders ) { }
+
+        [Theory]
+        [InlineData( "api/orders/42?api-version=1.0" )]
+        [InlineData( "api/orders/42?api-version=2.0" )]
+        [InlineData( "api/orders?api-version=2.0" )]
+        public async Task then_get_should_return_200( string requestUrl )
+        {
+            // arrange
+
+            // act
+            var response = await GetAsync( requestUrl );
+
+            // assert
+            response.StatusCode.Should().Be( OK );
+        }
+
+        [Theory]
+        [InlineData( "api/orders?api-version=1.0" )]
+        [InlineData( "api/orders?api-version=2.0" )]
+        public async Task then_post_should_return_201( string requestUrl )
+        {
+            // arrange
+            var content = new { customer = "Bill Mei" };
+
+            // act
+            var response = await PostAsync( requestUrl, content );
+
+            // assert
+            response.StatusCode.Should().Be( Created );
+        }
+
+        [Fact]
+        public async Task then_put_should_return_204()
+        {
+            // arrange
+            var requestUrl = "api/orders/42?api-version=2.0";
+            var content = new { customer = "Bill Mei" };
+
+            // act
+            var response = await PutAsync( requestUrl, content );
+
+            // assert
+            response.StatusCode.Should().Be( NoContent );
+        }
+
+        [Theory]
+        [InlineData( "api/orders/42" )]
+        [InlineData( "api/orders/42?api-version=1.0" )]
+        [InlineData( "api/orders/42?api-version=2.0" )]
+        public async Task then_delete_should_return_204( string requestUrl )
+        {
+            // arrange
+
+            // act
+            var response = await DeleteAsync( requestUrl );
+
+            // assert
+            response.StatusCode.Should().Be( NoContent );
+        }
+    }
+}

test/Microsoft.AspNet.WebApi.Acceptance.Tests/Http/Conventions/Controllers/OrdersController.cs

@@ -0,0 +1,35 @@
+namespace Microsoft.Web.Http.Conventions.Controllers
+{
+    using System.Web.Http;
+    using static System.Net.HttpStatusCode;
+
+    [RoutePrefix( "api/orders" )]
+    public class OrdersController : ApiController
+    {
+        [Route]
+        public IHttpActionResult Get() => Ok();
+
+        [Route( "{id}", Name = "GetOrderById" )]
+        public IHttpActionResult Get( int id ) => Ok();
+
+        [Route]
+        public IHttpActionResult Post( [FromBody] Order order )
+        {
+            order.Id = 42;
+            return CreatedAtRoute( "GetOrderById", new { id = order.Id }, order );
+        }
+
+        [Route( "{id}" )]
+        public IHttpActionResult Put( int id, [FromBody] Order order ) => StatusCode( NoContent );
+
+        [Route( "{id}" )]
+        public IHttpActionResult Delete( int id ) => StatusCode( NoContent );
+    }
+
+    public class Order
+    {
+        public int Id { get; set; }
+
+        public string Customer { get; set; }
+    }
+}