Create a test context to take away a lot of the repeating plumbing code (Buildalyzer#260)

Author: Corniel

Buildalyzer.sln

@@ -1,4 +1,3 @@
-
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.9.34622.214

tests/Buildalyzer.Tests/Integration/SimpleProjectsFixture.cs

@@ -2,6 +2,7 @@
 using System.IO;
 using System.IO.Compression;
 using Buildalyzer.Environment;
+using Buildalyzer.TestTools;
 using FluentAssertions;
 using Shouldly;
 
@@ -60,27 +61,23 @@ public class SimpleProjectsFixture
     };
 
     [Test]
-    public void DesignTimeBuildsProject(
+    public void Builds_DesignTime(
         [ValueSource(nameof(Preferences))] EnvironmentPreference preference,
         [ValueSource(nameof(ProjectFiles))] string projectFile)
     {
-        // Given
-        StringWriter log = new StringWriter();
-        IProjectAnalyzer analyzer = GetProjectAnalyzer(projectFile, log);
-        EnvironmentOptions options = new EnvironmentOptions
+        using var ctx = Context.ForProject(projectFile);
+
+        var options = new EnvironmentOptions
         {
-            Preference = preference
+            Preference = preference,
+            DesignTime = true,
         };
 
-        // When
-        DeleteProjectDirectory(projectFile, "obj");
-        DeleteProjectDirectory(projectFile, "bin");
-        IAnalyzerResults results = analyzer.Build(options);
+        var results = ctx.Analyzer.Build(options);
 
-        // Then
-        results.Count.ShouldBeGreaterThan(0, log.ToString());
-        results.OverallSuccess.ShouldBeTrue(log.ToString());
-        results.ShouldAllBe(x => x.Succeeded, log.ToString());
+        results.Should().NotBeEmpty();
+        results.OverallSuccess.Should().BeTrue();
+        results.Should().AllSatisfy(r => r.Succeeded.Should().BeTrue());
     }
 
     [Test]
@@ -139,7 +136,7 @@ public void GetsSourceFiles(
     [Test]
     public void GetsReferences(
         [ValueSource(nameof(Preferences))] EnvironmentPreference preference,
-        [ValueSource(nameof(ProjectFiles))] [NotNull] string projectFile)
+        [ValueSource(nameof(ProjectFiles))][NotNull] string projectFile)
     {
         // Given
         StringWriter log = new StringWriter();
@@ -685,7 +682,7 @@ public static void DuplicateProjectReferences()
     }
 
     [Test]
-    public void GetsAdditionalCscFiles()
+    public void Resolves_additional_files_for_Razor_project()
     {
         // Given
         StringWriter log = new StringWriter();
@@ -699,7 +696,7 @@ public void GetsAdditionalCscFiles()
     }
 
     [Test]
-    public void GetsAdditionalFile()
+    public void Resolves_additional_files()
     {
         // Given
         StringWriter log = new StringWriter();
@@ -710,24 +707,7 @@ public void GetsAdditionalFile()
             .Should().BeEquivalentTo("message.txt");
     }
 
-    [Test]
-    public void HandlesProcessFailure()
-    {
-        // Given
-        StringWriter log = new StringWriter();
-        IProjectAnalyzer analyzer = GetProjectAnalyzer(@"SdkNet6Exe\SdkNet6Exe.csproj", log);
-
-        // When
-        IAnalyzerResults results = analyzer.Build(new EnvironmentOptions
-        {
-            Arguments = { "/unknown" } // This argument will cause msbuild to immediately fail
-        });
-
-        // Then
-        results.OverallSuccess.ShouldBeFalse();
-    }
-
-    private static IProjectAnalyzer GetProjectAnalyzer(string projectFile, StringWriter log)
+    private static IProjectAnalyzer GetProjectAnalyzer(string projectFile, System.IO.StringWriter log)
     {
         IProjectAnalyzer analyzer = new AnalyzerManager(
             new AnalyzerManagerOptions

tests/Buildalyzer.Tests/TestTools/BuildalyzerTestContext.cs

@@ -0,0 +1,90 @@
+using System.Diagnostics;
+using System.IO;
+
+namespace Buildalyzer.TestTools;
+
+/// <summary>Creates a test context for testing <see cref="IProjectAnalyzer"/>s.</summary>
+/// <remarks>
+/// The context ensures an fresh build (deletes previous artifacts in advance).
+/// The context logs to the console in DEBUG mode.
+/// </remarks>
+public sealed class BuildalyzerTestContext : IDisposable
+{
+    public TextWriter Log => IsDisposed ? throw new ObjectDisposedException(GetType().FullName) : log;
+
+    [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+    private readonly TextWriter log = new StringWriter();
+
+    public BuildalyzerTestContext(FileInfo projectFile)
+    {
+        ProjectFile = projectFile;
+        Manager = new AnalyzerManager(
+            new AnalyzerManagerOptions
+            {
+                LogWriter = Log,
+            });
+
+        Analyzer = Manager.GetProject(projectFile.FullName);
+
+        DebugMode(ref InDebugMode);
+        AddBinaryLogger();
+        DeleteSubDirectory("bin");
+        DeleteSubDirectory("obj");
+    }
+
+    public FileInfo ProjectFile { get; }
+
+    public AnalyzerManager Manager { get; }
+
+    public IProjectAnalyzer Analyzer { get; }
+
+    /// <inheritdoc />
+    public void Dispose()
+    {
+        if (!IsDisposed)
+        {
+            if (InDebugMode)
+            {
+                Console.WriteLine(Log.ToString());
+            }
+            Log.Dispose();
+
+            IsDisposed = true;
+        }
+    }
+
+    [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+    private bool IsDisposed;
+
+    /// <summary>Ensures that the analysis is done ignoring previous results.</summary>
+    private void DeleteSubDirectory(string path)
+    {
+        var directory = new DirectoryInfo(Path.Combine(ProjectFile.Directory!.FullName, path));
+
+        if (directory.Exists)
+        {
+            try
+            {
+                directory.Delete(true);
+                Log.WriteLine($"Deleted all files at {directory}");
+            }
+            catch (Exception x)
+            {
+                Log.WriteLine(x);
+            }
+        }
+    }
+
+    [Conditional("BinaryLog")]
+    private void AddBinaryLogger()
+    {
+        Analyzer.AddBinaryLogger(Path.Combine(@"C:\Temp\", Path.ChangeExtension(ProjectFile.Name, ".core.binlog")));
+    }
+
+    /// <summary>Sets <paramref name="inDebugMode"/> to true when run in DEBUG mode.</summary>
+    [Conditional("DEBUG")]
+    private void DebugMode(ref bool inDebugMode) => inDebugMode = true;
+
+    [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+    private readonly bool InDebugMode;
+}

tests/Buildalyzer.Tests/TestTools/Context.cs

@@ -0,0 +1,23 @@
+using System.Diagnostics.Contracts;
+using System.IO;
+
+namespace Buildalyzer.TestTools;
+
+public static class Context
+{
+    [Pure]
+    public static BuildalyzerTestContext ForProject(string path) => new(GetProjectPath(path));
+
+    private static FileInfo GetProjectPath(string file)
+    {
+        var location = new FileInfo(typeof(Context).Assembly.Location).Directory!;
+        return new FileInfo(Path.Combine(
+            location.FullName,
+            "..",
+            "..",
+            "..",
+            "..",
+            "projects",
+            file));
+    }
+}

tests/Buildalyzer.Workspaces.Tests/Buildalyzer.Workspaces.Tests.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
@@ -22,6 +22,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\src\Buildalyzer.Workspaces\Buildalyzer.Workspaces.csproj" />
+    <ProjectReference Include="..\Buildalyzer.Tests\Buildalyzer.Tests.csproj" />
   </ItemGroup>
 
   <ItemGroup Label="Additional files">

tests/Buildalyzer.Workspaces.Tests/ProjectAnalyzerExtensionsFixture.cs

@@ -1,6 +1,8 @@
 using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
+using Buildalyzer.TestTools;
+using FluentAssertions;
 using Microsoft.CodeAnalysis;
 using NUnit.Framework;
 using Shouldly;
@@ -12,19 +14,14 @@ namespace Buildalyzer.Workspaces.Tests;
 public class ProjectAnalyzerExtensionsFixture
 {
     [Test]
-    public void LoadsWorkspace()
+    public void Loads_Workspace()
     {
-        // Given
-        SafeStringWriter log = new SafeStringWriter();
-        IProjectAnalyzer analyzer = GetProjectAnalyzer(@"projects\SdkNetStandardProject\SdkNetStandardProject.csproj", log);
+        using var ctx = Context.ForProject(@"SdkNetStandardProject\SdkNetStandardProject.csproj");
 
-        // When
-        Workspace workspace = analyzer.GetWorkspace();
+        var workspace = ctx.Analyzer.GetWorkspace();
 
-        // Then
-        string logged = log.ToString();
-        logged.ShouldNotContain("Workspace failed");
-        workspace.CurrentSolution.Projects.First().Documents.ShouldContain(x => x.Name == "Class1.cs", log.ToString());
+        ctx.Log.ToString().Should().NotContain("Workspace failed");
+        workspace.CurrentSolution.Projects.First().Documents.First().Should().BeEquivalentTo(new { Name = "Class1.cs" });
     }
 
     [Test]