|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using Microsoft.AspNetCore.Razor.Language;
using Microsoft.AspNetCore.Razor.Language.Extensions;
using Microsoft.AspNetCore.Razor.Language.Intermediate;
using Xunit;
namespace Microsoft.AspNetCore.Mvc.Razor.Extensions;
public class ModelDirectiveTest : RazorProjectEngineTestBase
{
protected override RazorLanguageVersion Version => RazorLanguageVersion.Version_3_0;
protected override void ConfigureProjectEngine(RazorProjectEngineBuilder builder)
{
// Notice we're not registering the ModelDirective.Pass here so we can run it on demand.
builder.AddDirective(ModelDirective.Directive);
builder.Features.Add(new RazorPageDocumentClassifierPass());
builder.Features.Add(new MvcViewDocumentClassifierPass());
}
protected override void ConfigureCodeDocumentProcessor(RazorCodeDocumentProcessor processor)
{
processor.ExecutePhasesThrough<IRazorDocumentClassifierPhase>();
// Note: InheritsDirectivePass needs to run before ModelDirective.Pass.
processor.ExecutePass<InheritsDirectivePass>();
}
[Fact]
public void ModelDirective_GetModelType_GetsTypeFromFirstWellFormedDirective()
{
// Arrange
var codeDocument = ProjectEngine.CreateCodeDocument(@"
@model Type1
@model Type2
@model
");
var processor = CreateCodeDocumentProcessor(codeDocument);
var documentNode = processor.GetDocumentNode();
// Act
var result = ModelDirective.GetModelType(documentNode).Content;
// Assert
Assert.Equal("Type1", result);
}
[Fact]
public void ModelDirective_GetModelType_DefaultsToDynamic()
{
// Arrange
var codeDocument = ProjectEngine.CreateCodeDocument(@" ");
var processor = CreateCodeDocumentProcessor(codeDocument);
var documentNode = processor.GetDocumentNode();
// Act
var result = ModelDirective.GetModelType(documentNode).Content;
// Assert
Assert.Equal("dynamic", result);
}
[Fact]
public void ModelDirectivePass_Execute_ReplacesTModelInBaseType()
{
// Arrange
var codeDocument = ProjectEngine.CreateCodeDocument(@"
@inherits BaseType<TModel>
@model Type1
");
var processor = CreateCodeDocumentProcessor(codeDocument);
// Act
processor.ExecutePass<ModelDirective.Pass>();
// Assert
var documentNode = processor.GetDocumentNode();
var classNode = documentNode.GetClassNode();
var baseType = classNode.BaseType;
Assert.NotNull(baseType);
Assert.Equal("BaseType", baseType.BaseType.Content);
Assert.NotNull(baseType.BaseType.Source);
Assert.NotNull(baseType.ModelType);
Assert.Equal("Type1", baseType.ModelType.Content);
Assert.NotNull(baseType.ModelType.Source);
}
[Fact]
public void ModelDirectivePass_Execute_ReplacesTModelInBaseType_DifferentOrdering()
{
// Arrange
var codeDocument = ProjectEngine.CreateCodeDocument(@"
@model Type1
@inherits BaseType<TModel>
@model Type2
");
var processor = CreateCodeDocumentProcessor(codeDocument);
// Act
processor.ExecutePass<ModelDirective.Pass>();
// Assert
var documentNode = processor.GetDocumentNode();
var classNode = documentNode.GetClassNode();
var baseType = classNode.BaseType;
Assert.NotNull(baseType);
Assert.Equal("BaseType", baseType.BaseType.Content);
Assert.NotNull(baseType.BaseType.Source);
Assert.NotNull(baseType.ModelType);
Assert.Equal("Type1", baseType.ModelType.Content);
Assert.NotNull(baseType.ModelType.Source);
}
[Fact]
public void ModelDirectivePass_Execute_NoOpWithoutTModel()
{
// Arrange
var codeDocument = ProjectEngine.CreateCodeDocument(@"
@inherits BaseType
@model Type1
");
var processor = CreateCodeDocumentProcessor(codeDocument);
// Act
processor.ExecutePass<ModelDirective.Pass>();
// Assert
var documentNode = processor.GetDocumentNode();
var classNode = documentNode.GetClassNode();
var baseType = classNode.BaseType;
Assert.NotNull(baseType);
Assert.Equal("BaseType", baseType.BaseType.Content);
Assert.NotNull(baseType.BaseType.Source);
// ISSUE: https://github.com/dotnet/razor/issues/10987 we don't issue a warning or emit anything for the unused model
Assert.Null(baseType.ModelType);
}
[Fact]
public void ModelDirectivePass_Execute_ReplacesTModelInBaseType_DefaultDynamic()
{
// Arrange
var codeDocument = ProjectEngine.CreateCodeDocument(@"
@inherits BaseType<TModel>
");
var processor = CreateCodeDocumentProcessor(codeDocument);
// Act
processor.ExecutePass<ModelDirective.Pass>();
// Assert
var documentNode = processor.GetDocumentNode();
var classNode = documentNode.GetClassNode();
var baseType = classNode.BaseType;
Assert.NotNull(baseType);
Assert.Equal("BaseType", baseType.BaseType.Content);
Assert.NotNull(baseType.BaseType.Source);
Assert.NotNull(baseType.ModelType);
Assert.Equal("dynamic", baseType.ModelType.Content);
Assert.Null(baseType.ModelType.Source);
}
[Fact]
public void ModelDirectivePass_DesignTime_AddsTModelUsingDirective()
{
// Arrange
var codeDocument = ProjectEngine.CreateDesignTimeCodeDocument(@"
@inherits BaseType<TModel>
");
var processor = CreateCodeDocumentProcessor(codeDocument);
// Act
processor.ExecutePass<ModelDirective.Pass>();
// Assert
var documentNode = processor.GetDocumentNode();
var namespaceNode = documentNode.GetNamespaceNode();
var classNode = documentNode.GetClassNode();
var baseType = classNode.BaseType;
Assert.NotNull(baseType);
Assert.Equal("BaseType", baseType.BaseType.Content);
Assert.Null(baseType.BaseType.Source);
Assert.NotNull(baseType.ModelType);
Assert.Equal("dynamic", baseType.ModelType.Content);
Assert.Null(baseType.ModelType.Source);
var usingNode = Assert.IsType<UsingDirectiveIntermediateNode>(namespaceNode.Children[0]);
Assert.Equal($"TModel = global::{typeof(object).FullName}", usingNode.Content);
}
[Fact]
public void ModelDirectivePass_DesignTime_WithModel_AddsTModelUsingDirective()
{
// Arrange
var codeDocument = ProjectEngine.CreateDesignTimeCodeDocument(@"
@inherits BaseType<TModel>
@model SomeType
");
var processor = CreateCodeDocumentProcessor(codeDocument);
// Act
processor.ExecutePass<ModelDirective.Pass>();
// Assert
var documentNode = processor.GetDocumentNode();
var namespaceNode = documentNode.GetNamespaceNode();
var classNode = documentNode.GetClassNode();
var baseType = classNode.BaseType;
Assert.NotNull(baseType);
Assert.Equal("BaseType", baseType.BaseType.Content);
Assert.Null(baseType.BaseType.Source);
Assert.NotNull(baseType.ModelType);
Assert.Equal("SomeType", baseType.ModelType.Content);
Assert.Null(baseType.ModelType.Source);
var usingNode = Assert.IsType<UsingDirectiveIntermediateNode>(namespaceNode.Children[0]);
Assert.Equal($"TModel = global::System.Object", usingNode.Content);
}
}
|