Merge branch 'develop' into feat/filetype-maps

Author: AnakinRaW

.github/workflows/release.yml

@@ -47,6 +47,8 @@ jobs:
       - name: Create Net Core Release
         # use publish for .NET Core
         run:  dotnet publish ${{ env.TOOL_PROJ_PATH }} --configuration Release -f net10.0 --output ./releases/net10.0 /p:DebugType=None /p:DebugSymbols=false
+      - name: Create Linux Release
+        run:  dotnet publish ${{ env.TOOL_PROJ_PATH }} --configuration Release -f net10.0 --runtime linux-x64 --self-contained true --output ./releases/linux-x64 /p:DebugType=None /p:DebugSymbols=false
       - name: Upload a Build Artifact
         uses: actions/upload-artifact@v7
         with:
@@ -109,12 +111,13 @@ jobs:
         # Create a GitHub release on push to main only
         if: |
             github.ref == 'refs/heads/main' &&  github.event_name == 'push'
-        uses: softprops/action-gh-release@v2
+        uses: softprops/action-gh-release@v3
         with:
           name: v${{ steps.nbgv.outputs.SemVer2 }}
           tag_name: v${{ steps.nbgv.outputs.SemVer2 }}
           token: ${{ secrets.GITHUB_TOKEN }}
           generate_release_notes: true
           files: | 
             ./releases/net481/ModVerify.exe
-            ./releases/ModVerify-Net10.zip
+            ./releases/ModVerify-Net10.zip
+            ./releases/linux-x64/ModVerify

Directory.Build.props

@@ -33,7 +33,7 @@
 
 	<ItemGroup>
 		<PackageReference Update="SauceControl.InheritDoc" Version="2.0.2" />
-		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.201" PrivateAssets="All"/>
+		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.203" PrivateAssets="All"/>
 		<PackageReference Include="Nerdbank.GitVersioning" Condition="!Exists('packages.config')">
 			<PrivateAssets>all</PrivateAssets>
 			<Version>3.9.50</Version>

ModVerify.slnx

@@ -17,6 +17,8 @@
     <Project Path="modules/ModdingToolBase/src/Updater/ExternalUpdater.Core/ExternalUpdater.Core.csproj" />
   </Folder>
   <Folder Name="/PetroglyphTools/">
+    <Project Path="src/PetroglyphTools/PG.StarWarsGame.Engine.FileSystem.Test/PG.StarWarsGame.Engine.FileSystem.Test.csproj" />
+    <Project Path="src/PetroglyphTools/PG.StarWarsGame.Engine.FileSystem/PG.StarWarsGame.Engine.FileSystem.csproj" />
     <Project Path="src/PetroglyphTools/PG.StarWarsGame.Engine/PG.StarWarsGame.Engine.csproj" />
     <Project Path="src/PetroglyphTools/PG.StarWarsGame.Files.ALO/PG.StarWarsGame.Files.ALO.csproj" />
     <Project Path="src/PetroglyphTools/PG.StarWarsGame.Files.ChunkFiles.Test/PG.StarWarsGame.Files.ChunkFiles.Test.csproj" Id="cf14a3d6-9f76-479a-9ae2-c3f2e8c6464c">

README.md

@@ -80,13 +80,58 @@ In general ModVerify has two operation mods.
 1. `verify` Verifying a game or mod 
 2. `createBaseline` Creating a baseline for a game or mod, that can be used for further verifications in order to verify you did not add more errors to your mods.
 
-### Example
-This is an example run configuration that analyzes a specific mod, uses a the FoC basline and writes the output into a dedicated directory: 
+### Examples
 
-```bash
+#### Example 1: Auto-detection with a custom baseline
+Analyzes a specific mod, uses the FoC baseline and writes the output into a dedicated directory:
+
+**Windows:**
+```bat
 .\ModVerify.exe verify --path "C:\My Games\FoC\Mods\MyMod" --outDir "C:\My Games\FoC\Mods\MyMod\verifyResults" --baseline ./focBaseline.json
 ```
 
+**Linux:**
+```bash
+./ModVerify verify \
+  --path "/home/user/games/FoC/Mods/MyMod" \
+  --outDir "/home/user/games/FoC/Mods/MyMod/verifyResults" \
+  --baseline ./focBaseline.json
+```
+
+#### Example 2: Manual mod setup with sub-mods, EaW fallback and default baseline
+Uses manual mod setup, including sub-mods and the EaW fallback game, and uses the default embedded baseline:
+
+**Windows:**
+```bat
+.\ModVerify.exe verify --mods "C:\My Games\FoC\Mods\MySubMod;C:\My Games\FoC\Mods\MyMod" --game "C:\My Games\FoC" --fallbackGame "C:\My Games\EaW" --engine FOC --useDefaultBaseline
+```
+
+**Linux:**
+```bash
+./ModVerify verify \
+  --mods "/home/user/games/FoC/Mods/MySubMod:/home/user/games/FoC/Mods/MyMod" \
+  --game "/home/user/games/FoC" \
+  --fallbackGame "/home/user/games/EaW" \
+  --engine FOC \
+  --useDefaultBaseline
+```
+
+#### Example 3: Layering a mod-specific baseline on top of the default baseline
+A typical mod-dev workflow: filter the base game's known findings with the embedded default baseline, *and* filter your mod's own accepted findings with your own baseline. The two baselines stay independent — you can regenerate your mod baseline without touching the default.
+
+**Windows:**
+```bat
+.\ModVerify.exe verify --path "C:\My Games\FoC\Mods\MyMod" --useDefaultBaseline --baseline ./myModBaseline.json
+```
+
+**Linux:**
+```bash
+./ModVerify verify \
+  --path "/home/user/games/FoC/Mods/MyMod" \
+  --useDefaultBaseline \
+  --baseline ./myModBaseline.json
+```
+
 ---
 
 ## Available Checks
@@ -116,6 +161,33 @@ The following verifiers are currently implemented:
 If you want to create your own baseline use the `createBaseline` option. 
 
 ### Example
+
+**Windows**
 ```bash
 ModVerify.exe createBaseline --outFile myBaseline.json --path "C:\My Games\FoC\Mods\MyMod"
 ```
+**Linux**
+```bash
+./ModVerify createBaseline \
+  --outFile myBaseline.json \
+  --path "C:\My Games\FoC\Mods\MyMod"
+```
+
+### Creating a mod baseline on top of a base baseline
+
+If you maintain a mod and only want your baseline to contain findings your mod is responsible for, supply the base baselines you want to subtract out. Findings already covered by the base baselines are excluded from the new file. The base baselines themselves are not modified, so they can keep being maintained independently.
+
+**Windows**
+```bat
+.\ModVerify.exe createBaseline --outFile myModBaseline.json --path "C:\My Games\FoC\Mods\MyMod" --useDefaultBaseline
+```
+
+**Linux**
+```bash
+./ModVerify createBaseline \
+  --outFile myModBaseline.json \
+  --path "/home/user/games/FoC/Mods/MyMod" \
+  --useDefaultBaseline
+```
+
+You can also chain a custom base baseline via `--baseline <path>`, and combine it with `--useDefaultBaseline`.

src/ModVerify.CliApp/App/CreateBaselineAction.cs

@@ -1,8 +1,7 @@
-using AET.ModVerify.App.Reporting;
+using AET.ModVerify.App.Reporting;
 using AET.ModVerify.App.Settings;
 using AET.ModVerify.App.Utilities;
 using AET.ModVerify.Reporting;
-using AET.ModVerify.Reporting.Baseline;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using System;
@@ -15,7 +14,7 @@ internal sealed class CreateBaselineAction(AppBaselineSettings settings, IServic
     : ModVerifyApplicationAction<AppBaselineSettings>(settings, serviceProvider)
 {
     private readonly IFileSystem _fileSystem = serviceProvider.GetRequiredService<IFileSystem>();
-    
+
     protected override void PrintAction(VerificationTarget target)
     {
         Console.WriteLine();
@@ -29,11 +28,11 @@ protected override void PrintAction(VerificationTarget target)
     protected override async Task<int> ProcessResult(VerificationResult result)
     {
         var baselineFactory = ServiceProvider.GetRequiredService<IBaselineFactory>();
-        var baseline = baselineFactory.CreateBaseline(result.Target, Settings, result.Errors);
+        var baseline = baselineFactory.CreateBaseline(result.Target, Settings, result.Errors.NewErrors);
 
         var fullPath = _fileSystem.Path.GetFullPath(Settings.NewBaselinePath);
-        Logger?.LogInformation(ModVerifyConstants.ConsoleEventId, 
-            "Writing Baseline to '{FullPath}' with {Number} findings", fullPath, result.Errors.Count);
+        Logger?.LogInformation(ModVerifyConstants.ConsoleEventId,
+            "Writing Baseline to '{FullPath}' with {Number} findings", fullPath, result.Errors.NewErrors.Count);
 
         await baselineFactory.WriteBaselineAsync(baseline, Settings.NewBaselinePath);
 
@@ -46,9 +45,4 @@ protected override async Task<int> ProcessResult(VerificationResult result)
 
         return ModVerifyConstants.Success;
     }
-
-    protected override VerificationBaseline GetBaseline(VerificationTarget verificationTarget)
-    {
-        return VerificationBaseline.Empty;
-    }
 }

src/ModVerify.CliApp/App/ModVerifyApplicationAction.cs

@@ -1,14 +1,17 @@
 using System;
 using System.IO.Abstractions;
+using System.Linq;
 using System.Threading.Tasks;
 using AET.ModVerify.App.GameFinder;
 using AET.ModVerify.App.Reporting;
 using AET.ModVerify.App.Settings;
 using AET.ModVerify.App.TargetSelectors;
+using AET.ModVerify.App.Utilities;
 using AET.ModVerify.Reporting;
 using AET.ModVerify.Reporting.Baseline;
 using AET.ModVerify.Reporting.Suppressions;
 using AnakinRaW.ApplicationBase;
+using AnakinRaW.CommonUtilities.SimplePipeline;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
@@ -74,18 +77,59 @@ public async Task<int> ExecuteAsync()
         var verificationResult = await VerifyTargetAsync(verificationTarget)
             .ConfigureAwait(false);
 
+        Console.WriteLine();
+
+        switch (verificationResult.Status)
+        {
+            case VerificationCompletionStatus.Cancelled:
+                return ModVerifyConstants.VerifyCancelled;
+            case VerificationCompletionStatus.Failed:
+                return ReportVerificationFailure(verificationResult.Exception!);
+        }
+
         return await ProcessResult(verificationResult);
     }
 
+    private int ReportVerificationFailure(Exception verificationException)
+    {
+        var exceptionToReport = verificationException switch
+        {
+            AggregateException aggregate => aggregate.InnerExceptions.FirstOrDefault() ?? aggregate,
+            StepFailureException stepFailure => stepFailure.FailedSteps.First().Error!,
+            _ => verificationException
+        };
+
+        ConsoleUtilities.WriteApplicationFatalError(_appEnvironment.ApplicationName, exceptionToReport);
+        Logger?.LogError(exceptionToReport, exceptionToReport.Message);
+
+        return exceptionToReport.HResult;
+    }
+
     protected abstract Task<int> ProcessResult(VerificationResult result);
-    
-    protected abstract VerificationBaseline GetBaseline(VerificationTarget verificationTarget);
+
+    protected virtual BaselineCollection GetBaselines(VerificationTarget verificationTarget)
+    {
+        var baselineSelector = new BaselineSelector(Settings, ServiceProvider);
+        var baselines = baselineSelector.SelectBaselines(verificationTarget);
+        if (!baselines.IsEmpty)
+        {
+            Console.WriteLine();
+            ModVerifyConsoleUtilities.WriteBaselineInfo(baselines);
+            foreach (var entry in baselines)
+            {
+                Logger?.LogDebug("Using baseline {Baseline} from source '{Identifier}'",
+                    entry.Baseline.ToString(), entry.Identifier);
+            }
+            Console.WriteLine();
+        }
+        return baselines;
+    }
 
     private async Task<VerificationResult> VerifyTargetAsync(VerificationTarget verificationTarget)
     {
         var progressReporter = new VerifyConsoleProgressReporter(verificationTarget.Name, Settings.ReportSettings);
 
-        var baseline = GetBaseline(verificationTarget);
+        var baselines = GetBaselines(verificationTarget);
         var suppressions = GetSuppressions();
 
         try
@@ -95,11 +139,11 @@ private async Task<VerificationResult> VerifyTargetAsync(VerificationTarget veri
             Logger?.LogInformation(ModVerifyConstants.ConsoleEventId, "Verifying '{Target}'...", verificationTarget.Name);
 
             var verificationResult = await verifierService.VerifyAsync(
-                verificationTarget, 
+                verificationTarget,
                 Settings.VerifierServiceSettings,
-                baseline, 
+                baselines,
                 suppressions,
-                progressReporter, 
+                progressReporter,
                 new EngineInitializeProgressReporter(verificationTarget.Engine));
 
             progressReporter.Report(string.Empty, 1.0);
@@ -112,6 +156,10 @@ private async Task<VerificationResult> VerifyTargetAsync(VerificationTarget veri
                 case VerificationCompletionStatus.Cancelled:
                     Logger?.LogWarning(ModVerifyConstants.ConsoleEventId, "Verification was cancelled.");
                     break;
+                case VerificationCompletionStatus.Failed:
+                    progressReporter.ReportError("Verification failed!", 
+                        $"An unexpected error occurred while verifying '{verificationTarget.Name}'.");
+                    break;
                 case VerificationCompletionStatus.Completed:
                 default:
                     Logger?.LogInformation(ModVerifyConstants.ConsoleEventId, "Verification completed successfully.");

src/ModVerify.CliApp/App/VerifyAction.cs

@@ -1,5 +1,4 @@
-using AET.ModVerify.App.Reporting;
-using AET.ModVerify.App.Settings;
+using AET.ModVerify.App.Settings;
 using AET.ModVerify.App.Utilities;
 using AET.ModVerify.Reporting;
 using Microsoft.Extensions.Logging;
@@ -8,7 +7,6 @@
 using System.Linq;
 using System.Threading.Tasks;
 using AET.ModVerify.Reporting.Reporters;
-using AET.ModVerify.Reporting.Baseline;
 
 namespace AET.ModVerify.App;
 
@@ -41,7 +39,7 @@ protected override async Task<int> ProcessResult(VerificationResult result)
         await reportBroker.ReportAsync(result);
 
         if (Settings.AppFailsOnMinimumSeverity.HasValue &&
-            result.Errors.Any(x => x.Severity >= Settings.AppFailsOnMinimumSeverity))
+            result.Errors.NewErrors.Any(x => x.Severity >= Settings.AppFailsOnMinimumSeverity))
         {
             Logger?.LogInformation(ModVerifyConstants.ConsoleEventId,
                 "The verification of {Target} completed with findings of the specified failure severity {Severity}",
@@ -53,31 +51,18 @@ protected override async Task<int> ProcessResult(VerificationResult result)
         return ModVerifyConstants.Success;
     }
 
-    protected override VerificationBaseline GetBaseline(VerificationTarget verificationTarget)
-    {
-        var baselineSelector = new BaselineSelector(Settings, ServiceProvider);
-        var baseline = baselineSelector.SelectBaseline(verificationTarget, out var baselinePath);
-        if (!baseline.IsEmpty)
-        {
-            Console.WriteLine();
-            ModVerifyConsoleUtilities.WriteBaselineInfo(baseline, baselinePath);
-            Logger?.LogDebug("Using baseline {Baseline} from location '{Path}'", baseline.ToString(), baselinePath);
-            Console.WriteLine();
-        }
-        return baseline;
-    }
-
     private IReadOnlyCollection<IVerificationReporter> CreateReporters()
     {
-        var reporters = new List<IVerificationReporter>();
-
-        reporters.Add(IVerificationReporter.CreateConsole(new ConsoleReporterSettings
+        var reporters = new List<IVerificationReporter>
         {
-            Verbose = Settings.ReportSettings.Verbose,
-            MinimumReportSeverity = Settings.VerifierServiceSettings.FailFastSettings.IsFailFast
-                ? VerificationSeverity.Information
-                : VerificationSeverity.Error
-        }, ServiceProvider));
+            IVerificationReporter.CreateConsole(new ConsoleReporterSettings
+            {
+                Verbose = Settings.ReportSettings.Verbose,
+                MinimumReportSeverity = Settings.VerifierServiceSettings.FailFastSettings.IsFailFast
+                    ? VerificationSeverity.Information
+                    : VerificationSeverity.Error
+            }, ServiceProvider)
+        };
 
         var outputDirectory = Settings.ReportDirectory;
         reporters.Add(IVerificationReporter.CreateJson(new JsonReporterSettings