Fix: Handle invalid parameter configuration (kutoga#42)

* Handle invalid states * Update version * Fix test helpers * Add a test * Using ordering * Fix example * Update README * Downgrade netcore2.2 to netcore2.1
nasa03 · Aug 30, 2020 · f81184f · f81184f
1 parent 6303884
commit f81184f
Show file tree

Hide file tree

Showing 11 changed files with 75 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 # FluentArgs: Fluent Argument Parsing for .NET
 <strong>
 Version:
-0.9.6
+0.9.7
 
 </strong>
 
@@ -862,6 +862,11 @@ namespace Example
             {
                 throw new NotImplementedException();
             }
+
+            public Task PrintInvalidStateError(IReadOnlyCollection<string>? helpFlagAliases)
+            {
+                throw new NotImplementedException();
+            }
         }
     }
 }

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -12,7 +12,7 @@ variables:
   docDirectory: '$(Build.SourcesDirectory)/doc'
   major: '0'
   minor: '9'
-  patch: '6'
+  patch: '7'
 
 steps:
 - script: dotnet tool install --global Paket --version 5.203.0

diff --git a/doc/DummyProject/DummyProject.csproj b/doc/DummyProject/DummyProject.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <LangVersion>8.0</LangVersion>
     <OutputType>Exe</OutputType>
-    <TargetFramework>netcoreapp2.2</TargetFramework>
+    <TargetFramework>netcoreapp2.1</TargetFramework>
     <NoWarn>SA1633;SA1400;CA1303;SA0001</NoWarn>
   </PropertyGroup>
 

diff --git a/doc/examples/HandleErrors03.cs b/doc/examples/HandleErrors03.cs
@@ -42,6 +42,11 @@ public Task PrintInvalidCommandValueError(IReadOnlyCollection<string> aliases, s
             {
                 throw new NotImplementedException();
             }
+
+            public Task PrintInvalidStateError(IReadOnlyCollection<string>? helpFlagAliases)
+            {
+                throw new NotImplementedException();
+            }
         }
     }
 }
diff --git a/source/FluentArgs.Test.Helpers/DummyParsingErrorPrinter.cs b/source/FluentArgs.Test.Helpers/DummyParsingErrorPrinter.cs
@@ -32,6 +32,8 @@ public class DummyParsingErrorPrinter :
         public IReadOnlyCollection<(IReadOnlyCollection<string> remainingArguments, IReadOnlyCollection<string>? helpFlagAliases)> NotAllArgumentsAreUsedErrors =>
             notAllArgumentsAreUsedErrors;
 
+        public int InvalidStateErrors { get; private set; } = 0;
+
         public Task PrintArgumentMissingError(IReadOnlyCollection<string>? aliases, Type targetType, string description, IReadOnlyCollection<string>? helpFlagAliases)
         {
             argumentMissingErrors.Add((aliases, targetType, description, helpFlagAliases));
@@ -55,5 +57,11 @@ public Task PrintInvalidCommandValueError(IReadOnlyCollection<string> aliases, s
             invalidCommandValueErrors.Add((aliases, value, helpFlagAliases));
             return Task.CompletedTask;
         }
+
+        public Task PrintInvalidStateError(IReadOnlyCollection<string>? helpFlagAliases)
+        {
+            ++InvalidStateErrors;
+            return Task.CompletedTask;
+        }
     }
 }
diff --git a/source/FluentArgs.Test/Parsing/ErrorTests.cs b/source/FluentArgs.Test/Parsing/ErrorTests.cs
@@ -23,6 +23,7 @@ public static void IfAnArgumentIsMissing_ShouldFailAndPropagateError()
             parseSuccess.Should().BeFalse();
             called.Should().BeFalse();
             dummyParsingErrorPrinter.ArgumentParsingErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.InvalidStateErrors.Should().Be(0);
             dummyParsingErrorPrinter.ArgumentMissingErrors.Count.Should().Be(1);
             dummyParsingErrorPrinter.ArgumentMissingErrors.First().aliases.Should().BeEquivalentTo("-x");
             dummyParsingErrorPrinter.ArgumentMissingErrors.First().helpFlagAliases.Should().BeNull();
@@ -62,6 +63,7 @@ public static void IfArgumentCannotBeParsed_ShouldFailAndPropagateError()
             parseSuccess.Should().BeFalse();
             called.Should().BeFalse();
             dummyParsingErrorPrinter.ArgumentMissingErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.InvalidStateErrors.Should().Be(0);
             dummyParsingErrorPrinter.ArgumentParsingErrors.Count.Should().Be(1);
             dummyParsingErrorPrinter.ArgumentParsingErrors.First().aliases.Should().BeEquivalentTo("-n");
             dummyParsingErrorPrinter.InvalidCommandValueErrors.Should().BeEmpty();
@@ -86,6 +88,7 @@ public static void IfArgumentWithACustomParserCannotBeParsed_ShouldFailAndPropag
             parseSuccess.Should().BeFalse();
             called.Should().BeFalse();
             dummyParsingErrorPrinter.ArgumentMissingErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.InvalidStateErrors.Should().Be(0);
             dummyParsingErrorPrinter.ArgumentParsingErrors.Count.Should().Be(1);
             dummyParsingErrorPrinter.ArgumentParsingErrors.First().aliases.Should().BeEquivalentTo("-n");
             dummyParsingErrorPrinter.InvalidCommandValueErrors.Should().BeEmpty();
@@ -128,6 +131,7 @@ public static void FailedValidation_ShouldRecommendHelp()
             parseSuccess.Should().BeFalse();
             called.Should().BeFalse();
             dummyParsingErrorPrinter.ArgumentMissingErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.InvalidStateErrors.Should().Be(0);
             dummyParsingErrorPrinter.ArgumentParsingErrors.Count.Should().Be(1);
             dummyParsingErrorPrinter.ArgumentParsingErrors.First().aliases.Should().BeNull();
             dummyParsingErrorPrinter.ArgumentParsingErrors.First().helpFlagAliases.Should().BeEquivalentTo("-h", "--help");
@@ -155,6 +159,7 @@ public static void FailedValidationWithCustomParser_ShouldRecommendHelp()
             parseSuccess.Should().BeFalse();
             called.Should().BeFalse();
             dummyParsingErrorPrinter.ArgumentMissingErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.InvalidStateErrors.Should().Be(0);
             dummyParsingErrorPrinter.ArgumentParsingErrors.Count.Should().Be(1);
             dummyParsingErrorPrinter.ArgumentParsingErrors.First().aliases.Should().BeNull();
             dummyParsingErrorPrinter.ArgumentParsingErrors.First().helpFlagAliases.Should().BeEquivalentTo("-h", "--help");
@@ -182,6 +187,7 @@ public static void InvalidCommandValues_ShouldRecommendHelp()
             called.Should().BeFalse();
             dummyParsingErrorPrinter.ArgumentMissingErrors.Should().BeEmpty();
             dummyParsingErrorPrinter.ArgumentParsingErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.InvalidStateErrors.Should().Be(0);
             dummyParsingErrorPrinter.InvalidCommandValueErrors.Count.Should().Be(1);
             dummyParsingErrorPrinter.InvalidCommandValueErrors.First().aliases.Should().BeEquivalentTo("-n");
             dummyParsingErrorPrinter.InvalidCommandValueErrors.First().helpFlagAliases.Should().BeEquivalentTo("-h", "--help");
@@ -221,9 +227,30 @@ public static void IfTooManyArgumentsAreGivenAndItisDisallows_ShouldRecommendHel
             dummyParsingErrorPrinter.ArgumentMissingErrors.Should().BeEmpty();
             dummyParsingErrorPrinter.ArgumentParsingErrors.Should().BeEmpty();
             dummyParsingErrorPrinter.InvalidCommandValueErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.InvalidStateErrors.Should().Be(0);
             dummyParsingErrorPrinter.NotAllArgumentsAreUsedErrors.Count.Should().Be(1);
             dummyParsingErrorPrinter.NotAllArgumentsAreUsedErrors.First().remainingArguments.Should().BeEquivalentWithSameOrdering("a", "b");
             dummyParsingErrorPrinter.NotAllArgumentsAreUsedErrors.First().helpFlagAliases.Should().BeEquivalentTo("-h", "--help");
         }
+
+        [Fact]
+        public static void InvalidStates_ShouldRecommendHelp()
+        {
+            var args = new[] { "-a" };
+            var dummyParsingErrorPrinter = new DummyParsingErrorPrinter();
+            var builder = FluentArgsBuilder.New()
+                .RegisterDefaultHelpFlags()
+                .RegisterParsingErrorPrinter(dummyParsingErrorPrinter)
+                .Invalid();
+
+            var parseSuccess = builder.Parse(args);
+
+            parseSuccess.Should().BeFalse();
+            dummyParsingErrorPrinter.ArgumentMissingErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.ArgumentParsingErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.InvalidCommandValueErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.NotAllArgumentsAreUsedErrors.Should().BeEmpty();
+            dummyParsingErrorPrinter.InvalidStateErrors.Should().Be(1);
+        }
     }
 }
diff --git a/source/FluentArgs/Exceptions/InvalidStateException.cs b/source/FluentArgs/Exceptions/InvalidStateException.cs
@@ -0,0 +1,8 @@
+namespace FluentArgs.Exceptions
+{
+    using System;
+
+    internal class InvalidStateException : Exception
+    {
+    }
+}
diff --git a/source/FluentArgs/Execution/InvalidStep.cs b/source/FluentArgs/Execution/InvalidStep.cs
@@ -4,6 +4,7 @@
     using System.Collections.Generic;
     using System.Text;
     using System.Threading.Tasks;
+    using FluentArgs.Exceptions;
 
     internal class InvalidStep : Step
     {
@@ -19,7 +20,7 @@ public override Task Accept(IStepVisitor visitor)
 
         public override Task Execute(State state)
         {
-            throw new Exception("TODO: Invalid state: show helP");
+            throw new InvalidStateException();
         }
     }
 }
diff --git a/source/FluentArgs/FluentArgsDefinition.cs b/source/FluentArgs/FluentArgsDefinition.cs
@@ -84,6 +84,12 @@ public async Task<bool> ParseFromState(State state)
                     InitialStep.ParserSettings.HelpFlag?.Names).ConfigureAwait(false);
                 return false;
             }
+            catch (InvalidStateException)
+            {
+                await InitialStep.ParserSettings!.ParsingErrorPrinter.PrintInvalidStateError(
+                    InitialStep.ParserSettings.HelpFlag?.Names).ConfigureAwait(false);
+                return false;
+            }
         }
 
         private static IEnumerable<Action<State>> GetPostValidations(ParserSettings? settings)

diff --git a/source/FluentArgs/Help/SimpleParsingErrorPrinter.cs b/source/FluentArgs/Help/SimpleParsingErrorPrinter.cs
@@ -54,6 +54,14 @@ await errorLineWriter
             await WriteHelpFlagInfo(helpFlagAliases).ConfigureAwait(false);
         }
 
+        public async Task PrintInvalidStateError(IReadOnlyCollection<string>? helpFlagAliases)
+        {
+            await errorLineWriter
+                .WriteLine("The used parameter combination is invalid.")
+                .ConfigureAwait(false);
+            await WriteHelpFlagInfo(helpFlagAliases).ConfigureAwait(false);
+        }
+
         public async Task PrintNotAllArgumentsAreUsedError(IReadOnlyCollection<string> remainingArguments, IReadOnlyCollection<string>? helpFlagAliases)
         {
             await errorLineWriter

diff --git a/source/FluentArgs/IParsingErrorPrinter.cs b/source/FluentArgs/IParsingErrorPrinter.cs
@@ -26,5 +26,8 @@ Task PrintInvalidCommandValueError(
             IReadOnlyCollection<string> aliases,
             string value,
             IReadOnlyCollection<string>? helpFlagAliases);
+
+        Task PrintInvalidStateError(
+            IReadOnlyCollection<string>? helpFlagAliases);
     }
 }