// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. #if NET45 using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNet.Http; using Microsoft.AspNet.Routing.Logging; using Microsoft.Framework.Logging; using Moq; using Xunit; namespace Microsoft.AspNet.Routing { public class RouteCollectionTest { [Fact] public async Task RouteAsync_LogsCorrectValuesWhenHandled() { // Arrange var sink = new TestSink( TestSink.EnableWithTypeName, TestSink.EnableWithTypeName); var loggerFactory = new TestLoggerFactory(sink); var routes = new RouteCollection(); var route = CreateRoute(accept: true); routes.Add(route.Object); var context = CreateRouteContext("/Cool", loggerFactory); // Act await routes.RouteAsync(context); // Assert Assert.Equal(1, sink.Scopes.Count); var scope = sink.Scopes[0]; Assert.Equal(typeof(RouteCollection).FullName, scope.LoggerName); Assert.Equal("RouteCollection.RouteAsync", scope.Scope); // There is a record for IsEnabled and one for WriteCore. Assert.Equal(2, sink.Writes.Count); var enabled = sink.Writes[0]; Assert.Equal(typeof(RouteCollection).FullName, enabled.LoggerName); Assert.Equal("RouteCollection.RouteAsync", enabled.Scope); Assert.Null(enabled.State); var write = sink.Writes[1]; Assert.Equal(typeof(RouteCollection).FullName, write.LoggerName); Assert.Equal("RouteCollection.RouteAsync", write.Scope); var values = Assert.IsType(write.State); Assert.Equal("RouteCollection.RouteAsync", values.Name); Assert.NotNull(values.Routes); Assert.Equal(true, values.Handled); } [Fact] public async Task RouteAsync_LogsCorrectValuesWhenNotHandled() { // Arrange var sink = new TestSink( TestSink.EnableWithTypeName, TestSink.EnableWithTypeName); var loggerFactory = new TestLoggerFactory(sink); var routes = new RouteCollection(); var route = CreateRoute(accept: false); routes.Add(route.Object); var context = CreateRouteContext("/Cool", loggerFactory); // Act await routes.RouteAsync(context); // Assert Assert.Equal(1, sink.Scopes.Count); var scope = sink.Scopes[0]; Assert.Equal(typeof(RouteCollection).FullName, scope.LoggerName); Assert.Equal("RouteCollection.RouteAsync", scope.Scope); // There is a record for IsEnabled and one for WriteCore. Assert.Equal(2, sink.Writes.Count); var enabled = sink.Writes[0]; Assert.Equal(typeof(RouteCollection).FullName, enabled.LoggerName); Assert.Equal("RouteCollection.RouteAsync", enabled.Scope); Assert.Null(enabled.State); var write = sink.Writes[1]; Assert.Equal(typeof(RouteCollection).FullName, write.LoggerName); Assert.Equal("RouteCollection.RouteAsync", write.Scope); var values = Assert.IsType(write.State); Assert.Equal("RouteCollection.RouteAsync", values.Name); Assert.NotNull(values.Routes); Assert.Equal(false, values.Handled); } [Fact] public async Task RouteAsync_FirstMatches() { // Arrange var routes = new RouteCollection(); var route1 = CreateRoute(accept: true); routes.Add(route1.Object); var route2 = CreateRoute(accept: false); routes.Add(route2.Object); var context = CreateRouteContext("/Cool"); // Act await routes.RouteAsync(context); // Assert route1.Verify(e => e.RouteAsync(It.IsAny()), Times.Exactly(1)); route2.Verify(e => e.RouteAsync(It.IsAny()), Times.Exactly(0)); Assert.True(context.IsHandled); } [Fact] public async Task RouteAsync_SecondMatches() { // Arrange var routes = new RouteCollection(); var route1 = CreateRoute(accept: false); routes.Add(route1.Object); var route2 = CreateRoute(accept: true); routes.Add(route2.Object); var context = CreateRouteContext("/Cool"); // Act await routes.RouteAsync(context); // Assert route1.Verify(e => e.RouteAsync(It.IsAny()), Times.Exactly(1)); route2.Verify(e => e.RouteAsync(It.IsAny()), Times.Exactly(1)); Assert.True(context.IsHandled); } [Fact] public async Task RouteAsync_NoMatch() { // Arrange var routes = new RouteCollection(); var route1 = CreateRoute(accept: false); routes.Add(route1.Object); var route2 = CreateRoute(accept: false); routes.Add(route2.Object); var context = CreateRouteContext("/Cool"); // Act await routes.RouteAsync(context); // Assert route1.Verify(e => e.RouteAsync(It.IsAny()), Times.Exactly(1)); route2.Verify(e => e.RouteAsync(It.IsAny()), Times.Exactly(1)); Assert.False(context.IsHandled); } [Fact] public void NamedRouteTests_GetNamedRoute_ReturnsValue() { // Arrange var routeCollection = GetNestedRouteCollection(new string[] { "Route1", "Route2", "RouteName", "Route3" }); var virtualPathContext = CreateVirtualPathContext("RouteName"); // Act var stringVirtualPath = routeCollection.GetVirtualPath(virtualPathContext); // Assert Assert.Equal("RouteName", stringVirtualPath); } [Fact] public void NamedRouteTests_GetNamedRoute_RouteNotFound() { // Arrange var routeCollection = GetNestedRouteCollection(new string[] { "Route1", "Route2", "Route3" }); var virtualPathContext = CreateVirtualPathContext("NonExistantRoute"); // Act var stringVirtualPath = routeCollection.GetVirtualPath(virtualPathContext); // Assert Assert.Null(stringVirtualPath); } [Fact] public void NamedRouteTests_GetNamedRoute_AmbiguousRoutesInCollection_DoesNotThrowForUnambiguousRoute() { // Arrange var routeCollection = GetNestedRouteCollection(new string[] { "Route1", "Route2", "Route3", "Route4" }); // Add Duplicate route. routeCollection.Add(CreateNamedRoute("Route3")); var virtualPathContext = CreateVirtualPathContext("Route1"); // Act var stringVirtualPath = routeCollection.GetVirtualPath(virtualPathContext); // Assert Assert.Equal("Route1", stringVirtualPath); } [Fact] public void NamedRouteTests_GetNamedRoute_AmbiguousRoutesInCollection_ThrowsForAmbiguousRoute() { // Arrange var ambiguousRoute = "ambiguousRoute"; var routeCollection = GetNestedRouteCollection(new string[] { "Route1", "Route2", ambiguousRoute, "Route4" }); // Add Duplicate route. routeCollection.Add(CreateNamedRoute(ambiguousRoute)); var virtualPathContext = CreateVirtualPathContext(ambiguousRoute); // Act & Assert var ex = Assert.Throws(() => routeCollection.GetVirtualPath(virtualPathContext)); Assert.Equal("The supplied route name 'ambiguousRoute' is ambiguous and matched more than one route.", ex.Message); } private static RouteCollection GetRouteCollectionWithNamedRoutes(IEnumerable routeNames) { var routes = new RouteCollection(); foreach (var routeName in routeNames) { var route1 = CreateNamedRoute(routeName); routes.Add(route1); } return routes; } private static RouteCollection GetNestedRouteCollection(string[] routeNames) { var rnd = new Random(); int index = rnd.Next(0, routeNames.Length - 1); var first = routeNames.Take(index).ToArray(); var second = routeNames.Skip(index).ToArray(); var rc1 = GetRouteCollectionWithNamedRoutes(first); var rc2 = GetRouteCollectionWithNamedRoutes(second); var rc3 = new RouteCollection(); var rc4 = new RouteCollection(); rc1.Add(rc3); rc4.Add(rc2); // Add a few unnamedRoutes. rc1.Add(CreateRoute().Object); rc2.Add(CreateRoute().Object); rc3.Add(CreateRoute().Object); rc3.Add(CreateRoute().Object); rc4.Add(CreateRoute().Object); rc4.Add(CreateRoute().Object); var routeCollection = new RouteCollection(); routeCollection.Add(rc1); routeCollection.Add(rc4); return routeCollection; } private static INamedRouter CreateNamedRoute(string name, bool accept = false) { var target = new Mock(MockBehavior.Strict); target .Setup(e => e.GetVirtualPath(It.IsAny())) .Callback(c => c.IsBound = accept) .Returns(c => name) .Verifiable(); target .SetupGet(e => e.Name) .Returns(name); target .Setup(e => e.RouteAsync(It.IsAny())) .Callback((c) => c.IsHandled = accept) .Returns(Task.FromResult(null)) .Verifiable(); return target.Object; } private static VirtualPathContext CreateVirtualPathContext(string routeName) { return new VirtualPathContext(null, null, null, routeName); } private static RouteContext CreateRouteContext(string requestPath, ILoggerFactory factory = null) { if (factory == null) { factory = NullLoggerFactory.Instance; } var request = new Mock(MockBehavior.Strict); request.SetupGet(r => r.Path).Returns(new PathString(requestPath)); var context = new Mock(MockBehavior.Strict); context.Setup(m => m.RequestServices.GetService(typeof(ILoggerFactory))) .Returns(factory); context.SetupGet(c => c.Request).Returns(request.Object); return new RouteContext(context.Object); } private static Mock CreateRoute(bool accept = true) { var target = new Mock(MockBehavior.Strict); target .Setup(e => e.GetVirtualPath(It.IsAny())) .Callback(c => c.IsBound = accept) .Returns(null) .Verifiable(); target .Setup(e => e.RouteAsync(It.IsAny())) .Callback((c) => c.IsHandled = accept) .Returns(Task.FromResult(null)) .Verifiable(); return target; } } } #endif