mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
62d448354c
### 属性参数校验（Attribute Validation）
- AutoUiPageGenerator
- 新增 GF_AutoBehavior_004 诊断：
- 检测 AutoUiPageAttribute 参数无效情况
- 添加测试用例验证错误参数的诊断报告
- AutoRegisterExportedCollectionsGenerator
- 新增 GF_AutoExport_008 诊断：
- 检测 RegisterExportedCollectionAttribute 参数无效情况
- 改进 TryGetRegistrationAttributeArguments 方法：
- 精确报告错误位置
- 更新文档以包含新增诊断规则
### 泛型约束支持（Generic Constraints）
- AutoUiPageGenerator / AutoRegisterModuleGenerator
- 支持以下泛型约束的正确生成：
- class?
- notnull
- unmanaged
- 添加对应测试用例确保生成正确性
### 诊断体系优化（Diagnostics Improvements）
- AutoRegisterModuleGenerator
- 重构 AutoRegisterModuleDiagnostics：
- 优化诊断定义顺序，提高可读性与维护性
505 lines
24 KiB
C#
505 lines
24 KiB
C#
using GFramework.Godot.SourceGenerators.Registration;
|
|
using GFramework.Godot.SourceGenerators.Tests.Core;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Tests.Registration;
|
|
|
|
[TestFixture]
|
|
public class AutoRegisterExportedCollectionsGeneratorTests
|
|
{
|
|
[Test]
|
|
public async Task Generates_Batch_Registration_Method_For_Annotated_Collections()
|
|
{
|
|
const string source = """
|
|
#nullable enable
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper<TReference, TNotNull, TValue, TUnmanaged>
|
|
where TReference : class?
|
|
where TNotNull : notnull
|
|
where TValue : struct
|
|
where TUnmanaged : unmanaged
|
|
{
|
|
private readonly IntRegistry? _registry = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public List<int>? Values { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
const string expected = """
|
|
// <auto-generated />
|
|
#nullable enable
|
|
|
|
namespace TestApp;
|
|
|
|
partial class Bootstrapper<TReference, TNotNull, TValue, TUnmanaged>
|
|
where TReference : class?
|
|
where TNotNull : notnull
|
|
where TValue : struct
|
|
where TUnmanaged : unmanaged
|
|
{
|
|
private void __RegisterExportedCollections_Generated()
|
|
{
|
|
if (this.Values is not null && this._registry is not null)
|
|
{
|
|
foreach (var __generatedItem in this.Values)
|
|
{
|
|
this._registry.Register(__generatedItem);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
""";
|
|
|
|
await GeneratorTest<AutoRegisterExportedCollectionsGenerator>.RunAsync(
|
|
source,
|
|
("TestApp_Bootstrapper.AutoRegisterExportedCollections.g.cs", expected));
|
|
}
|
|
|
|
[Test]
|
|
public async Task Reports_Diagnostic_When_Collection_Element_Type_Cannot_Be_Inferred()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using System.Collections;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly IntRegistry _registry = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public IEnumerable {|#0:Values|} { get; } = new ArrayList();
|
|
}
|
|
}
|
|
""";
|
|
|
|
var test = new CSharpSourceGeneratorTest<AutoRegisterExportedCollectionsGenerator, DefaultVerifier>
|
|
{
|
|
TestState =
|
|
{
|
|
Sources = { source }
|
|
},
|
|
DisabledDiagnostics = { "GF_Common_Trace_001" }
|
|
};
|
|
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_005", DiagnosticSeverity.Error)
|
|
.WithLocation(0)
|
|
.WithArguments("Values"));
|
|
|
|
await test.RunAsync();
|
|
}
|
|
|
|
[Test]
|
|
public async Task Generates_Batch_Registration_Method_When_Register_Method_Uses_Array_Parameter()
|
|
{
|
|
const string source = """
|
|
#nullable enable
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class ArrayRegistry
|
|
{
|
|
public void Register(int[] value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly ArrayRegistry _registry = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(ArrayRegistry.Register))]
|
|
public List<int[]> Values { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
const string expected = """
|
|
// <auto-generated />
|
|
#nullable enable
|
|
|
|
namespace TestApp;
|
|
|
|
partial class Bootstrapper
|
|
{
|
|
private void __RegisterExportedCollections_Generated()
|
|
{
|
|
if (this.Values is not null && this._registry is not null)
|
|
{
|
|
foreach (var __generatedItem in this.Values)
|
|
{
|
|
this._registry.Register(__generatedItem);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
""";
|
|
|
|
await GeneratorTest<AutoRegisterExportedCollectionsGenerator>.RunAsync(
|
|
source,
|
|
("TestApp_Bootstrapper.AutoRegisterExportedCollections.g.cs", expected));
|
|
}
|
|
|
|
[Test]
|
|
public async Task Reports_Diagnostic_When_Collection_Member_Is_Not_Instance_Readable()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly IntRegistry _registry = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public static List<int> {|#0:StaticValues|} = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public static List<int> {|#1:StaticPropertyValues|} { get; } = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public List<int> {|#2:WriteOnlyValues|} { set { } }
|
|
}
|
|
}
|
|
""";
|
|
|
|
var test = new CSharpSourceGeneratorTest<AutoRegisterExportedCollectionsGenerator, DefaultVerifier>
|
|
{
|
|
TestState =
|
|
{
|
|
Sources = { source }
|
|
},
|
|
DisabledDiagnostics = { "GF_Common_Trace_001" },
|
|
TestBehaviors = TestBehaviors.SkipGeneratedSourcesCheck
|
|
};
|
|
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_006", DiagnosticSeverity.Error)
|
|
.WithLocation(0)
|
|
.WithArguments("StaticValues"));
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_006", DiagnosticSeverity.Error)
|
|
.WithLocation(1)
|
|
.WithArguments("StaticPropertyValues"));
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_006", DiagnosticSeverity.Error)
|
|
.WithLocation(2)
|
|
.WithArguments("WriteOnlyValues"));
|
|
|
|
await test.RunAsync();
|
|
}
|
|
|
|
[Test]
|
|
public async Task Reports_Diagnostic_When_Registry_Member_Is_Not_Instance_Readable()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private static readonly IntRegistry {|#0:_registry|} = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public List<int> Values { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
var test = new CSharpSourceGeneratorTest<AutoRegisterExportedCollectionsGenerator, DefaultVerifier>
|
|
{
|
|
TestState =
|
|
{
|
|
Sources = { source }
|
|
},
|
|
DisabledDiagnostics = { "GF_Common_Trace_001" },
|
|
TestBehaviors = TestBehaviors.SkipGeneratedSourcesCheck
|
|
};
|
|
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_007", DiagnosticSeverity.Error)
|
|
.WithLocation(0)
|
|
.WithArguments("_registry", "Values"));
|
|
|
|
await test.RunAsync();
|
|
}
|
|
|
|
[Test]
|
|
public async Task Reports_Diagnostic_When_Register_Method_Is_Not_Accessible_From_Owner_Type()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
private void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly IntRegistry _registry = new();
|
|
|
|
[RegisterExportedCollection(nameof(_registry), "Register")]
|
|
public List<int> {|#0:Values|} { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
var test = new CSharpSourceGeneratorTest<AutoRegisterExportedCollectionsGenerator, DefaultVerifier>
|
|
{
|
|
TestState =
|
|
{
|
|
Sources = { source }
|
|
},
|
|
DisabledDiagnostics = { "GF_Common_Trace_001" },
|
|
TestBehaviors = TestBehaviors.SkipGeneratedSourcesCheck
|
|
};
|
|
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_003", DiagnosticSeverity.Error)
|
|
.WithLocation(0)
|
|
.WithArguments("Register", "_registry", "Values"));
|
|
|
|
await test.RunAsync();
|
|
}
|
|
|
|
[Test]
|
|
public async Task Reports_Diagnostic_When_RegisterExportedCollection_Attribute_Arguments_Are_Invalid()
|
|
{
|
|
const string source = """
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly IntRegistry _registry = new();
|
|
|
|
[{|#0:RegisterExportedCollection(nameof(_registry))|}]
|
|
public List<int> Values { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
var test = new CSharpSourceGeneratorTest<AutoRegisterExportedCollectionsGenerator, DefaultVerifier>
|
|
{
|
|
TestState =
|
|
{
|
|
Sources = { source }
|
|
},
|
|
DisabledDiagnostics = { "GF_Common_Trace_001" },
|
|
TestBehaviors = TestBehaviors.SkipGeneratedSourcesCheck
|
|
};
|
|
|
|
test.ExpectedDiagnostics.Add(new DiagnosticResult("GF_AutoExport_008", DiagnosticSeverity.Error)
|
|
.WithLocation(0)
|
|
.WithArguments("Values"));
|
|
|
|
await test.RunAsync();
|
|
}
|
|
|
|
[Test]
|
|
public async Task Generates_Only_One_Source_When_Multiple_Partial_Declarations_Are_Annotated()
|
|
{
|
|
const string source = """
|
|
#nullable enable
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using GFramework.Godot.SourceGenerators.Abstractions;
|
|
|
|
namespace GFramework.Godot.SourceGenerators.Abstractions
|
|
{
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = true)]
|
|
public sealed class AutoRegisterExportedCollectionsAttribute : Attribute { }
|
|
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
|
|
public sealed class RegisterExportedCollectionAttribute : Attribute
|
|
{
|
|
public RegisterExportedCollectionAttribute(string registryMemberName, string registerMethodName) { }
|
|
}
|
|
}
|
|
|
|
namespace TestApp
|
|
{
|
|
public sealed class IntRegistry
|
|
{
|
|
public void Register(int value) { }
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
private readonly IntRegistry? _registry = new();
|
|
}
|
|
|
|
[AutoRegisterExportedCollections]
|
|
public partial class Bootstrapper
|
|
{
|
|
[RegisterExportedCollection(nameof(_registry), nameof(IntRegistry.Register))]
|
|
public List<int>? Values { get; } = new();
|
|
}
|
|
}
|
|
""";
|
|
|
|
const string expected = """
|
|
// <auto-generated />
|
|
#nullable enable
|
|
|
|
namespace TestApp;
|
|
|
|
partial class Bootstrapper
|
|
{
|
|
private void __RegisterExportedCollections_Generated()
|
|
{
|
|
if (this.Values is not null && this._registry is not null)
|
|
{
|
|
foreach (var __generatedItem in this.Values)
|
|
{
|
|
this._registry.Register(__generatedItem);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
""";
|
|
|
|
await GeneratorTest<AutoRegisterExportedCollectionsGenerator>.RunAsync(
|
|
source,
|
|
("TestApp_Bootstrapper.AutoRegisterExportedCollections.g.cs", expected));
|
|
}
|
|
}
|