src/VisualStudio/IntegrationTest/New.IntegrationTests/AbstractEditorTest.cs - main - githubmirror/roslyn

src/VisualStudio/IntegrationTest/New.IntegrationTests/AbstractEditorTest.cs
98 строк4 KB
Cyrus Najmabadi
Merge remote-tracking branch 'upstream/main' into fileScopedNamespace
22 май 2024, 20:05
22 май 2024, 20:05d623561
// 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.

using System.Threading;
using System.Threading.Tasks;
using Microsoft.VisualStudio.IntegrationTest.Utilities;
using Roslyn.Test.Utilities;
using Roslyn.Utilities;
using Xunit;

namespace Roslyn.VisualStudio.IntegrationTests;

public abstract class AbstractEditorTest : AbstractIntegrationTest
{
    private readonly string? _solutionName;
    private readonly string? _projectTemplate;
    private readonly string? _templateGroupId;

    protected AbstractEditorTest()
    {
    }

    protected AbstractEditorTest(string solutionName)
        : this(solutionName, WellKnownProjectTemplates.ClassLibrary)
    {
    }

    protected AbstractEditorTest(string solutionName, string projectTemplate, string? templateGroupId = null)
    {
        _solutionName = solutionName;
        _projectTemplate = projectTemplate;
        _templateGroupId = templateGroupId;
    }

    protected abstract string LanguageName { get; }

    public override async Task InitializeAsync()
    {
        await base.InitializeAsync().ConfigureAwait(true);

        if (_solutionName != null)
        {
            RoslynDebug.AssertNotNull(_projectTemplate);

            await TestServices.SolutionExplorer.CreateSolutionAsync(_solutionName, HangMitigatingCancellationToken);
            await TestServices.SolutionExplorer.AddProjectAsync(ProjectName, _projectTemplate, _templateGroupId, LanguageName, HangMitigatingCancellationToken);
            await TestServices.SolutionExplorer.RestoreNuGetPackagesAsync(ProjectName, HangMitigatingCancellationToken);

            // Winforms and XAML do not open text files on creation
            // so these editor tasks will not work if that is the project template being used.
            if (_projectTemplate is not WellKnownProjectTemplates.WinFormsApplication and
                not WellKnownProjectTemplates.WpfApplication and
                not WellKnownProjectTemplates.CSharpNetCoreClassLibrary and
                not WellKnownProjectTemplates.VisualBasicNetCoreClassLibrary and
                not WellKnownProjectTemplates.Blazor)
            {
                await ClearEditorAsync(HangMitigatingCancellationToken);
            }
        }
    }

    protected async Task ClearEditorAsync(CancellationToken cancellationToken)
        => await SetUpEditorAsync("$$", cancellationToken);

    protected async Task SetUpEditorAsync(string markupCode, CancellationToken cancellationToken)
    {
        MarkupTestFile.GetPositionAndSpans(markupCode, out var code, out int? caretPosition, out var spans);

        Assert.True(caretPosition.HasValue || spans.ContainsKey("selection"), "Must specify either a caret position ($$) or at least one selection span ({|selection:|})");

        await TestServices.Editor.DismissCompletionSessionsAsync(cancellationToken);
        await TestServices.Editor.DismissLightBulbSessionAsync(cancellationToken);

        var originalValue = await TestServices.Workspace.IsPrettyListingOnAsync(LanguageName, cancellationToken);

        await TestServices.Workspace.SetPrettyListingAsync(LanguageName, false, cancellationToken);
        try
        {
            await TestServices.Editor.SetTextAsync(code, cancellationToken);

            if (caretPosition.HasValue)
            {
                await TestServices.Editor.MoveCaretAsync(caretPosition.Value, cancellationToken);
            }
            else
            {
                await TestServices.Editor.SetMultiSelectionAsync(spans["selection"], cancellationToken);
            }

            await TestServices.Editor.ActivateAsync(cancellationToken);
        }
        finally
        {
            await TestServices.Workspace.SetPrettyListingAsync(LanguageName, originalValue, cancellationToken);
        }
    }
}