Add links to scenario files in the test report

Author: cezarypiatek

README.md

@@ -201,6 +201,11 @@ There's also an option to generate a nice html report for all test scenarios. Ju
 
 ![image](https://github.com/cezarypiatek/NScenario/assets/7759991/13c501d6-d26b-4406-93fb-1da29dca9bff)
 
+
+This report browser supports links to scenario steps definition. To make it work, you need to set the following msbuild properties (or environment variables):
+- RepositoryUrl
+- SourceRevisionId
+
 ## Test scenario title
 
 Test scenario title is generated by removing underscores and splitting camel/pascalcase string from the test method name (`[CallerMemberName]` is used to retrieve that name). This allows for immediate review of the test name (I saw many, extremely long and totally ridiculous test method names. A good test method name should reveal the intention of the test case, not its details). You can always override the default title by setting it explicitly during test scenario creation (especially useful for parametrized test methods):

src/NScenario/ReportExtensions.cs

@@ -1,5 +1,7 @@
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
+using System.Reflection;
 using System.Text.Json;
 
 namespace NScenario;
@@ -8,8 +10,21 @@ public static class ReportExtensions
 {
     public static void SaveAsReport(this IReadOnlyList<ScenarioInfo> scenarios, string outputPath)
     {
+        var callingAssembly = Assembly.GetCallingAssembly();
+        var sourceControlInfo = RepoPathResolver.GetSourceControlInfo(callingAssembly);
+        var repositoryRootDir = RepoPathResolver.FindRepoRootDirectory(scenarios.FirstOrDefault()?.FilePath);
         var template = ResourceExtractor.GetEmbeddedResourceContent("NScenario.report-browser-template.html");
-        var report = template.Replace("//[DATA_PLACEHOLDER]", JsonSerializer.Serialize(scenarios));
+        var scenariosPayload = JsonSerializer.Serialize(new
+        {
+            SourceControlInfo = new
+            {
+                RepositoryUrl = sourceControlInfo?.RepositoryUrl,
+                Revision = sourceControlInfo?.Revision,
+                RepositoryRootDir = repositoryRootDir
+            },
+            Scenarios = scenarios
+        });
+        var report = template.Replace("//[DATA_PLACEHOLDER]", scenariosPayload);
         File.WriteAllText(outputPath, report);
     }
 }

src/NScenario/Reporting/RepoPathResolver.cs

@@ -0,0 +1,40 @@
+using System.IO;
+using System.Linq;
+using System.Reflection;
+
+namespace NScenario;
+
+internal static class RepoPathResolver
+{
+    public static string? FindRepoRootDirectory(string? fileInTheRepo)
+    {
+        if (fileInTheRepo == null)
+            return null;
+        
+        var currentDirectory = new DirectoryInfo(Path.GetDirectoryName(fileInTheRepo) ?? string.Empty);
+
+        while (currentDirectory is { Exists: true })
+        {
+            if (Directory.Exists(Path.Combine(currentDirectory.FullName, ".git")))
+            {
+                return currentDirectory.FullName;
+            }
+            currentDirectory = currentDirectory.Parent;
+        }
+
+        return null;
+    }
+
+    public static SourceControlInfo? GetSourceControlInfo(Assembly assembly)
+    {
+        var repositoryUrl = assembly.GetCustomAttributes<AssemblyMetadataAttribute>().FirstOrDefault(x => x.Key == "RepositoryUrl")?.Value;
+        var revision = assembly.GetCustomAttributes<AssemblyInformationalVersionAttribute>().FirstOrDefault()?.InformationalVersion?.Split('+').LastOrDefault();
+
+        if (string.IsNullOrWhiteSpace(repositoryUrl) == false && string.IsNullOrWhiteSpace(revision) == false)
+        {
+            return new SourceControlInfo(repositoryUrl, revision);
+        }
+
+        return null;
+    }
+}

src/NScenario/Reporting/SourceControlInfo.cs

@@ -0,0 +1,3 @@
+namespace NScenario;
+
+internal record SourceControlInfo(string RepositoryUrl, string Revision);