Add tests

Author: reakaleek

docs-builder.sln

@@ -53,6 +53,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "docs-assembler", "src\docs-
 EndProject
 Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "authoring", "tests\authoring\authoring.fsproj", "{018F959E-824B-4664-B345-066784478D24}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "docs-mover", "src\docs-mover\docs-mover.csproj", "{7D36DDDA-9E0B-4D2C-8033-5D62FF8B6166}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -95,6 +97,10 @@ Global
 		{018F959E-824B-4664-B345-066784478D24}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{018F959E-824B-4664-B345-066784478D24}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{018F959E-824B-4664-B345-066784478D24}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7D36DDDA-9E0B-4D2C-8033-5D62FF8B6166}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7D36DDDA-9E0B-4D2C-8033-5D62FF8B6166}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7D36DDDA-9E0B-4D2C-8033-5D62FF8B6166}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7D36DDDA-9E0B-4D2C-8033-5D62FF8B6166}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{4D198E25-C211-41DC-9E84-B15E89BD7048} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
@@ -106,5 +112,6 @@ Global
 		{A2A34BBC-CB5E-4100-9529-A12B6ECB769C} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
 		{28350800-B44B-479B-86E2-1D39E321C0B4} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
 		{018F959E-824B-4664-B345-066784478D24} = {67B576EE-02FA-4F9B-94BC-3630BC09ECE5}
+		{7D36DDDA-9E0B-4D2C-8033-5D62FF8B6166} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
 	EndGlobalSection
 EndGlobal

docs/docset.yml

@@ -97,3 +97,7 @@ toc:
       - file: req.md
       - folder: nested
       - file: cross-links.md
+      - folder: mover
+        children:
+          - file: first-page.md
+          - file: second-page.md

docs/testing/mover/first-page.md

@@ -0,0 +1,3 @@
+# First Page
+
+[Link to second page](second-page.md)

docs/testing/mover/second-page.md

@@ -0,0 +1,6 @@
+# Second Page
+
+[Link to first page](first-page.md)
+
+[Absolut link to first page](/testing/mover/first-page.md)
+```

src/docs-builder/Cli/Commands.cs

@@ -7,6 +7,7 @@
 using ConsoleAppFramework;
 using Documentation.Builder.Diagnostics.Console;
 using Documentation.Builder.Http;
+using Documentation.Mover;
 using Elastic.Markdown;
 using Elastic.Markdown.IO;
 using Microsoft.Extensions.Logging;
@@ -128,7 +129,7 @@ public async Task<int> Move(
 		};
 		var set = new DocumentationSet(context);
 
-		var moveCommand = new Move(fileSystem, set, logger);
+		var moveCommand = new Move(fileSystem, fileSystem, set, logger);
 		return await moveCommand.Execute(source, target, dryRun ?? false, ctx);
 	}
 }

src/docs-builder/docs-builder.csproj

@@ -30,6 +30,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\docs-mover\docs-mover.csproj" />
     <ProjectReference Include="..\Elastic.Markdown\Elastic.Markdown.csproj" />
   </ItemGroup>
 </Project>

src/docs-builder/Cli/Move.cs renamed to src/docs-mover/Move.cs

@@ -1,22 +1,30 @@
-// Licensed to Elasticsearch B.V under one or more agreements.
+// Licensed to Elasticsearch B.V under one or more agreements.
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
+using System.Collections.ObjectModel;
 using System.IO.Abstractions;
 using System.Text.RegularExpressions;
 using Elastic.Markdown.IO;
 using Microsoft.Extensions.Logging;
 
-namespace Documentation.Builder.Cli;
+namespace Documentation.Mover;
 
-internal class Move(IFileSystem fileSystem, DocumentationSet documentationSet, ILoggerFactory loggerFactory)
+public class Move(IFileSystem readFileSystem, IFileSystem writeFileSystem, DocumentationSet documentationSet, ILoggerFactory loggerFactory)
 {
 	private readonly ILogger _logger = loggerFactory.CreateLogger<Move>();
 	private readonly List<(string filePath, string originalContent, string newContent)> _changes = [];
+	private readonly List<LinkModification> _linkModifications = [];
 	private const string ChangeFormatString = "Change \e[31m{0}\e[0m to \e[32m{1}\e[0m at \e[34m{2}:{3}:{4}\e[0m";
 
+	public record LinkModification(string OldLink, string NewLink, string SourceFile, int LineNumber, int ColumnNumber);
+
+
+	public ReadOnlyCollection<LinkModification> LinkModifications => _linkModifications.AsReadOnly();
+
 	public async Task<int> Execute(string? source, string? target, bool isDryRun, Cancel ctx = default)
 	{
+		_linkModifications.Clear();
 		if (isDryRun)
 			_logger.LogInformation("Running in dry-run mode");
 
@@ -25,12 +33,13 @@ public async Task<int> Execute(string? source, string? target, bool isDryRun, Ca
 			return 1;
 		}
 
+
 		var sourcePath = Path.GetFullPath(source!);
 		var targetPath = Path.GetFullPath(target!);
 
 		var (_, sourceMarkdownFile) = documentationSet.MarkdownFiles.Single(i => i.Value.FilePath == sourcePath);
 
-		var sourceContent = await fileSystem.File.ReadAllTextAsync(sourceMarkdownFile.FilePath, ctx);
+		var sourceContent = await readFileSystem.File.ReadAllTextAsync(sourceMarkdownFile.FilePath, ctx);
 
 		var markdownLinkRegex = new Regex(@"\[([^\]]*)\]\(((?:\.{0,2}\/)?[^:)]+\.md(?:#[^)]*)?)\)", RegexOptions.Compiled);
 
@@ -51,16 +60,13 @@ public async Task<int> Execute(string? source, string? target, bool isDryRun, Ca
 			var newLink = $"[{match.Groups[1].Value}]({newPath})";
 			var lineNumber = sourceContent.Substring(0, match.Index).Count(c => c == '\n') + 1;
 			var columnNumber = match.Index - sourceContent.LastIndexOf('\n', match.Index);
-			_logger.LogInformation(
-				string.Format(
-					ChangeFormatString,
-					match.Value,
-					newLink,
-					sourceMarkdownFile.SourceFile.FullName,
-					lineNumber,
-					columnNumber
-				)
-			);
+			_linkModifications.Add(new LinkModification(
+				match.Value,
+				newLink,
+				sourceMarkdownFile.SourceFile.FullName,
+				lineNumber,
+				columnNumber
+			));
 			return newLink;
 		});
 
@@ -76,22 +82,34 @@ await ProcessMarkdownFile(
 			);
 		}
 
+		foreach (var (oldLink, newLink, sourceFile, lineNumber, columnNumber) in LinkModifications)
+		{
+			_logger.LogInformation(string.Format(
+				ChangeFormatString,
+				oldLink,
+				newLink,
+				sourceFile,
+				lineNumber,
+				columnNumber
+			));
+		}
+
 		if (isDryRun)
 			return 0;
 
 		var targetDirectory = Path.GetDirectoryName(targetPath);
-		fileSystem.Directory.CreateDirectory(targetDirectory!);
-		fileSystem.File.Move(sourcePath, targetPath);
+		readFileSystem.Directory.CreateDirectory(targetDirectory!);
+		readFileSystem.File.Move(sourcePath, targetPath);
 		try
 		{
 			foreach (var (filePath, _, newContent) in _changes)
-				await fileSystem.File.WriteAllTextAsync(filePath, newContent, ctx);
+				await writeFileSystem.File.WriteAllTextAsync(filePath, newContent, ctx);
 		}
 		catch (Exception)
 		{
 			foreach (var (filePath, originalContent, _) in _changes)
-				await fileSystem.File.WriteAllTextAsync(filePath, originalContent, ctx);
-			fileSystem.File.Move(targetPath, sourcePath);
+				await writeFileSystem.File.WriteAllTextAsync(filePath, originalContent, ctx);
+			writeFileSystem.File.Move(targetPath, sourcePath);
 			throw;
 		}
 		return 0;
@@ -124,13 +142,13 @@ private bool ValidateInputs(string? source, string? target)
 			return false;
 		}
 
-		if (!fileSystem.File.Exists(source))
+		if (!readFileSystem.File.Exists(source))
 		{
 			_logger.LogError($"Source file {source} does not exist");
 			return false;
 		}
 
-		if (fileSystem.File.Exists(target))
+		if (readFileSystem.File.Exists(target))
 		{
 			_logger.LogError($"Target file {target} already exists");
 			return false;
@@ -145,7 +163,7 @@ private async Task ProcessMarkdownFile(
 		MarkdownFile value,
 		Cancel ctx)
 	{
-		var content = await fileSystem.File.ReadAllTextAsync(value.FilePath, ctx);
+		var content = await readFileSystem.File.ReadAllTextAsync(value.FilePath, ctx);
 		var currentDir = Path.GetDirectoryName(value.FilePath)!;
 		var pathInfo = GetPathInfo(currentDir, source, target);
 		var linkPattern = BuildLinkPattern(pathInfo);
@@ -199,30 +217,25 @@ MarkdownFile value
 					: "";
 
 				string newLink;
-				if (originalPath.StartsWith("/"))
+				if (originalPath.StartsWith('/'))
 				{
-					// Absolute style link
 					newLink = $"[{match.Groups[1].Value}]({absoluteStyleTarget}{anchor})";
 				}
 				else
 				{
-					// Relative link
 					var relativeTarget = Path.GetRelativePath(Path.GetDirectoryName(value.FilePath)!, target);
 					newLink = $"[{match.Groups[1].Value}]({relativeTarget}{anchor})";
 				}
 
 				var lineNumber = content.Substring(0, match.Index).Count(c => c == '\n') + 1;
 				var columnNumber = match.Index - content.LastIndexOf('\n', match.Index);
-				_logger.LogInformation(
-					string.Format(
-						ChangeFormatString,
-						match.Value,
-						newLink,
-						value.SourceFile.FullName,
-						lineNumber,
-						columnNumber
-						)
-					);
+				_linkModifications.Add(new LinkModification(
+					match.Value,
+					newLink,
+					value.SourceFile.FullName,
+					lineNumber,
+					columnNumber
+				));
 				return newLink;
 			});
 }

src/docs-mover/docs-mover.csproj

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>net9.0</TargetFramework>
+        <RootNamespace>Documentation.Mover</RootNamespace>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <AssemblyName>Documentation.Mover</AssemblyName>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\Elastic.Markdown\Elastic.Markdown.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Microsoft.Extensions.Logging" Version="9.0.0" />
+    </ItemGroup>
+
+</Project>

tests/Elastic.Markdown.Tests/DocSet/NavigationTestsBase.cs

@@ -8,6 +8,7 @@
 using Elastic.Markdown.IO;
 using Elastic.Markdown.IO.Configuration;
 using FluentAssertions;
+using Microsoft.Extensions.Logging;
 using Xunit.Abstractions;
 
 namespace Elastic.Markdown.Tests.DocSet;
@@ -16,14 +17,14 @@ public class NavigationTestsBase : IAsyncLifetime
 {
 	protected NavigationTestsBase(ITestOutputHelper output)
 	{
-		var logger = new TestLoggerFactory(output);
+		LoggerFactory = new TestLoggerFactory(output);
 		ReadFileSystem = new FileSystem(); //use real IO to read docs.
-		var writeFs = new MockFileSystem(new MockFileSystemOptions //use in memory mock fs to test generation
+		WriteFileSystem = new MockFileSystem(new MockFileSystemOptions //use in memory mock fs to test generation
 		{
 			CurrentDirectory = Paths.Root.FullName
 		});
 		var collector = new TestDiagnosticsCollector(output);
-		var context = new BuildContext(ReadFileSystem, writeFs)
+		var context = new BuildContext(ReadFileSystem, WriteFileSystem)
 		{
 			Force = false,
 			UrlPathPrefix = null,
@@ -33,11 +34,13 @@ protected NavigationTestsBase(ITestOutputHelper output)
 		Set = new DocumentationSet(context);
 
 		Set.Files.Should().HaveCountGreaterThan(10);
-		Generator = new DocumentationGenerator(Set, logger);
-
+		Generator = new DocumentationGenerator(Set, LoggerFactory);
 	}
 
+	protected ILoggerFactory LoggerFactory { get; }
+
 	protected FileSystem ReadFileSystem { get; set; }
+	protected IFileSystem WriteFileSystem { get; set; }
 	protected DocumentationSet Set { get; }
 	protected DocumentationGenerator Generator { get; }
 	protected ConfigurationFile Configuration { get; set; } = default!;

tests/Elastic.Markdown.Tests/Elastic.Markdown.Tests.csproj

@@ -21,6 +21,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\src\docs-mover\docs-mover.csproj" />
     <ProjectReference Include="..\..\src\Elastic.Markdown\Elastic.Markdown.csproj"/>
   </ItemGroup>