simplify meg testing logic

Author: AnakinRaW

src/PetroglyphTools/PG.StarWarsGame.Engine.Testing/IRepoOriginWriter.cs

@@ -1,17 +1,11 @@
-using System.IO.Abstractions;
+using System;
 using System.Reflection;
 
 namespace PG.StarWarsGame.Engine.Testing;
 
 /// <summary>Provides per-origin write operations against the underlying file system.</summary>
 public interface IRepoOriginWriter
 {
-    /// <summary>Gets the file system backing this origin.</summary>
-    IFileSystem FileSystem { get; }
-
-    /// <summary>Gets the absolute path of this origin's root.</summary>
-    string OriginPath { get; }
-
     /// <summary>Writes the text content to a file relative to the origin root.</summary>
     void Write(string relativePath, string content);
 
@@ -30,4 +24,13 @@ public interface IRepoOriginWriter
     /// <summary>Writes the XML content to <c>Data/XML/&lt;name&gt;</c> relative to the origin root.</summary>
     /// <remarks><paramref name="name"/> may contain subpath separators.</remarks>
     void WriteXml(string name, string content);
+
+    /// <summary>Writes a MEG archive composed via the configure callback to a file relative to the origin root.</summary>
+    /// <param name="relativePath">The destination path relative to the origin root.</param>
+    /// <param name="configure">The callback that populates the archive entries.</param>
+    void WriteMeg(string relativePath, Action<IMegContentBuilder> configure);
+
+    /// <summary>Writes an empty MEG archive to a file relative to the origin root.</summary>
+    /// <param name="relativePath">The destination path relative to the origin root.</param>
+    void WriteEmptyMeg(string relativePath);
 }

src/PetroglyphTools/PG.StarWarsGame.Engine.Testing/MegContentBuilder.cs

@@ -1,18 +1,13 @@
 using System;
-using System.Collections.Generic;
 using System.Reflection;
 using System.Text;
-using PG.StarWarsGame.Files.MEG.Services.Builder.Normalization;
+using PG.StarWarsGame.Files.MEG.Services.Builder;
 
 namespace PG.StarWarsGame.Engine.Testing;
 
-internal sealed class MegContentBuilder : IMegContentBuilder
+internal sealed class MegContentBuilder(IMegBuilder inner) : IMegContentBuilder
 {
-    private static readonly EmpireAtWarMegDataEntryPathNormalizer Normalizer = new();
-
-    private readonly List<PendingEntry> _entries = new();
-
-    public IReadOnlyList<PendingEntry> Entries => _entries;
+    private readonly IMegBuilder _inner = inner ?? throw new ArgumentNullException(nameof(inner));
 
     public IMegContentBuilder Add(string entryName, byte[] content)
     {
@@ -21,8 +16,10 @@ public IMegContentBuilder Add(string entryName, byte[] content)
         if (content == null)
             throw new ArgumentNullException(nameof(content));
 
-        _entries.Add(new PendingEntry(Normalize(entryName), content));
-        return this;
+        var result = _inner.AddBytes(content, entryName, encrypt: false);
+        return !result.Added 
+            ? throw new InvalidOperationException($"Failed to add MEG entry '{entryName}': {result.Status} ({result.Message ?? "no message"}).") 
+            : this;
     }
 
     public IMegContentBuilder Add(string entryName, string content)
@@ -38,15 +35,4 @@ public IMegContentBuilder AddEmbedded(string entryName, string resourceName, Ass
         var asm = source ?? Assembly.GetCallingAssembly();
         return Add(entryName, EmbeddedFixtures.Load(resourceName, asm));
     }
-
-    private static string Normalize(string entryName)
-    {
-        return Normalizer.Normalize(entryName);
-    }
-
-    internal readonly struct PendingEntry(string normalizedName, byte[] content)
-    {
-        public string NormalizedName { get; } = normalizedName;
-        public byte[] Content { get; } = content;
-    }
 }

src/PetroglyphTools/PG.StarWarsGame.Engine.Testing/MegWriterExtensions.cs

@@ -1,35 +1,36 @@
 using System;
 using System.IO.Abstractions;
 using System.Reflection;
+using Microsoft.Extensions.DependencyInjection;
+using PG.StarWarsGame.Files.MEG.Files;
+using PG.StarWarsGame.Files.MEG.Services.Builder;
 
 namespace PG.StarWarsGame.Engine.Testing;
 
-internal sealed class RepoOriginWriter(IFileSystem fileSystem, string originPath) : IRepoOriginWriter
+internal sealed class RepoOriginWriter(IServiceProvider services, string originPath) : IRepoOriginWriter
 {
-    private readonly IFileSystem _fs = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
-
-    public IFileSystem FileSystem => _fs;
-
-    public string OriginPath { get; } = originPath ?? throw new ArgumentNullException(nameof(originPath));
+    private readonly IServiceProvider _services = services ?? throw new ArgumentNullException(nameof(services));
+    private readonly IFileSystem _fileSystem = services.GetRequiredService<IFileSystem>();
+    private readonly string _originPath = originPath ?? throw new ArgumentNullException(nameof(originPath));
 
     public void Write(string relativePath, string content)
     {
-        if (content == null) 
+        if (content == null)
             throw new ArgumentNullException(nameof(content));
-        
+
         var dst = Resolve(relativePath);
         EnsureParent(dst);
-        _fs.File.WriteAllText(dst, content);
+        _fileSystem.File.WriteAllText(dst, content);
     }
 
     public void Write(string relativePath, byte[] content)
     {
         if (content == null)
             throw new ArgumentNullException(nameof(content));
-        
+
         var dst = Resolve(relativePath);
         EnsureParent(dst);
-        _fs.File.WriteAllBytes(dst, content);
+        _fileSystem.File.WriteAllBytes(dst, content);
     }
 
     public void WriteEmbedded(string relativePath, string resourceName, Assembly? source = null)
@@ -42,34 +43,53 @@ public void WriteEmbedded(string relativePath, string resourceName, Assembly? so
     public void Remove(string relativePath)
     {
         var dst = Resolve(relativePath);
-        if (_fs.File.Exists(dst))
-            _fs.File.Delete(dst);
+        if (_fileSystem.File.Exists(dst))
+            _fileSystem.File.Delete(dst);
     }
 
     public void WriteXml(string name, string content)
     {
         if (name == null)
             throw new ArgumentNullException(nameof(name));
-        
-        Write(_fs.Path.Combine("Data", "XML", Normalize(name)), content);
+
+        Write(_fileSystem.Path.Combine("Data", "XML", Normalize(name)), content);
+    }
+
+    public void WriteMeg(string relativePath, Action<IMegContentBuilder> configure)
+    {
+        if (configure == null)
+            throw new ArgumentNullException(nameof(configure));
+
+        var dst = Resolve(relativePath);
+        EnsureParent(dst);
+
+        using var megBuilder = new EmpireAtWarMegBuilder(_fileSystem.Path.GetDirectoryName(dst)!, _services);
+        configure(new MegContentBuilder(megBuilder));
+        using var fileInfo = new MegFileInformation(dst, MegFileVersion.V1, encryptionData: null);
+        megBuilder.Build(fileInfo, overwrite: true);
+    }
+
+    public void WriteEmptyMeg(string relativePath)
+    {
+        WriteMeg(relativePath, _ => { });
     }
 
     private string Resolve(string relativePath)
     {
-        return relativePath == null 
-            ? throw new ArgumentNullException(nameof(relativePath)) 
-            : _fs.Path.Combine(OriginPath, Normalize(relativePath));
+        return relativePath == null
+            ? throw new ArgumentNullException(nameof(relativePath))
+            : _fileSystem.Path.Combine(_originPath, Normalize(relativePath));
     }
 
     private string Normalize(string path)
     {
-        return path.Replace('\\', _fs.Path.DirectorySeparatorChar).Replace('/', _fs.Path.DirectorySeparatorChar);
+        return path.Replace('\\', _fileSystem.Path.DirectorySeparatorChar).Replace('/', _fileSystem.Path.DirectorySeparatorChar);
     }
 
     private void EnsureParent(string fullPath)
     {
-        var dir = _fs.Path.GetDirectoryName(fullPath);
+        var dir = _fileSystem.Path.GetDirectoryName(fullPath);
         if (!string.IsNullOrEmpty(dir))
-            _fs.Directory.CreateDirectory(dir!);
+            _fileSystem.Directory.CreateDirectory(dir!);
     }
 }

src/PetroglyphTools/PG.StarWarsGame.Engine.Testing/RepoOriginWriter.cs

@@ -1,25 +1,28 @@
 using System;
 using System.Collections.Generic;
 using System.IO.Abstractions;
+using Microsoft.Extensions.DependencyInjection;
 
 namespace PG.StarWarsGame.Engine.Testing;
 
 /// <summary>Builds a temp-directory-backed <see cref="VirtualGameRepo"/> from raw file content.</summary>
 public sealed class VirtualGameRepoBuilder
 {
+    private readonly IServiceProvider _services;
     private readonly IFileSystem _fs;
     private readonly string _tempRoot;
     private readonly string _gameRoot;
-    private readonly List<string> _modPaths = new();
-    private readonly List<string> _fallbackPaths = new();
+    private readonly List<string> _modPaths = [];
+    private readonly List<string> _fallbackPaths = [];
     private string? _fallbackGamePath;
 
     /// <summary>Initializes a new instance of the <see cref="VirtualGameRepoBuilder"/> class.</summary>
-    /// <param name="fileSystem">The file system used for all builder I/O.</param>
-    /// <exception cref="ArgumentNullException"><paramref name="fileSystem"/> is <see langword="null"/>.</exception>
-    public VirtualGameRepoBuilder(IFileSystem fileSystem)
+    /// <param name="services">The service provider supplying the file system and file-format services used by the builder.</param>
+    /// <exception cref="ArgumentNullException"><paramref name="services"/> is <see langword="null"/>.</exception>
+    public VirtualGameRepoBuilder(IServiceProvider services)
     {
-        _fs = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
+        _services = services ?? throw new ArgumentNullException(nameof(services));
+        _fs = services.GetRequiredService<IFileSystem>();
         _tempRoot = _fs.Path.Combine(_fs.Path.GetTempPath(),
             $"PG.StarWarsGame.Engine.Testing.{Guid.NewGuid():N}");
         _gameRoot = _fs.Path.Combine(_tempRoot, "game");
@@ -31,10 +34,10 @@ public VirtualGameRepoBuilder(IFileSystem fileSystem)
     /// <exception cref="ArgumentNullException"><paramref name="configure"/> is <see langword="null"/>.</exception>
     public VirtualGameRepoBuilder WithGame(Action<IRepoOriginWriter> configure)
     {
-        if (configure == null) 
+        if (configure == null)
             throw new ArgumentNullException(nameof(configure));
-        
-        configure(new RepoOriginWriter(_fs, _gameRoot));
+
+        configure(new RepoOriginWriter(_services, _gameRoot));
         return this;
     }
 
@@ -45,13 +48,13 @@ public VirtualGameRepoBuilder WithFallbackGame(Action<IRepoOriginWriter> configu
     {
         if (configure == null)
             throw new ArgumentNullException(nameof(configure));
-        
+
         if (_fallbackGamePath == null)
         {
             _fallbackGamePath = _fs.Path.Combine(_tempRoot, "fallback", "_primary");
             _fs.Directory.CreateDirectory(_fallbackGamePath);
         }
-        configure(new RepoOriginWriter(_fs, _fallbackGamePath));
+        configure(new RepoOriginWriter(_services, _fallbackGamePath));
         return this;
     }
 
@@ -62,18 +65,18 @@ public VirtualGameRepoBuilder WithFallbackGame(Action<IRepoOriginWriter> configu
     /// <exception cref="ArgumentNullException"><paramref name="configure"/> is <see langword="null"/>.</exception>
     public VirtualGameRepoBuilder WithFallback(string name, Action<IRepoOriginWriter> configure)
     {
-        if (string.IsNullOrEmpty(name)) 
+        if (string.IsNullOrEmpty(name))
             throw new ArgumentException("Fallback name must be non-empty.", nameof(name));
-        if (configure == null) 
+        if (configure == null)
             throw new ArgumentNullException(nameof(configure));
-        
+
         var dir = _fs.Path.Combine(_tempRoot, "fallback", name);
         if (!_fallbackPaths.Contains(dir))
         {
             _fs.Directory.CreateDirectory(dir);
             _fallbackPaths.Add(dir);
         }
-        configure(new RepoOriginWriter(_fs, dir));
+        configure(new RepoOriginWriter(_services, dir));
         return this;
     }
 
@@ -89,14 +92,14 @@ public VirtualGameRepoBuilder WithMod(string name, Action<IRepoOriginWriter> con
             throw new ArgumentException("Mod name must be non-empty.", nameof(name));
         if (configure == null)
             throw new ArgumentNullException(nameof(configure));
-        
+
         var dir = _fs.Path.Combine(_tempRoot, "mods", name);
         if (!_modPaths.Contains(dir))
         {
             _fs.Directory.CreateDirectory(dir);
             _modPaths.Add(dir);
         }
-        configure(new RepoOriginWriter(_fs, dir));
+        configure(new RepoOriginWriter(_services, dir));
         return this;
     }