BuildCheck does not run on restore

src/Build.UnitTests/BackEnd/MockLoggingService.cs

@@ -496,7 +496,7 @@ public BuildEventContext CreateProjectCacheBuildEventContext(int submissionId, i
             => new BuildEventContext(0, 0, 0, 0, 0, 0, 0);
 
         /// <inheritdoc />
-        public void LogProjectEvaluationStarted(BuildEventContext eventContext, string projectFile)
+        public void LogProjectEvaluationStarted(BuildEventContext eventContext, string projectFile, bool isRestore)
         {
         }
 

src/Build/BackEnd/Components/Logging/EvaluationLoggingContext.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections;
+using System.Collections.Generic;
 using Microsoft.Build.BackEnd.Logging;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Framework.Profiler;
@@ -27,9 +28,9 @@ public EvaluationLoggingContext(ILoggingService loggingService, BuildEventContex
             IsValid = true;
         }
 
-        public void LogProjectEvaluationStarted()
+        public void LogProjectEvaluationStarted(bool isRestore)
         {
-            LoggingService.LogProjectEvaluationStarted(BuildEventContext, _projectFile);
+            LoggingService.LogProjectEvaluationStarted(BuildEventContext, _projectFile, isRestore);
         }
 
         /// <summary>

src/Build/BackEnd/Components/Logging/ILoggingService.cs

@@ -485,8 +485,9 @@ MessageImportance MinimumRequiredMessageImportance
         /// </summary>
         /// <param name="eventContext">The event context to use for logging</param>
         /// <param name="projectFile">Project file being built</param>
+        /// <param name="isRestore">Something for now</param>
         /// <returns>The evaluation event context for the project.</returns>
-        void LogProjectEvaluationStarted(BuildEventContext eventContext, string projectFile);
+        void LogProjectEvaluationStarted(BuildEventContext eventContext, string projectFile, bool isRestore);
 
         /// <summary>
         /// Logs that a project evaluation has finished

src/Build/BackEnd/Components/Logging/LoggingServiceLogMethods.cs

@@ -444,14 +444,15 @@ public BuildEventContext CreateProjectCacheBuildEventContext(
         }
 
         /// <inheritdoc />
-        public void LogProjectEvaluationStarted(BuildEventContext projectEvaluationEventContext, string projectFile)
+        public void LogProjectEvaluationStarted(BuildEventContext projectEvaluationEventContext, string projectFile, bool isRestore)
         {
             ProjectEvaluationStartedEventArgs evaluationEvent =
                 new ProjectEvaluationStartedEventArgs(ResourceUtilities.GetResourceString("EvaluationStarted"),
                     projectFile)
                 {
                     BuildEventContext = projectEvaluationEventContext,
-                    ProjectFile = projectFile
+                    ProjectFile = projectFile,
+                    IsRestore = isRestore
                 };
 
             ProcessLoggingEvent(evaluationEvent);

src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs

@@ -1105,9 +1105,9 @@ private async Task<BuildResult> BuildProject()
             ErrorUtilities.VerifyThrow(_targetBuilder != null, "Target builder is null");
 
             // We consider this the entrypoint for the project build for purposes of BuildCheck processing 
-
-            var buildCheckManager = (_componentHost.GetComponent(BuildComponentType.BuildCheckManagerProvider) as IBuildCheckManagerProvider)!.Instance;
-            buildCheckManager.SetDataSource(BuildCheckDataSource.BuildExecution);
+            var propertyEntry = _requestEntry.RequestConfiguration.GlobalProperties[MSBuildConstants.MSBuildIsRestoring];
+            IBuildCheckManager buildCheckManager = propertyEntry is not null ? null : (_componentHost.GetComponent(BuildComponentType.BuildCheckManagerProvider) as IBuildCheckManagerProvider)!.Instance;
+            buildCheckManager?.SetDataSource(BuildCheckDataSource.BuildExecution);
 
             // Make sure it is null before loading the configuration into the request, because if there is a problem
             // we do not wand to have an invalid projectLoggingContext floating around. Also if this is null the error will be
@@ -1121,10 +1121,12 @@ private async Task<BuildResult> BuildProject()
                 // Load the project
                 if (!_requestEntry.RequestConfiguration.IsLoaded)
                 {
-                    buildCheckManager.StartProjectEvaluation(
+
+                    buildCheckManager?.StartProjectEvaluation(
                         BuildCheckDataSource.BuildExecution,
                         _requestEntry.Request.ParentBuildEventContext,
                         _requestEntry.RequestConfiguration.ProjectFullPath);
+
 
                     _requestEntry.RequestConfiguration.LoadProjectIntoConfiguration(
                         _componentHost,
@@ -1146,13 +1148,13 @@ private async Task<BuildResult> BuildProject()
             }
             finally
             {
-                buildCheckManager.EndProjectEvaluation(
+                buildCheckManager?.EndProjectEvaluation(
                     BuildCheckDataSource.BuildExecution,
                     _requestEntry.Request.ParentBuildEventContext);
             }
 
             _projectLoggingContext = _nodeLoggingContext.LogProjectStarted(_requestEntry);
-            buildCheckManager.StartProjectRequest(
+            buildCheckManager?.StartProjectRequest(
                 BuildCheckDataSource.BuildExecution,
                 _requestEntry.Request.ParentBuildEventContext);
 
@@ -1223,7 +1225,7 @@ private async Task<BuildResult> BuildProject()
             }
             finally
             {
-                buildCheckManager.EndProjectRequest(
+                buildCheckManager?.EndProjectRequest(
                     BuildCheckDataSource.BuildExecution,
                     _requestEntry.Request.ParentBuildEventContext);
             }

src/Build/BuildCheck/Infrastructure/BuildCheckConnectorLogger.cs

@@ -8,6 +8,7 @@
 using Microsoft.Build.BuildCheck.Acquisition;
 using Microsoft.Build.Experimental.BuildCheck;
 using Microsoft.Build.Framework;
+using Microsoft.Build.Shared;
 using static Microsoft.Build.BuildCheck.Infrastructure.BuildCheckManagerProvider;
 
 namespace Microsoft.Build.BuildCheck.Infrastructure;
@@ -31,6 +32,8 @@ internal BuildCheckConnectorLogger(
 
     public string? Parameters { get; set; }
 
+    private bool isRestore = false;
+
     public void Initialize(IEventSource eventSource)
     {
         eventSource.AnyEventRaised += EventSource_AnyEventRaised;
@@ -48,6 +51,11 @@ public void Shutdown()
 
     private void HandleProjectEvaluationFinishedEvent(ProjectEvaluationFinishedEventArgs eventArgs)
     {
+        if (isRestore)
+        {
+            return;
+        }
+
         if (!IsMetaProjFile(eventArgs.ProjectFile))
         {
             _buildCheckManager.ProcessEvaluationFinishedEventArgs(
@@ -60,12 +68,30 @@ private void HandleProjectEvaluationFinishedEvent(ProjectEvaluationFinishedEvent
 
     private void HandleProjectEvaluationStartedEvent(ProjectEvaluationStartedEventArgs eventArgs)
     {
+        if (eventArgs.IsRestore)
+        {
+            isRestore = true;
+            return;
+        }
+
         if (!IsMetaProjFile(eventArgs.ProjectFile))
         {
             _buildCheckManager.StartProjectEvaluation(BuildCheckDataSource.EventArgs, eventArgs.BuildEventContext!, eventArgs.ProjectFile!);
         }
     }
 
+    private void HandleProjectFinishedEvent(ProjectFinishedEventArgs projectFinishedEventArgs)
+    {
+        if (isRestore)
+        {
+            isRestore = false;
+        }
+        else
+        {
+            _buildCheckManager.EndProjectRequest(BuildCheckDataSource.EventArgs, projectFinishedEventArgs.BuildEventContext!);
+        }
+    }
+
     private bool IsMetaProjFile(string? projectFile) => !string.IsNullOrEmpty(projectFile) && projectFile!.EndsWith(".metaproj", StringComparison.OrdinalIgnoreCase);
 
     private void EventSource_AnyEventRaised(object sender, BuildEventArgs e)
@@ -100,8 +126,15 @@ private void EventSource_BuildFinished(object sender, BuildFinishedEventArgs e)
     {
         { typeof(ProjectEvaluationFinishedEventArgs), (BuildEventArgs e) => HandleProjectEvaluationFinishedEvent((ProjectEvaluationFinishedEventArgs) e) },
         { typeof(ProjectEvaluationStartedEventArgs), (BuildEventArgs e) => HandleProjectEvaluationStartedEvent((ProjectEvaluationStartedEventArgs) e) },
-        { typeof(ProjectStartedEventArgs), (BuildEventArgs e) => _buildCheckManager.StartProjectRequest(BuildCheckDataSource.EventArgs, e.BuildEventContext!) },
-        { typeof(ProjectFinishedEventArgs), (BuildEventArgs e) => _buildCheckManager.EndProjectRequest(BuildCheckDataSource.EventArgs, e.BuildEventContext!) },
+        { typeof(ProjectStartedEventArgs), (BuildEventArgs e) => 
+            {
+              if (!isRestore)
+              {
+                _buildCheckManager.StartProjectRequest(BuildCheckDataSource.EventArgs, e.BuildEventContext!);
+              }
+            }
+        },
+        { typeof(ProjectFinishedEventArgs), (BuildEventArgs e) => HandleProjectFinishedEvent((ProjectFinishedEventArgs) e) },
         { typeof(BuildCheckTracingEventArgs), (BuildEventArgs e) => _stats.Merge(((BuildCheckTracingEventArgs)e).TracingData, (span1, span2) => span1 + span2) },
         { typeof(BuildCheckAcquisitionEventArgs), (BuildEventArgs e) => _buildCheckManager.ProcessAnalyzerAcquisition(((BuildCheckAcquisitionEventArgs)e).ToAnalyzerAcquisitionData(), e.BuildEventContext!) },
     };

src/Build/Evaluation/Evaluator.cs

@@ -626,7 +626,7 @@ private void Evaluate()
                     }
                 }
 
-                _evaluationLoggingContext.LogProjectEvaluationStarted();
+                _evaluationLoggingContext.LogProjectEvaluationStarted(_data.GlobalPropertiesDictionary[MSBuildConstants.MSBuildIsRestoring] is not null); ;
 
                 ErrorUtilities.VerifyThrow(_data.EvaluationId != BuildEventContext.InvalidEvaluationId, "Evaluation should produce an evaluation ID");
 

src/BuildCheck.UnitTests/EndToEndTests.cs

@@ -35,32 +35,60 @@ public EndToEndTests(ITestOutputHelper output)
     [InlineData(false, false)]
     public void SampleAnalyzerIntegrationTest(bool buildInOutOfProcessNode, bool analysisRequested)
     {
-        string contents = $"""
-            <Project Sdk="Microsoft.NET.Sdk" DefaultTargets="Hello">
-
+        TransientTestFile projectFile = SetupTestFiles();
+        _env.SetEnvironmentVariable("MSBUILDNOINPROCNODE", buildInOutOfProcessNode ? "1" : "0");
+        _env.SetEnvironmentVariable("MSBUILDLOGPROPERTIESANDITEMSAFTEREVALUATION", "1");
+        string output = RunnerUtilities.ExecBootstrapedMSBuild(
+            $"{Path.GetFileName(projectFile.Path)} /m:1 /p:BuildProjectReferences=false -nr:False -restore" +
+            (analysisRequested ? " -analyze" : string.Empty), out bool success, false, _env.Output);
+        _env.Output.WriteLine(output);
+        success.ShouldBeTrue();
+        // The conflicting outputs warning appears - but only if analysis was requested
+        if (analysisRequested)
+        {
+            output.ShouldContain("BC0101");
+        }
+        else
+        {
+            output.ShouldNotContain("BC0101");
+        }
+    }
+
+    [Fact]
+    public void NoRunOnRestore()
+    {
+        TransientTestFile projectFile = SetupTestFiles();
+        string output = RunnerUtilities.ExecBootstrapedMSBuild(
+            $"{Path.GetFileName(projectFile.Path)} /m:1 -nr:False -analyze -t:restore", out bool success);
+        _env.Output.WriteLine(output);
+        success.ShouldBeTrue();
+        output.ShouldNotContain("BC0101");
+    }
+
+    private TransientTestFile SetupTestFiles()
+    {
+        {
+            string contents = $"""
+            <Project Sdk="Microsoft.NET.Sdk" DefaultTargets="ResolveProjectReferences">
                 <PropertyGroup>
-                <OutputType>Exe</OutputType>
-                <TargetFramework>net8.0</TargetFramework>
-                <ImplicitUsings>enable</ImplicitUsings>
-                <Nullable>enable</Nullable>
+                    <OutputType>Exe</OutputType>
+                    <TargetFramework>net8.0</TargetFramework>
+                    <ImplicitUsings>enable</ImplicitUsings>
+                    <Nullable>enable</Nullable>
                 </PropertyGroup>
-                  
+
                 <PropertyGroup Condition="$(Test) == true">
-                <TestProperty>Test</TestProperty>
+                    <TestProperty>Test</TestProperty>
                 </PropertyGroup>
-                 
+
                 <ItemGroup>
-                <ProjectReference Include=".\FooBar-Copy.csproj" />
+                    <ProjectReference Include=".\FooBar-Copy.csproj" />
                 </ItemGroup>
-
-                <Target Name="Hello">
-                <Message Importance="High" Condition="$(Test2) == true" Text="XYZABC" />
-                </Target>
-
+
             </Project>
             """;
 
-        string contents2 = $"""
+            string contents2 = $"""
             <Project Sdk="Microsoft.NET.Sdk">
 
                 <PropertyGroup>
@@ -77,24 +105,21 @@ public void SampleAnalyzerIntegrationTest(bool buildInOutOfProcessNode, bool ana
                 <ItemGroup>
                 <Reference Include="bin/foo.dll" />
                 </ItemGroup>
-
-                <Target Name="Hello">
-                <Message Importance="High" Condition="$(Test2) == true" Text="XYZABC" />
-                </Target>
 
             </Project>
             """;
-        TransientTestFolder workFolder = _env.CreateFolder(createFolder: true);
-        TransientTestFile projectFile = _env.CreateFile(workFolder, "FooBar.csproj", contents);
-        TransientTestFile projectFile2 = _env.CreateFile(workFolder, "FooBar-Copy.csproj", contents2);
 
-        // var cache = new SimpleProjectRootElementCache();
-        // ProjectRootElement xml = ProjectRootElement.OpenProjectOrSolution(projectFile.Path, /*unused*/null, /*unused*/null, cache, false /*Not explicitly loaded - unused*/);
+            TransientTestFolder workFolder = _env.CreateFolder(createFolder: true);
+            TransientTestFile projectFile = _env.CreateFile(workFolder, "FooBar.csproj", contents);
+            TransientTestFile projectFile2 = _env.CreateFile(workFolder, "FooBar-Copy.csproj", contents2);
+
+            // var cache = new SimpleProjectRootElementCache();
+            // ProjectRootElement xml = ProjectRootElement.OpenProjectOrSolution(projectFile.Path, /*unused*/null, /*unused*/null, cache, false /*Not explicitly loaded - unused*/);
 
 
-        TransientTestFile config = _env.CreateFile(workFolder, "editorconfig.json",
-            /*lang=json,strict*/
-            """
+            TransientTestFile config = _env.CreateFile(workFolder, "editorconfig.json",
+                /*lang=json,strict*/
+                """
             {
                 "BC0101": {
                     "IsEnabled": true,
@@ -112,26 +137,11 @@ public void SampleAnalyzerIntegrationTest(bool buildInOutOfProcessNode, bool ana
             }
             """);
 
-        // OSX links /var into /private, which makes Path.GetTempPath() return "/var..." but Directory.GetCurrentDirectory return "/private/var...".
-        // This discrepancy breaks path equality checks in analyzers if we pass to MSBuild full path to the initial project.
-        // See if there is a way of fixing it in the engine - tracked: https://github.com/orgs/dotnet/projects/373/views/1?pane=issue&itemId=55702688.
-        _env.SetCurrentDirectory(Path.GetDirectoryName(projectFile.Path));
-
-        _env.SetEnvironmentVariable("MSBUILDNOINPROCNODE", buildInOutOfProcessNode ? "1" : "0");
-        _env.SetEnvironmentVariable("MSBUILDLOGPROPERTIESANDITEMSAFTEREVALUATION", "1");
-        string output = RunnerUtilities.ExecBootstrapedMSBuild(
-            $"{Path.GetFileName(projectFile.Path)} /m:1 -nr:False -restore" +
-            (analysisRequested ? " -analyze" : string.Empty), out bool success, false, _env.Output);
-        _env.Output.WriteLine(output);
-        success.ShouldBeTrue();
-        // The conflicting outputs warning appears - but only if analysis was requested
-        if (analysisRequested)
-        {
-            output.ShouldContain("BC0101");
-        }
-        else
-        {
-            output.ShouldNotContain("BC0101");
+            // OSX links /var into /private, which makes Path.GetTempPath() return "/var..." but Directory.GetCurrentDirectory return "/private/var...".
+            // This discrepancy breaks path equality checks in analyzers if we pass to MSBuild full path to the initial project.
+            // See if there is a way of fixing it in the engine - tracked: https://github.com/orgs/dotnet/projects/373/views/1?pane=issue&itemId=55702688.
+            _env.SetCurrentDirectory(Path.GetDirectoryName(projectFile.Path));
+            return (projectFile);
         }
     }
 }

src/Framework/ProjectEvaluationStartedEventArgs.cs

@@ -30,5 +30,8 @@ public ProjectEvaluationStartedEventArgs(string? message, params object[]? messa
         /// Gets or sets the full path of the project that started evaluation.
         /// </summary>
         public string? ProjectFile { get; set; }
+
+
+        public bool IsRestore { get; internal set; }
     }
 }