feat: make CompareNETObjects ComparisonConfig configurable (#395)

* Expose ComparisonConfig as an option in OperatorSettings

Fixes #364

Signed-off-by: Erin Allison <erin@eallison.us>

* Fix tests

Signed-off-by: Erin Allison <erin@eallison.us>

src/KubeOps/Operator/Builder/OperatorBuilder.cs

@@ -3,6 +3,7 @@
 using DotnetKubernetesClient;
 using k8s;
 using k8s.Models;
+using KellermanSoftware.CompareNetObjects;
 using KubeOps.Operator.Caching;
 using KubeOps.Operator.Controller;
 using KubeOps.Operator.DevOps;

src/KubeOps/Operator/Caching/ResourceCache{TEntity}.cs

@@ -13,21 +13,20 @@ namespace KubeOps.Operator.Caching;
 internal class ResourceCache<TEntity>
     where TEntity : IKubernetesObject<V1ObjectMeta>
 {
-    private const string ResourceVersion = "ResourceVersion";
-    private const string ManagedFields = "ManagedFields";
     private const string Finalizers = "Metadata.Finalizers";
     private const string Status = "Status";
 
-    private readonly CompareLogic _compare = new(
-        new() { Caching = true, AutoClearCache = false, MembersToIgnore = new() { ResourceVersion, ManagedFields }, });
+    private readonly CompareLogic _compare;
 
     private readonly ConcurrentDictionary<string, TEntity> _cache = new();
 
     private readonly ResourceCacheMetrics<TEntity> _metrics;
 
-    public ResourceCache(ResourceCacheMetrics<TEntity> metrics)
+    public ResourceCache(ResourceCacheMetrics<TEntity> metrics, OperatorSettings settings)
     {
         _metrics = metrics;
+
+        _compare = new CompareLogic(settings.CacheComparisonConfig);
     }
 
     public TEntity Get(string id) => _cache[id];

src/KubeOps/Operator/OperatorSettings.cs

@@ -2,6 +2,7 @@
 using System.Reflection;
 using System.Text.RegularExpressions;
 using DotnetKubernetesClient;
+using KellermanSoftware.CompareNetObjects;
 using KubeOps.Operator.Errors;
 using KubeOps.Operator.Serialization;
 using Microsoft.Rest.Serialization;
@@ -158,6 +159,17 @@ public sealed class OperatorSettings
     /// </summary>
     public short HttpsPort { get; set; } = 5001;
 
+    /// <summary>
+    /// The configuration used when comparing resources against each-other for caching
+    /// or other similar processing.
+    /// </summary>
+    public ComparisonConfig CacheComparisonConfig { get; set; } = new()
+    {
+        Caching = true,
+        AutoClearCache = false,
+        MembersToIgnore = new List<string> { "ResourceVersion", "ManagedFields" },
+    };
+
     internal JsonSerializerSettings SerializerSettings { get; } = new()
     {
         DateFormatHandling = DateFormatHandling.IsoDateFormat,

tests/KubeOps.Test/Operator/Caching/ResourceCache.Test.cs

@@ -10,7 +10,7 @@ namespace KubeOps.Test.Operator.Caching;
 
 public class ResourceCacheTest
 {
-    private readonly ResourceCache<TestStatusEntity> _cache = new(new(new()));
+    private readonly ResourceCache<TestStatusEntity> _cache = new(new(new()), new());
 
     [Fact]
     public void Throws_When_Not_Found()