[Endpoint routing review]First draft to enable endpoint routing using dynamic controller (OData#2035)

* Enable endpoint routing using dynamic controller

* Update to 7.4.0

* Update the PublicAPI test cases

* Add the E2E test cases

* Change the startup to test the per-route configuration

* Some test codes about policy

* Use MatcherPolicy Instead of EndpointSelector to resolve the ambiguity

* Address the comments and add LinkGenerator test cases

* Revert the EF Core version to 2.2.0 to make Aggregation E2E test pass

Author: xuzhg

samples/AspNetCore3xEndpointSample.Web/AspNetCore3xEndpointSample.Web.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="3.1.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="3.1.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Proxies" Version="3.1.0" />
+  </ItemGroup>
+  
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Microsoft.AspNetCore.OData\Microsoft.AspNetCore.OData.csproj" />
+  </ItemGroup>
+
+
+</Project>

samples/AspNetCore3xEndpointSample.Web/Controllers/CustomersController.cs

@@ -0,0 +1,90 @@
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+// Licensed under the MIT License.  See License.txt in the project root for license information.
+
+using System.Collections.Generic;
+using System.Linq;
+using AspNetCore3xEndpointSample.Web.Models;
+using Microsoft.AspNet.OData;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.EntityFrameworkCore;
+
+namespace AspNetCore3xEndpointSample.Web.Controllers
+{
+    public class CustomersController : ODataController
+    {
+        private readonly CustomerOrderContext _context;
+
+        public CustomersController(CustomerOrderContext context)
+        {
+            _context = context;
+
+            if (_context.Customers.Count() == 0)
+            {
+                IList<Customer> customers = new List<Customer>
+                {
+                    new Customer
+                    {
+                        Name = "Jonier",
+                        HomeAddress = new Address { City = "Redmond", Street = "156 AVE NE"},
+                        FavoriteAddresses = new List<Address>
+                        {
+                            new Address { City = "Redmond", Street = "256 AVE NE"},
+                            new Address { City = "Redd", Street = "56 AVE NE"},
+                        },
+                        Order = new Order { Title = "104m" },
+                        Orders = Enumerable.Range(0, 2).Select(e => new Order { Title = "abc" + e }).ToList()
+                    },
+                    new Customer
+                    {
+                        Name = "Sam",
+                        HomeAddress = new Address { City = "Bellevue", Street = "Main St NE"},
+                        FavoriteAddresses = new List<Address>
+                        {
+                            new Address { City = "Red4ond", Street = "456 AVE NE"},
+                            new Address { City = "Re4d", Street = "51 NE"},
+                        },
+                        Order = new Order { Title = "Zhang" },
+                        Orders = Enumerable.Range(0, 2).Select(e => new Order { Title = "xyz" + e }).ToList()
+                    },
+                    new Customer
+                    {
+                        Name = "Peter",
+                        HomeAddress = new Address {  City = "Hollewye", Street = "Main St NE"},
+                        FavoriteAddresses = new List<Address>
+                        {
+                            new Address { City = "R4mond", Street = "546 NE"},
+                            new Address { City = "R4d", Street = "546 AVE"},
+                        },
+                        Order = new Order { Title = "Jichan" },
+                        Orders = Enumerable.Range(0, 2).Select(e => new Order { Title = "ijk" + e }).ToList()
+                    },
+                };
+
+                foreach (var customer in customers)
+                {
+                    _context.Customers.Add(customer);
+                    _context.Orders.Add(customer.Order);
+                    _context.Orders.AddRange(customer.Orders);
+                }
+
+                _context.SaveChanges();
+            }
+        }
+
+        [EnableQuery]
+        public IActionResult Get()
+        {
+            // Be noted: without the NoTracking setting, the query for $select=HomeAddress with throw exception:
+            // A tracking query projects owned entity without corresponding owner in result. Owned entities cannot be tracked without their owner...
+            _context.ChangeTracker.QueryTrackingBehavior = QueryTrackingBehavior.NoTracking;
+
+            return Ok(_context.Customers);
+        }
+
+        [EnableQuery]
+        public IActionResult Get(int key)
+        {
+            return Ok(_context.Customers.FirstOrDefault(c => c.Id == key));
+        }
+    }
+}

samples/AspNetCore3xEndpointSample.Web/Controllers/WeatherForecastController.cs

@@ -0,0 +1,45 @@
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+// Licensed under the MIT License.  See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using AspNetCore3xEndpointSample.Web.Models;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+
+namespace AspNetCore3xEndpointSample.Web.Controllers
+{
+    /// <summary>
+    /// Keep this one to test that the non-odata request can dispatch correctly.
+    /// </summary>
+    [ApiController]
+    [Route("[controller]")]
+    public class WeatherForecastController : ControllerBase
+    {
+        private static readonly string[] Summaries = new[]
+        {
+            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
+        };
+
+        private readonly ILogger<WeatherForecastController> _logger;
+
+        public WeatherForecastController(ILogger<WeatherForecastController> logger)
+        {
+            _logger = logger;
+        }
+
+        [HttpGet]
+        public IEnumerable<WeatherForecast> Get()
+        {
+            var rng = new Random();
+            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
+            {
+                Date = DateTime.Now.AddDays(index),
+                TemperatureC = rng.Next(-20, 55),
+                Summary = Summaries[rng.Next(Summaries.Length)]
+            })
+            .ToArray();
+        }
+    }
+}

samples/AspNetCore3xEndpointSample.Web/Models/CustomerOrder.cs

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+// Licensed under the MIT License.  See License.txt in the project root for license information.
+
+using System.Collections.Generic;
+using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
+
+namespace AspNetCore3xEndpointSample.Web.Models
+{
+    public class Customer
+    {
+        public int Id { get; set; }
+
+        public string Name { get; set; }
+
+        public virtual Address HomeAddress { get; set; }
+
+        public virtual IList<Address> FavoriteAddresses { get; set; }
+
+        public virtual Order Order { get; set; }
+
+        public virtual IList<Order> Orders { get; set; }
+    }
+
+    public class Order
+    {
+        public int Id { get; set; }
+
+        public string Title { get; set; }
+    }
+
+    [Owned, ComplexType]
+    public class Address
+    {
+        public string City { get; set; }
+
+        public string Street { get; set; }
+    }
+}

samples/AspNetCore3xEndpointSample.Web/Models/CustomerOrderContext.cs

@@ -0,0 +1,24 @@
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+// Licensed under the MIT License.  See License.txt in the project root for license information.
+
+using Microsoft.EntityFrameworkCore;
+
+namespace AspNetCore3xEndpointSample.Web.Models
+{
+    public class CustomerOrderContext : DbContext
+    {
+        public CustomerOrderContext(DbContextOptions<CustomerOrderContext> options)
+            : base(options)
+        {
+        }
+
+        public DbSet<Customer> Customers { get; set; }
+
+        public DbSet<Order> Orders { get; set; }
+
+        protected override void OnModelCreating(ModelBuilder modelBuilder)
+        {
+            modelBuilder.Entity<Customer>().OwnsOne(c => c.HomeAddress).WithOwner();
+        }
+    }
+}

samples/AspNetCore3xEndpointSample.Web/Models/EdmModelBuilder.cs

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+// Licensed under the MIT License.  See License.txt in the project root for license information.
+
+using Microsoft.AspNet.OData.Builder;
+using Microsoft.OData.Edm;
+
+namespace AspNetCore3xEndpointSample.Web.Models
+{
+    public static class EdmModelBuilder
+    {
+        private static IEdmModel _edmModel;
+
+        public static IEdmModel GetEdmModel()
+        {
+            if (_edmModel == null)
+            {
+                var builder = new ODataConventionModelBuilder();
+                builder.EntitySet<Customer>("Customers");
+                builder.EntitySet<Order>("Orders");
+                _edmModel = builder.GetEdmModel();
+            }
+
+            return _edmModel;
+        }
+
+    }
+}

samples/AspNetCore3xEndpointSample.Web/Models/WeatherForecast.cs

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+// Licensed under the MIT License.  See License.txt in the project root for license information.
+
+using System;
+
+namespace AspNetCore3xEndpointSample.Web.Models
+{
+    public class WeatherForecast
+    {
+        public DateTime Date { get; set; }
+
+        public int TemperatureC { get; set; }
+
+        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
+
+        public string Summary { get; set; }
+    }
+}

samples/AspNetCore3xEndpointSample.Web/Program.cs

@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+// Licensed under the MIT License.  See License.txt in the project root for license information.
+
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Hosting;
+
+namespace AspNetCore3xEndpointSample.Web
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            CreateHostBuilder(args).Build().Run();
+        }
+
+        public static IHostBuilder CreateHostBuilder(string[] args) =>
+            Host.CreateDefaultBuilder(args)
+                .ConfigureWebHostDefaults(webBuilder =>
+                {
+                    webBuilder.UseStartup<Startup>();
+                });
+    }
+}

samples/AspNetCore3xEndpointSample.Web/Properties/launchSettings.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:2087",
+      "sslPort": 0
+    }
+  },
+  "profiles": {
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "launchUrl": "weatherforecast",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "AspNetCore3xEndpointSample.Web": {
+      "commandName": "Project",
+      "launchBrowser": false,
+      "launchUrl": "odata/Customers",
+      "applicationUrl": "http://localhost:5000",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}