File: Formatters\JsonOutputFormatterTestBase.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 System.Text;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Abstractions;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.Primitives;
using Microsoft.Net.Http.Headers;
 
namespace Microsoft.AspNetCore.Mvc.Formatters;
 
public abstract class JsonOutputFormatterTestBase
{
    [Theory]
    [InlineData("application/json", false, "application/json")]
    [InlineData("application/json", true, "application/json")]
    [InlineData("application/xml", false, null)]
    [InlineData("application/xml", true, null)]
    [InlineData("application/*", false, "application/json")]
    [InlineData("text/*", false, "text/json")]
    [InlineData("custom/*", false, null)]
    [InlineData("application/json;v=2", false, null)]
    [InlineData("application/json;v=2", true, null)]
    [InlineData("application/some.entity+json", false, null)]
    [InlineData("application/some.entity+json", true, "application/some.entity+json")]
    [InlineData("application/some.entity+json;v=2", true, "application/some.entity+json;v=2")]
    [InlineData("application/some.entity+xml", true, null)]
    public void CanWriteResult_ReturnsExpectedValueForMediaType(
        string mediaType,
        bool isServerDefined,
        string expectedResult)
    {
        // Arrange
        var formatter = GetOutputFormatter();
 
        var body = new MemoryStream();
        var actionContext = GetActionContext(MediaTypeHeaderValue.Parse(mediaType), body);
        var outputFormatterContext = new OutputFormatterWriteContext(
            actionContext.HttpContext,
            new TestHttpResponseStreamWriterFactory().CreateWriter,
            typeof(string),
            new object())
        {
            ContentType = new StringSegment(mediaType),
            ContentTypeIsServerDefined = isServerDefined,
        };
 
        // Act
        var actualCanWriteValue = formatter.CanWriteResult(outputFormatterContext);
 
        // Assert
        var expectedContentType = expectedResult ?? mediaType;
        Assert.Equal(expectedResult != null, actualCanWriteValue);
        Assert.Equal(new StringSegment(expectedContentType), outputFormatterContext.ContentType);
    }
 
    public static TheoryData<string, string, bool> WriteCorrectCharacterEncoding
    {
        get
        {
            var data = new TheoryData<string, string, bool>
                {
                    { "This is a test 激光這兩個字是甚麼意思 string written using utf-8", "utf-8", true },
                    { "This is a test 激光這兩個字是甚麼意思 string written using utf-16", "utf-16", true },
                    { "This is a test 激光這兩個字是甚麼意思 string written using utf-32", "utf-32", false },
                    { "This is a test æøå string written using iso-8859-1", "iso-8859-1", false },
                };
 
            return data;
        }
    }
 
    [Theory]
    [MemberData(nameof(WriteCorrectCharacterEncoding))]
    public async Task WriteToStreamAsync_UsesCorrectCharacterEncoding(
       string content,
       string encodingAsString,
       bool isDefaultEncoding)
    {
        // Arrange
        var formatter = GetOutputFormatter();
        var expectedContent = "\"" + content + "\"";
        var mediaType = MediaTypeHeaderValue.Parse(string.Format(CultureInfo.InvariantCulture, "application/json; charset={0}", encodingAsString));
        var encoding = CreateOrGetSupportedEncoding(formatter, encodingAsString, isDefaultEncoding);
 
        var body = new MemoryStream();
        var actionContext = GetActionContext(mediaType, body);
 
        var outputFormatterContext = new OutputFormatterWriteContext(
            actionContext.HttpContext,
            new TestHttpResponseStreamWriterFactory().CreateWriter,
            typeof(string),
            content)
        {
            ContentType = new StringSegment(mediaType.ToString()),
        };
 
        // Act
        await formatter.WriteResponseBodyAsync(outputFormatterContext, Encoding.GetEncoding(encodingAsString));
 
        // Assert
        var actualContent = encoding.GetString(body.ToArray());
        Assert.Equal(expectedContent, actualContent, StringComparer.OrdinalIgnoreCase);
        Assert.True(body.CanWrite, "Response body should not be disposed.");
    }
 
    [Fact]
    public async Task WriteResponseBodyAsync_Encodes()
    {
        // Arrange
        var formatter = GetOutputFormatter();
        var expectedContent = "{\"key\":\"Hello \\n <b>Wörld</b>\"}"{\"key\":\"Hello \\n <b>Wörld</b>\"}";
        var content = new { key = "Hello \n <b>Wörld</b>" };
 
        var mediaType = MediaTypeHeaderValue.Parse("application/json; charset=utf-8");
        var encoding = CreateOrGetSupportedEncoding(formatter, "utf-8", isDefaultEncoding: true);
 
        var body = new MemoryStream();
        var actionContext = GetActionContext(mediaType, body);
 
        var outputFormatterContext = new OutputFormatterWriteContext(
            actionContext.HttpContext,
            new TestHttpResponseStreamWriterFactory().CreateWriter,
            typeof(object),
            content)
        {
            ContentType = new StringSegment(mediaType.ToString()),
        };
 
        // Act
        await formatter.WriteResponseBodyAsync(outputFormatterContext, Encoding.GetEncoding("utf-8"));
 
        // Assert
        var actualContent = encoding.GetString(body.ToArray());
        Assert.Equal(expectedContent, actualContent);
    }
 
    [Fact]
    public async Task ErrorDuringSerialization_DoesNotCloseTheBrackets()
    {
        // Arrange
        var outputFormatterContext = GetOutputFormatterContext(
            new ModelWithSerializationError(),
            typeof(ModelWithSerializationError));
        var jsonFormatter = GetOutputFormatter();
 
        // Act
        await Record.ExceptionAsync(() => jsonFormatter.WriteResponseBodyAsync(outputFormatterContext, Encoding.UTF8));
 
        // Assert
        var body = outputFormatterContext.HttpContext.Response.Body;
 
        Assert.NotNull(body);
        body.Position = 0;
 
        var content = new StreamReader(body, Encoding.UTF8).ReadToEnd();
        Assert.DoesNotContain("}", content);
    }
 
    protected static ActionContext GetActionContext(
        MediaTypeHeaderValue contentType,
        Stream responseStream = null)
    {
        var httpContext = new DefaultHttpContext();
        httpContext.Request.ContentType = contentType.ToString();
        httpContext.Request.Headers.AcceptCharset = contentType.Charset.ToString();
 
        httpContext.Response.Body = responseStream ?? new MemoryStream();
        return new ActionContext(httpContext, new RouteData(), new ActionDescriptor());
    }
 
    protected static OutputFormatterWriteContext GetOutputFormatterContext(
        object outputValue,
        Type outputType,
        string contentType = "application/xml; charset=utf-8",
        Stream responseStream = null,
        Func<Stream, Encoding, TextWriter> writerFactory = null)
    {
        var mediaTypeHeaderValue = MediaTypeHeaderValue.Parse(contentType);
 
        var actionContext = GetActionContext(mediaTypeHeaderValue, responseStream);
        return new OutputFormatterWriteContext(
            actionContext.HttpContext,
            writerFactory ?? new TestHttpResponseStreamWriterFactory().CreateWriter,
            outputType,
            outputValue)
        {
            ContentType = new StringSegment(contentType),
        };
    }
 
    protected static Encoding CreateOrGetSupportedEncoding(
        TextOutputFormatter formatter,
        string encodingAsString,
        bool isDefaultEncoding)
    {
        Encoding encoding = null;
        if (isDefaultEncoding)
        {
            encoding = formatter
                .SupportedEncodings
                .First((e) => e.WebName.Equals(encodingAsString, StringComparison.OrdinalIgnoreCase));
        }
        else
        {
            encoding = Encoding.GetEncoding(encodingAsString);
            formatter.SupportedEncodings.Add(encoding);
        }
 
        return encoding;
    }
 
    protected abstract TextOutputFormatter GetOutputFormatter();
 
    protected sealed class ModelWithSerializationError
    {
        public string Name { get; } = "Robert";
        public int Age
        {
            get
            {
                throw new NotImplementedException($"Property {nameof(Age)} has not been implemented");
            }
        }
    }
}