Centralize all CodeAction.Create calls to centralize the RS1035 disab…

…lement
xunit · Feb 13, 2024 · f6c256a · f6c256a
1 parent 1e0dae6
commit f6c256a
Show file tree

Hide file tree

Showing 26 changed files with 159 additions and 134 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -231,4 +231,3 @@ dotnet_diagnostic.CA1720.severity  = none  # Identifier contains type name
 dotnet_diagnostic.CA1724.severity  = none  # Type names should not match namespaces
 dotnet_diagnostic.CA1859.severity  = none  # Use concrete types when possible for improved performance
 dotnet_diagnostic.IDE1006.severity = none  # Naming rule violation
-dotnet_diagnostic.RS1035.severity  = none  # The symbol 'CultureInfo.CurrentCulture' is banned for use by analyzers (unresolvable conflict with CA1305, per https://github.com/dotnet/roslyn-analyzers/issues/7086)
diff --git a/src/xunit.analyzers.fixes/Utility/UseDifferentMethodCodeAction.cs b/src/xunit.analyzers.fixes/Utility/UseDifferentMethodCodeAction.cs
diff --git a/src/xunit.analyzers.fixes/Utility/XunitCodeAction.cs b/src/xunit.analyzers.fixes/Utility/XunitCodeAction.cs
@@ -0,0 +1,92 @@
+using System;
+using System.Globalization;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+using Microsoft.CodeAnalysis.Editing;
+
+namespace Microsoft.CodeAnalysis.CodeActions;
+
+internal static class XunitCodeAction
+{
+	public static CodeAction Create(
+		Func<CancellationToken, Task<Document>> createChangedDocument,
+		string equivalenceKey,
+		string title) =>
+			CodeAction.Create(
+				title,
+				createChangedDocument,
+				equivalenceKey
+			);
+
+#pragma warning disable RS1035  // The prohibiton on CultureInfo.CurrentCulture does not apply to fixers
+
+	public static CodeAction Create(
+		Func<CancellationToken, Task<Document>> createChangedDocument,
+		string equivalenceKey,
+		string titleFormat,
+		object? arg0) =>
+			CodeAction.Create(
+				string.Format(CultureInfo.CurrentCulture, titleFormat, arg0),
+				createChangedDocument,
+				equivalenceKey
+			);
+
+	public static CodeAction Create(
+		Func<CancellationToken, Task<Document>> createChangedDocument,
+		string equivalenceKey,
+		string titleFormat,
+		object? arg0,
+		object? arg1) =>
+			CodeAction.Create(
+				string.Format(CultureInfo.CurrentCulture, titleFormat, arg0, arg1),
+				createChangedDocument,
+				equivalenceKey
+			);
+
+	public static CodeAction Create(
+		Func<CancellationToken, Task<Document>> createChangedDocument,
+		string equivalenceKey,
+		string titleFormat,
+		object? arg0,
+		object? arg1,
+		object? arg2) =>
+			CodeAction.Create(
+				string.Format(CultureInfo.CurrentCulture, titleFormat, arg0, arg1, arg2),
+				createChangedDocument,
+				equivalenceKey
+			);
+
+	public static CodeAction Create(
+		Func<CancellationToken, Task<Document>> createChangedDocument,
+		string equivalenceKey,
+		string titleFormat,
+		params object?[] args) =>
+			CodeAction.Create(
+				string.Format(CultureInfo.CurrentCulture, titleFormat, args),
+				createChangedDocument,
+				equivalenceKey
+			);
+
+#pragma warning restore RS1035
+
+	public static CodeAction UseDifferentAssertMethod(
+		string equivalenceKey,
+		Document document,
+		InvocationExpressionSyntax invocation,
+		string replacementMethod) =>
+			CodeAction.Create(
+				"Use Assert." + replacementMethod,
+				async ct =>
+				{
+					var editor = await DocumentEditor.CreateAsync(document, ct).ConfigureAwait(false);
+
+					if (invocation.Expression is MemberAccessExpressionSyntax memberAccess)
+						if (editor.Generator.IdentifierName(replacementMethod) is SimpleNameSyntax replacementNameSyntax)
+							editor.ReplaceNode(memberAccess, memberAccess.WithName(replacementNameSyntax));
+
+					return editor.GetChangedDocument();
+				},
+				equivalenceKey
+			);
+}
diff --git a/src/xunit.analyzers.fixes/X1000/DoNotUseConfigureAwaitFixer.cs b/src/xunit.analyzers.fixes/X1000/DoNotUseConfigureAwaitFixer.cs
@@ -1,5 +1,4 @@
 using System.Composition;
-using System.Globalization;
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis;
@@ -68,15 +67,15 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context)
 		var replaceConfigureAwaitNode = SyntaxFactory.ParseExpression(replaceConfigureAwaitText);
 
 		context.RegisterCodeFix(
-			CodeAction.Create(
-				string.Format(CultureInfo.CurrentCulture, "Replace ConfigureAwait({0}) with ConfigureAwait({1})", original, replacement),
+			XunitCodeAction.Create(
 				async ct =>
 				{
 					var editor = await DocumentEditor.CreateAsync(context.Document, ct).ConfigureAwait(false);
 					editor.ReplaceNode(syntaxNode, replaceConfigureAwaitNode);
 					return editor.GetChangedDocument();
 				},
-				Key_ReplaceArgumentValue
+				Key_ReplaceArgumentValue,
+				"Replace ConfigureAwait({0}) with ConfigureAwait({1})", original, replacement
 			),
 			context.Diagnostics
 		);

diff --git a/src/xunit.analyzers.fixes/X1000/RemoveMethodParameterFix.cs b/src/xunit.analyzers.fixes/X1000/RemoveMethodParameterFix.cs
@@ -1,5 +1,4 @@
 using System.Composition;
-using System.Globalization;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CodeActions;
@@ -33,10 +32,10 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 		var parameterName = parameter.Identifier.Text;
 
 		context.RegisterCodeFix(
-			CodeAction.Create(
-				string.Format(CultureInfo.CurrentCulture, "Remove parameter '{0}'", parameterName),
+			XunitCodeAction.Create(
 				ct => context.Document.RemoveNode(parameter, ct),
-				Key_RemoveParameter
+				Key_RemoveParameter,
+				"Remove parameter '{0}'", parameterName
 			),
 			context.Diagnostics
 		);

diff --git a/src/xunit.analyzers.fixes/X1000/TestClassShouldHaveTFixtureArgumentFixer.cs b/src/xunit.analyzers.fixes/X1000/TestClassShouldHaveTFixtureArgumentFixer.cs
@@ -1,5 +1,4 @@
 using System.Composition;
-using System.Globalization;
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis;
@@ -44,15 +43,15 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 			return;
 
 		context.RegisterCodeFix(
-			CodeAction.Create(
-				string.Format(CultureInfo.CurrentCulture, "Generate constructor '{0}({1})'", testClassName, tFixtureName),
+			XunitCodeAction.Create(
 				ct => context.Document.AddConstructor(
 					classDeclaration,
 					typeDisplayName: tFixtureDisplayName,
 					typeName: tFixtureName,
 					ct
 				),
-				Key_GenerateConstructor
+				Key_GenerateConstructor,
+				"Generate constructor '{0}({1})'", testClassName, tFixtureName
 			),
 			context.Diagnostics
 		);

diff --git a/src/xunit.analyzers.fixes/X1000/TestMethodMustNotHaveMultipleFactAttributesFixer.cs b/src/xunit.analyzers.fixes/X1000/TestMethodMustNotHaveMultipleFactAttributesFixer.cs
@@ -44,10 +44,10 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 			var simpleName = GetAttributeSimpleName(attributeType);
 
 			context.RegisterCodeFix(
-				CodeAction.Create(
-					string.Format(CultureInfo.CurrentCulture, "Keep '{0}' attribute", simpleName),
+				XunitCodeAction.Create(
 					ct => RemoveAttributes(context.Document, methodDeclaration, attributeTypes, attributeType, ct),
-					Key_KeepAttribute(simpleName)
+					Key_KeepAttribute(simpleName),
+					"Keep '{0}' attribute", simpleName
 				),
 				context.Diagnostics
 			);

diff --git a/src/xunit.analyzers.fixes/X1000/TheoryMethodCannotHaveDefaultParameterFixer.cs b/src/xunit.analyzers.fixes/X1000/TheoryMethodCannotHaveDefaultParameterFixer.cs
@@ -1,5 +1,4 @@
 using System.Composition;
-using System.Globalization;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CodeActions;
@@ -30,10 +29,10 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 		var parameterName = parameter.Identifier.Text;
 
 		context.RegisterCodeFix(
-			CodeAction.Create(
-				string.Format(CultureInfo.CurrentCulture, "Remove parameter '{0}' default", parameterName),
+			XunitCodeAction.Create(
 				ct => context.Document.RemoveNode(parameter.Default, ct),
-				Key_RemoveParameterDefault
+				Key_RemoveParameterDefault,
+				"Remove parameter '{0}' default", parameterName
 			),
 			context.Diagnostics
 		);

diff --git a/src/xunit.analyzers.fixes/X2000/AssertCollectionContainsShouldNotUseBoolCheckFixer.cs b/src/xunit.analyzers.fixes/X2000/AssertCollectionContainsShouldNotUseBoolCheckFixer.cs
@@ -1,5 +1,4 @@
 using System.Composition;
-using System.Globalization;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
@@ -42,10 +41,10 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 			return;
 
 		context.RegisterCodeFix(
-			CodeAction.Create(
-				string.Format(CultureInfo.CurrentCulture, "Use Assert.{0}", replacement),
+			XunitCodeAction.Create(
 				ct => UseContainsCheck(context.Document, invocation, replacement, ct),
-				Key_UseAlternateAssert
+				Key_UseAlternateAssert,
+				"Use Assert.{0}", replacement
 			),
 			context.Diagnostics
 		);

diff --git a/...ers.fixes/X2000/AssertEnumerableAnyCheckShouldNotBeUsedForCollectionContainsCheckFixer.cs b/...ers.fixes/X2000/AssertEnumerableAnyCheckShouldNotBeUsedForCollectionContainsCheckFixer.cs
@@ -1,5 +1,4 @@
 using System.Composition;
-using System.Globalization;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
@@ -42,10 +41,10 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 			return;
 
 		context.RegisterCodeFix(
-			CodeAction.Create(
-				string.Format(CultureInfo.CurrentCulture, "Use Assert.{0}", replacement),
+			XunitCodeAction.Create(
 				ct => UseContainsCheck(context.Document, invocation, replacement, ct),
-				Key_UseAlternateAssert
+				Key_UseAlternateAssert,
+				"Use Assert.{0}", replacement
 			),
 			context.Diagnostics
 		);

diff --git a/src/xunit.analyzers.fixes/X2000/AssertEqualPrecisionShouldBeInRangeFixer.cs b/src/xunit.analyzers.fixes/X2000/AssertEqualPrecisionShouldBeInRangeFixer.cs
@@ -1,5 +1,4 @@
 using System.Composition;
-using System.Globalization;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
@@ -43,10 +42,10 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 			return;
 
 		context.RegisterCodeFix(
-			CodeAction.Create(
-				string.Format(CultureInfo.CurrentCulture, "Use precision {0}", replacementInt),
+			XunitCodeAction.Create(
 				ct => UseRecommendedPrecision(context.Document, precisionArgument, replacementInt, ct),
-				Key_UsePrecision
+				Key_UsePrecision,
+				"Use precision {0}", replacementInt
 			),
 			context.Diagnostics
 		);

diff --git a/src/xunit.analyzers.fixes/X2000/AssertEqualShouldNotBeUsedForBoolLiteralCheckFixer.cs b/src/xunit.analyzers.fixes/X2000/AssertEqualShouldNotBeUsedForBoolLiteralCheckFixer.cs
@@ -1,5 +1,4 @@
 using System.Composition;
-using System.Globalization;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
@@ -45,10 +44,10 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 
 		if (invocation.Expression is MemberAccessExpressionSyntax)
 			context.RegisterCodeFix(
-				CodeAction.Create(
-					string.Format(CultureInfo.CurrentCulture, "Use Assert.{0}", replacement),
+				XunitCodeAction.Create(
 					ct => UseBoolCheckAsync(context.Document, invocation, replacement, ct),
-					Key_UseAlternateAssert
+					Key_UseAlternateAssert,
+					"Use Assert.{0}", replacement
 				),
 				context.Diagnostics
 			);

diff --git a/src/xunit.analyzers.fixes/X2000/AssertEqualShouldNotBeUsedForCollectionSizeCheckFixer.cs b/src/xunit.analyzers.fixes/X2000/AssertEqualShouldNotBeUsedForCollectionSizeCheckFixer.cs
@@ -1,5 +1,4 @@
 using System.Composition;
-using System.Globalization;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
@@ -44,10 +43,10 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 			return;
 
 		context.RegisterCodeFix(
-			CodeAction.Create(
-				string.Format(CultureInfo.CurrentCulture, "Use Assert.{0}", replacement),
+			XunitCodeAction.Create(
 				ct => UseCollectionSizeAssertionAsync(context.Document, invocation, replacement, ct),
-				Key_UseAlternateAssert
+				Key_UseAlternateAssert,
+				"Use Assert.{0}", replacement
 			),
 			context.Diagnostics
 		);

diff --git a/src/xunit.analyzers.fixes/X2000/AssertEqualShouldNotBeUsedForNullCheckFixer.cs b/src/xunit.analyzers.fixes/X2000/AssertEqualShouldNotBeUsedForNullCheckFixer.cs
@@ -1,5 +1,4 @@
 using System.Composition;
-using System.Globalization;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
@@ -43,10 +42,10 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 
 		if (invocation.Expression is MemberAccessExpressionSyntax)
 			context.RegisterCodeFix(
-				CodeAction.Create(
-					string.Format(CultureInfo.CurrentCulture, "Use Assert.{0}", replacement),
+				XunitCodeAction.Create(
 					ct => UseNullCheckAsync(context.Document, invocation, replacement, ct),
-					Key_UseAlternateAssert
+					Key_UseAlternateAssert,
+					"Use Assert.{0}", replacement
 				),
 				context.Diagnostics
 			);

diff --git a/src/xunit.analyzers.fixes/X2000/AssertEqualsShouldNotBeUsedFixer.cs b/src/xunit.analyzers.fixes/X2000/AssertEqualsShouldNotBeUsedFixer.cs
@@ -1,8 +1,8 @@
 using System.Composition;
-using System.Globalization;
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CodeActions;
 using Microsoft.CodeAnalysis.CodeFixes;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 
@@ -37,8 +37,7 @@ public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
 
 		if (invocation.Expression is MemberAccessExpressionSyntax)
 			context.RegisterCodeFix(
-				new UseDifferentMethodCodeAction(
-					string.Format(CultureInfo.CurrentCulture, "Use Assert.{0}", replacement),
+				XunitCodeAction.UseDifferentAssertMethod(
 					Key_UseAlternateAssert,
 					context.Document,
 					invocation,