feat(client): Use true generics again (#640)

This readds all methods in the kubernetes client that were annotated with <TEntity> in their methods. This allows true generic calls.
buehler · Oct 18, 2023 · a95278d · a95278d
1 parent 881111b
commit a95278d
Show file tree

Hide file tree

Showing 42 changed files with 999 additions and 1,043 deletions.
diff --git a/examples/Operator/Controller/V1TestEntityController.cs b/examples/Operator/Controller/V1TestEntityController.cs
@@ -2,7 +2,6 @@
 using KubeOps.Abstractions.Events;
 using KubeOps.Abstractions.Queue;
 using KubeOps.Abstractions.Rbac;
-using KubeOps.KubernetesClient;
 
 using Microsoft.Extensions.Logging;
 
@@ -14,18 +13,15 @@ namespace Operator.Controller;
 public class V1TestEntityController : IEntityController<V1TestEntity>
 {
     private readonly ILogger<V1TestEntityController> _logger;
-    private readonly IKubernetesClient<V1TestEntity> _client;
     private readonly EntityRequeue<V1TestEntity> _requeue;
     private readonly EventPublisher _eventPublisher;
 
     public V1TestEntityController(
         ILogger<V1TestEntityController> logger,
-        IKubernetesClient<V1TestEntity> client,
         EntityRequeue<V1TestEntity> requeue,
         EventPublisher eventPublisher)
     {
         _logger = logger;
-        _client = client;
         _requeue = requeue;
         _eventPublisher = eventPublisher;
     }

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -24,8 +24,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="README.md" Pack="true" PackagePath="\"/>
-        <None Include="$(MSBuildThisFileDirectory)\..\LICENSE" Pack="true" PackagePath="\"/>
+        <None Include="README.md" Pack="true" PackagePath="\" />
+        <None Include="$(MSBuildThisFileDirectory)\..\LICENSE" Pack="true" PackagePath="\" />
         <None Include="$(MSBuildThisFileDirectory)\..\res\icon.png">
             <Pack>true</Pack>
             <PackagePath>\</PackagePath>
@@ -35,16 +35,16 @@
 
     <ItemGroup>
         <PackageReference
-                Include="StyleCop.Analyzers"
-                Version="1.2.0-beta.507"
-                PrivateAssets="all"
-                Condition="$(MSBuildProjectExtension) == '.csproj'"/>
+            Include="StyleCop.Analyzers"
+            Version="1.2.0-beta.507"
+            PrivateAssets="all"
+            Condition="$(MSBuildProjectExtension) == '.csproj'" />
         <PackageReference
-                Include="SonarAnalyzer.CSharp"
-                Version="9.12.0.78982"
-                PrivateAssets="all"
-                Condition="$(MSBuildProjectExtension) == '.csproj'"/>
-        <PackageReference Include="Roslynator.Analyzers" Version="4.5.0" PrivateAssets="All"/>
+            Include="SonarAnalyzer.CSharp"
+            Version="9.12.0.78982"
+            PrivateAssets="all"
+            Condition="$(MSBuildProjectExtension) == '.csproj'" />
+        <PackageReference Include="Roslynator.Analyzers" Version="4.5.0" PrivateAssets="All" />
     </ItemGroup>
 
     <ItemGroup>
@@ -56,4 +56,4 @@
             <_Parameter1>DynamicProxyGenAssembly2</_Parameter1>
         </AssemblyAttribute>
     </ItemGroup>
-</Project>
+</Project>
diff --git a/src/KubeOps.Abstractions/Builder/IOperatorBuilder.cs b/src/KubeOps.Abstractions/Builder/IOperatorBuilder.cs
@@ -2,7 +2,6 @@
 using k8s.Models;
 
 using KubeOps.Abstractions.Controller;
-using KubeOps.Abstractions.Entities;
 using KubeOps.Abstractions.Finalizer;
 
 using Microsoft.Extensions.DependencyInjection;
@@ -19,34 +18,6 @@ public interface IOperatorBuilder
     /// </summary>
     IServiceCollection Services { get; }
 
-    /// <summary>
-    /// <para>
-    /// Register an entity Kubernetes client within the operator.
-    /// This is used to register IKubernetesClient{TEntity} for the entity.
-    /// An alternative way to create any Kubernetes client is to use the
-    /// KubernetesClientFactory or instantiate the client by yourself.
-    /// </para>
-    /// </summary>
-    /// <param name="metadata">The metadata of the entity.</param>
-    /// <typeparam name="TEntity">The type of the entity.</typeparam>
-    /// <returns>The builder for chaining.</returns>
-    IOperatorBuilder AddEntityClient<TEntity>(EntityMetadata metadata)
-        where TEntity : IKubernetesObject<V1ObjectMeta>;
-
-    /// <summary>
-    /// <para>
-    /// Register an entity Kubernetes client within the operator.
-    /// This is used to register IKubernetesClient{TEntity} for the entity.
-    /// An alternative way to create any Kubernetes client is to use the
-    /// KubernetesClientFactory or instantiate the client by yourself.
-    /// This method uses reflection to get the metadata from the entity.
-    /// </para>
-    /// </summary>
-    /// <typeparam name="TEntity">The type of the entity.</typeparam>
-    /// <returns>The builder for chaining.</returns>
-    IOperatorBuilder AddEntityClient<TEntity>()
-        where TEntity : IKubernetesObject<V1ObjectMeta>;
-
     /// <summary>
     /// Add a controller implementation for a specific entity to the operator.
     /// The metadata for the entity must be added as well.

diff --git a/src/KubeOps.Abstractions/Builder/OperatorSettings.cs b/src/KubeOps.Abstractions/Builder/OperatorSettings.cs
@@ -42,7 +42,7 @@ public sealed class OperatorSettings
     /// Defaults to `false`.
     /// </para>
     /// </summary>
-    public bool EnableLeaderElection { get; set; }
+    public bool EnableLeaderElection { get; set; } = false;
 
     /// <summary>
     /// Defines how long one lease is valid for any leader.

diff --git a/src/KubeOps.Cli/Commands/Utilities/Version.cs b/src/KubeOps.Cli/Commands/Utilities/Version.cs
@@ -12,7 +12,9 @@ public static Command Command
     {
         get
         {
-            var cmd = new Command("api-version", "Prints the actual server version of the connected kubernetes cluster.");
+            var cmd = new Command(
+                "api-version",
+                "Prints the actual server version of the connected kubernetes cluster.");
             cmd.AddAlias("av");
             cmd.SetHandler(() =>
                 Handler(AnsiConsole.Console, new Kubernetes(KubernetesClientConfiguration.BuildDefaultConfig())));

diff --git a/src/KubeOps.Cli/Program.cs b/src/KubeOps.Cli/Program.cs
@@ -19,7 +19,8 @@
     .UseParseErrorReporting(ExitCodes.UsageError)
     .UseExceptionHandler((ex, ctx) =>
     {
-        AnsiConsole.MarkupLineInterpolated($"[red]An error occurred whiled executing {ctx.ParseResult.CommandResult.Command}[/]");
+        AnsiConsole.MarkupLineInterpolated(
+            $"[red]An error occurred whiled executing {ctx.ParseResult.CommandResult.Command}[/]");
         AnsiConsole.MarkupLineInterpolated($"[red]{ex.Message}[/]");
         ctx.ExitCode = ExitCodes.Error;
     })

diff --git a/src/KubeOps.Generator/Generators/EntityDefinitionGenerator.cs b/src/KubeOps.Generator/Generators/EntityDefinitionGenerator.cs
@@ -78,41 +78,7 @@ public void Execute(GeneratorExecutionContext context)
                             TokenList(
                                 Token(SyntaxKind.PublicKeyword),
                                 Token(SyntaxKind.StaticKeyword),
-                                Token(SyntaxKind.ReadOnlyKeyword))))))
-                .AddMembers(MethodDeclaration(IdentifierName("IOperatorBuilder"), "RegisterEntities")
-                    .WithModifiers(
-                        TokenList(Token(SyntaxKind.PublicKeyword), Token(SyntaxKind.StaticKeyword)))
-                    .WithParameterList(ParameterList(
-                        SingletonSeparatedList(
-                            Parameter(
-                                    Identifier("builder"))
-                                .WithModifiers(
-                                    TokenList(
-                                        Token(SyntaxKind.ThisKeyword)))
-                                .WithType(
-                                    IdentifierName("IOperatorBuilder")))))
-                    .WithBody(Block(
-                        receiver.Entities
-                            .Select(e => ExpressionStatement(
-                                InvocationExpression(
-                                        MemberAccessExpression(
-                                            SyntaxKind.SimpleMemberAccessExpression,
-                                            IdentifierName("builder"),
-                                            GenericName(Identifier("AddEntityClient"))
-                                                .WithTypeArgumentList(
-                                                    TypeArgumentList(
-                                                        SingletonSeparatedList<TypeSyntax>(
-                                                            IdentifierName(context.Compilation
-                                                                .GetSemanticModel(e.Class.SyntaxTree)
-                                                                .GetDeclaredSymbol(e.Class)!
-                                                                .ToDisplayString(SymbolDisplayFormat
-                                                                    .FullyQualifiedFormat)))))))
-                                    .WithArgumentList(
-                                        ArgumentList(
-                                            SingletonSeparatedList(
-                                                Argument(
-                                                    IdentifierName(e.Class.Identifier)))))))
-                            .Append<StatementSyntax>(ReturnStatement(IdentifierName("builder"))))))))
+                                Token(SyntaxKind.ReadOnlyKeyword))))))))
             .NormalizeWhitespace();
 
         context.AddSource(

diff --git a/src/KubeOps.Generator/Generators/OperatorBuilderGenerator.cs b/src/KubeOps.Generator/Generators/OperatorBuilderGenerator.cs
@@ -40,22 +40,16 @@ public void Execute(GeneratorExecutionContext context)
                     .WithBody(Block(
                         ExpressionStatement(
                             InvocationExpression(
-                                    MemberAccessExpression(
-                                        SyntaxKind.SimpleMemberAccessExpression,
-                                        IdentifierName("builder"),
-                                        IdentifierName("RegisterEntities")))),
+                                MemberAccessExpression(
+                                    SyntaxKind.SimpleMemberAccessExpression,
+                                    IdentifierName("builder"),
+                                    IdentifierName("RegisterControllers")))),
                         ExpressionStatement(
                             InvocationExpression(
-                                    MemberAccessExpression(
-                                        SyntaxKind.SimpleMemberAccessExpression,
-                                        IdentifierName("builder"),
-                                        IdentifierName("RegisterControllers")))),
-                        ExpressionStatement(
-                            InvocationExpression(
-                                    MemberAccessExpression(
-                                        SyntaxKind.SimpleMemberAccessExpression,
-                                        IdentifierName("builder"),
-                                        IdentifierName("RegisterFinalizers")))),
+                                MemberAccessExpression(
+                                    SyntaxKind.SimpleMemberAccessExpression,
+                                    IdentifierName("builder"),
+                                    IdentifierName("RegisterFinalizers")))),
                         ReturnStatement(IdentifierName("builder")))))))
             .NormalizeWhitespace();