xunit/xunit#3174: xUnit1003 doesn't detect IDataAttribute

Author: bradwilson

src/xunit.analyzers.tests/Analyzers/X1000/TheoryMethodMustHaveTestDataTests.cs

@@ -1,4 +1,5 @@
 using System.Threading.Tasks;
+using Microsoft.CodeAnalysis.CSharp;
 using Xunit;
 using Verify = CSharpVerifier<Xunit.Analyzers.TheoryMethodMustHaveTestData>;
 
@@ -43,6 +44,48 @@ public void TestMethod3() { }
 		await Verify.VerifyAnalyzer(source);
 	}
 
+	[Fact]
+	public async Task TheoryMethodWithCustomDataAttribute_v3_DoesNotTrigger()
+	{
+		var source = /* lang=c#-test */ """
+			using System;
+			using System.Collections.Generic;
+			using System.Reflection;
+			using System.Threading.Tasks;
+			using Xunit;
+			using Xunit.Sdk;
+			using Xunit.v3;
+
+			public class TestClass {
+				[Theory]
+				[MyData]
+				public void TestMethod() { }
+			}
+
+			public class MyData : Attribute, IDataAttribute {
+				public bool? Explicit => throw new NotImplementedException();
+				public string? Label => throw new NotImplementedException();
+				public string? Skip => throw new NotImplementedException();
+				public Type? SkipType => throw new NotImplementedException();
+				public string? SkipUnless => throw new NotImplementedException();
+				public string? SkipWhen => throw new NotImplementedException();
+				public string? TestDisplayName => throw new NotImplementedException();
+				public int? Timeout => throw new NotImplementedException();
+				public string[]? Traits => throw new NotImplementedException();
+
+				public ValueTask<IReadOnlyCollection<ITheoryDataRow>> GetData(
+					MethodInfo testMethod,
+					DisposalTracker disposalTracker) =>
+						throw new NotImplementedException();
+
+				public bool SupportsDiscoveryEnumeration() =>
+					throw new NotImplementedException();
+			}
+			""";
+
+		await Verify.VerifyAnalyzerV3(LanguageVersion.CSharp8, source);
+	}
+
 	[Fact]
 	public async Task TheoryMethodMissingData_Triggers()
 	{

src/xunit.analyzers/Utility/Constants.cs

@@ -143,6 +143,7 @@ public static class Xunit
 			public const string IAttributeInfo_V2 = "Xunit.Abstractions.IAttributeInfo";
 			public const string IClassFixtureOfT = "Xunit.IClassFixture`1";
 			public const string ICollectionFixtureOfT = "Xunit.ICollectionFixture`1";
+			public const string IDataAttribute_V3 = "Xunit.v3.IDataAttribute";
 			public const string IMessageSink_V2 = "Xunit.Abstractions.IMessageSink";
 			public const string IMessageSink_V3 = "Xunit.Sdk.IMessageSink";
 			public const string IMessageSinkMessage_V2 = "Xunit.Abstractions.IMessageSinkMessage";

src/xunit.analyzers/Utility/TypeSymbolFactory.cs

@@ -145,6 +145,9 @@ public static INamedTypeSymbol ICollectionOfT(Compilation compilation) =>
 	public static INamedTypeSymbol? ICriticalNotifyCompletion(Compilation compilation) =>
 		Guard.ArgumentNotNull(compilation).GetTypeByMetadataName("System.Runtime.CompilerServices.ICriticalNotifyCompletion");
 
+	public static INamedTypeSymbol? IDataAttribute_V3(Compilation compilation) =>
+		Guard.ArgumentNotNull(compilation).GetTypeByMetadataName(Constants.Types.Xunit.IDataAttribute_V3);
+
 	public static INamedTypeSymbol IDisposable(Compilation compilation) =>
 		Guard.ArgumentNotNull(compilation).GetSpecialType(SpecialType.System_IDisposable);
 

src/xunit.analyzers/Utility/V3CoreContext.cs

@@ -16,6 +16,7 @@ public class V3CoreContext : ICoreContext
 	readonly Lazy<INamedTypeSymbol?> lazyFactAttributeType;
 	readonly Lazy<INamedTypeSymbol?> lazyIClassFixtureType;
 	readonly Lazy<INamedTypeSymbol?> lazyICollectionFixtureType;
+	readonly Lazy<INamedTypeSymbol?> lazyIDataAttributeType;
 	readonly Lazy<INamedTypeSymbol?> lazyInlineDataAttributeType;
 	readonly Lazy<INamedTypeSymbol?> lazyITestContextAccessorType;
 	readonly Lazy<INamedTypeSymbol?> lazyITestOutputHelperType;
@@ -39,6 +40,7 @@ public class V3CoreContext : ICoreContext
 		lazyFactAttributeType = new(() => TypeSymbolFactory.FactAttribute(compilation));
 		lazyIClassFixtureType = new(() => TypeSymbolFactory.IClassFixureOfT(compilation));
 		lazyICollectionFixtureType = new(() => TypeSymbolFactory.ICollectionFixtureOfT(compilation));
+		lazyIDataAttributeType = new(() => TypeSymbolFactory.IDataAttribute_V3(compilation));
 		lazyInlineDataAttributeType = new(() => TypeSymbolFactory.InlineDataAttribute(compilation));
 		lazyITestContextAccessorType = new(() => TypeSymbolFactory.ITestContextAccessor_V3(compilation));
 		lazyITestOutputHelperType = new(() => TypeSymbolFactory.ITestOutputHelper_V3(compilation));
@@ -93,6 +95,12 @@ public class V3CoreContext : ICoreContext
 	public INamedTypeSymbol? ICollectionFixtureType =>
 		lazyICollectionFixtureType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>IDataAttribute</c>, if available.
+	/// </summary>
+	public INamedTypeSymbol? IDataAttributeType =>
+		lazyIDataAttributeType.Value;
+
 	/// <inheritdoc/>
 	public INamedTypeSymbol? InlineDataAttributeType =>
 		lazyInlineDataAttributeType.Value;

src/xunit.analyzers/X1000/TheoryMethodMustHaveTestData.cs

@@ -27,16 +27,20 @@ public override void AnalyzeCompilation(
 				return;
 
 			var attributes = symbol.GetAttributes();
-			if (attributes.ContainsAttributeType(xunitContext.Core.TheoryAttributeType) &&
-				(attributes.Length == 1 || !attributes.ContainsAttributeType(xunitContext.Core.DataAttributeType)))
-			{
+			if (!attributes.ContainsAttributeType(xunitContext.Core.TheoryAttributeType))
+				return;
+
+			var hasData = attributes.ContainsAttributeType(xunitContext.Core.DataAttributeType);
+			if (!hasData && xunitContext.V3Core?.IDataAttributeType is not null)
+				hasData = attributes.ContainsAttributeType(xunitContext.V3Core.IDataAttributeType);
+
+			if (!hasData)
 				context.ReportDiagnostic(
 					Diagnostic.Create(
 						Descriptors.X1003_TheoryMethodMustHaveTestData,
 						symbol.Locations.First()
 					)
 				);
-			}
 		}, SymbolKind.Method);
 	}
 }