|
// 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.
#nullable disable
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.CodeRefactorings;
using Microsoft.CodeAnalysis.CodeRefactorings.MoveType;
using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.Editor.UnitTests.CodeActions;
using Microsoft.CodeAnalysis.Editor.UnitTests.Diagnostics;
using Microsoft.CodeAnalysis.Shared.Utilities;
using Microsoft.CodeAnalysis.Test.Utilities;
using Microsoft.CodeAnalysis.Text;
using Microsoft.CodeAnalysis.UnitTests;
using Roslyn.Test.Utilities;
using Xunit;
namespace Microsoft.CodeAnalysis.Editor.UnitTests.MoveType
{
public abstract class AbstractMoveTypeTest : AbstractCodeActionTest
{
private readonly string RenameFileCodeActionTitle = FeaturesResources.Rename_file_to_0;
private readonly string RenameTypeCodeActionTitle = FeaturesResources.Rename_type_to_0;
// TODO: Requires WPF due to IInlineRenameService dependency (https://github.com/dotnet/roslyn/issues/46153)
protected override TestComposition GetComposition()
=> EditorTestCompositions.EditorFeaturesWpf
.AddExcludedPartTypes(typeof(IDiagnosticUpdateSourceRegistrationService))
.AddParts(typeof(MockDiagnosticUpdateSourceRegistrationService));
protected override CodeRefactoringProvider CreateCodeRefactoringProvider(Workspace workspace, TestParameters parameters)
=> new MoveTypeCodeRefactoringProvider();
protected async Task TestRenameTypeToMatchFileAsync(
string originalCode,
string expectedCode = null,
bool expectedCodeAction = true,
object fixProviderData = null)
{
var testOptions = new TestParameters(fixProviderData: fixProviderData);
using (var workspace = CreateWorkspaceFromOptions(originalCode, testOptions))
{
if (expectedCodeAction)
{
Assert.True(expectedCode != null, $"{nameof(expectedCode)} should be present if {nameof(expectedCodeAction)} is true.");
var documentId = workspace.Documents[0].Id;
var documentName = workspace.Documents[0].Name;
MarkupTestFile.GetSpan(expectedCode, out var expectedText, out var span);
var codeActionTitle = string.Format(RenameTypeCodeActionTitle, expectedText.Substring(span.Start, span.Length));
var oldSolutionAndNewSolution = await TestOperationAsync(
testOptions, workspace, expectedText, codeActionTitle);
// the original source document does not exist in the new solution.
var newSolution = oldSolutionAndNewSolution.Item2;
var document = newSolution.GetDocument(documentId);
Assert.NotNull(document);
Assert.Equal(documentName, document.Name);
}
else
{
var (actions, _) = await GetCodeActionsAsync(workspace, testOptions);
if (actions.Length > 0)
{
var renameFileAction = actions.Any(static (action, self) => action.Title.StartsWith(self.RenameTypeCodeActionTitle), this);
Assert.False(renameFileAction, "Rename Type to match file name code action was not expected, but shows up.");
}
}
}
}
protected async Task TestRenameFileToMatchTypeAsync(
string originalCode,
string expectedDocumentName = null,
bool expectedCodeAction = true,
IList<string> destinationDocumentContainers = null,
object fixProviderData = null)
{
var testOptions = new TestParameters(fixProviderData: fixProviderData);
using (var workspace = CreateWorkspaceFromOptions(originalCode, testOptions))
{
if (expectedCodeAction)
{
Assert.True(expectedDocumentName != null, $"{nameof(expectedDocumentName)} should be present if {nameof(expectedCodeAction)} is true.");
var oldDocumentId = workspace.Documents[0].Id;
var expectedText = workspace.Documents[0].GetTextBuffer().CurrentSnapshot.GetText();
var spans = workspace.Documents[0].SelectedSpans;
var codeActionTitle = string.Format(RenameFileCodeActionTitle, expectedDocumentName);
var oldSolutionAndNewSolution = await TestOperationAsync(
testOptions, workspace, expectedText, codeActionTitle);
// The code action updated the Name of the file in-place
var newSolution = oldSolutionAndNewSolution.Item2;
var newDocument = newSolution.GetDocument(oldDocumentId);
Assert.Equal(expectedDocumentName, newDocument.Name);
if (destinationDocumentContainers != null)
{
Assert.Equal(destinationDocumentContainers, newDocument.Folders);
}
}
else
{
var (actions, _) = await GetCodeActionsAsync(workspace, testOptions);
if (actions.Length > 0)
{
var renameFileAction = actions.Any(static (action, self) => action.Title.StartsWith(self.RenameFileCodeActionTitle), this);
Assert.False(renameFileAction, "Rename File to match type code action was not expected, but shows up.");
}
}
}
}
private async Task<Tuple<Solution, Solution>> TestOperationAsync(
TestParameters parameters,
Workspaces.TestWorkspace workspace,
string expectedCode,
string operation)
{
var (actions, _) = await GetCodeActionsAsync(workspace, parameters);
var action = actions.Single(a => a.Title.Equals(operation, StringComparison.CurrentCulture));
var operations = await action.GetOperationsAsync(
workspace.CurrentSolution, new ProgressTracker(), CancellationToken.None);
return await TestOperationsAsync(workspace,
expectedText: expectedCode,
operations: operations,
conflictSpans: ImmutableArray<TextSpan>.Empty,
renameSpans: ImmutableArray<TextSpan>.Empty,
warningSpans: ImmutableArray<TextSpan>.Empty,
navigationSpans: ImmutableArray<TextSpan>.Empty,
expectedChangedDocumentId: null);
}
private protected async Task TestMoveTypeToNewFileAsync(
string originalCode,
string expectedSourceTextAfterRefactoring,
string expectedDocumentName,
string destinationDocumentText,
ImmutableArray<string> destinationDocumentContainers = default,
bool expectedCodeAction = true,
int index = 0,
OptionsCollection options = null)
{
var testOptions = new TestParameters(index: index, options: options);
if (expectedCodeAction)
{
using var workspace = CreateWorkspaceFromOptions(originalCode, testOptions);
// replace with default values on null.
destinationDocumentContainers = destinationDocumentContainers.NullToEmpty();
var sourceDocumentId = workspace.Documents[0].Id;
// Verify the newly added document and its text
var oldSolutionAndNewSolution = await TestAddDocumentAsync(
testOptions, workspace, destinationDocumentText,
expectedDocumentName, destinationDocumentContainers);
// Verify source document's text after moving type.
var oldSolution = oldSolutionAndNewSolution.Item1;
var newSolution = oldSolutionAndNewSolution.Item2;
var changedDocumentIds = SolutionUtilities.GetChangedDocuments(oldSolution, newSolution);
Assert.True(changedDocumentIds.Contains(sourceDocumentId), "source document was not changed.");
var modifiedSourceDocument = newSolution.GetDocument(sourceDocumentId);
var actualSourceTextAfterRefactoring = (await modifiedSourceDocument.GetTextAsync()).ToString();
Assert.Equal(expectedSourceTextAfterRefactoring, actualSourceTextAfterRefactoring);
}
else
{
await TestMissingAsync(originalCode);
}
}
}
}
|