Skip to content

Commit

Permalink
Testing fixes (#110)
Browse files Browse the repository at this point in the history 
* nit: fix null ref

* nit: Stop things complaining about .NET Core 2.1

* Ensure that all the diagnostic errors are reported in the tests
  • Loading branch information
@andrewlock
andrewlock authored Oct 20, 2024
1 parent 0525216 commit dd27676
Show file tree
Hide file tree
Showing 6 changed files with 91 additions and 59 deletions.
4 changes: 2 additions & 2 deletions src/NetEscapades.EnumGenerators/EnumGenerator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,9 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
static (spc, toIntercept) => ExecuteInterceptors(toIntercept, spc));
#else
context.RegisterSourceOutput(interceptableEnumsAndLocations,
static (spc, enumAndlocation) =>
static (spc, enumAndLocation) =>
{
spc.ReportDiagnostic(Diagnostic.Create(DiagnosticHelper.SdkVersionTooLow, location: enumAndlocation.location.ToLocation()));
spc.ReportDiagnostic(Diagnostic.Create(DiagnosticHelper.SdkVersionTooLow, location: enumAndLocation.location?.ToLocation()));
});
#endif
context.RegisterImplementationSourceOutput(settings,
Expand Down
1 change: 1 addition & 0 deletions tests/Directory.Build.props
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<NuGetAudit>false</NuGetAudit>
<ArtifactsPath>$(MSBuildThisFileDirectory)../artifacts</ArtifactsPath>
<SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings>
<NoWarn>NU1901;NU1902;NU1903;NU1904</NoWarn>
</PropertyGroup>
<ItemGroup>
<!-- Ignore 2.1.0 advisories -->
Expand Down
18 changes: 8 additions & 10 deletions tests/NetEscapades.EnumGenerators.Tests/EnumGeneratorTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ public enum MyEnum
[Description("4th")]
Fourth = 3
}
}"
}
""";

var (diagnostics, output) = TestHelpers.GetGeneratedOutput<EnumGenerator>(new(input));
Expand Down Expand Up @@ -222,7 +222,7 @@ public enum MyEnum
[Description("Number 4")]
Fourth = 3
}
}"
}
""";

var (diagnostics, output) = TestHelpers.GetGeneratedOutput<EnumGenerator>(new(input));
Expand Down Expand Up @@ -297,7 +297,6 @@ public enum MyEnum
public Task CanHandleNamespaceAndClassNameAreTheSame()
{
const string input = @"using NetEscapades.EnumGenerators;
using System.ComponentModel.DataAnnotations;
namespace Foo
{
Expand All @@ -321,18 +320,18 @@ public Task HandlesStringsWithQuotesAndSlashesInDescription()
const string input =
""""
using NetEscapades.EnumGenerators;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel;
namespace Test;
[EnumExtensions]
public enum StringTesting
{
[System.ComponentModel.Description("Quotes \"")] Quotes,
[System.ComponentModel.Description(@"Literal Quotes """)] LiteralQuotes,
[System.ComponentModel.Description("Backslash \\")] Backslash,
[System.ComponentModel.Description(@"LiteralBackslash \")] BackslashLiteral,
[System.ComponentModel.Description("New\nLine")] NewLine,
[Description("Quotes \"")] Quotes,
[Description(@"Literal Quotes """)] LiteralQuotes,
[Description("Backslash \\")] Backslash,
[Description(@"LiteralBackslash \")] BackslashLiteral,
[Description("New\nLine")] NewLine,
}
"""";

Expand Down Expand Up @@ -427,5 +426,4 @@ public Task CanGenerateExternalEnumExtensionsWithCustomNamespaceAndName()
Assert.Empty(diagnostics);
return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
}

}
71 changes: 39 additions & 32 deletions tests/NetEscapades.EnumGenerators.Tests/InterceptorTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,15 @@ namespace NetEscapades.EnumGenerators.Tests.Roslyn4_04;
[UsesVerify]
public class InterceptorTests
{
private readonly Dictionary<string, string> _interceptionEnabled =
private readonly Dictionary<string, string> _analyzerOpts =
new() { { "build_property.EnableEnumGeneratorInterceptor", "true" } };

private readonly Dictionary<string, string> _features =
new()
{
{ "InterceptorsPreviewNamespaces", "NetEscapades.EnumGenerators" },
{ "InterceptorsNamespaces", "NetEscapades.EnumGenerators" },
};
#if INTERCEPTORS
[Fact]
public Task CanInterceptToString()
Expand All @@ -36,7 +42,7 @@ internal enum MyEnum
Second = 1,
}
public class InnerClass
internal class InnerClass
{
public MyEnum _field = default;
public MyEnum Property {get;set;} = default;
Expand All @@ -52,7 +58,7 @@ public void MyTest()
}
""";
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_interceptionEnabled, input));
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_analyzerOpts, _features, input));

Assert.Empty(diagnostics);
return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
Expand All @@ -77,7 +83,7 @@ internal enum MyEnum
Third = 4,
}
public class InnerClass
internal class InnerClass
{
public MyEnum _field = default;
public MyEnum Property {get;set;} = default;
Expand All @@ -93,7 +99,7 @@ public void MyTest()
}
""";
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_interceptionEnabled, input));
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_analyzerOpts, _features, input));

Assert.Empty(diagnostics);
return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
Expand Down Expand Up @@ -136,23 +142,23 @@ public class InnerClass
public void MyTest()
{
var result = AnotherEnum.First.ToString();
AssertValue(MyEnum.First);
AssertValue(AnotherEnum.Second);
AssertValue(MyEnum.Third);
AssertValue1(MyEnum.First);
AssertValue2(AnotherEnum.Second);
AssertValue1(MyEnum.Third);
var result2 = YetAnotherEnum.First.ToString();
AssertValue(YetAnotherEnum.Second);
AssertValue3(YetAnotherEnum.Second);
void AssertValue(MyEnum value)
void AssertValue1(MyEnum value)
{
var toString = value.ToString();
}
void AssertValue(AnotherEnum value)
void AssertValue2(AnotherEnum value)
{
var toString = value.ToString();
}
void AssertValue(YetAnotherEnum value)
void AssertValue3(YetAnotherEnum value)
{
var toString = value.ToString();
}
Expand All @@ -161,7 +167,7 @@ void AssertValue(YetAnotherEnum value)
}
""";
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_interceptionEnabled, input));
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_analyzerOpts, _features, input));

Assert.Empty(diagnostics);
return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
Expand All @@ -173,6 +179,7 @@ public Task DoesNotInterceptEnumMarkedAsNotInterceptable()
const string input =
"""
using NetEscapades.EnumGenerators;
using System;
namespace MyTestNameSpace
{
Expand Down Expand Up @@ -200,30 +207,30 @@ internal enum YetAnotherEnum
Third = 2,
}
public class InnerClass
internal class InnerClass
{
public void MyTest()
{
var result = AnotherEnum.First.ToString();
AssertValue(MyEnum.First);
AssertValue(AnotherEnum.Second);
AssertValue(MyEnum.Third);
AssertValue1(MyEnum.First);
AssertValue2(AnotherEnum.Second);
AssertValue1(MyEnum.Third);
var result2 = YetAnotherEnum.First.ToString();
AssertValue(YetAnotherEnum.Second);
AssertValue3(YetAnotherEnum.Second);
var hasValue = AnotherEnum.Second.HasFlag(AnotherEnum.First);
void AssertValue(MyEnum value)
void AssertValue1(MyEnum value)
{
var toString = value.ToString();
}
void AssertValue(AnotherEnum value)
void AssertValue2(AnotherEnum value)
{
var toString = value.ToString();
}
void AssertValue(YetAnotherEnum value)
void AssertValue3(YetAnotherEnum value)
{
var toString = value.ToString();
}
Expand All @@ -232,7 +239,7 @@ void AssertValue(YetAnotherEnum value)
}
""";
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_interceptionEnabled, input));
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_analyzerOpts, _features, input));

Assert.Empty(diagnostics);
return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
Expand Down Expand Up @@ -272,7 +279,7 @@ void AssertValue(StringComparison value)
}
""";
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_interceptionEnabled, input));
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_analyzerOpts, _features, input));

Assert.Empty(diagnostics);
return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
Expand Down Expand Up @@ -314,7 +321,7 @@ void AssertValue(StringComparison value)
}
""";
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_interceptionEnabled, input));
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_analyzerOpts, _features, input));

Assert.Empty(diagnostics);
return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
Expand Down Expand Up @@ -357,7 +364,7 @@ void AssertValue(StringComparison value)
}
""";
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_interceptionEnabled, input));
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_analyzerOpts, _features, input));

Assert.Empty(diagnostics);
return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
Expand All @@ -379,7 +386,7 @@ internal enum MyEnum
Second = 1,
}
public class InnerClass
internal class InnerClass
{
public MyEnum _field = default;
public MyEnum Property {get;set;} = default;
Expand All @@ -394,7 +401,7 @@ public void MyTest()
}
}
""";
var opts = new TestHelpers.Options(LanguageVersion.CSharp11, _interceptionEnabled, input);
var opts = new TestHelpers.Options(LanguageVersion.CSharp11, _analyzerOpts, _features, input);
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(opts);

Expand All @@ -418,7 +425,7 @@ internal enum MyEnum
Second = 1,
}
public class InnerClass
internal class InnerClass
{
public MyEnum _field = default;
public MyEnum Property {get;set;} = default;
Expand Down Expand Up @@ -456,7 +463,7 @@ internal enum MyEnum
Second = 1,
}
public class InnerClass
internal class InnerClass
{
public MyEnum _field = default;
public MyEnum Property {get;set;} = default;
Expand All @@ -471,7 +478,7 @@ public void MyTest()
}
}
""";
var opts = new TestHelpers.Options(LanguageVersion.CSharp10, _interceptionEnabled, input);
var opts = new TestHelpers.Options(LanguageVersion.CSharp10, _analyzerOpts, _features, input);
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(opts);

Expand Down Expand Up @@ -512,7 +519,7 @@ public void MyTest()
}
""";
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_interceptionEnabled, input));
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_analyzerOpts, _features, input));

diagnostics.Should().ContainSingle(x => x.Id == DiagnosticHelper.SdkVersionTooLow.Id);
return Verifier.Verify(output).ScrubExpectedChanges().UseDirectory("Snapshots");
Expand Down Expand Up @@ -554,7 +561,7 @@ void AssertValue(StringComparison value)
}
""";
var (diagnostics, output) =
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_interceptionEnabled, input));
TestHelpers.GetGeneratedTrees<EnumGenerator, TrackingNames>(new(_analyzerOpts, _features, input));

diagnostics.Should()
.OnlyContain(x => x.Id == DiagnosticHelper.SdkVersionTooLow.Id)
Expand Down
18 changes: 15 additions & 3 deletions ...ests/Snapshots/InterceptorTests.DoesNotInterceptEnumMarkedAsNotInterceptable.verified.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,18 @@ namespace MyTestNameSpace
_ => value.ToString(),
};

/// <summary>
/// Determines whether one or more bit fields are set in the current instance.
/// Equivalent to calling <see cref="global::System.Enum.HasFlag" /> on <paramref name="value"/>.
/// </summary>
/// <param name="value">The value of the instance to investigate</param>
/// <param name="flag">The flag to check for</param>
/// <returns><c>true</c> if the fields set in the flag are also set in the current instance; otherwise <c>false</c>.</returns>
/// <remarks>If the underlying value of <paramref name="flag"/> is zero, the method returns true.
/// This is consistent with the behaviour of <see cref="global::System.Enum.HasFlag" /></remarks>
public static bool HasFlagFast(this global::MyTestNameSpace.AnotherEnum value, global::MyTestNameSpace.AnotherEnum flag)
=> flag == 0 ? true : (value & flag) == flag;

/// <summary>
/// Returns a boolean telling whether the given enum value exists in the enumeration.
/// </summary>
Expand Down Expand Up @@ -1170,12 +1182,12 @@ namespace NetEscapades.EnumGenerators
{
static file class EnumInterceptors
{
[global::System.Runtime.CompilerServices.InterceptsLocation(123, "REDACTED")] // Program.cs(33,44)
[global::System.Runtime.CompilerServices.InterceptsLocation(123, "REDACTED")] // Program.cs(49,38)
[global::System.Runtime.CompilerServices.InterceptsLocation(123, "REDACTED")] // Program.cs(34,44)
[global::System.Runtime.CompilerServices.InterceptsLocation(123, "REDACTED")] // Program.cs(50,38)
public static string AnotherEnumExtensionsToString(this global::System.Enum value)
=> global::MyTestNameSpace.AnotherEnumExtensions.ToStringFast((global::MyTestNameSpace.AnotherEnum)value);

[global::System.Runtime.CompilerServices.InterceptsLocation(123, "REDACTED")] // Program.cs(40,47)
[global::System.Runtime.CompilerServices.InterceptsLocation(123, "REDACTED")] // Program.cs(41,47)
public static bool AnotherEnumExtensionsHasFlag(this global::System.Enum value, global::System.Enum flag)
=> global::MyTestNameSpace.AnotherEnumExtensions.HasFlagFast((global::MyTestNameSpace.AnotherEnum)value, (global::MyTestNameSpace.AnotherEnum)flag);

Expand Down
Loading

0 comments on commit dd27676

Please sign in to comment.