Make ATS analyzer packaged in Aspire.Hosting and opt-in

Directory.Build.props

@@ -26,6 +26,7 @@
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
     <UsePublicApiAnalyzers>true</UsePublicApiAnalyzers>
+    <EnableAspireHostingAnalyzers>true</EnableAspireHostingAnalyzers>
     <!-- Redirect test logs into a subfolder -->
     <TestResultsLogDir>$([MSBuild]::NormalizeDirectory('$(ArtifactsLogDir)', 'TestLogs'))</TestResultsLogDir>
     <!-- We don't want to use the workload for AppHost projects in this repo -->

playground/Directory.Build.targets

@@ -13,7 +13,7 @@
     <ProjectReference Include="$(RepoRoot)src\Aspire.Dashboard\Aspire.Dashboard.csproj" />
   </ItemGroup>
 
-  <ItemGroup Condition="'$(IsAspireHost)' == 'true' and '$(RepoRoot)' != '' and '$(SkipAspireHostingAnalyzersReference)' != 'true'">
+  <ItemGroup Condition="'$(IsAspireHost)' == 'true' and '$(RepoRoot)' != '' and '$(EnableAspireHostingAnalyzers)' == 'true' and '$(SkipAspireHostingAnalyzersReference)' != 'true'">
     <ProjectReference Include="$(MSBuildThisFileDirectory)..\src\Aspire.Hosting.Analyzers\Aspire.Hosting.Analyzers.csproj" IsAspireProjectResource="false"
                       PrivateAssets="all"
                       ReferenceOutputAssembly="false"

src/Aspire.Hosting.AppHost/Aspire.Hosting.AppHost.csproj

@@ -52,7 +52,7 @@
     <Error Condition="'$(AspireHostingAnalyzerFile)' == ''" Text="Could not find Aspire.Hosting.Analyzers.dll." />
 
     <ItemGroup>
-      <None Include="$(AspireHostingAnalyzerFile)" Pack="True" PackagePath="analyzers/dotnet/cs" />
+      <None Include="$(AspireHostingAnalyzerFile)" Pack="True" PackagePath="build\" />
     </ItemGroup>
   </Target>
 

src/Aspire.Hosting.AppHost/build/Aspire.Hosting.AppHost.in.targets

@@ -3,6 +3,7 @@
   <PropertyGroup>
     <!-- Similar to ASP.NET Core and Worker apps, set the default CWD of orchestrator projects to be the project directory. -->
     <RunWorkingDirectory Condition=" '$(RunWorkingDirectory)' == '' and '$(EnableDefaultRunWorkingDirectory)' != 'false' ">$(MSBuildProjectDirectory)</RunWorkingDirectory>
+    <EnableAspireHostingAnalyzers Condition="'$(EnableAspireHostingAnalyzers)' == ''">false</EnableAspireHostingAnalyzers>
     <AspireGeneratedClassesVisibility Condition="'$(AspireGeneratedClassesVisibility)' == ''">public</AspireGeneratedClassesVisibility>
     <_AspireIntermediatePath>$(IntermediateOutputPath)Aspire\</_AspireIntermediatePath>
     <_GeneratedClassNameFixupRegex>(((?&lt;=\.)|^)(?=\d)|\W)</_GeneratedClassNameFixupRegex>
@@ -11,6 +12,7 @@
     <_AspireTasksTfm Condition="'$(MSBuildRuntimeType)' == 'Core'">net8.0</_AspireTasksTfm>
     <_AspireTasksTfm Condition="'$(MSBuildRuntimeType)' != 'Core'">net472</_AspireTasksTfm>
     <_AspireTasksAssembly Condition="'$(_AspireTasksAssembly)' == ''">$(MSBuildThisFileDirectory)..\tools\$(_AspireTasksTfm)\Aspire.Hosting.Tasks.dll</_AspireTasksAssembly>
+    <_AspireHostingAnalyzerAssembly Condition="'$(_AspireHostingAnalyzerAssembly)' == ''">$(MSBuildThisFileDirectory)Aspire.Hosting.Analyzers.dll</_AspireHostingAnalyzerAssembly>
   </PropertyGroup>
 
   <!-- Use TaskHostFactory when running in the repo so the Aspire.Hosting.Tasks.dll assembly is not locked. -->
@@ -22,6 +24,10 @@
     <ProjectCapability Include="Aspire_@VERSION@" Condition=" '$(IsAspireHost)' == 'true' " />
   </ItemGroup>
 
+  <ItemGroup Condition="'$(IsAspireHost)' == 'true' and '$(EnableAspireHostingAnalyzers)' == 'true'">
+    <Analyzer Include="$(_AspireHostingAnalyzerAssembly)" Condition="Exists('$(_AspireHostingAnalyzerAssembly)')" />
+  </ItemGroup>
+
   <ItemGroup>
     <JsonSchemaSegment Include="$(MSBuildThisFileDirectory)..\AspireAppHostConfiguration.json"
                        FilePathPattern="appsettings\..*json" />

tests/Aspire.Hosting.Tests/MSBuildTests.cs

@@ -139,7 +139,12 @@ await Verify(new
             });
     }
 
-    private static void CreateDirectoryBuildFiles(string basePath, string repoRoot)
+    private static void CreateDirectoryBuildFiles(
+        string basePath,
+        string repoRoot,
+        bool enableAspireHostingAnalyzers = false,
+        bool useAnalyzerProjectReference = false,
+        string? analyzerAssemblyPath = null)
     {
 #if DEBUG
         var config = "Debug";
@@ -151,7 +156,9 @@ private static void CreateDirectoryBuildFiles(string basePath, string repoRoot)
         $"""
         <Project>
           <PropertyGroup>
+            <RepoRoot>{repoRoot}\</RepoRoot>
             <SkipAspireWorkloadManifest>true</SkipAspireWorkloadManifest>
+            <EnableAspireHostingAnalyzers>{enableAspireHostingAnalyzers.ToString().ToLowerInvariant()}</EnableAspireHostingAnalyzers>
           </PropertyGroup>
 
           <Import Project="{repoRoot}\src\Aspire.Hosting.AppHost\build\Aspire.Hosting.AppHost.props" />
@@ -162,8 +169,18 @@ private static void CreateDirectoryBuildFiles(string basePath, string repoRoot)
         <Project>
           <PropertyGroup>
             <_AspireTasksAssembly>{repoRoot}\artifacts\bin\Aspire.Hosting.Tasks\{config}\net8.0\Aspire.Hosting.Tasks.dll</_AspireTasksAssembly>
+            <_AspireHostingAnalyzerAssembly Condition="'$(EnableAspireHostingAnalyzers)' == 'true' and '{analyzerAssemblyPath}' != ''">{analyzerAssemblyPath}</_AspireHostingAnalyzerAssembly>
           </PropertyGroup>
 
+          <ItemGroup Condition="'$(EnableAspireHostingAnalyzers)' == 'true' and '{useAnalyzerProjectReference.ToString().ToLowerInvariant()}' == 'true'">
+            <ProjectReference Include="{repoRoot}\src\Aspire.Hosting.Analyzers\Aspire.Hosting.Analyzers.csproj"
+                              IsAspireProjectResource="false"
+                              PrivateAssets="all"
+                              ReferenceOutputAssembly="false"
+                              OutputItemType="Analyzer"
+                              SetTargetFramework="TargetFramework=netstandard2.0" />
+          </ItemGroup>
+
           <Import Project="{repoRoot}\src\Aspire.Hosting.AppHost\build\Aspire.Hosting.AppHost.in.targets" />
           <Import Project="{repoRoot}\src\Aspire.AppHost.Sdk\SDK\Sdk.in.targets" />
         </Project>
@@ -372,6 +389,194 @@ the Aspire.AppHost.SDK targets that will automatically add these references to p
         Assert.Contains("warning ASPIRE004", output);
     }
 
+    [Fact]
+    public void AspireHostingAnalyzersAreDisabledByDefault()
+    {
+        var repoRoot = MSBuildUtils.GetRepoRoot();
+        using var tempDirectory = new TestTempDirectory();
+
+        var appHostDirectory = Path.Combine(tempDirectory.Path, "AppHost");
+        Directory.CreateDirectory(appHostDirectory);
+
+        File.WriteAllText(Path.Combine(appHostDirectory, "AppHost.csproj"),
+            $"""
+            <Project Sdk="Microsoft.NET.Sdk">
+
+              <PropertyGroup>
+                <OutputType>Exe</OutputType>
+                <TargetFramework>net8.0</TargetFramework>
+                <ImplicitUsings>enable</ImplicitUsings>
+                <Nullable>enable</Nullable>
+                <IsAspireHost>true</IsAspireHost>
+
+                <!--
+                  Test applications have their own way of referencing Aspire.Hosting.AppHost, as well as DCP and Dashboard, so we disable
+                  the Aspire.AppHost.SDK targets that will automatically add these references to projects.
+                -->
+                <SkipAddAspireDefaultReferences Condition="'$(TestsRunningOutsideOfRepo)' != 'true'">true</SkipAddAspireDefaultReferences>
+                <AspireHostingSDKVersion>9.0.0</AspireHostingSDKVersion>
+                <_AspireUseTaskHostFactory>true</_AspireUseTaskHostFactory>
+              </PropertyGroup>
+
+              <ItemGroup>
+                <ProjectReference Include="{repoRoot}\src\Aspire.Hosting.AppHost\Aspire.Hosting.AppHost.csproj" IsAspireProjectResource="false" />
+              </ItemGroup>
+
+            </Project>
+            """);
+
+        File.WriteAllText(Path.Combine(appHostDirectory, "AppHost.cs"),
+            """
+            using Aspire.Hosting;
+
+            var builder = DistributedApplication.CreateBuilder(args);
+            builder.AddCustomResource();
+            builder.Build().Run();
+
+            public static class CustomResourceExtensions
+            {
+                public static IDistributedApplicationBuilder AddCustomResource(this IDistributedApplicationBuilder builder)
+                {
+                    return builder;
+                }
+            }
+            """);
+
+        CreateDirectoryBuildFiles(appHostDirectory, repoRoot);
+
+        var output = BuildProject(appHostDirectory);
+
+        Assert.DoesNotContain("warning ASPIRE014", output);
+    }
+
+    [Fact]
+    public void AspireHostingAnalyzersCanBeEnabledWithMsBuildProperty()
+    {
+        var repoRoot = MSBuildUtils.GetRepoRoot();
+        using var tempDirectory = new TestTempDirectory();
+
+        var appHostDirectory = Path.Combine(tempDirectory.Path, "AppHost");
+        Directory.CreateDirectory(appHostDirectory);
+
+        File.WriteAllText(Path.Combine(appHostDirectory, "AppHost.csproj"),
+            $"""
+            <Project Sdk="Microsoft.NET.Sdk">
+
+              <PropertyGroup>
+                <OutputType>Exe</OutputType>
+                <TargetFramework>net8.0</TargetFramework>
+                <ImplicitUsings>enable</ImplicitUsings>
+                <Nullable>enable</Nullable>
+                <IsAspireHost>true</IsAspireHost>
+
+                <!--
+                  Test applications have their own way of referencing Aspire.Hosting.AppHost, as well as DCP and Dashboard, so we disable
+                  the Aspire.AppHost.SDK targets that will automatically add these references to projects.
+                -->
+                <SkipAddAspireDefaultReferences Condition="'$(TestsRunningOutsideOfRepo)' != 'true'">true</SkipAddAspireDefaultReferences>
+                <AspireHostingSDKVersion>9.0.0</AspireHostingSDKVersion>
+                <_AspireUseTaskHostFactory>true</_AspireUseTaskHostFactory>
+              </PropertyGroup>
+
+              <ItemGroup>
+                <ProjectReference Include="{repoRoot}\src\Aspire.Hosting.AppHost\Aspire.Hosting.AppHost.csproj" IsAspireProjectResource="false" />
+              </ItemGroup>
+
+            </Project>
+            """);
+
+        File.WriteAllText(Path.Combine(appHostDirectory, "AppHost.cs"),
+            """
+            using Aspire.Hosting;
+
+            var builder = DistributedApplication.CreateBuilder(args);
+            builder.AddCustomResource();
+            builder.Build().Run();
+
+            public static class CustomResourceExtensions
+            {
+                public static IDistributedApplicationBuilder AddCustomResource(this IDistributedApplicationBuilder builder)
+                {
+                    return builder;
+                }
+            }
+            """);
+
+        CreateDirectoryBuildFiles(appHostDirectory, repoRoot, enableAspireHostingAnalyzers: true, useAnalyzerProjectReference: true);
+
+        var output = BuildProject(appHostDirectory);
+
+        Assert.Contains("warning ASPIRE014", output);
+    }
+
+    [Fact]
+    public void AspireHostingAnalyzersCanBeEnabledWhenRepoRootIsSet()
+    {
+        var repoRoot = MSBuildUtils.GetRepoRoot();
+        using var tempDirectory = new TestTempDirectory();
+
+#if DEBUG
+        var config = "Debug";
+#else
+        var config = "Release";
+#endif
+
+        var appHostDirectory = Path.Combine(tempDirectory.Path, "AppHost");
+        Directory.CreateDirectory(appHostDirectory);
+
+        File.WriteAllText(Path.Combine(appHostDirectory, "AppHost.csproj"),
+            $"""
+            <Project Sdk="Microsoft.NET.Sdk">
+
+              <PropertyGroup>
+                <OutputType>Exe</OutputType>
+                <TargetFramework>net8.0</TargetFramework>
+                <ImplicitUsings>enable</ImplicitUsings>
+                <Nullable>enable</Nullable>
+                <IsAspireHost>true</IsAspireHost>
+
+                <!--
+                  Test applications have their own way of referencing Aspire.Hosting.AppHost, as well as DCP and Dashboard, so we disable
+                  the Aspire.AppHost.SDK targets that will automatically add these references to projects.
+                -->
+                <SkipAddAspireDefaultReferences Condition="'$(TestsRunningOutsideOfRepo)' != 'true'">true</SkipAddAspireDefaultReferences>
+                <AspireHostingSDKVersion>9.0.0</AspireHostingSDKVersion>
+                <_AspireUseTaskHostFactory>true</_AspireUseTaskHostFactory>
+              </PropertyGroup>
+
+              <ItemGroup>
+                <ProjectReference Include="{repoRoot}\src\Aspire.Hosting.AppHost\Aspire.Hosting.AppHost.csproj" IsAspireProjectResource="false" />
+              </ItemGroup>
+
+            </Project>
+            """);
+
+        File.WriteAllText(Path.Combine(appHostDirectory, "AppHost.cs"),
+            """
+            using Aspire.Hosting;
+
+            var builder = DistributedApplication.CreateBuilder(args);
+            builder.AddCustomResource();
+            builder.Build().Run();
+
+            public static class CustomResourceExtensions
+            {
+                public static IDistributedApplicationBuilder AddCustomResource(this IDistributedApplicationBuilder builder)
+                {
+                    return builder;
+                }
+            }
+            """);
+
+        var analyzerAssemblyPath = Path.Combine(repoRoot, "artifacts", "bin", "Aspire.Hosting.Analyzers", config, "netstandard2.0", "Aspire.Hosting.Analyzers.dll");
+
+        CreateDirectoryBuildFiles(appHostDirectory, repoRoot, enableAspireHostingAnalyzers: true, analyzerAssemblyPath: analyzerAssemblyPath);
+
+        var output = BuildProject(appHostDirectory);
+
+        Assert.Contains("warning ASPIRE014", output);
+    }
+
     /// <summary>
     /// Tests that when GenerateAssemblyInfo is set to false, a build error is emitted.
     /// </summary>