src/Middleware/ResponseCaching/test/TestUtils.cs - main - githubmirror/aspnetcore

src/Middleware/ResponseCaching/test/TestUtils.cs
392 строки15 KB
Korolev Dmitry
Add validation to ResponseCachingKeyProvider delimiter characters (#66672)
14 май 2026, 14:27
14 май 2026, 14:277244f07
// 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.Net.Http;
using System.Text;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Http.Features;
using Microsoft.AspNetCore.TestHost;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Extensions.Logging.Testing;
using Microsoft.Extensions.ObjectPool;
using Microsoft.Extensions.Options;
using Microsoft.Extensions.Primitives;
using Microsoft.Net.Http.Headers;

namespace Microsoft.AspNetCore.ResponseCaching.Tests;

internal class TestUtils
{
    static TestUtils()
    {
        // Force sharding in tests
        StreamUtilities.BodySegmentSize = 10;
    }

    private static bool TestRequestDelegate(HttpContext context, string guid)
    {
        var headers = context.Response.GetTypedHeaders();

        var expires = context.Request.Query["Expires"];
        if (!string.IsNullOrEmpty(expires))
        {
            headers.Expires = DateTimeOffset.Now.AddSeconds(int.Parse(expires, CultureInfo.InvariantCulture));
        }

        if (headers.CacheControl == null)
        {
            headers.CacheControl = new CacheControlHeaderValue
            {
                Public = true,
                MaxAge = string.IsNullOrEmpty(expires) ? TimeSpan.FromSeconds(10) : (TimeSpan?)null
            };
        }
        else
        {
            headers.CacheControl.Public = true;
            headers.CacheControl.MaxAge = string.IsNullOrEmpty(expires) ? TimeSpan.FromSeconds(10) : (TimeSpan?)null;
        }
        headers.Date = DateTimeOffset.UtcNow;
        headers.Headers["X-Value"] = guid;

        var contentLength = context.Request.Query["ContentLength"];
        if (!string.IsNullOrEmpty(contentLength))
        {
            headers.ContentLength = long.Parse(contentLength, CultureInfo.InvariantCulture);
        }

        if (context.Request.Method != "HEAD")
        {
            return true;
        }
        return false;
    }

    internal static async Task TestRequestDelegateWriteAsync(HttpContext context)
    {
        var uniqueId = Guid.NewGuid().ToString();
        if (TestRequestDelegate(context, uniqueId))
        {
            await context.Response.WriteAsync(uniqueId);
        }
    }

    internal static async Task TestRequestDelegateSendFileAsync(HttpContext context)
    {
        var path = Path.Combine(AppContext.BaseDirectory, "TestDocument.txt");
        var uniqueId = Guid.NewGuid().ToString();
        if (TestRequestDelegate(context, uniqueId))
        {
            await context.Response.SendFileAsync(path, 0, null);
            await context.Response.WriteAsync(uniqueId);
        }
    }

    internal static Task TestRequestDelegateWrite(HttpContext context)
    {
        var uniqueId = Guid.NewGuid().ToString();
        if (TestRequestDelegate(context, uniqueId))
        {
            var feature = context.Features.Get<IHttpBodyControlFeature>();
            if (feature != null)
            {
                feature.AllowSynchronousIO = true;
            }
            context.Response.Write(uniqueId);
        }
        return Task.CompletedTask;
    }

    internal static IResponseCachingKeyProvider CreateTestKeyProvider()
    {
        return CreateTestKeyProvider(new ResponseCachingOptions());
    }

    internal static IResponseCachingKeyProvider CreateTestKeyProvider(ResponseCachingOptions options)
    {
        return new ResponseCachingKeyProvider(new DefaultObjectPoolProvider(), Options.Create(options));
    }

    internal static IEnumerable<IHostBuilder> CreateBuildersWithResponseCaching(
        Action<IApplicationBuilder> configureDelegate = null,
        ResponseCachingOptions options = null,
        Action<HttpContext> contextAction = null)
    {
        return CreateBuildersWithResponseCaching(configureDelegate, options, new RequestDelegate[]
            {
                    context =>
                    {
                        contextAction?.Invoke(context);
                        return TestRequestDelegateWrite(context);
                    },
                    context =>
                    {
                        contextAction?.Invoke(context);
                        return TestRequestDelegateWriteAsync(context);
                    },
                    context =>
                    {
                        contextAction?.Invoke(context);
                        return TestRequestDelegateSendFileAsync(context);
                    },
            });
    }

    private static IEnumerable<IHostBuilder> CreateBuildersWithResponseCaching(
        Action<IApplicationBuilder> configureDelegate = null,
        ResponseCachingOptions options = null,
        IEnumerable<RequestDelegate> requestDelegates = null)
    {
        if (configureDelegate == null)
        {
            configureDelegate = app => { };
        }
        if (requestDelegates == null)
        {
            requestDelegates = new RequestDelegate[]
            {
                    TestRequestDelegateWriteAsync,
                    TestRequestDelegateWrite
            };
        }

        foreach (var requestDelegate in requestDelegates)
        {
            // Test with in memory ResponseCache
            yield return new HostBuilder()
                .ConfigureWebHost(webHostBuilder =>
                {
                    webHostBuilder
                    .UseTestServer()
                    .ConfigureServices(services =>
                    {
                        services.AddResponseCaching(responseCachingOptions =>
                        {
                            if (options != null)
                            {
                                responseCachingOptions.MaximumBodySize = options.MaximumBodySize;
                                responseCachingOptions.UseCaseSensitivePaths = options.UseCaseSensitivePaths;
                                responseCachingOptions.TimeProvider = options.TimeProvider;
                            }
                        });
                    })
                    .Configure(app =>
                    {
                        configureDelegate(app);
                        app.UseResponseCaching();
                        app.Run(requestDelegate);
                    });
                });
        }
    }

    internal static ResponseCachingMiddleware CreateTestMiddleware(
        RequestDelegate next = null,
        IResponseCache cache = null,
        ResponseCachingOptions options = null,
        TestSink testSink = null,
        IResponseCachingKeyProvider keyProvider = null,
        IResponseCachingPolicyProvider policyProvider = null)
    {
        if (next == null)
        {
            next = httpContext => Task.CompletedTask;
        }
        if (cache == null)
        {
            cache = new TestResponseCache();
        }
        if (options == null)
        {
            options = new ResponseCachingOptions();
        }
        if (keyProvider == null)
        {
            keyProvider = new ResponseCachingKeyProvider(new DefaultObjectPoolProvider(), Options.Create(options));
        }
        if (policyProvider == null)
        {
            policyProvider = new TestResponseCachingPolicyProvider();
        }

        return new ResponseCachingMiddleware(
            next,
            Options.Create(options),
            testSink == null ? (ILoggerFactory)NullLoggerFactory.Instance : new TestLoggerFactory(testSink, true),
            policyProvider,
            cache,
            keyProvider);
    }

    internal static ResponseCachingContext CreateTestContext()
    {
        return new ResponseCachingContext(new DefaultHttpContext(), NullLogger.Instance)
        {
            ResponseTime = DateTimeOffset.UtcNow
        };
    }

    internal static ResponseCachingContext CreateTestContext(ITestSink testSink)
    {
        return new ResponseCachingContext(new DefaultHttpContext(), new TestLogger("ResponseCachingTests", testSink, true))
        {
            ResponseTime = DateTimeOffset.UtcNow
        };
    }

    internal static void AssertLoggedMessages(IEnumerable<WriteContext> messages, params LoggedMessage[] expectedMessages)
    {
        var messageList = messages.ToList();
        Assert.Equal(messageList.Count, expectedMessages.Length);

        for (var i = 0; i < messageList.Count; i++)
        {
            Assert.Equal(expectedMessages[i].EventId, messageList[i].EventId);
            Assert.Equal(expectedMessages[i].LogLevel, messageList[i].LogLevel);
        }
    }

    public static HttpRequestMessage CreateRequest(string method, string requestUri)
    {
        return new HttpRequestMessage(new HttpMethod(method), requestUri);
    }
}

internal static class HttpResponseWritingExtensions
{
    internal static void Write(this HttpResponse response, string text)
    {
        ArgumentNullException.ThrowIfNull(response);
        ArgumentNullException.ThrowIfNull(text);

        byte[] data = Encoding.UTF8.GetBytes(text);
        response.Body.Write(data, 0, data.Length);
    }
}

internal class LoggedMessage
{
    internal static LoggedMessage RequestMethodNotCacheable => new LoggedMessage(1, LogLevel.Debug);
    internal static LoggedMessage RequestWithAuthorizationNotCacheable => new LoggedMessage(2, LogLevel.Debug);
    internal static LoggedMessage RequestWithNoCacheNotCacheable => new LoggedMessage(3, LogLevel.Debug);
    internal static LoggedMessage RequestWithPragmaNoCacheNotCacheable => new LoggedMessage(4, LogLevel.Debug);
    internal static LoggedMessage ExpirationMinFreshAdded => new LoggedMessage(5, LogLevel.Debug);
    internal static LoggedMessage ExpirationSharedMaxAgeExceeded => new LoggedMessage(6, LogLevel.Debug);
    internal static LoggedMessage ExpirationMustRevalidate => new LoggedMessage(7, LogLevel.Debug);
    internal static LoggedMessage ExpirationMaxStaleSatisfied => new LoggedMessage(8, LogLevel.Debug);
    internal static LoggedMessage ExpirationMaxAgeExceeded => new LoggedMessage(9, LogLevel.Debug);
    internal static LoggedMessage ExpirationExpiresExceeded => new LoggedMessage(10, LogLevel.Debug);
    internal static LoggedMessage ResponseWithoutPublicNotCacheable => new LoggedMessage(11, LogLevel.Debug);
    internal static LoggedMessage ResponseWithNoStoreNotCacheable => new LoggedMessage(12, LogLevel.Debug);
    internal static LoggedMessage ResponseWithNoCacheNotCacheable => new LoggedMessage(13, LogLevel.Debug);
    internal static LoggedMessage ResponseWithSetCookieNotCacheable => new LoggedMessage(14, LogLevel.Debug);
    internal static LoggedMessage ResponseWithVaryStarNotCacheable => new LoggedMessage(15, LogLevel.Debug);
    internal static LoggedMessage ResponseWithPrivateNotCacheable => new LoggedMessage(16, LogLevel.Debug);
    internal static LoggedMessage ResponseWithUnsuccessfulStatusCodeNotCacheable => new LoggedMessage(17, LogLevel.Debug);
    internal static LoggedMessage NotModifiedIfNoneMatchStar => new LoggedMessage(18, LogLevel.Debug);
    internal static LoggedMessage NotModifiedIfNoneMatchMatched => new LoggedMessage(19, LogLevel.Debug);
    internal static LoggedMessage NotModifiedIfModifiedSinceSatisfied => new LoggedMessage(20, LogLevel.Debug);
    internal static LoggedMessage NotModifiedServed => new LoggedMessage(21, LogLevel.Information);
    internal static LoggedMessage CachedResponseServed => new LoggedMessage(22, LogLevel.Information);
    internal static LoggedMessage GatewayTimeoutServed => new LoggedMessage(23, LogLevel.Information);
    internal static LoggedMessage NoResponseServed => new LoggedMessage(24, LogLevel.Information);
    internal static LoggedMessage VaryByRulesUpdated => new LoggedMessage(25, LogLevel.Debug);
    internal static LoggedMessage ResponseCached => new LoggedMessage(26, LogLevel.Information);
    internal static LoggedMessage ResponseNotCached => new LoggedMessage(27, LogLevel.Information);
    internal static LoggedMessage ResponseContentLengthMismatchNotCached => new LoggedMessage(28, LogLevel.Warning);
    internal static LoggedMessage ExpirationInfiniteMaxStaleSatisfied => new LoggedMessage(29, LogLevel.Debug);
    internal static LoggedMessage RequestContainsInvalidCacheSymbols => new LoggedMessage(30, LogLevel.Debug);

    private LoggedMessage(int evenId, LogLevel logLevel)
    {
        EventId = evenId;
        LogLevel = logLevel;
    }

    internal int EventId { get; }
    internal LogLevel LogLevel { get; }
}

internal class TestResponseCachingPolicyProvider : IResponseCachingPolicyProvider
{
    public bool AllowCacheLookupValue { get; set; } = false;
    public bool AllowCacheStorageValue { get; set; } = false;
    public bool AttemptResponseCachingValue { get; set; } = false;
    public bool IsCachedEntryFreshValue { get; set; } = true;
    public bool IsResponseCacheableValue { get; set; } = true;

    public bool AllowCacheLookup(ResponseCachingContext context) => AllowCacheLookupValue;

    public bool AllowCacheStorage(ResponseCachingContext context) => AllowCacheStorageValue;

    public bool AttemptResponseCaching(ResponseCachingContext context) => AttemptResponseCachingValue;

    public bool IsCachedEntryFresh(ResponseCachingContext context) => IsCachedEntryFreshValue;

    public bool IsResponseCacheable(ResponseCachingContext context) => IsResponseCacheableValue;
}

internal class TestResponseCachingKeyProvider : IResponseCachingKeyProvider
{
    private readonly string _baseKey;
    private readonly StringValues _varyKey;

    public TestResponseCachingKeyProvider(string lookupBaseKey = null, StringValues? lookupVaryKey = null)
    {
        _baseKey = lookupBaseKey;
        if (lookupVaryKey.HasValue)
        {
            _varyKey = lookupVaryKey.Value;
        }
    }

    public IEnumerable<string> CreateLookupVaryByKeys(ResponseCachingContext context)
    {
        foreach (var varyKey in _varyKey)
        {
            yield return _baseKey + varyKey;
        }
    }

    public string CreateBaseKey(ResponseCachingContext context)
    {
        return _baseKey;
    }

    public string CreateStorageVaryByKey(ResponseCachingContext context)
    {
        throw new NotImplementedException();
    }
}

internal class TestResponseCache : IResponseCache
{
    private readonly IDictionary<string, IResponseCacheEntry> _storage = new Dictionary<string, IResponseCacheEntry>();
    public int GetCount { get; private set; }
    public int SetCount { get; private set; }

    public IResponseCacheEntry Get(string key)
    {
        GetCount++;
        try
        {
            return _storage[key];
        }
        catch
        {
            return null;
        }
    }

    public void Set(string key, IResponseCacheEntry entry, TimeSpan validFor)
    {
        SetCount++;
        _storage[key] = entry;
    }
}