Skip to content

Update KubernetesEntitySyntaxReceiver to support reading entity metadata from const variables #979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update KubernetesEntitySyntaxReceiver to support reading entity metadata from const variables #979

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e223df8
Update KubernetesEntitySyntaxReceiver to support reading entity metad…
smbecker Nov 3, 2025
e54cccc
Refactor to use GeneratorSyntaxContext.SemanticModel.GetConstantValue…
smbecker Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions src/KubeOps.Generator/SyntaxReceiver/KubernetesEntitySyntaxReceiver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ internal sealed class KubernetesEntitySyntaxReceiver : ISyntaxContextReceiver
{
private const string KindName = "Kind";
private const string GroupName = "Group";
private const string PluralName = "Plural";
private const string PluralName = "PluralName";
private const string VersionName = "ApiVersion";
private const string DefaultVersion = "v1";

Expand All @@ -28,15 +28,24 @@ public void OnVisitSyntaxNode(GeneratorSyntaxContext context)

Entities.Add(new(
cls,
GetArgumentValue(attr, KindName) ?? cls.Identifier.ToString(),
GetArgumentValue(attr, VersionName) ?? DefaultVersion,
GetArgumentValue(attr, GroupName),
GetArgumentValue(attr, PluralName)));
GetArgumentValue(context, attr, KindName) ?? cls.Identifier.ToString(),
GetArgumentValue(context, attr, VersionName) ?? DefaultVersion,
GetArgumentValue(context, attr, GroupName),
GetArgumentValue(context, attr, PluralName)));
}

private static string? GetArgumentValue(AttributeSyntax attr, string argName) =>
attr.ArgumentList?.Arguments.FirstOrDefault(a => a.NameEquals?.Name.ToString() == argName) is
{ Expression: LiteralExpressionSyntax { Token.ValueText: { } value } }
? value
: null;
private static string? GetArgumentValue(GeneratorSyntaxContext context, AttributeSyntax attr, string argName)
{
var argument = attr.ArgumentList?.Arguments.FirstOrDefault(a => a.NameEquals?.Name.ToString() == argName)?.Expression;
if (argument != null)
{
var constValue = context.SemanticModel.GetConstantValue(argument);
if (constValue is { HasValue: true, Value: string attrValue })
{
return attrValue;
}
}

return null;
}
}
78 changes: 78 additions & 0 deletions test/KubeOps.Generator.Test/EntityInitializerGenerator.Test.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,4 +336,82 @@ public V1TestEntity()
.ToString().ReplaceLineEndings();
result.Should().Be(expectedResult);
}

[Fact]
public void Should_Generate_Default_Ctor_For_Partial_Entity_With_Metadata_Const()
{
var inputCompilation = """
[KubernetesEntity(Group = KubeGroup, ApiVersion = KubeApiVersion, Kind = KubeKind, PluralName = KubePluralName)]
public partial class V1TestEntity : IKubernetesObject<V1ObjectMeta>
{
public const string KubeApiVersion = "v1";
public const string KubeGroup = "testing.dev";
public const string KubeKind = "TestEntity";
public const string KubePluralName = "testentities";
}
""".CreateCompilation();
var expectedResult = """
// <auto-generated>
// This code was generated by a tool.
// Changes to this file may cause incorrect behavior and will be lost if the code is regenerated.
// </auto-generated>
#pragma warning disable CS1591
public partial class V1TestEntity
{
public V1TestEntity()
{
ApiVersion = "testing.dev/v1";
Kind = "TestEntity";
}
}
""".ReplaceLineEndings();

var driver = CSharpGeneratorDriver.Create(new EntityInitializerGenerator());
driver.RunGeneratorsAndUpdateCompilation(inputCompilation, out var output, out ImmutableArray<Diagnostic> _);

var result = output.SyntaxTrees
.First(s => s.FilePath.Contains("V1TestEntity.init.g.cs"))
.ToString().ReplaceLineEndings();
result.Should().Be(expectedResult);
}

[Fact]
public void Should_Generate_Default_Ctor_For_Partial_Entity_With_External_Metadata_Const()
{
var inputCompilation = """
internal static class Constants
{
public const string KubeApiVersion = "v1";
public const string KubeGroup = "testing.dev";
public const string KubeKind = "TestEntity";
public const string KubePluralName = "testentities";
}

[KubernetesEntity(Group = Constants.KubeGroup, ApiVersion = Constants.KubeApiVersion, Kind = Constants.KubeKind, PluralName = Constants.KubePluralName)]
public partial class V1TestEntity : IKubernetesObject<V1ObjectMeta>;
""".CreateCompilation();
var expectedResult = """
// <auto-generated>
// This code was generated by a tool.
// Changes to this file may cause incorrect behavior and will be lost if the code is regenerated.
// </auto-generated>
#pragma warning disable CS1591
public partial class V1TestEntity
{
public V1TestEntity()
{
ApiVersion = "testing.dev/v1";
Kind = "TestEntity";
}
}
""".ReplaceLineEndings();

var driver = CSharpGeneratorDriver.Create(new EntityInitializerGenerator());
driver.RunGeneratorsAndUpdateCompilation(inputCompilation, out var output, out ImmutableArray<Diagnostic> _);

var result = output.SyntaxTrees
.First(s => s.FilePath.Contains("V1TestEntity.init.g.cs"))
.ToString().ReplaceLineEndings();
result.Should().Be(expectedResult);
}
}