src/Workspaces/Remote/ServiceHubTest/RazorAnalyzerAssemblyResolverTests.cs - main - githubmirror/roslyn

src/Workspaces/Remote/ServiceHubTest/RazorAnalyzerAssemblyResolverTests.cs
200 строк8 KB
Joey Robichaud
Consolidate ExternalAccess libraries (#81593)
07 июл 2026, 23:16
07 июл 2026, 23:1697ee762
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#if NET

using System;
using System.Collections.Immutable;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Runtime.Loader;
using Basic.Reference.Assemblies;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.Remote.Razor;
using Microsoft.CodeAnalysis.Test.Utilities;
using Roslyn.Test.Utilities;
using Roslyn.Utilities;
using Xunit;

namespace Microsoft.CodeAnalysis.Remote.UnitTests;

public sealed class RazorAnalyzerAssemblyResolverTests : IDisposable
{
    private TempRoot TempRoot { get; } = new TempRoot();
    private ImmutableArray<string?> InitialAssemblies { get; }

    public RazorAnalyzerAssemblyResolverTests()
    {
        // Ensure that test infrastructure and compilation assemblies are already loaded
        // before we take the snapshot below. These are lazily loaded on first use, and
        // if that first use happens *after* the snapshot is taken then those assemblies
        // show up as unexpected additions and the assertion in Dispose fails.
        TestHelpers.EnsureAssemblyLoaded("Microsoft.CodeAnalysis.CSharp", typeof(CSharpCompilation).TypeHandle);
        TestHelpers.EnsureAssemblyLoaded("Basic.Reference.Assemblies.NetStandard20", typeof(NetStandard20).TypeHandle);
        TestHelpers.EnsureAssemblyLoaded("Microsoft.CodeAnalysis.Remote.ServiceHub", typeof(RazorAnalyzerAssemblyResolver).TypeHandle);
        TestHelpers.EnsureAssemblyLoaded("Microsoft.CodeAnalysis.Test.Utilities", typeof(AssertEx).TypeHandle);
        TestHelpers.EnsureAssemblyLoaded("xunit.assert", typeof(Assert).TypeHandle);
        TestHelpers.EnsureAssemblyLoaded("System.Threading.Tasks.Parallel", typeof(System.Threading.Tasks.Parallel).TypeHandle);

        InitialAssemblies = AssemblyLoadContext.GetLoadContext(GetType().Assembly)!.Assemblies.SelectAsArray(a => a.FullName);
    }

    public void Dispose()
    {
        TempRoot.Dispose();

        // This test should not be loading any of the razor assemblies into the test assembly load context. That
        // would indicate a bug in our product code where it was incorrectly using the default load context.
        //
        // Note: if this test fails due to a normal test assembly, like xunit.assert, being loaded after the
        // snapshot, then add that assembly to the list of assemblies loaded in the constructor above.
        var count = AssemblyLoadContext.GetLoadContext(GetType().Assembly)!.Assemblies.SelectAsArray(a => a.FullName);
        AssertEx.SetEqual(InitialAssemblies, count);
    }

    private static void CreateRazorAssemblies(string directory, string versionNumber = "1.0.0.0")
    {
        _ = Directory.CreateDirectory(directory);
        foreach (var simpleName in RazorAnalyzerAssemblyResolver.RazorAssemblyNames)
        {
            BuildOne(simpleName);
        }

        void BuildOne(string simpleName)
        {
            var i = simpleName.LastIndexOf('.');
            var typeName = simpleName[(i + 1)..];
            var source = $$"""
                using System.Reflection;

                [assembly: AssemblyVersion("{{versionNumber}}")]
                [assembly: AssemblyFileVersion("{{versionNumber}}")]

                public sealed class {{typeName}} { }
                """;

            var compilation = CSharpCompilation.Create(
                simpleName,
                [CSharpSyntaxTree.ParseText(source)],
                NetStandard20.References.All,
                new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary));
            var result = compilation.Emit(Path.Combine(directory, $"{simpleName}.dll"));
            Assert.True(result.Success);
        }
    }

    private static void RunWithLoader(Action<RazorAnalyzerAssemblyResolver, AnalyzerAssemblyLoader, AssemblyLoadContext> action)
    {
        var compilerLoadContext = new AssemblyLoadContext("Compiler", isCollectible: true);
        var currentLoadContext = new AssemblyLoadContext("Current", isCollectible: true);
        var loader = new AnalyzerAssemblyLoader([], [AnalyzerAssemblyLoader.DiskAnalyzerAssemblyResolver], compilerLoadContext);
        var resolver = CreateResolver();
        action(resolver, loader, currentLoadContext);

        Assert.Empty(currentLoadContext.Assemblies);
        currentLoadContext.Unload();
        compilerLoadContext.Unload();
    }

    internal static RazorAnalyzerAssemblyResolver CreateResolver() => new();

    /// <summary>
    /// When running in Visual Studio the razor generator will be redirected to the razor language
    /// services directory. That will not always contain all of the necessary Razor DLLs, so the
    /// resolver needs to fall back to the compiler context to find them.
    /// </summary>
    [Fact]
    public void FallbackToCompilerContext()
    {
        var dir1 = TempRoot.CreateDirectory().Path;
        CreateRazorAssemblies(dir1);
        var dir2 = TempRoot.CreateDirectory().Path;
        var fileName = $"{RazorAnalyzerAssemblyResolver.RazorUtilsAssemblyName}.dll";
        File.Move(Path.Combine(dir1, fileName), Path.Combine(dir2, fileName));

        RunWithLoader((resolver, loader, currentLoadContext) =>
        {
            Assembly? expectedAssembly = null;
            loader.CompilerLoadContext.Resolving += (context, name) =>
            {
                if (name.Name == RazorAnalyzerAssemblyResolver.RazorUtilsAssemblyName)
                {
                    expectedAssembly = context.LoadFromAssemblyPath(Path.Combine(dir2, fileName));
                    return expectedAssembly;
                }

                return null;
            };

            var actualAssembly = resolver.Resolve(
                loader,
                new AssemblyName(RazorAnalyzerAssemblyResolver.RazorUtilsAssemblyName),
                currentLoadContext,
                dir1);
            Assert.NotNull(expectedAssembly);
            Assert.NotNull(actualAssembly);
            Assert.Same(expectedAssembly, actualAssembly);
        });
    }

    [Fact]
    public void FirstLoadWins()
    {
        var dir1 = TempRoot.CreateDirectory().Path;
        CreateRazorAssemblies(dir1, versionNumber: "1.0.0.0");
        var dir2 = TempRoot.CreateDirectory().Path;
        CreateRazorAssemblies(dir2, versionNumber: "2.0.0.0");

        RunWithLoader((resolver, loader, currentLoadContext) =>
        {
            var assembly1 = resolver.Resolve(
                loader,
                new AssemblyName(RazorAnalyzerAssemblyResolver.RazorCompilerAssemblyName),
                currentLoadContext,
                dir1);
            var assembly2 = resolver.Resolve(
                loader,
                new AssemblyName(RazorAnalyzerAssemblyResolver.RazorCompilerAssemblyName),
                currentLoadContext,
                dir2);
            Assert.Same(assembly1, assembly2);
        });
    }

    [Fact]
    public void ChooseServiceHubFolder()
    {
        var dir = TempRoot.CreateDirectory().Path;
        CreateRazorAssemblies(dir);
        var serviceHubFolder = Path.Combine(dir, RazorAnalyzerAssemblyResolver.ServiceHubCoreFolderName);
        CreateRazorAssemblies(serviceHubFolder);

        CoreTest(dir, serviceHubFolder);
        CoreTest(dir + Path.DirectorySeparatorChar, serviceHubFolder);
        CoreTest(serviceHubFolder, serviceHubFolder);
        CoreTest(serviceHubFolder + Path.DirectorySeparatorChar, serviceHubFolder);

        void CoreTest(string loadDir, string serviceHubDir)
        {
            RunWithLoader((resolver, loader, currentLoadContext) =>
            {
                var assembly1 = resolver.Resolve(
                    loader,
                    new AssemblyName(RazorAnalyzerAssemblyResolver.RazorCompilerAssemblyName),
                    currentLoadContext,
                    loadDir);
                var assembly2 = resolver.Resolve(
                    loader,
                    new AssemblyName(RazorAnalyzerAssemblyResolver.RazorCompilerAssemblyName),
                    currentLoadContext,
                    serviceHubFolder);
                Assert.NotNull(assembly1);
                Assert.Same(assembly1, assembly2);
                Assert.Equal(serviceHubDir, Path.GetDirectoryName(assembly1.Location));
            });
        }
    }
}
#endif