feat(attributes): add ignore entity attribute.

This closes #25.

Author: Christoph Bühler

src/KubeOps/KubeOps.csproj

@@ -47,4 +47,8 @@
         </AssemblyAttribute>
     </ItemGroup>
 
+    <ItemGroup>
+      <Folder Include="Testing" />
+    </ItemGroup>
+
 </Project>

src/KubeOps/Operator/Commands/Generators/CrdGenerator.cs

@@ -6,6 +6,7 @@
 using System.Text;
 using System.Threading.Tasks;
 using k8s.Models;
+using KubeOps.Operator.Entities.Annotations;
 using KubeOps.Operator.Entities.Extensions;
 using KubeOps.Operator.Entities.Kustomize;
 using KubeOps.Operator.Serialization;
@@ -75,15 +76,16 @@ public async Task<int> OnExecuteAsync(CommandLineApplication app)
             return ExitCodes.Success;
         }
 
-        public static IEnumerable<V1CustomResourceDefinition> GenerateCrds()
+        public static IEnumerable<V1CustomResourceDefinition> GenerateCrds(Assembly? assembly = null)
         {
-            var assembly = Assembly.GetEntryAssembly();
+            assembly ??= Assembly.GetEntryAssembly();
             if (assembly == null)
             {
                 throw new Exception("No Entry Assembly found.");
             }
 
             return GetTypesWithAttribute<KubernetesEntityAttribute>(assembly)
+                .Where(type => !type.GetCustomAttributes<IgnoreEntityAttribute>().Any())
                 .Select(EntityToCrdExtensions.CreateCrd);
         }
 

src/KubeOps/Operator/Entities/Annotations/IgnoreEntityAttribute.cs

@@ -0,0 +1,13 @@
+using System;
+
+namespace KubeOps.Operator.Entities.Annotations
+{
+    /// <summary>
+    /// Attribute that states that the given entity should be
+    /// ignored during CRD generation.
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Class)]
+    public class IgnoreEntityAttribute : Attribute
+    {
+    }
+}

tests/KubeOps.Test/Operator/Entities/CrdGeneration.Test.cs

@@ -1,7 +1,9 @@
 using System;
 using System.Linq;
+using System.Reflection;
 using FluentAssertions;
 using k8s.Models;
+using KubeOps.Operator.Commands.Generators;
 using KubeOps.Operator.Entities.Extensions;
 using KubeOps.Test.Operator.Entities.TestEntities;
 using Xunit;
@@ -217,5 +219,13 @@ public void Should_Set_Required_Null_If_No_Required()
             var specProperties = crd.Spec.Versions.First().Schema.OpenAPIV3Schema.Properties["spec"];
             specProperties.Required.Should().BeNull();
         }
+
+        [Fact]
+        public void Should_Ignore_Entity_With_Ignore_Attribute()
+        {
+            var crds = CrdGenerator.GenerateCrds(Assembly.GetExecutingAssembly()).ToList();
+            crds.Should().NotContain(crd => crd.Spec.Names.Kind == "TestIgnoredEntity");
+            crds.Should().Contain(crd => crd.Spec.Names.Kind == "TestSpecEntity");
+        }
     }
 }

tests/KubeOps.Test/Operator/Entities/TestEntities/TestIgnoredEntity.cs

@@ -0,0 +1,12 @@
+using k8s.Models;
+using KubeOps.Operator.Entities;
+using KubeOps.Operator.Entities.Annotations;
+
+namespace KubeOps.Test.Operator.Entities.TestEntities
+{
+    [IgnoreEntity]
+    [KubernetesEntity(Group = "kubeops.test.dev", ApiVersion = "V1")]
+    public class TestIgnoredEntity : CustomKubernetesEntity
+    {
+    }
+}