// Copyright (c) .NET Foundation. All rights reserved. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. using System; using System.Collections.Generic; using System.Linq; using Microsoft.AspNetCore.Razor.Language.Extensions; using Xunit; namespace Microsoft.AspNetCore.Razor.Language.Legacy { public class CSharpDirectivesTest : CsHtmlCodeParserTestBase { [Fact] public void DirectiveDescriptor_FileScopedMultipleOccurring_CanHaveDuplicates() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, builder => { builder.Usage = DirectiveUsage.FileScopedMultipleOccurring; builder.AddTypeToken(); }); // Act & Assert ParseDocumentTest( @"@custom System.Text.Encoding.ASCIIEncoding @custom System.Text.Encoding.UTF8Encoding", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_FileScopedSinglyOccurring_ErrorsIfDuplicate() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, builder => { builder.Usage = DirectiveUsage.FileScopedSinglyOccurring; builder.AddTypeToken(); }); // Act & Assert ParseDocumentTest( @"@custom System.Text.Encoding.ASCIIEncoding @custom System.Text.Encoding.UTF8Encoding", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_FileScoped_CanBeBeneathOtherDirectives() { // Arrange var customDescriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, builder => { builder.Usage = DirectiveUsage.FileScopedSinglyOccurring; builder.AddTypeToken(); }); var somethingDescriptor = DirectiveDescriptor.CreateDirective( "something", DirectiveKind.SingleLine, builder => { builder.Usage = DirectiveUsage.FileScopedMultipleOccurring; builder.AddMemberToken(); }); // Act & Assert ParseDocumentTest( @"@custom System.Text.Encoding.ASCIIEncoding @something Else", new[] { customDescriptor, somethingDescriptor }); } [Fact] public void DirectiveDescriptor_FileScoped_CanBeBeneathOtherWhiteSpaceCommentsAndDirectives() { // Arrange var customDescriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, builder => { builder.Usage = DirectiveUsage.FileScopedSinglyOccurring; builder.AddTypeToken(); }); var somethingDescriptor = DirectiveDescriptor.CreateDirective( "something", DirectiveKind.SingleLine, builder => { builder.Usage = DirectiveUsage.FileScopedMultipleOccurring; builder.AddMemberToken(); }); // Act & Assert ParseDocumentTest( @"@* There are two directives beneath this *@ @custom System.Text.Encoding.ASCIIEncoding @something Else
This is extra
", new[] { customDescriptor, somethingDescriptor }); } [Fact] public void DirectiveDescriptor_TokensMustBeSeparatedBySpace() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddStringToken().AddStringToken()); // Act & Assert ParseCodeBlockTest( "@custom \"string1\"\"string2\"", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_CanHandleEOFIncompleteNamespaceTokens() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddNamespaceToken()); // Act & Assert ParseCodeBlockTest( "@custom System.", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_CanHandleEOFInvalidNamespaceTokens() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddNamespaceToken()); // Act & Assert ParseCodeBlockTest( "@custom System<", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_CanHandleIncompleteNamespaceTokens() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddNamespaceToken()); // Act & Assert ParseCodeBlockTest( "@custom System." + Environment.NewLine, new[] { descriptor }); } [Fact] public void DirectiveDescriptor_CanHandleInvalidNamespaceTokens() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddNamespaceToken()); // Act & Assert ParseCodeBlockTest( "@custom System<" + Environment.NewLine, new[] { descriptor }); } [Fact] public void ExtensibleDirectiveDoesNotErorrIfNotAtStartOfLineBecauseOfWhitespace() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddTypeToken()); // Act & Assert ParseCodeBlockTest(Environment.NewLine + " @custom System.Text.Encoding.ASCIIEncoding", new[] { descriptor }); } [Fact] public void BuiltInDirectiveDoesNotErorrIfNotAtStartOfLineBecauseOfWhitespace() { // Act & Assert ParseCodeBlockTest(Environment.NewLine + " @addTagHelper \"*, Foo\""); } [Fact] public void BuiltInDirectiveErrorsIfNotAtStartOfLine() { // Act & Assert ParseCodeBlockTest("{ @addTagHelper \"*, Foo\"" + Environment.NewLine + "}"); } [Fact] public void ExtensibleDirectiveErrorsIfNotAtStartOfLine() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddTypeToken()); // Act & Assert ParseCodeBlockTest( "{ @custom System.Text.Encoding.ASCIIEncoding" + Environment.NewLine + "}", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_UnderstandsTypeTokens() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddTypeToken()); // Act & Assert ParseCodeBlockTest( "@custom System.Text.Encoding.ASCIIEncoding", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_UnderstandsMemberTokens() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddMemberToken()); // Act & Assert ParseCodeBlockTest( "@custom Some_Member", new[] { descriptor }); } [Fact] public void Parser_ParsesNamespaceDirectiveToken_WithSingleSegment() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddNamespaceToken()); // Act & Assert ParseCodeBlockTest( "@custom BaseNamespace", new[] { descriptor }); } [Fact] public void Parser_ParsesNamespaceDirectiveToken_WithMultipleSegments() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddNamespaceToken()); // Act & Assert ParseCodeBlockTest( "@custom BaseNamespace.Foo.Bar", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_UnderstandsStringTokens() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddStringToken()); // Act & Assert ParseCodeBlockTest( "@custom \"AString\"", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_StringToken_ParserErrorForUnquotedValue() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddStringToken()); // Act & Assert ParseCodeBlockTest( "@custom AString", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_StringToken_ParserErrorForNonStringValue() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddStringToken()); // Act & Assert ParseCodeBlockTest( "@custom {foo?}", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_StringToken_ParserErrorForSingleQuotedValue() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddStringToken()); // Act & Assert ParseCodeBlockTest( "@custom 'AString'", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_StringToken_ParserErrorForPartialQuotedValue() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddStringToken()); // Act & Assert ParseCodeBlockTest( "@custom AString\"", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_UnderstandsMultipleTokens() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddTypeToken().AddMemberToken().AddStringToken()); // Act & Assert ParseCodeBlockTest( "@custom System.Text.Encoding.ASCIIEncoding Some_Member \"AString\"", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_UnderstandsRazorBlocks() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.RazorBlock, b => b.AddStringToken()); // Act & Assert ParseCodeBlockTest( "@custom \"Header\" {F{o}o
}", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_UnderstandsCodeBlocks() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.CodeBlock, b => b.AddStringToken()); // Act & Assert ParseCodeBlockTest( "@custom \"Name\" { foo(); bar(); }", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_AllowsWhiteSpaceAroundTokens() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddTypeToken().AddMemberToken()); // Act & Assert ParseCodeBlockTest( "@custom System.Text.Encoding.ASCIIEncoding Some_Member ", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_ErrorsForInvalidMemberTokens() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddMemberToken()); // Act & Assert ParseCodeBlockTest( "@custom -Some_Member", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_NoErrorsSemicolonAfterDirective() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddStringToken()); // Act & Assert ParseCodeBlockTest( "@custom \"hello\" ; ", new[] { descriptor }); } [Fact] public void DirectiveDescriptor_AllowsNullableTypes() { // Arrange var variants = new[] { "string?", "string?[]", "global::System.Int32?", "KeyValuePairF{o}o
}", new[] { SectionDirective.Directive, }); } [Fact] public void OptionalDirectiveTokens_AreSkipped() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddOptionalStringToken()); // Act & Assert ParseCodeBlockTest( "@custom ", new[] { descriptor }); } [Fact] public void OptionalDirectiveTokens_WithSimpleTokens_AreParsed() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddOptionalStringToken()); // Act & Assert ParseCodeBlockTest( "@custom \"simple-value\"", new[] { descriptor }); } [Fact] public void OptionalDirectiveTokens_WithBraces_AreParsed() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddOptionalStringToken()); // Act & Assert ParseCodeBlockTest( "@custom \"{formaction}?/{id}?\"", new[] { descriptor }); } [Fact] public void OptionalDirectiveTokens_WithMultipleOptionalTokens_AreParsed() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "custom", DirectiveKind.SingleLine, b => b.AddOptionalStringToken().AddOptionalTypeToken()); // Act & Assert ParseCodeBlockTest( "@custom \"{formaction}?/{id}?\" System.String", new[] { descriptor }); } [Fact] public void OptionalMemberTokens_WithMissingMember_IsParsed() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "TestDirective", DirectiveKind.SingleLine, b => b.AddOptionalMemberToken().AddOptionalStringToken()); // Act & Assert ParseCodeBlockTest( "@TestDirective ", new[] { descriptor }); } [Fact] public void OptionalMemberTokens_WithMemberSpecified_IsParsed() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "TestDirective", DirectiveKind.SingleLine, b => b.AddOptionalMemberToken().AddOptionalStringToken()); // Act & Assert ParseCodeBlockTest( "@TestDirective PropertyName", new[] { descriptor }); } [Fact] public void Directives_CanUseReservedWord_Class() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "class", DirectiveKind.SingleLine); // Act & Assert ParseCodeBlockTest( "@class", new[] { descriptor }); } [Fact] public void Directives_CanUseReservedWord_Namespace() { // Arrange var descriptor = DirectiveDescriptor.CreateDirective( "namespace", DirectiveKind.SingleLine); // Act & Assert ParseCodeBlockTest( "@namespace", new[] { descriptor }); } internal virtual void ParseCodeBlockTest(string document) { ParseCodeBlockTest(document, Array.Empty