fix: Change the labels to an array (#881)

This pull request introduces changes to improve type consistency,
enhance test coverage, and refactor the `Handler` method in the
`OperatorGenerator` class for better dependency injection. Below is a
summary of the most important changes:

### Type Consistency Improvements:
* Changed the `Labels` property in `KustomizationConfig` from
`KustomizationCommonLabels?` to an array type
`KustomizationCommonLabels[]?` to allow multiple labels.
(`src/KubeOps.Abstractions/Kustomize/KustomizationConfig.cs`)
* Updated the `Labels` assignment in the `Handler` method to use array
initialization syntax for consistency with the new type.
(`src/KubeOps.Cli/Commands/Generator/OperatorGenerator.cs`)

### Refactoring for Dependency Injection:
* Refactored the `Handler` method in `OperatorGenerator` to inject
`IAnsiConsole` as a parameter instead of directly using
`AnsiConsole.Console`. This improves testability and decouples the
method from the static console instance.
(`src/KubeOps.Cli/Commands/Generator/OperatorGenerator.cs`)
[[1]](diffhunk://#diff-cf95f5a9676479797ff0ade11e4dd8d679dd1974142058976f3a35ca6a63b4f2L39-R45)
[[2]](diffhunk://#diff-cf95f5a9676479797ff0ade11e4dd8d679dd1974142058976f3a35ca6a63b4f2L54-R62)
[[3]](diffhunk://#diff-cf95f5a9676479797ff0ade11e4dd8d679dd1974142058976f3a35ca6a63b4f2L74-R109)
[[4]](diffhunk://#diff-cf95f5a9676479797ff0ade11e4dd8d679dd1974142058976f3a35ca6a63b4f2L159-R159)
[[5]](diffhunk://#diff-cf95f5a9676479797ff0ade11e4dd8d679dd1974142058976f3a35ca6a63b4f2L170-R174)

### Test Coverage Enhancements:
* Added a new integration test
`Should_Generate_Valid_Installers_In_Cluster` to validate the generated
Kubernetes YAML files and ensure the presence of a valid
`kustomization.yaml` file.
(`test/KubeOps.Cli.Test/Management/Install.Integration.Test.cs`)
* Improved test dependencies by including `FluentAssertions` for better
assertions and validation in test cases.
(`test/KubeOps.Cli.Test/Management/Install.Integration.Test.cs`)

These changes improve the maintainability, testability, and
functionality of the codebase.

---------

Co-authored-by: Christoph Bühler <[email protected]>

Author: ewassef

src/KubeOps.Abstractions/Kustomize/KustomizationConfig.cs

@@ -26,7 +26,7 @@ public KustomizationConfig()
     /// <summary>
     /// Common labels for the resources.
     /// </summary>
-    public KustomizationCommonLabels? Labels { get; set; }
+    public KustomizationCommonLabels[]? Labels { get; set; }
 
     /// <summary>
     /// Resource list.

src/KubeOps.Cli/Commands/Generator/OperatorGenerator.cs

@@ -36,13 +36,13 @@ public static Command Command
                     Arguments.SolutionOrProjectFile,
                 };
             cmd.AddAlias("op");
-            cmd.SetHandler(Handler);
+            cmd.SetHandler(ctx => Handler(AnsiConsole.Console, ctx));
 
             return cmd;
         }
     }
 
-    private static async Task Handler(InvocationContext ctx)
+    internal static async Task Handler(IAnsiConsole console, InvocationContext ctx)
     {
         var name = ctx.ParseResult.GetValueForArgument(Arguments.OperatorName);
         var file = ctx.ParseResult.GetValueForArgument(Arguments.SolutionOrProjectFile);
@@ -51,15 +51,15 @@ private static async Task Handler(InvocationContext ctx)
         var dockerImage = ctx.ParseResult.GetValueForOption(Options.AccessibleDockerImage)!;
         var dockerImageTag = ctx.ParseResult.GetValueForOption(Options.AccessibleDockerTag)!;
 
-        var result = new ResultOutput(AnsiConsole.Console, format);
-        AnsiConsole.Console.WriteLine("Generate operator resources.");
+        var result = new ResultOutput(console, format);
+        console.WriteLine("Generate operator resources.");
 
-        AnsiConsole.Console.MarkupLine("[green]Load Project/Solution file.[/]");
+        console.MarkupLine("[green]Load Project/Solution file.[/]");
         var parser = file switch
         {
-            { Extension: ".csproj", Exists: true } => await AssemblyLoader.ForProject(AnsiConsole.Console, file),
+            { Extension: ".csproj", Exists: true } => await AssemblyLoader.ForProject(console, file),
             { Extension: ".sln", Exists: true } => await AssemblyLoader.ForSolution(
-                AnsiConsole.Console,
+                console,
                 file,
                 ctx.ParseResult.GetValueForOption(Options.SolutionProjectRegex),
                 ctx.ParseResult.GetValueForOption(Options.TargetFramework)),
@@ -71,42 +71,42 @@ private static async Task Handler(InvocationContext ctx)
         var validators = parser.GetValidatedEntities().ToList();
         var hasWebhooks = mutators.Count > 0 || validators.Count > 0 || parser.GetConvertedEntities().Any();
 
-        AnsiConsole.Console.MarkupLine("[green]Generate RBAC rules.[/]");
+        console.MarkupLine("[green]Generate RBAC rules.[/]");
         new RbacGenerator(parser, format).Generate(result);
 
-        AnsiConsole.Console.MarkupLine("[green]Generate Dockerfile.[/]");
+        console.MarkupLine("[green]Generate Dockerfile.[/]");
         new DockerfileGenerator(hasWebhooks).Generate(result);
 
         if (hasWebhooks)
         {
-            AnsiConsole.Console.MarkupLine(
+            console.MarkupLine(
                 "[yellow]The operator contains webhooks of some sort, generating webhook operator specific resources.[/]");
 
-            AnsiConsole.Console.MarkupLine("[green]Generate CA and Server certificates.[/]");
+            console.MarkupLine("[green]Generate CA and Server certificates.[/]");
             new CertificateGenerator(name, $"{name}-system").Generate(result);
 
-            AnsiConsole.Console.MarkupLine("[green]Generate Deployment and Service.[/]");
+            console.MarkupLine("[green]Generate Deployment and Service.[/]");
             new WebhookDeploymentGenerator(format).Generate(result);
 
             var caBundle =
                 Encoding.ASCII.GetBytes(
                     Convert.ToBase64String(Encoding.ASCII.GetBytes(result["ca.pem"].ToString() ?? string.Empty)));
 
-            AnsiConsole.Console.MarkupLine("[green]Generate Validation Webhooks.[/]");
+            console.MarkupLine("[green]Generate Validation Webhooks.[/]");
             new ValidationWebhookGenerator(validators, caBundle, format).Generate(result);
 
-            AnsiConsole.Console.MarkupLine("[green]Generate Mutation Webhooks.[/]");
+            console.MarkupLine("[green]Generate Mutation Webhooks.[/]");
             new MutationWebhookGenerator(mutators, caBundle, format).Generate(result);
 
-            AnsiConsole.Console.MarkupLine("[green]Generate CRDs.[/]");
+            console.MarkupLine("[green]Generate CRDs.[/]");
             new CrdGenerator(parser, caBundle, format).Generate(result);
         }
         else
         {
-            AnsiConsole.Console.MarkupLine("[green]Generate Deployment.[/]");
+            console.MarkupLine("[green]Generate Deployment.[/]");
             new DeploymentGenerator(format).Generate(result);
 
-            AnsiConsole.Console.MarkupLine("[green]Generate CRDs.[/]");
+            console.MarkupLine("[green]Generate CRDs.[/]");
             new CrdGenerator(parser, Array.Empty<byte>(), format).Generate(result);
         }
 
@@ -120,7 +120,7 @@ private static async Task Handler(InvocationContext ctx)
             {
                 NamePrefix = $"{name}-",
                 Namespace = $"{name}-system",
-                Labels = new KustomizationCommonLabels(new Dictionary<string, string> { { "operator", name }, }),
+                Labels = [new KustomizationCommonLabels(new Dictionary<string, string> { { "operator", name }, })],
                 Resources = result.DefaultFormatFiles.ToList(),
                 Images =
                     new List<KustomizationImage>
@@ -156,7 +156,7 @@ private static async Task Handler(InvocationContext ctx)
         {
             if (ctx.ParseResult.GetValueForOption(Options.ClearOutputPath))
             {
-                AnsiConsole.Console.MarkupLine("[yellow]Clear output path.[/]");
+                console.MarkupLine("[yellow]Clear output path.[/]");
                 try
                 {
                     Directory.Delete(outPath, true);
@@ -167,11 +167,11 @@ private static async Task Handler(InvocationContext ctx)
                 }
                 catch (Exception e)
                 {
-                    AnsiConsole.Console.MarkupLine($"[red]Could not clear output path: {e.Message}[/]");
+                    console.MarkupLine($"[red]Could not clear output path: {e.Message}[/]");
                 }
             }
 
-            AnsiConsole.Console.MarkupLine($"[green]Write output to {outPath}.[/]");
+            console.MarkupLine($"[green]Write output to {outPath}.[/]");
             await result.Write(outPath);
         }
         else

test/KubeOps.Cli.Test/Management/Install.Integration.Test.cs

@@ -1,8 +1,12 @@
 using System.CommandLine;
 using System.CommandLine.Invocation;
+using System.Text;
+
+using FluentAssertions;
 
 using k8s;
 
+using KubeOps.Cli.Commands.Generator;
 using KubeOps.Cli.Commands.Management;
 
 using Spectre.Console.Testing;
@@ -15,8 +19,9 @@ public class InstallIntegrationTest
         Path.Join(Directory.GetCurrentDirectory(), "..", "..", "..", "..", "..", "examples", "Operator",
             "Operator.csproj");
 
-    [Fact(Skip =
-        "For some reason, the MetadataReferences are not loaded when the assembly parser is used from a test project.")]
+    [Fact
+    (Skip = "For some reason, the MetadataReferences are not loaded when the assembly parser is used from a test project.")
+    ]
     public async Task Should_Install_Crds_In_Cluster()
     {
         var console = new TestConsole();
@@ -27,4 +32,56 @@ public async Task Should_Install_Crds_In_Cluster()
 
         await Install.Handler(console, client, ctx);
     }
+
+    [Fact
+    (Skip = "We need to think of a good way to validate the kustomization given there is not real schema published")
+    ]
+    public async Task Should_Generate_Valid_Installers_In_Cluster()
+    {
+        var console = new TestConsole();
+        var client = new Kubernetes(KubernetesClientConfiguration.BuildDefaultConfig());
+        var cmd = OperatorGenerator.Command;
+        var ctx = new InvocationContext(
+            cmd.Parse("operator", "test", ProjectPath));
+
+        await OperatorGenerator.Handler(console, ctx);
+        console.Output.Should().NotBeNull();
+        var separator = console.Lines.GroupBy(x => x).OrderByDescending(x => x.Count()).First().Key;
+        var groups = new List<string>();
+        var sb = new StringBuilder();
+        foreach (string consoleLine in console.Lines)
+        {
+            if (consoleLine.Equals(separator))
+            {
+                groups.Add(sb.ToString());
+                sb = new StringBuilder();
+            }
+            else
+            {
+                sb.AppendLine(consoleLine);
+            }
+        }
+
+        foreach (string s in groups.Skip(1))
+        {
+            // Verify its valid kubernetes yaml
+            var lines = s.Split(new[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries);
+            // first line should be the filename:
+            var filename = lines[0].Trim();
+            var content = lines[1..].ToList();
+            var file = filename.Split(" ")[1].Trim();
+            var fileContent = string.Join(Environment.NewLine, content);
+            // Assert there is a file name and valid kubernetesyaml
+            file.Should().NotBeNullOrEmpty();
+            fileContent.Should().NotBeNullOrEmpty();
+
+            KubernetesYaml.Deserialize<dynamic>(fileContent)
+                .Should().NotBeNull();
+
+            // Assert the file named kustomization.yaml exists and is a valid Kustomization file
+            if (file.Equals("kustomization.yaml"))
+            {
+            }
+        }
+    }
 }