From 852522fbaa470bb86c8d6d1a0d3ba69f6a3ab7e9 Mon Sep 17 00:00:00 2001
From: Drew Noakes <git@drewnoakes.com>
Date: Wed, 11 Dec 2024 10:41:04 +1100
Subject: [PATCH] Test that DT targets evaluate and build

We recently had an issue where a design-time target was merged containing invalid XML. These targets are crucial to almost everything the project system does, so a failure in them completely breaks the IDE.

In this change we add a unit test to validate that our C#/VB/F# design-time targets files can be correctly evaluated, and can build a simple target. This ensures both that they contain valid XML with valid MSBuild semantics.
---
 .../DesignTimeTargetsTests.cs                 | 63 +++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 tests/Microsoft.VisualStudio.ProjectSystem.Managed.UnitTests/ProjectSystem/DesignTimeTargets/DesignTimeTargetsTests.cs

diff --git a/tests/Microsoft.VisualStudio.ProjectSystem.Managed.UnitTests/ProjectSystem/DesignTimeTargets/DesignTimeTargetsTests.cs b/tests/Microsoft.VisualStudio.ProjectSystem.Managed.UnitTests/ProjectSystem/DesignTimeTargets/DesignTimeTargetsTests.cs
new file mode 100644
index 0000000000..319b00a695
--- /dev/null
+++ b/tests/Microsoft.VisualStudio.ProjectSystem.Managed.UnitTests/ProjectSystem/DesignTimeTargets/DesignTimeTargetsTests.cs
@@ -0,0 +1,63 @@
+// Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the LICENSE.md file in the project root for more information.
+
+using Microsoft.VisualStudio.Utilities;
+using Microsoft.Build.Evaluation;
+using Microsoft.Build.Framework;
+
+namespace Microsoft.VisualStudio.ProjectSystem.DesignTimeTargets;
+
+public sealed class DesignTimeTargetsTests
+{
+    [Theory]
+    [InlineData("Microsoft.CSharp.DesignTime.targets")]
+    [InlineData("Microsoft.VisualBasic.DesignTime.targets")]
+    [InlineData("Microsoft.FSharp.DesignTime.targets")]
+    public void ValidateDesignTimeTargetsEvaluateAndBuild(string targetFileName)
+    {
+        // eg: src\Microsoft.VisualStudio.ProjectSystem.Managed\ProjectSystem\DesignTimeTargets\Microsoft.CSharp.DesignTime.targets
+
+        string path = Path.Combine(RepoUtil.FindRepoRootPath(), "src", "Microsoft.VisualStudio.ProjectSystem.Managed", "ProjectSystem", "DesignTimeTargets", targetFileName);
+
+        // Force an evaluation of the project.
+        Project project = new(path);
+
+        Logger logger = new();
+
+        // Build a target. This isn't a particularly interesting target, but it's one of the few
+        // that don't require a target defined elsewhere. If we were to try and build all targets
+        // in the project (via project.Targets.Keys) we would hit error MSB4057 (target not found)
+        // because we are not importing the common targets, etc. here. This is just a smoke test
+        // to make sure we can build a target.
+        project.Build(["CollectPackageReferences"], [logger]);
+
+        // Unload everything when done.
+        project.ProjectCollection.UnloadAllProjects();
+
+        Assert.Empty(logger.Errors);
+        Assert.True(logger.Succeeded);
+    }
+
+    private sealed class Logger : ILogger
+    {
+        public LoggerVerbosity Verbosity { get; set; } = LoggerVerbosity.Quiet;
+        public string? Parameters { get; set; }
+
+        public bool? Succeeded { get; private set; }
+
+        public ImmutableList<BuildErrorEventArgs> Errors = [];
+
+        public void Initialize(IEventSource eventSource)
+        {
+            eventSource.ErrorRaised += (s, e) => ImmutableInterlocked.Update(
+                ref Errors,
+                static (errors, e) => errors.Add(e),
+                e);
+
+            eventSource.BuildFinished += (s, e) => Succeeded = e.Succeeded;
+        }
+
+        public void Shutdown()
+        {
+        }
+    }
+}