feat(crd generation): Treat IKubernetesObject types as x-kubernetes-embedded-resource (#162)

* Treat standard IKubernetesObject types as x-kubernetes-embedded-resource in CRD schema

* Limit x-kubernetes-embedded-resource to IKubernetesObject concrete derived types

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

Author: alexmg

src/KubeOps/Operator/Entities/Extensions/EntityToCrdExtensions.cs

@@ -182,10 +182,7 @@ private static V1JSONSchemaProps MapProperty(
             // check if embedded resource is set
             if (info.GetCustomAttribute<EmbeddedResourceAttribute>() != null)
             {
-                props.Type = Object;
-                props.Properties = null;
-                props.XKubernetesPreserveUnknownFields = true;
-                props.XKubernetesEmbeddedResource = true;
+                SetEmbeddedResourceProperties(props);
             }
 
             // get additional printer column information
@@ -251,6 +248,13 @@ private static V1JSONSchemaProps MapType(
             {
                 props.XKubernetesIntOrString = true;
             }
+            else if (typeof(IKubernetesObject).IsAssignableFrom(type) &&
+                     !type.IsAbstract &&
+                     !type.IsInterface &&
+                     type.Assembly == typeof(IKubernetesObject).Assembly)
+            {
+                SetEmbeddedResourceProperties(props);
+            }
             else if (!isSimpleType)
             {
                 ProcessType(type, props, additionalColumns, jsonPath);
@@ -306,6 +310,14 @@ private static V1JSONSchemaProps MapType(
             return props;
         }
 
+        private static void SetEmbeddedResourceProperties(V1JSONSchemaProps props)
+        {
+            props.Type = Object;
+            props.Properties = null;
+            props.XKubernetesPreserveUnknownFields = true;
+            props.XKubernetesEmbeddedResource = true;
+        }
+
         private static void ProcessType(
             Type type,
             V1JSONSchemaProps props,

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

@@ -334,16 +334,35 @@ public void Should_Set_IntOrString()
             specProperties.Properties["intOrString"].XKubernetesIntOrString.Should().BeTrue();
         }
 
+        [Theory]
+        [InlineData(nameof(TestSpecEntitySpec.KubernetesObject))]
+        [InlineData(nameof(TestSpecEntitySpec.Pod))]
+        public void Should_Map_Embedded_Resources(string property)
+        {
+            var crd = _testSpecEntity.CreateCrd();
+            var propertyName = property.ToCamelCase();
+
+            var specProperties = crd.Spec.Versions.First().Schema.OpenAPIV3Schema.Properties["spec"];
+            specProperties.Properties[propertyName].Type.Should().Be("object");
+            specProperties.Properties[propertyName].Properties.Should().BeNull();
+            specProperties.Properties[propertyName].XKubernetesPreserveUnknownFields.Should().BeTrue();
+            specProperties.Properties[propertyName].XKubernetesEmbeddedResource.Should().BeTrue();
+        }
+
         [Fact]
-        public void Should_Map_Embedded_Resources()
+        public void Should_Map_List_Of_Embedded_Resource()
         {
             var crd = _testSpecEntity.CreateCrd();
+            var propertyName = nameof(TestSpecEntitySpec.Pods).ToCamelCase();
 
             var specProperties = crd.Spec.Versions.First().Schema.OpenAPIV3Schema.Properties["spec"];
-            specProperties.Properties["kubernetesObject"].Type.Should().Be("object");
-            specProperties.Properties["kubernetesObject"].Properties.Should().BeNull();
-            specProperties.Properties["kubernetesObject"].XKubernetesPreserveUnknownFields.Should().BeTrue();
-            specProperties.Properties["kubernetesObject"].XKubernetesEmbeddedResource.Should().BeTrue();
+            var arrayProperty = specProperties.Properties[propertyName];
+            arrayProperty.Type.Should().Be("array");
+
+            var items = arrayProperty.Items as V1JSONSchemaProps;
+            items?.Type?.Should().Be("object");
+            items?.XKubernetesPreserveUnknownFields.Should().BeTrue();
+            items?.XKubernetesEmbeddedResource?.Should().BeTrue();
         }
 
         [Fact]

tests/KubeOps.Test/TestEntities/TestSpecEntity.cs

@@ -3,6 +3,7 @@
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Linq;
+using k8s;
 using k8s.Models;
 using KubeOps.Operator.Entities;
 using KubeOps.Operator.Entities.Annotations;
@@ -125,6 +126,10 @@ public class TestSpecEntitySpec
         [EmbeddedResource]
         public V1ConfigMap KubernetesObject { get; set; } = new V1ConfigMap();
 
+        public V1Pod Pod { get; set; } = new V1Pod();
+
+        public IList<V1Pod> Pods { get; set; } = Array.Empty<V1Pod>();
+
         [JsonProperty(PropertyName = "NameFromAttribute")]
         public string PropertyWithJsonAttribute { get; set; } = string.Empty;