feat: Support Live Unit Testing (#97)

Author: BenjaminMichaelis

IntelliTect.Multitool.Tests/IntelliTect.Multitool.Tests.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
 	<Import Project="../IntelliTect.Multitool/Build/IntelliTect.Multitool.targets" />
   <PropertyGroup>
@@ -21,5 +21,4 @@
   <ItemGroup>
     <ProjectReference Include="..\IntelliTect.Multitool\IntelliTect.Multitool.csproj" />
   </ItemGroup>
-
 </Project>

IntelliTect.Multitool.Tests/ReleaseDateAttribute.Tests.cs

@@ -1,5 +1,4 @@
-using System;
-using Xunit;
+using Xunit;
 
 namespace IntelliTect.Multitool.Tests;
 

IntelliTect.Multitool.Tests/RepositoryPaths.Tests.cs

@@ -10,4 +10,20 @@ public void GetDefaultRepoRoot_ReturnsRepoRootDirectory()
         // Makes the assumption that the repository directory for this solution is named the same as the solution
         Assert.EndsWith(nameof(Multitool), RepositoryPaths.GetDefaultRepoRoot());
     }
+
+    [Fact]
+    public void BuildVariables_BeingSetProperly()
+    {
+        Assert.Equal(3, RepositoryPaths.BuildVariables.Count);
+        
+        Assert.True(RepositoryPaths.BuildVariables.TryGetValue("BuildingForLiveUnitTesting", out _));
+        
+        Assert.True(RepositoryPaths.BuildVariables.TryGetValue("ProjectPath", out string? projectPath));
+        Assert.NotNull(projectPath);
+        Assert.NotEmpty(projectPath);
+        
+        Assert.True(RepositoryPaths.BuildVariables.TryGetValue("SolutionDir", out string? solutionDir));
+        Assert.NotNull(solutionDir);
+        Assert.NotEmpty(solutionDir);
+    }
 }

IntelliTect.Multitool/Build/IntelliTect.Multitool.targets

@@ -4,4 +4,20 @@
 			<_Parameter1>$([System.DateTime]::UtcNow.ToString("O"))</_Parameter1>
 		</AssemblyAttribute>
 	</ItemGroup>
+
+    <Target Name="WriteLaunchers" AfterTargets="CopyFilesToOutputDirectory">
+        <PropertyGroup>
+            <TempStagingPath Condition="'$(TempStagingPath)' == ''">$([System.IO.Path]::GetTempPath())</TempStagingPath>
+            <LUTInformation>
+                BuildingForLiveUnitTesting::$(BuildingForLiveUnitTesting)
+                SolutionDir::$(SolutionDir)
+                ProjectPath::$(ProjectPath)
+            </LUTInformation>
+        </PropertyGroup>
+
+        <WriteLinesToFile
+          File="$(TempStagingPath)\IntelliTect.MultiTool.BuildVariables.tmp"
+          Overwrite="true"
+          Lines="$(LUTInformation)" />
+    </Target>
 </Project>

IntelliTect.Multitool/RepositoryPaths.cs

@@ -1,28 +1,85 @@
+using System.Collections.ObjectModel;
+
 namespace IntelliTect.Multitool;
+
 /// <summary>
 /// Provides consistent environment-independent normalized pathing within a repository.
 /// </summary>
 public static class RepositoryPaths
 {
     /// <summary>
-    /// Finds the root of the repository by looking for the .git folder.
+    /// Name of the build variables file that is created by the build process.
+    /// </summary>
+    public const string BuildVariableFileName = "IntelliTect.MultiTool.BuildVariables.tmp";
+
+    /// <summary>
+    /// Holds the key value pairs of the build variables that this class can use.
+    /// </summary>
+    public static ReadOnlyDictionary<string, string?> BuildVariables { get; } = new(File.ReadAllLines(Path.Combine(Path.GetTempPath(), BuildVariableFileName))
+        .Select(line => line.Split("::"))
+        .ToDictionary(split => split[0].Trim(),
+        split => !string.IsNullOrEmpty(split[1]) ? split[1].Trim() : null));
+
+    /// <summary>
+    /// Finds the root of the repository by looking for the directory containing the .git directory.
+    /// Begins searching up from the current directory, and retries from the project directory if initially not found.
+    /// Defaults to the solution directory, if available, if the .git directory is not found.
     /// </summary>
     /// <returns>Full path to repo root.</returns>
     public static string GetDefaultRepoRoot()
     {
-        DirectoryInfo? currentDirectory = new(Directory.GetCurrentDirectory());
+        string gitDirectory;
+        DirectoryInfo? searchStartDirectory;
 
-        while (currentDirectory is not null)
+        // If not live unit testing, try searching from current directory. But if we are this will fail, so just skip
+        if (!(BuildVariables.TryGetValue("BuildingForLiveUnitTesting", out string? isLiveUnitTesting)
+            && isLiveUnitTesting == "true"))
         {
-            DirectoryInfo[] subDirectories = currentDirectory.GetDirectories(".git");
-            if (subDirectories.Length > 0)
+            searchStartDirectory = new(Directory.GetCurrentDirectory());
+            if (TrySearchForGitContainingDirectory(searchStartDirectory, out gitDirectory)
+                && !string.IsNullOrWhiteSpace(gitDirectory))
             {
-                return currentDirectory.FullName;
+                return gitDirectory;
             }
-
-            currentDirectory = currentDirectory.Parent;
         }
-
+        // Search from the project directory if we are live unit testing or if the initial search failed.
+        if (BuildVariables.TryGetValue("ProjectPath", out string? projectPath))
+        {
+            searchStartDirectory = new FileInfo(projectPath).Directory;
+            if (TrySearchForGitContainingDirectory(searchStartDirectory, out gitDirectory)
+                && !string.IsNullOrWhiteSpace(gitDirectory))
+            {
+                return gitDirectory;
+            }
+        }
+        // If all this fails, try returning the Solution Directory in hopes that is in the root of the repo.
+        if (BuildVariables.TryGetValue("SolutionDir", out string? solutionDir) && !string.IsNullOrWhiteSpace(solutionDir))
+        {
+            return Directory.Exists(solutionDir) ? solutionDir : throw new InvalidOperationException($"SolutionDir is not a valid directory.");
+        }
         throw new InvalidOperationException("Could not find the repo root directory from the current directory. Current directory is expected to be the repoRoot sub directory.");
     }
+
+    /// <summary>
+    /// Searches up from the <paramref name="searchStartDirectory"/> looking for a .git directory.
+    /// </summary>
+    /// <param name="searchStartDirectory">The directory to start searching from, will search up.</param>
+    /// <param name="gitParentDirectory">The parent directory to the .git directory.</param>
+    /// <returns><c>true</c> if the directory <paramref name="gitParentDirectory" /> was found successfully; otherwise, false.</returns>
+    public static bool TrySearchForGitContainingDirectory(DirectoryInfo? searchStartDirectory, out string gitParentDirectory)
+    {
+        while (searchStartDirectory is not null)
+        {
+            DirectoryInfo[] subDirectories = searchStartDirectory.GetDirectories(".git");
+            if (subDirectories.Length > 0)
+            {
+                gitParentDirectory = searchStartDirectory.FullName;
+                return true;
+            }
+
+            searchStartDirectory = searchStartDirectory.Parent;
+        } 
+        gitParentDirectory = string.Empty;
+        return false;
+    }
 }