317 lines
12 KiB
C#
317 lines
12 KiB
C#
// 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.IO;
|
|
using System.Security.Claims;
|
|
using System.Text;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.AspNetCore.Diagnostics.Elm;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.AspNetCore.Http.Features;
|
|
using Microsoft.Extensions.Logging;
|
|
using Microsoft.Extensions.Options;
|
|
using Moq;
|
|
using Xunit;
|
|
|
|
namespace Microsoft.AspNetCore.Diagnostics.Tests
|
|
{
|
|
public class ElmMiddlewareTest
|
|
{
|
|
private const string DefaultPath = "/Elm";
|
|
|
|
[Fact]
|
|
public void DefaultPageOptions_HasDefaultPath()
|
|
{
|
|
// Arrange & act
|
|
var options = new ElmOptions();
|
|
|
|
// Assert
|
|
Assert.Equal(DefaultPath, options.Path.Value);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Invoke_WithNonMatchingPath_IgnoresRequest()
|
|
{
|
|
// Arrange
|
|
var elmStore = new ElmStore();
|
|
var factory = new LoggerFactory();
|
|
var optionsMock = new Mock<IOptions<ElmOptions>>();
|
|
optionsMock
|
|
.SetupGet(o => o.Value)
|
|
.Returns(new ElmOptions());
|
|
factory.AddProvider(new ElmLoggerProvider(elmStore, optionsMock.Object));
|
|
|
|
RequestDelegate next = _ =>
|
|
{
|
|
return Task.FromResult<object>(null);
|
|
};
|
|
|
|
var captureMiddleware = new ElmCaptureMiddleware(
|
|
next,
|
|
factory,
|
|
optionsMock.Object);
|
|
var pageMiddleware = new ElmPageMiddleware(
|
|
next,
|
|
optionsMock.Object,
|
|
elmStore);
|
|
|
|
var contextMock = GetMockContext("/nonmatchingpath");
|
|
|
|
// Act
|
|
await captureMiddleware.Invoke(contextMock.Object);
|
|
await pageMiddleware.Invoke(contextMock.Object);
|
|
|
|
// Assert
|
|
// Request.Query is used by the ElmPageMiddleware to parse the query parameters
|
|
contextMock.VerifyGet(c => c.Request.Query, Times.Never());
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Invoke_WithMatchingPath_FulfillsRequest()
|
|
{
|
|
// Arrange
|
|
var elmStore = new ElmStore();
|
|
var factory = new LoggerFactory();
|
|
var optionsMock = new Mock<IOptions<ElmOptions>>();
|
|
optionsMock
|
|
.SetupGet(o => o.Value)
|
|
.Returns(new ElmOptions());
|
|
factory.AddProvider(new ElmLoggerProvider(elmStore, optionsMock.Object));
|
|
|
|
RequestDelegate next = _ =>
|
|
{
|
|
return Task.FromResult<object>(null);
|
|
};
|
|
|
|
var captureMiddleware = new ElmCaptureMiddleware(
|
|
next,
|
|
factory,
|
|
optionsMock.Object);
|
|
var pageMiddleware = new ElmPageMiddleware(
|
|
next,
|
|
optionsMock.Object,
|
|
elmStore);
|
|
var contextMock = GetMockContext("/Elm");
|
|
|
|
using (var responseStream = new MemoryStream())
|
|
{
|
|
contextMock
|
|
.SetupGet(c => c.Response.Body)
|
|
.Returns(responseStream);
|
|
contextMock
|
|
.SetupGet(c => c.RequestServices)
|
|
.Returns(() => null);
|
|
|
|
// Act
|
|
await captureMiddleware.Invoke(contextMock.Object);
|
|
await pageMiddleware.Invoke(contextMock.Object);
|
|
|
|
string response = Encoding.UTF8.GetString(responseStream.ToArray());
|
|
|
|
// Assert
|
|
contextMock.VerifyGet(c => c.Request.Query, Times.AtLeastOnce());
|
|
Assert.Contains("<title>ASP.NET Core Logs</title>", response);
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Invoke_BadRequestShowsError()
|
|
{
|
|
// Arrange
|
|
var elmStore = new ElmStore();
|
|
var factory = new LoggerFactory();
|
|
var optionsMock = new Mock<IOptions<ElmOptions>>();
|
|
optionsMock
|
|
.SetupGet(o => o.Value)
|
|
.Returns(new ElmOptions());
|
|
factory.AddProvider(new ElmLoggerProvider(elmStore, optionsMock.Object));
|
|
|
|
RequestDelegate next = _ =>
|
|
{
|
|
return Task.FromResult<object>(null);
|
|
};
|
|
|
|
var captureMiddleware = new ElmCaptureMiddleware(
|
|
next,
|
|
factory,
|
|
optionsMock.Object);
|
|
var pageMiddleware = new ElmPageMiddleware(
|
|
next,
|
|
optionsMock.Object,
|
|
elmStore);
|
|
var contextMock = GetMockContext("/Elm/666");
|
|
|
|
using (var responseStream = new MemoryStream())
|
|
{
|
|
contextMock
|
|
.SetupGet(c => c.Response.Body)
|
|
.Returns(responseStream);
|
|
|
|
// Act
|
|
await captureMiddleware.Invoke(contextMock.Object);
|
|
await pageMiddleware.Invoke(contextMock.Object);
|
|
|
|
string response = Encoding.UTF8.GetString(responseStream.ToArray());
|
|
|
|
// Assert
|
|
contextMock.VerifyGet(c => c.Request.Query, Times.AtLeastOnce());
|
|
Assert.Contains("Invalid Id", response);
|
|
}
|
|
}
|
|
|
|
private Mock<HttpContext> GetMockContext(string path)
|
|
{
|
|
var contextMock = new Mock<HttpContext>(MockBehavior.Strict);
|
|
contextMock
|
|
.SetupGet(c => c.Request.Path)
|
|
.Returns(new PathString(path));
|
|
contextMock
|
|
.SetupGet(c => c.Request.Host)
|
|
.Returns(new HostString("localhost"));
|
|
contextMock
|
|
.SetupGet(c => c.Request.ContentType)
|
|
.Returns("");
|
|
contextMock
|
|
.SetupGet(c => c.Request.Scheme)
|
|
.Returns("http");
|
|
contextMock
|
|
.SetupGet(c => c.Request.Scheme)
|
|
.Returns("http");
|
|
contextMock
|
|
.SetupGet(c => c.Response.StatusCode)
|
|
.Returns(200);
|
|
contextMock
|
|
.SetupGet(c => c.Response.Body)
|
|
.Returns(new Mock<Stream>().Object);
|
|
contextMock
|
|
.SetupGet(c => c.User)
|
|
.Returns(new ClaimsPrincipal());
|
|
contextMock
|
|
.SetupGet(c => c.Request.Method)
|
|
.Returns("GET");
|
|
contextMock
|
|
.SetupGet(c => c.Request.Protocol)
|
|
.Returns("HTTP/1.1");
|
|
contextMock
|
|
.SetupGet(c => c.Request.Headers)
|
|
.Returns(new Mock<IHeaderDictionary>().Object);
|
|
contextMock
|
|
.SetupGet(c => c.Request.QueryString)
|
|
.Returns(new QueryString());
|
|
contextMock
|
|
.SetupGet(c => c.Request.Query)
|
|
.Returns(new Mock<IQueryCollection>().Object);
|
|
contextMock
|
|
.SetupGet(c => c.Request.Cookies)
|
|
.Returns(new Mock<IRequestCookieCollection>().Object);
|
|
contextMock
|
|
.Setup(c => c.Request.ReadFormAsync(It.IsAny<System.Threading.CancellationToken>()))
|
|
.Returns(Task.FromResult(new Mock<IFormCollection>().Object));
|
|
contextMock
|
|
.Setup(c => c.Request.HasFormContentType)
|
|
.Returns(true);
|
|
var requestIdentifier = new Mock<IHttpRequestIdentifierFeature>();
|
|
requestIdentifier.Setup(f => f.TraceIdentifier).Returns(Guid.NewGuid().ToString());
|
|
var featureCollection = new FeatureCollection();
|
|
featureCollection.Set<IHttpRequestIdentifierFeature>(requestIdentifier.Object);
|
|
contextMock
|
|
.SetupGet(c => c.Features)
|
|
.Returns(featureCollection);
|
|
return contextMock;
|
|
}
|
|
|
|
[Fact]
|
|
public async Task SetsNewIdentifierFeature_IfNotPresentOnContext()
|
|
{
|
|
// Arrange
|
|
var context = new DefaultHttpContext();
|
|
var loggerFactory = new LoggerFactory();
|
|
loggerFactory.AddProvider(new ElmLoggerProvider(new ElmStore(), Options.Create(new ElmOptions())));
|
|
|
|
// Act & Assert
|
|
var errorPageMiddleware = new ElmCaptureMiddleware((innerContext) =>
|
|
{
|
|
var feature = innerContext.Features.Get<IHttpRequestIdentifierFeature>();
|
|
Assert.NotNull(feature);
|
|
Assert.False(string.IsNullOrEmpty(feature.TraceIdentifier));
|
|
return Task.FromResult(0);
|
|
}, loggerFactory, new TestElmOptions());
|
|
|
|
await errorPageMiddleware.Invoke(context);
|
|
|
|
Assert.Null(context.Features.Get<IHttpRequestIdentifierFeature>());
|
|
}
|
|
|
|
[Fact]
|
|
public async Task UsesIdentifierFeature_IfAlreadyPresentOnContext()
|
|
{
|
|
var context = new DefaultHttpContext();
|
|
var requestIdentifierFeature = new HttpRequestIdentifierFeature()
|
|
{
|
|
TraceIdentifier = Guid.NewGuid().ToString()
|
|
};
|
|
context.Features.Set<IHttpRequestIdentifierFeature>(requestIdentifierFeature);
|
|
var loggerFactory = new LoggerFactory();
|
|
loggerFactory.AddProvider(new ElmLoggerProvider(new ElmStore(), Options.Create(new ElmOptions())));
|
|
|
|
var errorPageMiddleware = new ElmCaptureMiddleware((innerContext) =>
|
|
{
|
|
Assert.Same(requestIdentifierFeature, innerContext.Features.Get<IHttpRequestIdentifierFeature>());
|
|
return Task.FromResult(0);
|
|
}, loggerFactory, new TestElmOptions());
|
|
|
|
await errorPageMiddleware.Invoke(context);
|
|
|
|
Assert.Same(requestIdentifierFeature, context.Features.Get<IHttpRequestIdentifierFeature>());
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData("")]
|
|
// Note that HttpRequestIdentifierFeature now provides a default TraceIdentifier and will never return null.
|
|
public async Task UpdatesTraceIdentifier_IfEmpty(string requestId)
|
|
{
|
|
var context = new DefaultHttpContext();
|
|
var requestIdentifierFeature = new HttpRequestIdentifierFeature() { TraceIdentifier = requestId };
|
|
context.Features.Set<IHttpRequestIdentifierFeature>(requestIdentifierFeature);
|
|
var loggerFactory = new LoggerFactory();
|
|
loggerFactory.AddProvider(new ElmLoggerProvider(new ElmStore(), Options.Create(new ElmOptions())));
|
|
|
|
var errorPageMiddleware = new ElmCaptureMiddleware((innerContext) =>
|
|
{
|
|
var feature = innerContext.Features.Get<IHttpRequestIdentifierFeature>();
|
|
Assert.NotNull(feature);
|
|
Assert.False(string.IsNullOrEmpty(feature.TraceIdentifier));
|
|
return Task.FromResult(0);
|
|
}, loggerFactory, new TestElmOptions());
|
|
|
|
await errorPageMiddleware.Invoke(context);
|
|
|
|
Assert.Equal(requestId, context.Features.Get<IHttpRequestIdentifierFeature>().TraceIdentifier);
|
|
}
|
|
|
|
private class TestElmOptions : IOptions<ElmOptions>
|
|
{
|
|
private readonly ElmOptions _innerOptions;
|
|
|
|
public TestElmOptions() :
|
|
this(new ElmOptions())
|
|
{
|
|
}
|
|
|
|
public TestElmOptions(ElmOptions innerOptions)
|
|
{
|
|
_innerOptions = innerOptions;
|
|
}
|
|
|
|
public ElmOptions Value
|
|
{
|
|
get
|
|
{
|
|
return _innerOptions;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|