File: HtmlGenerationWithCultureTest.cs
Web Access
Project: src\src\Mvc\test\Mvc.FunctionalTests\Microsoft.AspNetCore.Mvc.FunctionalTests.csproj (Microsoft.AspNetCore.Mvc.FunctionalTests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Net.Http;
using AngleSharp.Dom;
using AngleSharp.Dom.Html;
using AngleSharp.Extensions;
using AngleSharp.Html;
using HtmlGenerationWebSite;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc.Testing;
using Microsoft.AspNetCore.TestHost;
using Microsoft.AspNetCore.InternalTesting;
using Microsoft.Extensions.DependencyInjection;
using Xunit.Abstractions;
using Xunit.Sdk;
using Microsoft.AspNetCore.Builder;
using System.Reflection;
 
namespace Microsoft.AspNetCore.Mvc.FunctionalTests;
 
public class HtmlGenerationWithCultureTest : LoggedTest
{
    protected override void Initialize(TestContext context, MethodInfo methodInfo, object[] testMethodArguments, ITestOutputHelper testOutputHelper)
    {
        base.Initialize(context, methodInfo, testMethodArguments, testOutputHelper);
        Factory = new MvcTestFixture<StartupWithCultureReplace>(LoggerFactory)
            .WithWebHostBuilder(builder => builder.UseStartup<StartupWithCultureReplace>());
        Client = Factory.CreateDefaultClient();
    }
 
    public override void Dispose()
    {
        Factory.Dispose();
        base.Dispose();
    }
 
    public WebApplicationFactory<StartupWithCultureReplace> Factory { get; private set; }
    public HttpClient Client { get; private set; }
 
    [Fact]
    public async Task CacheTagHelper_AllowsVaryingByCulture()
    {
        // Arrange
        string culture;
        string correlationId;
        string cachedCorrelationId;
 
        // Act - 1
        var document = await Client.GetHtmlDocumentAsync("/CacheTagHelper_VaryByCulture?culture=fr-Fr&correlationId=10");
        ReadValuesFromDocument();
 
        // Assert - 1
        Assert.Equal("fr-FR", culture);
        Assert.Equal("10", correlationId);
        Assert.Equal("10", cachedCorrelationId);
 
        // Act - 2
        document = await Client.GetHtmlDocumentAsync("/CacheTagHelper_VaryByCulture?culture=en-GB&correlationId=11");
        ReadValuesFromDocument();
 
        // Assert - 2
        Assert.Equal("en-GB", culture);
        Assert.Equal("11", correlationId);
        Assert.Equal("11", cachedCorrelationId);
 
        // Act - 3
        document = await Client.GetHtmlDocumentAsync("/CacheTagHelper_VaryByCulture?culture=fr-Fr&correlationId=14");
        ReadValuesFromDocument();
 
        // Assert - 3
        Assert.Equal("fr-FR", culture);
        Assert.Equal("14", correlationId);
        // Verify we're reading a cached value
        Assert.Equal("10", cachedCorrelationId);
 
        void ReadValuesFromDocument()
        {
            culture = QuerySelector(document, "#culture").TextContent;
            correlationId = QuerySelector(document, "#correlation-id").TextContent;
            cachedCorrelationId = QuerySelector(document, "#cached-correlation-id").TextContent;
        }
    }
 
    [Fact]
    public async Task CacheTagHelper_AllowsVaryingByUICulture()
    {
        // Arrange
        string culture;
        string uiCulture;
        string correlationId;
        string cachedCorrelationId;
 
        // Act - 1
        var document = await Client.GetHtmlDocumentAsync("/CacheTagHelper_VaryByCulture?culture=fr-Fr&ui-culture=fr-FR&correlationId=10");
        ReadValuesFromDocument();
 
        // Assert - 1
        Assert.Equal("fr-FR", culture);
        Assert.Equal("fr-FR", uiCulture);
        Assert.Equal("10", correlationId);
        Assert.Equal("10", cachedCorrelationId);
 
        // Act - 2
        document = await Client.GetHtmlDocumentAsync("/CacheTagHelper_VaryByCulture?culture=fr-Fr&ui-culture=fr-CA&correlationId=11");
        ReadValuesFromDocument();
 
        // Assert - 2
        Assert.Equal("fr-FR", culture);
        Assert.Equal("fr-CA", uiCulture);
        Assert.Equal("11", correlationId);
        Assert.Equal("11", cachedCorrelationId);
 
        // Act - 3
        document = await Client.GetHtmlDocumentAsync("/CacheTagHelper_VaryByCulture?culture=fr-Fr&ui-culture=fr-FR&correlationId=14");
        ReadValuesFromDocument();
 
        // Assert - 3
        Assert.Equal("fr-FR", culture);
        Assert.Equal("fr-FR", uiCulture);
        Assert.Equal("14", correlationId);
        // Verify we're reading a cached value
        Assert.Equal("10", cachedCorrelationId);
 
        void ReadValuesFromDocument()
        {
            culture = QuerySelector(document, "#culture").TextContent;
            uiCulture = QuerySelector(document, "#ui-culture").TextContent;
            correlationId = QuerySelector(document, "#correlation-id").TextContent;
            cachedCorrelationId = QuerySelector(document, "#cached-correlation-id").TextContent;
        }
    }
 
    [QuarantinedTest("https://github.com/dotnet/aspnetcore/issues/56440")]
    [Fact]
    public async Task CacheTagHelper_VaryByCultureComposesWithOtherVaryByOptions()
    {
        // Arrange
        var client = Factory
            .WithWebHostBuilder(builder => builder
                .UseStartup<StartupWithCultureReplace>()
                .ConfigureTestServices(services => services.AddSingleton(LoggerFactory)))
            .CreateDefaultClient();
        string culture;
        string correlationId;
        string cachedCorrelationId;
 
        // Act - 1
        var document = await client.GetHtmlDocumentAsync("/CacheTagHelper_VaryByCulture?culture=fr-Fr&correlationId=10");
        ReadValuesFromDocument();
 
        // Assert - 1
        Assert.Equal("fr-FR", culture);
        Assert.Equal("10", correlationId);
        Assert.Equal("10", cachedCorrelationId);
 
        // Act - 2
        document = await client.GetHtmlDocumentAsync("/CacheTagHelper_VaryByCulture?culture=fr-Fr&correlationId=11&varyByQueryKey=new-key");
        ReadValuesFromDocument();
 
        // Assert - 2
        // vary-by-query should produce a new cached value.
        Assert.Equal("fr-FR", culture);
        Assert.Equal("11", correlationId);
        Assert.Equal("11", cachedCorrelationId);
 
        // Act - 3
        document = await client.GetHtmlDocumentAsync("/CacheTagHelper_VaryByCulture?culture=fr-Fr&correlationId=14");
        ReadValuesFromDocument();
 
        // Assert - 3
        Assert.Equal("fr-FR", culture);
        Assert.Equal("14", correlationId);
 
        if (cachedCorrelationId != "10")
        {
            // This is logging to investigate potential flakiness in this test tracked by https://github.com/aspnet/Mvc/issues/8281
            var documentContent = document.ToHtml(new HtmlMarkupFormatter());
            throw new XunitException($"Unexpected correlation Id, reading values from document:{Environment.NewLine}{documentContent}");
        }
 
        Assert.Equal("10", cachedCorrelationId);
 
        void ReadValuesFromDocument()
        {
            culture = QuerySelector(document, "#culture").TextContent;
            correlationId = QuerySelector(document, "#correlation-id").TextContent;
            cachedCorrelationId = QuerySelector(document, "#cached-correlation-id").TextContent;
        }
    }
 
    private static IElement QuerySelector(IHtmlDocument document, string selector)
    {
        var element = document.QuerySelector(selector);
        if (element == null)
        {
            throw new ArgumentException($"Document does not contain element that matches the selector {selector}: " + Environment.NewLine + document.DocumentElement.OuterHtml);
        }
 
        return element;
    }
}