Add verification mode

Author: arturjpv

ServerCodeExciser/ServerCodeExciser.cs

@@ -53,6 +53,10 @@ public sealed class Settings : CommandSettings
             [Description("Processes everything, but does not write any output to disk.")]
             public bool IsDryRun { get; init; }
 
+            [CommandOption("-v|--verify")]
+            [Description("Verify that all analized code does not require modifications to excise server scopes.")]
+            public bool Verify { get; init; }
+
             [CommandArgument(0, "[INPUT]")]
             [Description("The input folder to excise.")]
             public string InputPath { get; init; } = string.Empty;
@@ -81,7 +85,8 @@ public override int Execute([NotNull] CommandContext context, [NotNull] Settings
             parameters.ExciseAllFunctionsRegexString = settings.ExciseAllFunctionsRegexString ?? string.Empty;
             parameters.FullExcisionRegexString = settings.FullExcisionRegexString ?? string.Empty;
             parameters.ShouldOutputUntouchedFiles = settings.ShouldOutputUntouchedFiles;
-            parameters.IsDryRun = settings.ShouldOutputUntouchedFiles;
+            parameters.IsDryRun = settings.IsDryRun || settings.ShouldOutputUntouchedFiles || settings.Verify;
+            parameters.Verify = settings.Verify;
             parameters.UseFunctionStats = settings.UseFunctionStats;
             parameters.DontSkip = settings.DontSkip;
             if (settings.RequiredExcisionRatio.HasValue)

ServerCodeExciser/ServerCodeExcisionProcessor.cs

@@ -16,6 +16,7 @@ public class ServerCodeExcisionParameters
         public string FullExcisionRegexString { get; set; } = string.Empty;
         public bool ShouldOutputUntouchedFiles { get; set; } = false;
         public bool IsDryRun { get; set; } = false;
+        public bool Verify { get; set; } = false;
         public bool UseFunctionStats { get; set; } = false;
         public bool DontSkip { get; set; } = false;
         public float RequiredExcisionRatio { get; set; } = -1.0f;
@@ -128,6 +129,23 @@ public EExciserReturnValues ExciseServerCode(string filePattern, IServerCodeExci
 
             var endTime = DateTime.UtcNow;
 
+            // In verification mode error codes reverse the normal behavior of the exciser.
+            // Modifications required -> error
+            // No modifications required -> success
+            if (_parameters.Verify)
+            {
+                if (globalStats.CharactersExcised > 0)
+                {
+                    Console.Error.WriteLine("Executed in verification mode. Manual server code exicion is required.");
+                    return EExciserReturnValues.RequiresExcision;
+                }
+                else
+                {
+                    Console.WriteLine("Executed in verification mode. No modifications are required.");
+                    return EExciserReturnValues.Success;
+                }
+            }
+
             if (globalStats.CharactersExcised > 0)
             {
                 System.Diagnostics.Debug.Assert(globalStats.TotalNrCharacters > 0, "Something is terribly wrong.");

ServerCodeExcisionCommon/ServerCodeExcisionUtils.cs

@@ -82,7 +82,8 @@ public enum EExciserReturnValues
 		UnknownExcisionLanguage,
 		NothingExcised,
 		InternalExcisionError,
-		RequiredExcisionRatioNotReached		
+		RequiredExcisionRatioNotReached,
+		RequiresExcision
 	}
 
 	public class ExcisionException : Exception