fix: CRD schema generator does not take JsonProperty.PropertyName value into consideration (#159)

* fix: CRD schema generator should use PropertyName from JsonPropertyAttribute

* Minor performance tweak in ToCamelCase extension method

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

Author: alexmg

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

@@ -9,7 +9,9 @@
 using k8s.Models;
 using KubeOps.Operator.Entities.Annotations;
 using KubeOps.Operator.Errors;
+using KubeOps.Operator.Util;
 using Namotion.Reflection;
+using Newtonsoft.Json;
 
 namespace KubeOps.Operator.Entities.Extensions
 {
@@ -319,11 +321,11 @@ private static void ProcessType(
                                 !IgnoredToplevelProperties.Contains(info.Name.ToLowerInvariant()))
                     .Select(
                         prop => KeyValuePair.Create(
-                            CamelCase(prop.Name),
-                            MapProperty(prop, additionalColumns, $"{jsonPath}.{CamelCase(prop.Name)}"))));
+                            GetPropertyName(prop),
+                            MapProperty(prop, additionalColumns, $"{jsonPath}.{GetPropertyName(prop)}"))));
             props.Required = type.GetProperties()
                 .Where(prop => prop.GetCustomAttribute<RequiredAttribute>() != null)
-                .Select(prop => CamelCase(prop.Name))
+                .Select(prop => GetPropertyName(prop))
                 .ToList();
             if (props.Required.Count == 0)
             {
@@ -348,7 +350,12 @@ private static bool IsSimpleType(Type type) =>
              type.GetGenericTypeDefinition() == typeof(Nullable<>) &&
              IsSimpleType(type.GetGenericArguments()[0]));
 
-        private static string CamelCase(string str) => $"{str.Substring(0, 1).ToLower()}{str.Substring(1)}";
+        private static string GetPropertyName(PropertyInfo property)
+        {
+            var attribute = property.GetCustomAttribute<JsonPropertyAttribute>();
+            var propertyName = attribute?.PropertyName ?? property.Name;
+            return propertyName.ToCamelCase();
+        }
 
         private static bool IsGenericEnumerableType(Type type, [NotNullWhen(true)] out Type? closingType)
         {

src/KubeOps/Operator/Util/StringExtensions.cs

@@ -0,0 +1,10 @@
+namespace KubeOps.Operator.Util
+{
+    internal static class StringExtensions
+    {
+        internal static string ToCamelCase(this string value) =>
+            string.IsNullOrWhiteSpace(value) || char.IsLower(value[0])
+                ? value
+                : char.ToLowerInvariant(value[0]) + value[1..];
+    }
+}

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

@@ -7,7 +7,9 @@
 using KubeOps.Operator.Commands.Generators;
 using KubeOps.Operator.Entities.Extensions;
 using KubeOps.Operator.Errors;
+using KubeOps.Operator.Util;
 using KubeOps.Test.TestEntities;
+using Newtonsoft.Json;
 using Xunit;
 
 namespace KubeOps.Test.Operator.Entities
@@ -84,7 +86,7 @@ public void Should_Set_The_Correct_Type_And_Format_For_Types(string fieldName, s
         [InlineData(nameof(TestSpecEntitySpec.IntegerIReadOnlySet), "integer", null)]
         public void Should_Set_The_Correct_Array_Type(string property, string expectedType, bool? expectedNullable)
         {
-            var propertyName = char.ToLowerInvariant(property[0]) + property[1..];
+            var propertyName = property.ToCamelCase();
             var crd = _testSpecEntity.CreateCrd();
             var specProperties = crd.Spec.Versions.First().Schema.OpenAPIV3Schema.Properties["spec"];
 
@@ -105,7 +107,7 @@ public void Should_Set_The_Correct_Array_Type(string property, string expectedTy
         [InlineData(nameof(TestSpecEntitySpec.ComplexItemsDerivedList))]
         public void Should_Set_The_Correct_Complex_Array_Type(string property)
         {
-            var propertyName = char.ToLowerInvariant(property[0]) + property[1..];
+            var propertyName = property.ToCamelCase();
             var crd = _testSpecEntity.CreateCrd();
             var specProperties = crd.Spec.Versions.First().Schema.OpenAPIV3Schema.Properties["spec"];
 
@@ -352,13 +354,18 @@ public void Should_Throw_On_Not_Supported_Type()
         }
 
         [Fact]
-        public void Should_Add_GenericAdditionalPrinterColumns()
+        public void Should_Use_PropertyName_From_JsonPropertyAttribute()
         {
             var crd = _testSpecEntity.CreateCrd();
-            var apc = crd.Spec.Versions.First().AdditionalPrinterColumns;
 
-            apc.Should().NotBeNull();
-            apc.Should().ContainSingle(def => def.JsonPath == ".metadata.creationTimestamp" && def.Name == "Age");
+            var specProperties = crd.Spec.Versions.First().Schema.OpenAPIV3Schema.Properties["spec"];
+            var propertyNameFromType = nameof(TestSpecEntitySpec.PropertyWithJsonAttribute);
+            var propertyNameFromAttribute = typeof(TestSpecEntitySpec)
+                .GetProperty(propertyNameFromType)
+                ?.GetCustomAttribute<JsonPropertyAttribute>()
+                ?.PropertyName;
+            specProperties.Properties.Should().ContainKey(propertyNameFromAttribute?.ToCamelCase());
+            specProperties.Properties.Should().NotContainKey(propertyNameFromType.ToCamelCase());
         }
 
         [Fact]
@@ -383,5 +390,15 @@ public void Must_Not_Contain_Ignored_TopLevel_Properties()
             var specProperties = crd.Spec.Versions.First().Schema.OpenAPIV3Schema.Properties;
             specProperties.Should().NotContainKeys("metadata", "apiVersion", "kind");
         }
+
+        [Fact]
+        public void Should_Add_GenericAdditionalPrinterColumns()
+        {
+            var crd = _testSpecEntity.CreateCrd();
+            var apc = crd.Spec.Versions.First().AdditionalPrinterColumns;
+
+            apc.Should().NotBeNull();
+            apc.Should().ContainSingle(def => def.JsonPath == ".metadata.creationTimestamp" && def.Name == "Age");
+        }
     }
 }

tests/KubeOps.Test/TestEntities/TestSpecEntity.cs

@@ -6,6 +6,7 @@
 using k8s.Models;
 using KubeOps.Operator.Entities;
 using KubeOps.Operator.Entities.Annotations;
+using Newtonsoft.Json;
 
 namespace KubeOps.Test.TestEntities
 {
@@ -124,6 +125,9 @@ public class TestSpecEntitySpec
         [EmbeddedResource]
         public V1ConfigMap KubernetesObject { get; set; } = new V1ConfigMap();
 
+        [JsonProperty(PropertyName = "NameFromAttribute")]
+        public string PropertyWithJsonAttribute { get; set; } = string.Empty;
+
         public enum TestSpecEnum
         {
             Value1,