Merge pull request #1 from AlamoEngine-Tools/develop

New Releases

.github/workflows/release.yml

@@ -0,0 +1,69 @@
+name: Releasing ModVerify
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+
+# Builds and tests the solution.
+  test:
+    uses: ./.github/workflows/test.yml
+
+  pack:
+    name: Pack
+    needs: [test]
+    runs-on: windows-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+      - name: Create NetFramework Release
+        run:  dotnet publish .\src\ModVerify.CliApp\ModVerify.CliApp.csproj --configuration Release -f net48 --output ./releases/net48
+      - name: Create Net Core Release
+        run:  dotnet publish .\src\ModVerify.CliApp\ModVerify.CliApp.csproj --configuration Release -f net8.0 --output ./releases/net8.0
+      - name: Upload a Build Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: Binary Releases
+          path: ./releases
+          if-no-files-found: error
+          retention-days: 1
+
+  deploy:
+    name: Deploy
+    if: |
+      github.ref == 'refs/heads/main' &&  github.event_name == 'push'
+    needs: [pack]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/download-artifact@v4
+        with:
+          name: Binary Releases
+          path: ./releases
+      - name: Create NET Core zip
+        # Change into the artifacts directory to avoid including the directory itself in the zip archive
+        working-directory: ./releases/net8.0
+        run: zip -r ./releases/ModVerify-Net8.zip .
+      - uses: dotnet/[email protected]
+        id: nbgv
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: v${{ steps.nbgv.outputs.SemVer2 }}
+          tag_name: v${{ steps.nbgv.outputs.SemVer2 }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          generate_release_notes: true
+          files: | 
+            ./releases/net48/ModVerify.CliApp.exe
+            ./releases/ModVerify-Net8.zip

.github/workflows/test.yml

@@ -1,12 +1,12 @@
-name: Petroglyph Tools .NET Build & Test
+name: ModVerify Build & Test
 
 on:
   workflow_call:
   workflow_dispatch:
   push:
-    branches: [ main ]
+    branches: [ develop ]
   pull_request:
-    branches: [ main ]
+    branches: [ develop ]
 
 jobs:
   build-test:

Directory.Build.props

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup>
+    <PackageReference Include="Nerdbank.GitVersioning" Condition="!Exists('packages.config')">
+      <PrivateAssets>all</PrivateAssets>
+      <Version>3.6.133</Version>
+    </PackageReference>
+  </ItemGroup>
+</Project>

src/ModVerify.CliApp/FodyWeavers.xml

@@ -0,0 +1,3 @@
+<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
+  <Costura />
+</Weavers>

src/ModVerify.CliApp/ModVerify.CliApp.csproj

@@ -18,6 +18,10 @@
 	<ItemGroup>
 		<PackageReference Include="AlamoEngineTools.PG.StarWarsGame.Infrastructure.Clients" Version="3.1.5" />
 		<PackageReference Include="AlamoEngineTools.SteamAbstraction" Version="3.1.5" />
+		<PackageReference Include="Costura.Fody" Version="5.7.0">
+		  <PrivateAssets>all</PrivateAssets>
+		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+		</PackageReference>
 		<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.1" />

src/ModVerify.CliApp/Program.cs

@@ -80,7 +80,7 @@ static async Task Main(string[] args)
         }
     }
 
-    private static VerifyFocPipeline BuildPipeline(IPlayableObject playableObject, IGame fallbackGame)
+    private static VerifyGamePipeline BuildPipeline(IPlayableObject playableObject, IGame fallbackGame)
     {
         IList<string> mods = Array.Empty<string>();
         if (playableObject is IMod mod)
@@ -97,7 +97,9 @@ private static VerifyFocPipeline BuildPipeline(IPlayableObject playableObject, I
             playableObject.Game.Directory.FullName,
             fallbackGame.Directory.FullName);
 
-        return new VerifyFocPipeline(gameLocations, VerificationSettings.Default, _services);
+        var repo = _services.GetRequiredService<IGameRepositoryFactory>().Create(GameEngineType.Foc, gameLocations);
+
+        return new VerifyGamePipeline(repo, VerificationSettings.Default, _services);
     }
 
     private static IServiceProvider CreateAppServices()

src/ModVerify/GameVerificationException.cs

@@ -11,6 +11,10 @@ public sealed class GameVerificationException(IEnumerable<GameVerificationStep>
     private readonly string? _error = null;
     private readonly IEnumerable<IStep> _failedSteps = failedSteps ?? throw new ArgumentNullException(nameof(failedSteps));
 
+    public GameVerificationException(GameVerificationStep step) : this([step])
+    {
+    }
+
     /// <inheritdoc/>
     public override string Message => Error;
 

src/ModVerify/ModVerify.csproj

@@ -25,6 +25,10 @@
 		  <PrivateAssets>all</PrivateAssets>
 		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 	  </PackageReference>
+	  <PackageReference Include="Required" Version="1.0.0">
+		  <PrivateAssets>all</PrivateAssets>
+		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+	  </PackageReference>
 	</ItemGroup>
 
 	<ItemGroup>

src/ModVerify/Steps/GameVerificationStep.cs

@@ -12,7 +12,11 @@
 
 namespace AET.ModVerify.Steps;
 
-public abstract class GameVerificationStep(CreateGameDatabaseStep createDatabaseStep, IGameRepository repository, IServiceProvider serviceProvider)
+public abstract class GameVerificationStep(
+    CreateGameDatabaseStep createDatabaseStep,
+    IGameRepository repository, 
+    VerificationSettings settings,
+    IServiceProvider serviceProvider)
     : PipelineStep(serviceProvider)
 {
     protected readonly IFileSystem FileSystem = serviceProvider.GetRequiredService<IFileSystem>();
@@ -22,6 +26,8 @@ public abstract class GameVerificationStep(CreateGameDatabaseStep createDatabase
 
     public IReadOnlyCollection<VerificationError> VerifyErrors => _verifyErrors;
 
+    protected VerificationSettings Settings { get; } = settings;
+
     protected GameDatabase Database { get; private set; } = null!;
 
     protected IGameRepository Repository => repository;
@@ -34,14 +40,16 @@ protected sealed override void RunCore(CancellationToken token)
     {
         createDatabaseStep.Wait();
         Database = createDatabaseStep.GameDatabase;
-
+
+        Logger?.LogInformation($"Running verifier '{Name}'...");
         try
         {
             _errorLog = CreateVerificationLogFile();
             RunVerification(token);
         }
         finally
         {
+            Logger?.LogInformation($"Finished verifier '{Name}'");
             _errorLog.Dispose();
             _errorLog = null!;
         }
@@ -57,9 +65,11 @@ protected void AddError(VerificationError error)
             Logger?.LogTrace($"Error suppressed: '{error}'");
             return;
         }
-
         _verifyErrors.Add(error);
         _errorLog.WriteLine(error.Message);
+
+        if (Settings.ThrowBehavior == VerifyThrowBehavior.FailFast)
+            throw new GameVerificationException(this);
     }
 
     protected virtual bool OnError(VerificationError error)

src/ModVerify/Steps/VerifyReferencedModelsStep.cs

@@ -17,8 +17,12 @@
 
 namespace AET.ModVerify.Steps;
 
-internal sealed class VerifyReferencedModelsStep(CreateGameDatabaseStep createDatabaseStep, IGameRepository repository, IServiceProvider serviceProvider)
-    : GameVerificationStep(createDatabaseStep, repository, serviceProvider)
+internal sealed class VerifyReferencedModelsStep(
+    CreateGameDatabaseStep createDatabaseStep,
+    IGameRepository repository, 
+    VerificationSettings settings,
+    IServiceProvider serviceProvider)
+    : GameVerificationStep(createDatabaseStep, repository, settings, serviceProvider)
 {
     public const string ModelNotFound = "ALO00";
     public const string ModelBroken = "ALO01";

src/ModVerify/VerificationSettings.cs

@@ -0,0 +1,11 @@
+namespace AET.ModVerify;
+
+public record VerificationSettings
+{
+    public static readonly VerificationSettings Default = new()
+    {
+        ThrowBehavior = VerifyThrowBehavior.None
+    };
+
+    public VerifyThrowBehavior ThrowBehavior { get; init; }
+}

src/ModVerify/VerifyPipeline.cs → src/ModVerify/VerifyGamePipeline.cs

@@ -11,36 +11,26 @@
 
 namespace AET.ModVerify;
 
-
-public record VerificationSettings
-{
-    public static readonly VerificationSettings Default = new();
-
-    public bool ThrowOnError { get; init; }
-}
-
-
-public class VerifyFocPipeline : ParallelPipeline
+public class VerifyGamePipeline : ParallelPipeline
 {
     private IList<GameVerificationStep> _verificationSteps = null!;
-    private readonly GameLocations _gameLocations;
+    private readonly IGameRepository _repository;
     private readonly VerificationSettings _settings;
 
-    public VerifyFocPipeline(GameLocations gameLocations, VerificationSettings settings, IServiceProvider serviceProvider)
+    public VerifyGamePipeline(IGameRepository gameRepository, VerificationSettings settings, IServiceProvider serviceProvider)
         : base(serviceProvider, 4, false)
     {
-        _gameLocations = gameLocations;
+        _repository = gameRepository;
         _settings = settings;
     }
 
     protected override Task<IList<IStep>> BuildSteps()
     {
-        var repository = new FocGameRepository(_gameLocations, ServiceProvider);
+        var buildIndexStep = new CreateGameDatabaseStep(_repository, ServiceProvider);
 
-        var buildIndexStep = new CreateGameDatabaseStep(repository, ServiceProvider);
         _verificationSteps = new List<GameVerificationStep>
         {
-            new VerifyReferencedModelsStep(buildIndexStep, repository, ServiceProvider),
+            new VerifyReferencedModelsStep(buildIndexStep, _repository, _settings, ServiceProvider),
         };
 
         var allSteps = new List<IStep>
@@ -71,7 +61,7 @@ public override async Task RunAsync(CancellationToken token = default)
                 }
             }
 
-            if (_settings.ThrowOnError && failedSteps.Count > 0)
+            if (_settings.ThrowBehavior == VerifyThrowBehavior.FinalThrow && failedSteps.Count > 0)
                 throw new GameVerificationException(stepsWithVerificationErrors);
         }
         finally

src/ModVerify/VerifyThrowBehavior.cs

@@ -0,0 +1,8 @@
+namespace AET.ModVerify;
+
+public enum VerifyThrowBehavior
+{
+    None,
+    FinalThrow,
+    FailFast
+}

src/PetroglyphTools/PG.StarWarsGame.Engine/FileSystem/GameRepository.cs

@@ -34,6 +34,8 @@ public class FocGameRepository : IGameRepository
 
     private readonly IVirtualMegArchive? _masterMegArchive;
 
+    public GameEngineType EngineType => GameEngineType.Foc;
+
     public IRepository EffectsRepository { get; }
 
     public FocGameRepository(GameLocations gameLocations, IServiceProvider serviceProvider)

src/PetroglyphTools/PG.StarWarsGame.Engine/FileSystem/GameRepositoryFactory.cs

@@ -0,0 +1,13 @@
+using System;
+
+namespace PG.StarWarsGame.Engine.FileSystem;
+
+internal sealed class GameRepositoryFactory(IServiceProvider serviceProvider) :  IGameRepositoryFactory
+{
+    public IGameRepository Create(GameEngineType engineType, GameLocations gameLocations)
+    {
+        if (engineType == GameEngineType.Eaw)
+            throw new NotImplementedException("Empire at War is currently not supported.");
+        return new FocGameRepository(gameLocations, serviceProvider);
+    }
+}

src/PetroglyphTools/PG.StarWarsGame.Engine/FileSystem/IGameRepository.cs

@@ -2,7 +2,9 @@
 
 public interface IGameRepository : IRepository
 {
-   IRepository EffectsRepository { get; }
+    public GameEngineType EngineType { get; }
 
-   bool FileExists(string filePath, string[] extensions, bool megFileOnly = false);
+    IRepository EffectsRepository { get; }
+
+    bool FileExists(string filePath, string[] extensions, bool megFileOnly = false);
 }

src/PetroglyphTools/PG.StarWarsGame.Engine/FileSystem/IGameRepositoryFactory.cs

@@ -0,0 +1,6 @@
+namespace PG.StarWarsGame.Engine.FileSystem;
+
+public interface IGameRepositoryFactory
+{
+    IGameRepository Create(GameEngineType engineType, GameLocations gameLocations);
+}

src/PetroglyphTools/PG.StarWarsGame.Engine/GameDatabase.cs

@@ -5,6 +5,8 @@ namespace PG.StarWarsGame.Engine;
 
 public class GameDatabase
 {
+    public required GameEngineType EngineType { get; init; }
+
     public required GameConstants GameConstants { get; init; }
 
     public required IList<GameObject> GameObjects { get; init; }

src/PetroglyphTools/PG.StarWarsGame.Engine/GameEngineType.cs

@@ -0,0 +1,16 @@
+namespace PG.StarWarsGame.Engine;
+
+/// <summary>
+/// The type of engine can be either "Empire at War" of "Forces of Corruption"
+/// </summary>
+public enum GameEngineType
+{
+    /// <summary>
+    /// Empire at War
+    /// </summary>
+    Eaw = 0,
+    /// <summary>
+    /// Forces of Corruption
+    /// </summary>
+    Foc = 1
+}

src/PetroglyphTools/PG.StarWarsGame.Engine/PetroglyphEngineServiceContribution.cs

@@ -1,4 +1,5 @@
 using Microsoft.Extensions.DependencyInjection;
+using PG.StarWarsGame.Engine.FileSystem;
 using PG.StarWarsGame.Engine.Language;
 using PG.StarWarsGame.Engine.Xml;
 
@@ -8,6 +9,7 @@ public static class PetroglyphEngineServiceContribution
 {
     public static void ContributeServices(IServiceCollection serviceCollection)
     {
+        serviceCollection.AddSingleton<IGameRepositoryFactory>(sp => new GameRepositoryFactory(sp));
         serviceCollection.AddSingleton<IGameLanguageManager>(sp => new GameLanguageManager(sp));
         serviceCollection.AddSingleton<IPetroglyphXmlFileParserFactory>(sp => new PetroglyphXmlFileParserFactory(sp));
     }

src/PetroglyphTools/PG.StarWarsGame.Engine/Pipeline/CreateGameDatabasePipeline.cs

@@ -75,6 +75,7 @@ protected override async Task RunCoreAsync(CancellationToken token)
 
         GameDatabase = new GameDatabase
         {
+            EngineType = repository.EngineType,
             GameConstants = _parseGameConstants.Database,
             GameObjects = _parseGameObjects.Database
         };