// 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 ASPNET50 using System; using System.Collections.Generic; using Microsoft.AspNet.Testing; using Microsoft.Framework.DependencyInjection; using Microsoft.Framework.DependencyInjection.Fallback; using Microsoft.Framework.OptionsModel; using Moq; using Xunit; namespace Microsoft.AspNet.Routing.Template.Tests { public class TemplateRouteParserTests { [Fact] public void Parse_SingleLiteral() { // Arrange var template = "cool"; var expected = new RouteTemplate(new List()); expected.Segments.Add(new TemplateSegment()); expected.Segments[0].Parts.Add(TemplatePart.CreateLiteral("cool")); // Act var actual = TemplateParser.Parse(template); // Assert Assert.Equal(expected, actual, new TemplateEqualityComparer()); } [Fact] public void Parse_SingleParameter() { // Arrange var template = "{p}"; var expected = new RouteTemplate(new List()); expected.Segments.Add(new TemplateSegment()); expected.Segments[0].Parts.Add(TemplatePart.CreateParameter("p", false, false, defaultValue: null, inlineConstraints: null)); expected.Parameters.Add(expected.Segments[0].Parts[0]); // Act var actual = TemplateParser.Parse(template); // Assert Assert.Equal(expected, actual, new TemplateEqualityComparer()); } [Fact] public void Parse_OptionalParameter() { // Arrange var template = "{p?}"; var expected = new RouteTemplate(new List()); expected.Segments.Add(new TemplateSegment()); expected.Segments[0].Parts.Add(TemplatePart.CreateParameter("p", false, true, defaultValue: null, inlineConstraints: null)); expected.Parameters.Add(expected.Segments[0].Parts[0]); // Act var actual = TemplateParser.Parse(template); // Assert Assert.Equal(expected, actual, new TemplateEqualityComparer()); } [Fact] public void Parse_MultipleLiterals() { // Arrange var template = "cool/awesome/super"; var expected = new RouteTemplate(new List()); expected.Segments.Add(new TemplateSegment()); expected.Segments[0].Parts.Add(TemplatePart.CreateLiteral("cool")); expected.Segments.Add(new TemplateSegment()); expected.Segments[1].Parts.Add(TemplatePart.CreateLiteral("awesome")); expected.Segments.Add(new TemplateSegment()); expected.Segments[2].Parts.Add(TemplatePart.CreateLiteral("super")); // Act var actual = TemplateParser.Parse(template); // Assert Assert.Equal(expected, actual, new TemplateEqualityComparer()); } [Fact] public void Parse_MultipleParameters() { // Arrange var template = "{p1}/{p2}/{*p3}"; var expected = new RouteTemplate(new List()); expected.Segments.Add(new TemplateSegment()); expected.Segments[0].Parts.Add(TemplatePart.CreateParameter("p1", false, false, defaultValue: null, inlineConstraints: null)); expected.Parameters.Add(expected.Segments[0].Parts[0]); expected.Segments.Add(new TemplateSegment()); expected.Segments[1].Parts.Add(TemplatePart.CreateParameter("p2", false, false, defaultValue: null, inlineConstraints: null)); expected.Parameters.Add(expected.Segments[1].Parts[0]); expected.Segments.Add(new TemplateSegment()); expected.Segments[2].Parts.Add(TemplatePart.CreateParameter("p3", true, false, defaultValue: null, inlineConstraints: null)); expected.Parameters.Add(expected.Segments[2].Parts[0]); // Act var actual = TemplateParser.Parse(template); // Assert Assert.Equal(expected, actual, new TemplateEqualityComparer()); } [Fact] public void Parse_ComplexSegment_LP() { // Arrange var template = "cool-{p1}"; var expected = new RouteTemplate(new List()); expected.Segments.Add(new TemplateSegment()); expected.Segments[0].Parts.Add(TemplatePart.CreateLiteral("cool-")); expected.Segments[0].Parts.Add(TemplatePart.CreateParameter("p1", false, false, defaultValue: null, inlineConstraints: null)); expected.Parameters.Add(expected.Segments[0].Parts[1]); // Act var actual = TemplateParser.Parse(template); // Assert Assert.Equal(expected, actual, new TemplateEqualityComparer()); } [Fact] public void Parse_ComplexSegment_PL() { // Arrange var template = "{p1}-cool"; var expected = new RouteTemplate(new List()); expected.Segments.Add(new TemplateSegment()); expected.Segments[0].Parts.Add(TemplatePart.CreateParameter("p1", false, false, defaultValue: null, inlineConstraints: null)); expected.Parameters.Add(expected.Segments[0].Parts[0]); expected.Segments[0].Parts.Add(TemplatePart.CreateLiteral("cool-")); // Act var actual = TemplateParser.Parse(template); // Assert Assert.Equal(expected, actual, new TemplateEqualityComparer()); } [Fact] public void Parse_ComplexSegment_PLP() { // Arrange var template = "{p1}-cool-{p2}"; var expected = new RouteTemplate(new List()); expected.Segments.Add(new TemplateSegment()); expected.Segments[0].Parts.Add(TemplatePart.CreateParameter("p1", false, false, defaultValue: null, inlineConstraints: null)); expected.Parameters.Add(expected.Segments[0].Parts[0]); expected.Segments[0].Parts.Add(TemplatePart.CreateLiteral("cool-")); expected.Segments[0].Parts.Add(TemplatePart.CreateParameter("p2", false, false, defaultValue: null, inlineConstraints: null)); expected.Parameters.Add(expected.Segments[0].Parts[2]); // Act var actual = TemplateParser.Parse(template); // Assert Assert.Equal(expected, actual, new TemplateEqualityComparer()); } [Fact] public void Parse_ComplexSegment_LPL() { // Arrange var template = "cool-{p1}-awesome"; var expected = new RouteTemplate(new List()); expected.Segments.Add(new TemplateSegment()); expected.Segments[0].Parts.Add(TemplatePart.CreateLiteral("cool-")); expected.Segments[0].Parts.Add(TemplatePart.CreateParameter("p1", false, false, defaultValue: null, inlineConstraints: null)); expected.Parameters.Add(expected.Segments[0].Parts[1]); expected.Segments[0].Parts.Add(TemplatePart.CreateLiteral("-awesome")); // Act var actual = TemplateParser.Parse(template); // Assert Assert.Equal(expected, actual, new TemplateEqualityComparer()); } [Fact] public void InvalidTemplate_WithRepeatedParameter() { var ex = ExceptionAssert.Throws( () => TemplateParser.Parse("{Controller}.mvc/{id}/{controller}"), "The route parameter name 'controller' appears more than one time in the route template." + Environment.NewLine + "Parameter name: routeTemplate"); } [Theory] [InlineData("123{a}abc{")] [InlineData("123{a}abc}")] [InlineData("xyz}123{a}abc}")] [InlineData("{{p1}")] [InlineData("{p1}}")] [InlineData("p1}}p2{")] public void InvalidTemplate_WithMismatchedBraces(string template) { ExceptionAssert.Throws( () => TemplateParser.Parse(template), @"There is an incomplete parameter in the route template. Check that each '{' character has a matching '}' character." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_CannotHaveCatchAllInMultiSegment() { ExceptionAssert.Throws( () => TemplateParser.Parse("123{a}abc{*moo}"), "A path segment that contains more than one section, such as a literal section or a parameter, cannot contain a catch-all parameter." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_CannotHaveMoreThanOneCatchAll() { ExceptionAssert.Throws( () => TemplateParser.Parse("{*p1}/{*p2}"), "A catch-all parameter can only appear as the last segment of the route template." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_CannotHaveMoreThanOneCatchAllInMultiSegment() { ExceptionAssert.Throws( () => TemplateParser.Parse("{*p1}abc{*p2}"), "A path segment that contains more than one section, such as a literal section or a parameter, cannot contain a catch-all parameter." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_CannotHaveCatchAllWithNoName() { ExceptionAssert.Throws( () => TemplateParser.Parse("foo/{*}"), "The route parameter name '' is invalid. Route parameter names must be non-empty and cannot" + " contain these characters: '{', '}', '/'. The '?' character marks a parameter as optional," + " and can occur only at the end of the parameter. The '*' character marks a parameter as catch-all," + " and can occur only at the start of the parameter." + Environment.NewLine + "Parameter name: routeTemplate"); } [Theory] [InlineData("{**}", "*")] [InlineData("{a*}", "a*")] [InlineData("{*a*}", "a*")] [InlineData("{*a*:int}", "a*")] [InlineData("{*a*=5}", "a*")] [InlineData("{*a*b=5}", "a*b")] public void ParseRouteParameter_ThrowsIf_ParameterContainsAsterisk(string template, string parameterName) { // Arrange var expectedMessage = "The route parameter name '" + parameterName + "' is invalid. Route parameter " + "names must be non-empty and cannot contain these characters: '{', '}', '/'. The '?' character " + "marks a parameter as optional, and can occur only at the end of the parameter. The '*' character " + "marks a parameter as catch-all, and can occur only at the start of the parameter."; // Act & Assert ExceptionAssert.Throws( () => TemplateParser.Parse(template), expectedMessage + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_CannotHaveConsecutiveOpenBrace() { ExceptionAssert.Throws( () => TemplateParser.Parse("foo/{{p1}"), "There is an incomplete parameter in the route template. Check that each '{' character has a matching '}' character." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_CannotHaveConsecutiveCloseBrace() { ExceptionAssert.Throws( () => TemplateParser.Parse("foo/{p1}}"), "There is an incomplete parameter in the route template. Check that each '{' character has a matching '}' character." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_SameParameterTwiceThrows() { ExceptionAssert.Throws( () => TemplateParser.Parse("{aaa}/{AAA}"), "The route parameter name 'AAA' appears more than one time in the route template." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_SameParameterTwiceAndOneCatchAllThrows() { ExceptionAssert.Throws( () => TemplateParser.Parse("{aaa}/{*AAA}"), "The route parameter name 'AAA' appears more than one time in the route template." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_InvalidParameterNameWithCloseBracketThrows() { ExceptionAssert.Throws( () => TemplateParser.Parse("{a}/{aa}a}/{z}"), "There is an incomplete parameter in the route template. Check that each '{' character has a matching '}' character." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_InvalidParameterNameWithOpenBracketThrows() { ExceptionAssert.Throws( () => TemplateParser.Parse("{a}/{a{aa}/{z}"), "The route parameter name 'a{aa' is invalid. Route parameter names must be non-empty and cannot" + " contain these characters: '{', '}', '/'. The '?' character marks a parameter as optional, and" + " can occur only at the end of the parameter. The '*' character marks a parameter as catch-all," + " and can occur only at the start of the parameter." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_InvalidParameterNameWithEmptyNameThrows() { ExceptionAssert.Throws( () => TemplateParser.Parse("{a}/{}/{z}"), "The route parameter name '' is invalid. Route parameter names must be non-empty and cannot" + " contain these characters: '{', '}', '/'. The '?' character marks a parameter as optional, and" + " can occur only at the end of the parameter. The '*' character marks a parameter as catch-all," + " and can occur only at the start of the parameter." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_InvalidParameterNameWithQuestionThrows() { ExceptionAssert.Throws( () => TemplateParser.Parse("{Controller}.mvc/{?}"), "The route parameter name '' is invalid. Route parameter names must be non-empty and cannot" + " contain these characters: '{', '}', '/'. The '?' character marks a parameter as optional, and" + " can occur only at the end of the parameter. The '*' character marks a parameter as catch-all," + " and can occur only at the start of the parameter." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_ConsecutiveSeparatorsSlashSlashThrows() { ExceptionAssert.Throws( () => TemplateParser.Parse("{a}//{z}"), "The route template separator character '/' cannot appear consecutively. It must be separated by either a parameter or a literal value." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_WithCatchAllNotAtTheEndThrows() { ExceptionAssert.Throws( () => TemplateParser.Parse("foo/{p1}/{*p2}/{p3}"), "A catch-all parameter can only appear as the last segment of the route template." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_RepeatedParametersThrows() { ExceptionAssert.Throws( () => TemplateParser.Parse("foo/aa{p1}{p2}"), "A path segment cannot contain two consecutive parameters. They must be separated by a '/' or by a literal string." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_CannotStartWithSlash() { ExceptionAssert.Throws( () => TemplateParser.Parse("/foo"), "The route template cannot start with a '/' or '~' character." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_CannotStartWithTilde() { ExceptionAssert.Throws( () => TemplateParser.Parse("~foo"), "The route template cannot start with a '/' or '~' character." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_CannotContainQuestionMark() { ExceptionAssert.Throws( () => TemplateParser.Parse("foor?bar"), "The literal section 'foor?bar' is invalid. Literal sections cannot contain the '?' character." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_ParameterCannotContainQuestionMark_UnlessAtEnd() { ExceptionAssert.Throws( () => TemplateParser.Parse("{foor?b}"), "The route parameter name 'foor?b' is invalid. Route parameter names must be non-empty and cannot" + " contain these characters: '{', '}', '/'. The '?' character marks a parameter as optional, and" + " can occur only at the end of the parameter. The '*' character marks a parameter as catch-all," + " and can occur only at the start of the parameter." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_MultiSegmentParameterCannotContainOptionalParameter() { ExceptionAssert.Throws( () => TemplateParser.Parse("{foorb?}-bar-{z}"), "A path segment that contains more than one section, such as a literal section or a parameter, cannot contain an optional parameter." + Environment.NewLine + "Parameter name: routeTemplate"); } [Fact] public void InvalidTemplate_CatchAllMarkedOptional() { ExceptionAssert.Throws( () => TemplateParser.Parse("{a}/{*b?}"), "A catch-all parameter cannot be marked optional." + Environment.NewLine + "Parameter name: routeTemplate"); } private class TemplateEqualityComparer : IEqualityComparer { public bool Equals(RouteTemplate x, RouteTemplate y) { if (x == null && y == null) { return true; } else if (x == null || y == null) { return false; } else { if (x.Segments.Count != y.Segments.Count) { return false; } for (int i = 0; i < x.Segments.Count; i++) { if (x.Segments[i].Parts.Count != y.Segments[i].Parts.Count) { return false; } for (int j = 0; j < x.Segments[i].Parts.Count; j++) { if (!Equals(x.Segments[i].Parts[j], y.Segments[i].Parts[j])) { return false; } } } if (x.Parameters.Count != y.Parameters.Count) { return false; } for (int i = 0; i < x.Parameters.Count; i++) { if (!Equals(x.Parameters[i], y.Parameters[i])) { return false; } } return true; } } private bool Equals(TemplatePart x, TemplatePart y) { if (x.IsLiteral != y.IsLiteral || x.IsParameter != y.IsParameter || x.IsCatchAll != y.IsCatchAll || x.IsOptional != y.IsOptional || !String.Equals(x.Name, y.Name, StringComparison.Ordinal) || !String.Equals(x.Name, y.Name, StringComparison.Ordinal)) { return false; } return true; } public int GetHashCode(RouteTemplate obj) { throw new NotImplementedException(); } } } } #endif