File: Routing\KnownRouteValueConstraintTests.cs
Web Access
Project: src\src\Mvc\Mvc.Core\test\Microsoft.AspNetCore.Mvc.Core.Test.csproj (Microsoft.AspNetCore.Mvc.Core.Test)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Globalization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Abstractions;
using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.AspNetCore.Mvc.Infrastructure;
using Microsoft.AspNetCore.Routing;
using Microsoft.AspNetCore.InternalTesting;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging.Abstractions;
using Moq;
 
namespace Microsoft.AspNetCore.Mvc.Routing;
 
public class KnownRouteValueConstraintTests
{
    [Fact]
    public void ResolveFromServices_InjectsServiceProvider_HttpContextNotNeeded()
    {
        // Arrange
        var actionDescriptor = CreateActionDescriptor("testArea",
            "testController",
            "testAction");
        actionDescriptor.RouteValues.Add("randomKey", "testRandom");
        var descriptorCollectionProvider = CreateActionDescriptorCollectionProvider(actionDescriptor);
 
        var services = new ServiceCollection();
        services.AddRouting();
        services.AddSingleton(descriptorCollectionProvider);
 
        var routeOptionsSetup = new MvcCoreRouteOptionsSetup();
        services.Configure<RouteOptions>(routeOptionsSetup.Configure);
 
        var serviceProvider = services.BuildServiceProvider();
 
        var inlineConstraintResolver = serviceProvider.GetRequiredService<IInlineConstraintResolver>();
        var constraint = inlineConstraintResolver.ResolveConstraint("exists");
 
        var values = new RouteValueDictionary()
            {
                { "area", "testArea" },
                { "controller", "testController" },
                { "action", "testAction" },
                { "randomKey", "testRandom" }
            };
 
        // Act
        var knownRouteValueConstraint = Assert.IsType<KnownRouteValueConstraint>(constraint);
        var match = knownRouteValueConstraint.Match(httpContext: null, route: null, "area", values, RouteDirection.IncomingRequest);
 
        // Assert
        Assert.True(match);
    }
 
    [Theory]
    [InlineData("area", RouteDirection.IncomingRequest)]
    [InlineData("controller", RouteDirection.IncomingRequest)]
    [InlineData("action", RouteDirection.IncomingRequest)]
    [InlineData("randomKey", RouteDirection.IncomingRequest)]
    [InlineData("area", RouteDirection.UrlGeneration)]
    [InlineData("controller", RouteDirection.UrlGeneration)]
    [InlineData("action", RouteDirection.UrlGeneration)]
    [InlineData("randomKey", RouteDirection.UrlGeneration)]
    public void RouteKey_DoesNotExist_MatchFails(string keyName, RouteDirection direction)
    {
        // Arrange
        var values = new RouteValueDictionary();
        var httpContext = GetHttpContext();
        var route = Mock.Of<IRouter>();
        var descriptorCollectionProvider = CreateActionDescriptorCollectionProvider(new ActionDescriptor());
        var constraint = new KnownRouteValueConstraint(descriptorCollectionProvider);
 
        // Act
        var match = constraint.Match(httpContext, route, keyName, values, direction);
 
        // Assert
        Assert.False(match);
    }
 
    [Theory]
    [InlineData("area", RouteDirection.IncomingRequest)]
    [InlineData("controller", RouteDirection.IncomingRequest)]
    [InlineData("action", RouteDirection.IncomingRequest)]
    [InlineData("randomKey", RouteDirection.IncomingRequest)]
    [InlineData("area", RouteDirection.UrlGeneration)]
    [InlineData("controller", RouteDirection.UrlGeneration)]
    [InlineData("action", RouteDirection.UrlGeneration)]
    [InlineData("randomKey", RouteDirection.UrlGeneration)]
    public void RouteKey_Exists_MatchSucceeds(string keyName, RouteDirection direction)
    {
        // Arrange
        var actionDescriptor = CreateActionDescriptor("testArea",
            "testController",
            "testAction");
        actionDescriptor.RouteValues.Add("randomKey", "testRandom");
        var descriptorCollectionProvider = CreateActionDescriptorCollectionProvider(actionDescriptor);
 
        var httpContext = GetHttpContext();
        var route = Mock.Of<IRouter>();
        var values = new RouteValueDictionary()
            {
                { "area", "testArea" },
                { "controller", "testController" },
                { "action", "testAction" },
                { "randomKey", "testRandom" }
            };
        var constraint = new KnownRouteValueConstraint(descriptorCollectionProvider);
 
        // Act
        var match = constraint.Match(httpContext, route, keyName, values, direction);
 
        // Assert
        Assert.True(match);
    }
 
    [Theory]
    [InlineData("area", RouteDirection.IncomingRequest)]
    [InlineData("controller", RouteDirection.IncomingRequest)]
    [InlineData("action", RouteDirection.IncomingRequest)]
    [InlineData("randomKey", RouteDirection.IncomingRequest)]
    [InlineData("area", RouteDirection.UrlGeneration)]
    [InlineData("controller", RouteDirection.UrlGeneration)]
    [InlineData("action", RouteDirection.UrlGeneration)]
    [InlineData("randomKey", RouteDirection.UrlGeneration)]
    public void RouteValue_DoesNotExists_MatchFails(string keyName, RouteDirection direction)
    {
        // Arrange
        var actionDescriptor = CreateActionDescriptor(
            "testArea",
            "testController",
            "testAction");
        actionDescriptor.RouteValues.Add("randomKey", "testRandom");
        var descriptorCollectionProvider = CreateActionDescriptorCollectionProvider(actionDescriptor);
 
        var httpContext = GetHttpContext();
        var route = Mock.Of<IRouter>();
        var values = new RouteValueDictionary()
            {
                { "area", "invalidTestArea" },
                { "controller", "invalidTestController" },
                { "action", "invalidTestAction" },
                { "randomKey", "invalidTestRandom" }
            };
 
        var constraint = new KnownRouteValueConstraint(descriptorCollectionProvider);
 
        // Act
        var match = constraint.Match(httpContext, route, keyName, values, direction);
 
        // Assert
        Assert.False(match);
    }
 
    [Theory]
    [InlineData(RouteDirection.IncomingRequest)]
    [InlineData(RouteDirection.UrlGeneration)]
    public void RouteValue_IsNotAString_MatchFails(RouteDirection direction)
    {
        var actionDescriptor = CreateActionDescriptor("testArea",
            controller: null,
            action: null);
        var descriptorCollectionProvider = CreateActionDescriptorCollectionProvider(actionDescriptor);
 
        var httpContext = GetHttpContext();
        var route = Mock.Of<IRouter>();
        var values = new RouteValueDictionary()
            {
                { "area", 12 },
            };
        var constraint = new KnownRouteValueConstraint(descriptorCollectionProvider);
 
        // Act
        var match = constraint.Match(httpContext, route, "area", values, direction);
 
        // Assert
        Assert.False(match);
    }
 
    [Theory]
    [InlineData(RouteDirection.IncomingRequest)]
    [InlineData(RouteDirection.UrlGeneration)]
    public void ActionDescriptorCollection_SettingNullValue_Throws(RouteDirection direction)
    {
        // Arrange
        var actionDescriptorCollectionProvider = Mock.Of<IActionDescriptorCollectionProvider>();
        var constraint = new KnownRouteValueConstraint(actionDescriptorCollectionProvider);
 
        // Act & Assert
        var ex = Assert.Throws<InvalidOperationException>(
            () => constraint.Match(
                GetHttpContext(),
                Mock.Of<IRouter>(),
                "area",
                new RouteValueDictionary { { "area", "area" } },
                direction));
        var providerName = actionDescriptorCollectionProvider.GetType().FullName;
        Assert.Equal(
            $"The 'ActionDescriptors' property of '{providerName}' must not be null.",
            ex.Message);
    }
 
    [Theory]
    [InlineData("area", RouteDirection.IncomingRequest)]
    [InlineData("controller", RouteDirection.IncomingRequest)]
    [InlineData("action", RouteDirection.IncomingRequest)]
    [InlineData("randomKey", RouteDirection.IncomingRequest)]
    [InlineData("area", RouteDirection.UrlGeneration)]
    [InlineData("controller", RouteDirection.UrlGeneration)]
    [InlineData("action", RouteDirection.UrlGeneration)]
    [InlineData("randomKey", RouteDirection.UrlGeneration)]
    public void ServiceInjected_RouteKey_Exists_MatchSucceeds(string keyName, RouteDirection direction)
    {
        // Arrange
        var actionDescriptor = CreateActionDescriptor("testArea",
            "testController",
            "testAction");
        actionDescriptor.RouteValues.Add("randomKey", "testRandom");
 
        var provider = CreateActionDescriptorCollectionProvider(actionDescriptor);
 
        var constraint = new KnownRouteValueConstraint(provider);
 
        var values = new RouteValueDictionary()
            {
                { "area", "testArea" },
                { "controller", "testController" },
                { "action", "testAction" },
                { "randomKey", "testRandom" }
            };
 
        // Act
        var match = constraint.Match(httpContext: null, route: null, keyName, values, direction);
 
        // Assert
        Assert.True(match);
    }
 
    [Theory]
    [InlineData(RouteDirection.IncomingRequest)]
    [InlineData(RouteDirection.UrlGeneration)]
    [ReplaceCulture("de-CH", "de-CH")]
    public void ServiceInjected_RouteKey_Exists_UsesInvariantCulture(RouteDirection direction)
    {
        // Arrange
        var actionDescriptor = CreateActionDescriptor("testArea", "testController", "testAction");
        actionDescriptor.RouteValues.Add("randomKey", "10/31/2018 07:37:38 -07:00");
 
        var provider = CreateActionDescriptorCollectionProvider(actionDescriptor);
 
        var constraint = new KnownRouteValueConstraint(provider);
 
        var values = new RouteValueDictionary()
            {
                { "area", "testArea" },
                { "controller", "testController" },
                { "action", "testAction" },
                { "randomKey", new DateTimeOffset(2018, 10, 31, 7, 37, 38, TimeSpan.FromHours(-7)) },
            };
 
        // Act
        var match = constraint.Match(httpContext: null, route: null, "randomKey", values, direction);
 
        // Assert
        Assert.True(match);
    }
 
    private static HttpContext GetHttpContext() => new DefaultHttpContext();
 
    private static IActionDescriptorCollectionProvider CreateActionDescriptorCollectionProvider(ActionDescriptor actionDescriptor)
    {
        var actionProvider = new Mock<IActionDescriptorProvider>(MockBehavior.Strict);
 
        actionProvider
            .SetupGet(p => p.Order)
            .Returns(-1000);
 
        actionProvider
            .Setup(p => p.OnProvidersExecuting(It.IsAny<ActionDescriptorProviderContext>()))
            .Callback<ActionDescriptorProviderContext>(c => c.Results.Add(actionDescriptor));
 
        actionProvider
            .Setup(p => p.OnProvidersExecuted(It.IsAny<ActionDescriptorProviderContext>()))
            .Verifiable();
 
        var descriptorCollectionProvider = new DefaultActionDescriptorCollectionProvider(
            new[] { actionProvider.Object },
            Enumerable.Empty<IActionDescriptorChangeProvider>(),
            NullLogger<DefaultActionDescriptorCollectionProvider>.Instance);
        return descriptorCollectionProvider;
    }
 
    private static ActionDescriptor CreateActionDescriptor(string area, string controller, string action)
    {
        var actionDescriptor = new ControllerActionDescriptor()
        {
            ActionName = string.Format(CultureInfo.InvariantCulture, "Area: {0}, Controller: {1}, Action: {2}", area, controller, action),
        };
 
        actionDescriptor.RouteValues.Add("area", area);
        actionDescriptor.RouteValues.Add("controller", controller);
        actionDescriptor.RouteValues.Add("action", action);
 
        return actionDescriptor;
    }
}