feat: Add BaseSecret class and BaseSecretGenerator with required properties pattern (#369)

* Initial plan

* feat: add BaseSecret class for common secret properties

Co-authored-by: devantler <[email protected]>

* feat: add BaseSecretGenerator to reduce code duplication

Co-authored-by: devantler <[email protected]>

* refactor: replace primary constructor with required property in BaseSecret

Co-authored-by: devantler <[email protected]>

* refactor: simplify BaseSecret class and improve BaseSecretGenerator structure

Co-authored-by: devantler <[email protected]>

* fix: remove unnecessary null-conditional operator in BaseSecretGenerator error message

Co-authored-by: devantler <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: devantler <[email protected]>
Co-authored-by: Nikolai Emil Damm <[email protected]>

Author: Copilot

src/DevantlerTech.KubernetesGenerator.Native/BaseSecretGenerator.cs

@@ -0,0 +1,78 @@
+using System.Collections.ObjectModel;
+using DevantlerTech.KubernetesGenerator.Core;
+using DevantlerTech.KubernetesGenerator.Native.Models;
+
+namespace DevantlerTech.KubernetesGenerator.Native;
+
+/// <summary>
+/// Base class for secret generators.
+/// </summary>
+/// <typeparam name="T">The secret model type that inherits from BaseSecret.</typeparam>
+public abstract class BaseSecretGenerator<T> : BaseNativeGenerator<T> where T : BaseSecret
+{
+  /// <summary>
+  /// Gets the command prefix for the specific secret type (e.g., ["create", "secret", "tls"]).
+  /// </summary>
+  protected abstract ReadOnlyCollection<string> CommandPrefix { get; }
+
+  /// <summary>
+  /// Generates a secret using the appropriate kubectl create secret command.
+  /// </summary>
+  /// <param name="model">The secret object.</param>
+  /// <param name="outputPath">The output path for the generated YAML.</param>
+  /// <param name="overwrite">Whether to overwrite existing files.</param>
+  /// <param name="cancellationToken">The cancellation token.</param>
+  /// <exception cref="ArgumentNullException">Thrown when model is null.</exception>
+  /// <exception cref="KubernetesGeneratorException">Thrown when required parameters are missing.</exception>
+  public override async Task GenerateAsync(T model, string outputPath, bool overwrite = false, CancellationToken cancellationToken = default)
+  {
+    ArgumentNullException.ThrowIfNull(model);
+
+    var commonArgs = BuildCommonArguments(model);
+    var specificArgs = await BuildSpecificArgumentsAsync(model, cancellationToken).ConfigureAwait(false);
+
+    var args = new ReadOnlyCollection<string>(
+      [.. CommandPrefix, .. commonArgs, .. specificArgs]
+    );
+    string errorMessage = $"Failed to create {GetSecretTypeName()} secret '{model.Metadata.Name}' using kubectl";
+    await RunKubectlAsync(outputPath, overwrite, args, errorMessage, cancellationToken).ConfigureAwait(false);
+  }
+
+  /// <summary>
+  /// Builds the common arguments that all secret types share (name and namespace).
+  /// </summary>
+  /// <param name="model">The secret model.</param>
+  /// <returns>The common arguments.</returns>
+  static ReadOnlyCollection<string> BuildCommonArguments(T model)
+  {
+    ArgumentNullException.ThrowIfNull(model);
+
+    var args = new List<string>
+    {
+      model.Metadata.Name
+    };
+
+    // Add namespace if specified
+    if (!string.IsNullOrEmpty(model.Metadata.Namespace))
+    {
+      args.Add($"--namespace={model.Metadata.Namespace}");
+    }
+
+    return args.AsReadOnly();
+  }
+
+  /// <summary>
+  /// Builds the specific arguments for the secret type.
+  /// </summary>
+  /// <param name="model">The secret model.</param>
+  /// <param name="cancellationToken">The cancellation token.</param>
+  /// <returns>The specific arguments for this secret type.</returns>
+  protected abstract Task<ReadOnlyCollection<string>> BuildSpecificArgumentsAsync(T model, CancellationToken cancellationToken = default);
+
+  /// <summary>
+  /// Gets the human-readable name of the secret type for error messages.
+  /// </summary>
+  /// <returns>The secret type name.</returns>
+  protected virtual string GetSecretTypeName() =>
+    typeof(T).Name.Replace("Secret", "", StringComparison.Ordinal).ToUpperInvariant();
+}

src/DevantlerTech.KubernetesGenerator.Native/DockerRegistrySecretGenerator.cs

@@ -1,52 +1,29 @@
 using System.Collections.ObjectModel;
-using DevantlerTech.KubernetesGenerator.Core;
 using DevantlerTech.KubernetesGenerator.Native.Models;
 
 namespace DevantlerTech.KubernetesGenerator.Native;
 
 /// <summary>
 /// A generator for Docker registry Kubernetes Secret objects using 'kubectl create secret docker-registry' commands.
 /// </summary>
-public class DockerRegistrySecretGenerator : BaseNativeGenerator<DockerRegistrySecret>
+public class DockerRegistrySecretGenerator : BaseSecretGenerator<DockerRegistrySecret>
 {
-  static readonly string[] _defaultArgs = ["create", "secret", "docker-registry"];
   /// <summary>
-  /// Generates a Docker registry secret using kubectl create secret docker-registry command.
+  /// Gets the command prefix for Docker registry secrets.
   /// </summary>
-  /// <param name="model">The Docker registry secret object.</param>
-  /// <param name="outputPath">The output path for the generated YAML.</param>
-  /// <param name="overwrite">Whether to overwrite existing files.</param>
-  /// <param name="cancellationToken">The cancellation token.</param>
-  /// <exception cref="ArgumentNullException">Thrown when model is null.</exception>
-  /// <exception cref="KubernetesGeneratorException">Thrown when required parameters are missing.</exception>
-  public override async Task GenerateAsync(DockerRegistrySecret model, string outputPath, bool overwrite = false, CancellationToken cancellationToken = default)
-  {
-    ArgumentNullException.ThrowIfNull(model);
-
-    var args = new ReadOnlyCollection<string>(
-      [.. _defaultArgs, .. AddArguments(model)]
-    );
-    string errorMessage = $"Failed to create Docker registry secret '{model.Metadata?.Name}' using kubectl";
-    await RunKubectlAsync(outputPath, overwrite, args, errorMessage, cancellationToken).ConfigureAwait(false);
-  }
+  protected override ReadOnlyCollection<string> CommandPrefix => new(["create", "secret", "docker-registry"]);
 
   /// <summary>
-  /// Builds the kubectl arguments for creating a Docker registry secret from a DockerRegistrySecret object.
+  /// Builds the specific arguments for creating a Docker registry secret from a DockerRegistrySecret object.
   /// </summary>
   /// <param name="model">The DockerRegistrySecret object.</param>
+  /// <param name="cancellationToken">The cancellation token.</param>
   /// <returns>The kubectl arguments.</returns>
-  static ReadOnlyCollection<string> AddArguments(DockerRegistrySecret model)
+  protected override Task<ReadOnlyCollection<string>> BuildSpecificArgumentsAsync(DockerRegistrySecret model, CancellationToken cancellationToken = default)
   {
-    var args = new List<string>
-    {
-      model.Metadata.Name
-    };
+    ArgumentNullException.ThrowIfNull(model);
 
-    // Add namespace if specified
-    if (!string.IsNullOrEmpty(model.Metadata.Namespace))
-    {
-      args.Add($"--namespace={model.Metadata.Namespace}");
-    }
+    var args = new List<string>();
 
     // Add Docker registry specific arguments
     if (!string.IsNullOrEmpty(model.DockerServer))
@@ -58,6 +35,6 @@ static ReadOnlyCollection<string> AddArguments(DockerRegistrySecret model)
     args.Add($"--docker-password={model.DockerPassword}");
     args.Add($"--docker-email={model.DockerEmail}");
 
-    return args.AsReadOnly();
+    return Task.FromResult(args.AsReadOnly());
   }
 }

src/DevantlerTech.KubernetesGenerator.Native/GenericSecretGenerator.cs

@@ -1,52 +1,29 @@
 using System.Collections.ObjectModel;
-using DevantlerTech.KubernetesGenerator.Core;
 using DevantlerTech.KubernetesGenerator.Native.Models;
 
 namespace DevantlerTech.KubernetesGenerator.Native;
 
 /// <summary>
 /// A generator for generic Kubernetes Secret objects using 'kubectl create secret generic' commands.
 /// </summary>
-public class GenericSecretGenerator : BaseNativeGenerator<GenericSecret>
+public class GenericSecretGenerator : BaseSecretGenerator<GenericSecret>
 {
-  static readonly string[] _defaultArgs = ["create", "secret", "generic"];
   /// <summary>
-  /// Generates a generic secret using kubectl create secret generic command.
+  /// Gets the command prefix for generic secrets.
   /// </summary>
-  /// <param name="model">The secret object.</param>
-  /// <param name="outputPath">The output path for the generated YAML.</param>
-  /// <param name="overwrite">Whether to overwrite existing files.</param>
-  /// <param name="cancellationToken">The cancellation token.</param>
-  /// <exception cref="ArgumentNullException">Thrown when model is null.</exception>
-  /// <exception cref="KubernetesGeneratorException">Thrown when secret name is not provided.</exception>
-  public override async Task GenerateAsync(GenericSecret model, string outputPath, bool overwrite = false, CancellationToken cancellationToken = default)
-  {
-    ArgumentNullException.ThrowIfNull(model);
-
-    var args = new ReadOnlyCollection<string>(
-      [.. _defaultArgs, .. AddArguments(model)]
-    );
-    string errorMessage = $"Failed to create generic secret '{model.Metadata?.Name}' using kubectl";
-    await RunKubectlAsync(outputPath, overwrite, args, errorMessage, cancellationToken).ConfigureAwait(false);
-  }
+  protected override ReadOnlyCollection<string> CommandPrefix => new(["create", "secret", "generic"]);
 
   /// <summary>
-  /// Builds the kubectl arguments for creating a generic secret from a GenericSecret object.
+  /// Builds the specific arguments for creating a generic secret from a GenericSecret object.
   /// </summary>
   /// <param name="model">The GenericSecret object.</param>
-  static ReadOnlyCollection<string> AddArguments(GenericSecret model)
+  /// <param name="cancellationToken">The cancellation token.</param>
+  /// <returns>The kubectl arguments.</returns>
+  protected override Task<ReadOnlyCollection<string>> BuildSpecificArgumentsAsync(GenericSecret model, CancellationToken cancellationToken = default)
   {
-    var args = new List<string>
-    {
-      // The secret name is always available from the metadata (required in constructor)
-      model.Metadata.Name
-    };
+    ArgumentNullException.ThrowIfNull(model);
 
-    // Add namespace if specified
-    if (!string.IsNullOrEmpty(model.Metadata.Namespace))
-    {
-      args.Add($"--namespace={model.Metadata.Namespace}");
-    }
+    var args = new List<string>();
 
     // Add type if specified (but don't require it)
     if (!string.IsNullOrEmpty(model.Type))
@@ -60,6 +37,6 @@ static ReadOnlyCollection<string> AddArguments(GenericSecret model)
       args.Add($"--from-literal={kvp.Key}={kvp.Value}");
     }
 
-    return args.AsReadOnly();
+    return Task.FromResult(args.AsReadOnly());
   }
 }

src/DevantlerTech.KubernetesGenerator.Native/Models/BaseMetadata.cs

@@ -22,4 +22,4 @@ public abstract class BaseMetadata
   /// Gets or sets the annotations for this object.
   /// </summary>
   public IDictionary<string, string>? Annotations { get; init; }
-}
+}

src/DevantlerTech.KubernetesGenerator.Native/Models/BaseSecret.cs

@@ -0,0 +1,12 @@
+namespace DevantlerTech.KubernetesGenerator.Native.Models;
+
+/// <summary>
+/// Base class for Kubernetes secret models.
+/// </summary>
+public abstract class BaseSecret
+{
+  /// <summary>
+  /// Gets or sets the metadata for the secret.
+  /// </summary>
+  public required Metadata Metadata { get; set; }
+}

src/DevantlerTech.KubernetesGenerator.Native/Models/ClusterRole.cs

@@ -30,4 +30,4 @@ public class ClusterRole
   /// Gets or sets the aggregation rule for combining cluster roles.
   /// </summary>
   public ClusterRoleAggregationRule? AggregationRule { get; set; }
-}
+}

src/DevantlerTech.KubernetesGenerator.Native/Models/ClusterRoleAggregationRule.cs

@@ -9,4 +9,4 @@ public class ClusterRoleAggregationRule
   /// Gets or sets the cluster role selectors for aggregation.
   /// </summary>
   public required IList<ClusterRoleLabelSelector> ClusterRoleSelectors { get; init; } = [];
-}
+}

src/DevantlerTech.KubernetesGenerator.Native/Models/ClusterRoleBinding.cs

@@ -19,4 +19,4 @@ public class ClusterRoleBinding
   /// Gets or sets the subjects that are bound to the cluster role.
   /// </summary>
   public required IList<RoleBindingSubject> Subjects { get; init; }
-}
+}

src/DevantlerTech.KubernetesGenerator.Native/Models/ClusterRoleLabelSelector.cs

@@ -14,4 +14,4 @@ public class ClusterRoleLabelSelector
   /// Gets or sets the match expressions for the selector.
   /// </summary>
   public IList<MatchExpression>? MatchExpressions { get; init; }
-}
+}

src/DevantlerTech.KubernetesGenerator.Native/Models/ClusterRoleRule.cs

@@ -32,4 +32,4 @@ public class ClusterRoleRule
   /// Used for cluster-scoped permissions on non-resource endpoints.
   /// </summary>
   public IList<string>? NonResourceURLs { get; init; }
-}
+}