Filter out invalid name information to generate valid hook name

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "docfx": {
-      "version": "2.75.1",
+      "version": "2.75.2",
       "commands": ["docfx"]
     }
   }

.github/workflows/dotnet-release.yml

@@ -5,6 +5,7 @@ on:
     branches:
       - main
       - release
+      - "maintenance/**"
 
 jobs:
   semantic-release:

.github/workflows/dotnet-test.yml

@@ -25,7 +25,7 @@ jobs:
         run: dotnet format --verify-no-changes
 
       - name: Create Kubernetes Cluster
-        uses: helm/kind-action@v1.8.0
+        uses: helm/kind-action@v1.9.0
 
       - name: Execute Tests
         run: dotnet test --configuration ${{ runner.debug == '1' && 'Debug' || 'Release' }}

src/Directory.Build.props

@@ -41,10 +41,10 @@
             Condition="$(MSBuildProjectExtension) == '.csproj'" />
         <PackageReference
             Include="SonarAnalyzer.CSharp"
-            Version="9.16.0.82469"
+            Version="9.19.0.84025"
             PrivateAssets="all"
             Condition="$(MSBuildProjectExtension) == '.csproj'" />
-        <PackageReference Include="Roslynator.Analyzers" Version="4.9.0" PrivateAssets="All" />
+        <PackageReference Include="Roslynator.Analyzers" Version="4.10.0" PrivateAssets="All" />
     </ItemGroup>
 
     <ItemGroup>

src/KubeOps.Cli/Generators/MutationWebhookGenerator.cs

@@ -22,9 +22,11 @@ public void Generate(ResultOutput output)
 
         foreach (var hook in webhooks)
         {
+            var names = new List<string> { hook.Metadata.SingularName, hook.Metadata.Group ?? string.Empty, hook.Metadata.Version };
+            var hookName = string.Join(".", names.Where(name => !string.IsNullOrWhiteSpace(name)));
             mutatorConfig.Webhooks.Add(new V1MutatingWebhook
             {
-                Name = $"mutate.{hook.Metadata.SingularName}.{hook.Metadata.Group}.{hook.Metadata.Version}",
+                Name = $"mutate.{hookName}",
                 MatchPolicy = "Exact",
                 AdmissionReviewVersions = new[] { "v1" },
                 SideEffects = "None",

src/KubeOps.Cli/Generators/ValidationWebhookGenerator.cs

@@ -22,9 +22,11 @@ public void Generate(ResultOutput output)
 
         foreach (var hook in webhooks)
         {
+            var names = new List<string> { hook.Metadata.SingularName, hook.Metadata.Group ?? string.Empty, hook.Metadata.Version };
+            var hookName = string.Join(".", names.Where(name => !string.IsNullOrWhiteSpace(name)));
             validatorConfig.Webhooks.Add(new V1ValidatingWebhook
             {
-                Name = $"validate.{hook.Metadata.SingularName}.{hook.Metadata.Group}.{hook.Metadata.Version}",
+                Name = $"validate.{hookName}",
                 MatchPolicy = "Exact",
                 AdmissionReviewVersions = new[] { "v1" },
                 SideEffects = "None",

src/KubeOps.Cli/KubeOps.Cli.csproj

@@ -18,8 +18,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="BouncyCastle.Cryptography" Version="2.2.1" />
-        <PackageReference Include="Microsoft.Build.Locator" Version="1.6.10" />
+        <PackageReference Include="BouncyCastle.Cryptography" Version="2.3.0" />
+        <PackageReference Include="Microsoft.Build.Locator" Version="1.7.1" />
         <PackageReference Include="Microsoft.CodeAnalysis" Version="4.8.0" />
         <PackageReference Include="Microsoft.CodeAnalysis.Common" Version="4.8.0" />
         <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" />

src/KubeOps.Operator.Web/LocalTunnel/DevelopmentTunnelService.cs

@@ -47,26 +47,31 @@ private async Task RegisterValidators(Uri uri)
             .ValidationWebhooks
             .Select(t => (HookTypeName: t.BaseType!.GenericTypeArguments[0].Name.ToLowerInvariant(),
                 Entities.ToEntityMetadata(t.BaseType!.GenericTypeArguments[0]).Metadata))
-            .Select(hook => new V1ValidatingWebhook
+            .Select(hook =>
             {
-                Name = $"validate.{hook.Metadata.SingularName}.{hook.Metadata.Group}.{hook.Metadata.Version}",
-                MatchPolicy = "Exact",
-                AdmissionReviewVersions = new[] { "v1" },
-                SideEffects = "None",
-                Rules = new[]
+                var names = new List<string> { hook.Metadata.SingularName, hook.Metadata.Group ?? string.Empty, hook.Metadata.Version };
+                var hookName = string.Join(".", names.Where(name => !string.IsNullOrWhiteSpace(name)));
+                return new V1ValidatingWebhook
                 {
-                    new V1RuleWithOperations
+                    Name = $"validate.{hookName}",
+                    MatchPolicy = "Exact",
+                    AdmissionReviewVersions = new[] { "v1" },
+                    SideEffects = "None",
+                    Rules = new[]
                     {
-                        Operations = new[] { "*" },
-                        Resources = new[] { hook.Metadata.PluralName },
-                        ApiGroups = new[] { hook.Metadata.Group },
-                        ApiVersions = new[] { hook.Metadata.Version },
+                        new V1RuleWithOperations
+                        {
+                            Operations = new[] { "*" },
+                            Resources = new[] { hook.Metadata.PluralName },
+                            ApiGroups = new[] { hook.Metadata.Group },
+                            ApiVersions = new[] { hook.Metadata.Version },
+                        },
                     },
-                },
-                ClientConfig = new Admissionregistrationv1WebhookClientConfig
-                {
-                    Url = $"{uri}validate/{hook.HookTypeName}",
-                },
+                    ClientConfig = new Admissionregistrationv1WebhookClientConfig
+                    {
+                        Url = $"{uri}validate/{hook.HookTypeName}",
+                    },
+                };
             });
 
         var validatorConfig = new V1ValidatingWebhookConfiguration(
@@ -85,26 +90,31 @@ private async Task RegisterMutators(Uri uri)
             .MutationWebhooks
             .Select(t => (HookTypeName: t.BaseType!.GenericTypeArguments[0].Name.ToLowerInvariant(),
                 Entities.ToEntityMetadata(t.BaseType!.GenericTypeArguments[0]).Metadata))
-            .Select(hook => new V1MutatingWebhook
+            .Select(hook =>
             {
-                Name = $"mutate.{hook.Metadata.SingularName}.{hook.Metadata.Group}.{hook.Metadata.Version}",
-                MatchPolicy = "Exact",
-                AdmissionReviewVersions = new[] { "v1" },
-                SideEffects = "None",
-                Rules = new[]
+                var names = new List<string> { hook.Metadata.SingularName, hook.Metadata.Group ?? string.Empty, hook.Metadata.Version };
+                var hookName = string.Join(".", names.Where(name => !string.IsNullOrWhiteSpace(name)));
+                return new V1MutatingWebhook
                 {
-                    new V1RuleWithOperations
+                    Name = $"mutate.{hookName}",
+                    MatchPolicy = "Exact",
+                    AdmissionReviewVersions = new[] { "v1" },
+                    SideEffects = "None",
+                    Rules = new[]
                     {
-                        Operations = new[] { "*" },
-                        Resources = new[] { hook.Metadata.PluralName },
-                        ApiGroups = new[] { hook.Metadata.Group },
-                        ApiVersions = new[] { hook.Metadata.Version },
+                        new V1RuleWithOperations
+                        {
+                            Operations = new[] { "*" },
+                            Resources = new[] { hook.Metadata.PluralName },
+                            ApiGroups = new[] { hook.Metadata.Group },
+                            ApiVersions = new[] { hook.Metadata.Version },
+                        },
                     },
-                },
-                ClientConfig = new Admissionregistrationv1WebhookClientConfig
-                {
-                    Url = $"{uri}mutate/{hook.HookTypeName}",
-                },
+                    ClientConfig = new Admissionregistrationv1WebhookClientConfig
+                    {
+                        Url = $"{uri}mutate/{hook.HookTypeName}",
+                    },
+                };
             });
 
         var mutatorConfig = new V1MutatingWebhookConfiguration(

src/KubeOps.Operator/Watcher/ResourceWatcher{TEntity}.cs

@@ -111,7 +111,6 @@ private async void OnEntityRequeue(object? sender, (string Name, string? Namespa
             return;
         }
 
-        _entityCache.TryRemove(entity.Uid(), out _);
         await ReconcileModification(entity);
     }
 
@@ -173,16 +172,32 @@ private async void OnEvent(WatchEventType type, TEntity entity)
             entity.Name(),
             _lastResourceVersion);
 
-        _queue.RemoveIfQueued(entity);
-
         try
         {
             switch (type)
             {
-                case WatchEventType.Added or WatchEventType.Modified:
+                case WatchEventType.Added:
+                    _entityCache.TryAdd(entity.Uid(), entity.Generation() ?? 0);
+                    await ReconcileModification(entity);
+                    break;
+                case WatchEventType.Modified:
                     switch (entity)
                     {
                         case { Metadata.DeletionTimestamp: null }:
+                            _entityCache.TryGetValue(entity.Uid(), out var cachedGeneration);
+
+                            // Check if entity spec has changed through "Generation" value increment. Skip reconcile if not changed.
+                            if (entity.Generation() <= cachedGeneration)
+                            {
+                                _logger.LogDebug(
+                                    """Entity "{kind}/{name}" modification did not modify generation. Skip event.""",
+                                    entity.Kind,
+                                    entity.Name());
+                                return;
+                            }
+
+                            // update cached generation since generation now changed
+                            _entityCache.TryUpdate(entity.Uid(), entity.Generation() ?? 1, cachedGeneration);
                             await ReconcileModification(entity);
                             break;
                         case { Metadata: { DeletionTimestamp: not null, Finalizers.Count: > 0 } }:
@@ -216,31 +231,25 @@ private async void OnEvent(WatchEventType type, TEntity entity)
 
     private async Task ReconcileModification(TEntity entity)
     {
-        var latestGeneration = _entityCache.GetOrAdd(entity.Uid(), 0);
-        if (entity.Generation() <= latestGeneration)
-        {
-            _logger.LogDebug(
-                """Entity "{kind}/{name}" modification did not modify generation. Skip event.""",
-                entity.Kind,
-                entity.Name());
-            return;
-        }
-
-        _entityCache.TryUpdate(entity.Uid(), entity.Generation() ?? 1, latestGeneration);
+        // Re-queue should requested in the controller reconcile method. Invalidate any existing queues.
+        _queue.RemoveIfQueued(entity);
         await using var scope = _provider.CreateAsyncScope();
         var controller = scope.ServiceProvider.GetRequiredService<IEntityController<TEntity>>();
         await controller.ReconcileAsync(entity);
     }
 
     private async Task ReconcileDeletion(TEntity entity)
     {
+        _queue.RemoveIfQueued(entity);
+        _entityCache.TryRemove(entity.Uid(), out _);
         await using var scope = _provider.CreateAsyncScope();
         var controller = scope.ServiceProvider.GetRequiredService<IEntityController<TEntity>>();
         await controller.DeletedAsync(entity);
     }
 
     private async Task ReconcileFinalizer(TEntity entity)
     {
+        _queue.RemoveIfQueued(entity);
         var pendingFinalizer = entity.Finalizers();
         if (_finalizers.Value.Find(reg =>
                 reg.EntityType == entity.GetType() && pendingFinalizer.Contains(reg.Identifier)) is not

test/Directory.Build.props

@@ -10,7 +10,7 @@
 
     <ItemGroup>
         <PackageReference Include="FluentAssertions" Version="6.12.0" />
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
         <PackageReference Include="xunit" Version="2.6.6" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

test/KubeOps.Operator.Test/Controller/CancelEntityRequeue.Integration.Test.cs

@@ -34,6 +34,20 @@ public async Task Should_Cancel_Requeue_If_New_Event_Fires()
         Services.GetRequiredService<TimedEntityQueue<V1OperatorIntegrationTestEntity>>().Count.Should().Be(0);
     }
 
+    [Fact]
+    public async Task Should_Not_Affect_Queues_If_Only_Status_Updated()
+    {
+        _mock.TargetInvocationCount = 1;
+        var result = await _client.CreateAsync(new V1OperatorIntegrationTestEntity("test-entity", "username", _ns.Namespace));
+        result.Status.Status = "changed";
+        await _client.UpdateStatusAsync(result);
+        await _mock.WaitForInvocations;
+
+        _mock.Invocations.Count.Should().Be(1);
+        Services.GetRequiredService<TimedEntityQueue<V1OperatorIntegrationTestEntity>>().Count.Should().Be(1);
+
+    }
+
     public override async Task InitializeAsync()
     {
         await base.InitializeAsync();

test/KubeOps.Operator.Test/Controller/EntityController.Integration.Test.cs

@@ -57,6 +57,27 @@ void Check(int idx, string username)
         }
     }
 
+    [Fact]
+    public async Task Should_Not_Call_Reconcile_When_Only_Entity_Status_Changed()
+    {
+        _mock.TargetInvocationCount = 1;
+
+        var result =
+            await _client.CreateAsync(new V1OperatorIntegrationTestEntity("test-entity", "username", _ns.Namespace));
+        result.Status.Status = "changed";
+        // Update or UpdateStatus do not call Reconcile
+        await _client.UpdateAsync(result);
+        await _client.UpdateStatusAsync(result);
+        await _mock.WaitForInvocations;
+
+        _mock.Invocations.Count.Should().Be(1);
+
+        (string method, V1OperatorIntegrationTestEntity entity) = _mock.Invocations.Single();
+        method.Should().Be("ReconcileAsync");
+        entity.Should().BeOfType<V1OperatorIntegrationTestEntity>();
+        entity.Spec.Username.Should().Be("username");
+    }
+
     [Fact]
     public async Task Should_Call_Delete_For_Deleted_Entity()
     {

test/KubeOps.Operator.Test/Controller/EntityRequeue.Integration.Test.cs

@@ -35,6 +35,30 @@ public async Task Should_Requeue_Entity_And_Reconcile()
         _mock.Invocations.Count.Should().Be(5);
     }
 
+    [Fact]
+    public async Task Should_Separately_And_Reliably_Requeue_And_Reconcile_Multiple_Entities_In_Parallel()
+    {
+        _mock.TargetInvocationCount = 100;
+        await _client.CreateAsync(new V1OperatorIntegrationTestEntity("test-entity1", "username", _ns.Namespace));
+        await _client.CreateAsync(new V1OperatorIntegrationTestEntity("test-entity2", "username", _ns.Namespace));
+        await _client.CreateAsync(new V1OperatorIntegrationTestEntity("test-entity3", "username", _ns.Namespace));
+        await _client.CreateAsync(new V1OperatorIntegrationTestEntity("test-entity4", "username", _ns.Namespace));
+        await _mock.WaitForInvocations;
+
+        // Expecting invocations, but since in parallel, there is a possibility to for target hit while other are in flight.
+        _mock.Invocations.Count.Should().BeGreaterOrEqualTo(100).And.BeLessThan(105);
+        var invocationsGroupedById = _mock.Invocations.GroupBy(item => item.Entity.Metadata.Uid).ToList();
+        invocationsGroupedById.Count.Should().Be(4);
+        var invocationDistributions = invocationsGroupedById
+            .Select(g => (double)g.Count() / _mock.Invocations.Count * 100)
+            .ToList();
+        invocationDistributions
+            .All(p => p is >= 15 and <= 35) // Check that invocations are reasonably distributed
+            .Should()
+            .BeTrue($"each entity invocation proportion should be within the specified range of total invocations, " +
+                    $"but instead the distributions were: '{string.Join(", ", invocationDistributions)}'");
+    }
+
     public override async Task InitializeAsync()
     {
         await base.InitializeAsync();

test/KubeOps.Operator.Test/KubeOps.Operator.Test.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
     <ItemGroup>
         <PackageReference Include="KubernetesClient" Version="12.1.1"/>
-        <PackageReference Include="Microsoft.Build.Locator" Version="1.6.10"/>
+        <PackageReference Include="Microsoft.Build.Locator" Version="1.7.1"/>
         <PackageReference Include="Microsoft.CodeAnalysis" Version="4.8.0"/>
         <PackageReference Include="Microsoft.CodeAnalysis.Common" Version="4.8.0"/>
         <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0"/>

test/KubeOps.Operator.Web.Test/KubeOps.Operator.Web.Test.csproj

@@ -2,7 +2,7 @@
     <ItemGroup>
         <PackageReference Include="KubernetesClient" Version="12.1.1"/>
         <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="8.0.1"/>
-        <PackageReference Include="Microsoft.Build.Locator" Version="1.6.10"/>
+        <PackageReference Include="Microsoft.Build.Locator" Version="1.7.1"/>
         <PackageReference Include="Microsoft.CodeAnalysis" Version="4.8.0"/>
         <PackageReference Include="Microsoft.CodeAnalysis.Common" Version="4.8.0"/>
         <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0"/>

test/KubeOps.Operator.Web.Test/TestApp/TestServiceMutationWebhook.cs

@@ -0,0 +1,8 @@
+using k8s.Models;
+
+using KubeOps.Operator.Web.Webhooks.Admission.Mutation;
+
+namespace KubeOps.Operator.Web.Test.TestApp;
+
+[MutationWebhook(typeof(V1Service))]
+public class TestServiceMutationWebhook : MutationWebhook<V1Service>;

test/KubeOps.Operator.Web.Test/TestApp/TestServiceValidationWebhook.cs

@@ -0,0 +1,8 @@
+using k8s.Models;
+
+using KubeOps.Operator.Web.Webhooks.Admission.Validation;
+
+namespace KubeOps.Operator.Web.Test.TestApp;
+
+[ValidationWebhook(typeof(V1Service))]
+public class TestServiceValidationWebhook : ValidationWebhook<V1Service>;

test/KubeOps.Transpiler.Test/KubeOps.Transpiler.Test.csproj

@@ -2,7 +2,7 @@
 
     <ItemGroup>
         <PackageReference Include="KubernetesClient" Version="12.1.1"/>
-        <PackageReference Include="Microsoft.Build.Locator" Version="1.6.10" />
+        <PackageReference Include="Microsoft.Build.Locator" Version="1.7.1" />
         <PackageReference Include="Microsoft.CodeAnalysis" Version="4.8.0" />
         <PackageReference Include="Microsoft.CodeAnalysis.Common" Version="4.8.0" />
         <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" />