Added new properties and tests, updated method checks

Added `DoesAddOperator` property in `AppExtensionsReceiver.cs` and `NeonOperatorGenerateCrdsLive` in `Neon.Operator.Analyzers.targets` and `Neon.Operator.targets`. Updated `AppExtensionsGenerator.cs` to check `DoesAddOperator` instead of `IsTestProject`. `CustomResourceDefinitionGenerator.cs` now checks process name against a new array and `NeonOperatorGenerateCrdsLive` property. Added `Test_AppExtensions.cs` with tests for `UseKubernetesOperator` method invocation.

Author: marcusbooyah

src/Neon.Operator.Analyzers/Generators/AppExtensionsGenerator.cs

@@ -66,15 +66,11 @@ public Assembly OnResolveAssembly(object sender, ResolveEventArgs args)
 
         public void Execute(GeneratorExecutionContext context)
         {
-            if (context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.IsTestProject", out var isTestProject))
+            var doesAddOperator     = ((AppExtensionsReceiver)context.SyntaxReceiver)?.DoesAddOperator;
+
+            if (doesAddOperator == false)
             {
-                if (bool.TryParse(isTestProject, out var isTestProjectBool))
-                {
-                    if (isTestProjectBool == true)
-                    {
-                        return;
-                    }
-                }
+                return;
             }
 
             var metadataLoadContext = new MetadataLoadContext(context.Compilation);

src/Neon.Operator.Analyzers/Generators/CustomResourceDefinitionGenerator.cs

@@ -38,6 +38,8 @@
 using Neon.Operator.Webhooks;
 using Neon.Roslyn;
 
+using Microsoft.CodeAnalysis;
+
 using MetadataLoadContext = Neon.Roslyn.MetadataLoadContext;
 using XmlDocumentationProvider = Neon.Roslyn.XmlDocumentationProvider;
 
@@ -59,6 +61,8 @@ public class CustomResourceDefinitionGenerator : ISourceGenerator
 
         public static XmlDocumentationProvider DocumentationProvider { get; set; } = new XmlDocumentationProvider();
 
+        private static readonly string[] allowedProcesses = { "VBCSCompiler", "testhost", "dotnet" };
+
         public void Initialize(GeneratorInitializationContext context)
         {
             AppDomain.CurrentDomain.AssemblyResolve += OnResolveAssembly;
@@ -89,6 +93,32 @@ public void Execute(GeneratorExecutionContext context)
         {
             logs = new Dictionary<string, StringBuilder>();
 
+            var processName = System.Diagnostics.Process.GetCurrentProcess().MainModule.ModuleName;
+
+            if (!allowedProcesses.Contains(processName))
+            {
+                // this is a hack to disable the analyzer during live editing
+
+                if (context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.NeonOperatorGenerateCrdsLive", out var generateCrdsLive))
+                {
+                    if (bool.TryParse(generateCrdsLive, out bool generateCrdsLiveBool))
+                    {
+                        if (!generateCrdsLiveBool)
+                        {
+                            return;
+                        }
+                    }
+                    else
+                    {
+                        return;
+                    }
+                }
+                else
+                {
+                    return;
+                }
+            }
+
             if (context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.NeonOperatorGenerateCrds", out var generateCrds))
             {
                 if (bool.TryParse(generateCrds, out bool generateCrdsBool))

src/Neon.Operator.Analyzers/Receivers/AppExtensionsReceiver.cs

@@ -17,6 +17,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Linq;
 
 using Microsoft.CodeAnalysis;
@@ -27,13 +28,31 @@ namespace Neon.Operator.Analyzers.Receivers
     internal class AppExtensionsReceiver : ISyntaxReceiver
     {
         public List<ClassDeclarationSyntax> ClassesToRegister { get; } = new List<ClassDeclarationSyntax>();
+        public bool DoesAddOperator { get; private set; } = false;
+
         private static string[] classAttributes = new string[] 
         {
             "Webhook"
         };
 
         public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
         {
+            if (syntaxNode is InvocationExpressionSyntax)
+            {
+                try
+                {
+                    InvocationExpressionSyntax methodSyntax = (InvocationExpressionSyntax)syntaxNode;
+                    if (((MemberAccessExpressionSyntax)methodSyntax.Expression).Name.Identifier.ValueText == "UseKubernetesOperator")
+                    {
+                        DoesAddOperator = true;
+                    }
+                }
+                catch
+                {
+                    // pass
+                }
+            }
+
             if (syntaxNode is ClassDeclarationSyntax)
             {
                 var attributeSyntaxes = syntaxNode.DescendantNodes().OfType<AttributeSyntax>();

src/Neon.Operator.Analyzers/build/Neon.Operator.Analyzers.targets

@@ -6,6 +6,7 @@
         <CompilerVisibleProperty Include="NeonOperatorOlmOutputDir" />
         <CompilerVisibleProperty Include="NeonOperatorGenerateRbac" />
         <CompilerVisibleProperty Include="NeonOperatorGenerateCrds" />
+        <CompilerVisibleProperty Include="NeonOperatorGenerateCrdsLive" />
         <CompilerVisibleProperty Include="NeonOperatorWebhookOutputDir" />
         <CompilerVisibleProperty Include="NeonOperatorLeaderElectionDisabled" />
         <CompilerVisibleProperty Include="NeonOperatorAutoRegisterWebhooks" />

src/Neon.Operator/build/Neon.Operator.targets

@@ -6,6 +6,7 @@
         <CompilerVisibleProperty Include="NeonOperatorOlmOutputDir" />
         <CompilerVisibleProperty Include="NeonOperatorGenerateRbac" />
         <CompilerVisibleProperty Include="NeonOperatorGenerateCrds" />
+        <CompilerVisibleProperty Include="NeonOperatorGenerateCrdsLive" />
         <CompilerVisibleProperty Include="NeonOperatorWebhookOutputDir" />
         <CompilerVisibleProperty Include="NeonOperatorLeaderElectionDisabled" />
         <CompilerVisibleProperty Include="NeonOperatorAutoRegisterWebhooks" />

test/Test.Analyzers/Test_AppExtensions.cs

@@ -0,0 +1,136 @@
+// -----------------------------------------------------------------------------
+// FILE:	    TestAppExtensions.cs
+// CONTRIBUTOR: NEONFORGE Team
+// COPYRIGHT:   Copyright © 2005-2024 by NEONFORGE LLC.  All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License").
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+using System.Collections.Generic;
+using System.ComponentModel.DataAnnotations;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+using FluentAssertions;
+
+using k8s.Models;
+using Neon.IO;
+using Neon.Operator.Analyzers;
+
+using Neon.Operator.Attributes;
+
+using Neon.Roslyn.Xunit;
+
+namespace Test.Analyzers
+{
+    public class Test_AppExtensions
+    {
+        [Fact]
+        public async Task TestUseKubernetesOperator()
+        {
+            var source = @"
+using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+
+using Neon.Operator;
+
+namespace TestNamespace
+{
+    public class Startup
+    {
+        public IConfiguration Configuration { get; }
+
+        public Startup(IConfiguration configuration)
+        {
+            this.Configuration = configuration;
+        }
+
+        public void ConfigureServices(IServiceCollection services)
+        {
+            services.AddLogging(configure =>
+            {
+                configure.ClearProviders();
+                configure.AddConsole();
+            });
+
+            services.AddKubernetesOperator();
+        }
+
+        public void Configure(IApplicationBuilder app)
+        {
+            app.UseKubernetesOperator();
+        }
+    }
+}";
+            var testCompilation = new TestCompilationBuilder()
+                .AddSourceGenerator<AppExtensionsGenerator>()
+                .AddSource(source)
+                .AddAssembly(typeof(KubernetesEntityAttribute).Assembly)
+                .AddAssembly(typeof(AdditionalPrinterColumnAttribute).Assembly)
+                .Build();
+
+            testCompilation.Sources.Should().HaveCount(1);
+        }
+
+        [Fact]
+        public async Task TestDontUseKubernetesOperator()
+        {
+            var source = @"
+using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+
+using Neon.Operator;
+
+namespace TestNamespace
+{
+    public class Startup
+    {
+        public IConfiguration Configuration { get; }
+
+        public Startup(IConfiguration configuration)
+        {
+            this.Configuration = configuration;
+        }
+
+        public void ConfigureServices(IServiceCollection services)
+        {
+            services.AddLogging(configure =>
+            {
+                configure.ClearProviders();
+                configure.AddConsole();
+            });
+
+            services.AddKubernetesOperator();
+        }
+
+        public void Configure(IApplicationBuilder app)
+        {
+        }
+    }
+}";
+            var testCompilation = new TestCompilationBuilder()
+                .AddSourceGenerator<AppExtensionsGenerator>()
+                .AddSource(source)
+                .AddAssembly(typeof(KubernetesEntityAttribute).Assembly)
+                .AddAssembly(typeof(AdditionalPrinterColumnAttribute).Assembly)
+                .Build();
+
+            testCompilation.Sources.Should().BeEmpty();
+        }
+    }
+}