+ RunCommand now return FlowCommandResult containing info about result of handling commands

Author: trueromanus

src/FlowCommandLine/CommandLine.cs

@@ -123,31 +123,52 @@ public Task RunCommandAsync () {
         /// <summary>
         /// Run the command from the command line.
         /// </summary>
-        public void RunCommand () {
+        public FlowCommandResult RunCommand () {
             if ( m_asyncCommands.Any () ) throw new ArgumentException ( "You have asynchronized commands, you need to use RunCommandAsync method inside!" );
 
             if ( IsVersion () ) {
                 ShowVersion ();
-                return;
+
+                return new FlowCommandResult {
+                    EmptyInput = string.IsNullOrEmpty ( m_commandLine ),
+                    CommandHandled = false,
+                    Handled = true
+                };
             }
 
             var parts = GetParts ();
             if ( string.IsNullOrEmpty ( m_commandLine ) || !parts.Any () || IsHelpParameter ( m_commandLine ) || parts.Any ( IsHelpParameter ) ) {
                 ShowHelp ( parts, true );
-                return;
+
+                return new FlowCommandResult {
+                    EmptyInput = string.IsNullOrEmpty ( m_commandLine ),
+                    CommandHandled = false,
+                    Handled = parts.Any ()
+                };
             }
 
             ParseParameters ( parts, out var command, out var parameters );
 
             try {
                 if ( m_commands.TryGetValue ( command, out var flowCommand ) ) {
                     flowCommand.Execute ( parameters, m_commandLineProvider );
-                    return;
+
+                    return new FlowCommandResult {
+                        EmptyInput = string.IsNullOrEmpty ( m_commandLine ),
+                        CommandHandled = true,
+                        Handled = false
+                    };
                 }
             } catch {
             }
 
             ShowHelp ( parts );
+
+            return new FlowCommandResult {
+                EmptyInput = string.IsNullOrEmpty ( m_commandLine ),
+                CommandHandled = false,
+                Handled = false
+            };
         }
 
         public CommandLine AddOption ( string shortName = "", string fullName = "", string description = "", string propertyName = "", bool required = false ) {

src/FlowCommandLine/FlowCommandResult.cs

@@ -0,0 +1,23 @@
+namespace FlowCommandLine {
+
+    public class FlowCommandResult {
+
+        /// <summary>
+        /// It was empty input.
+        /// Can be useful if you need to make default behaviour if command line was empty.
+        /// </summary>
+        public bool EmptyInput { get; set; }
+
+        /// <summary>
+        /// Command was found handled.
+        /// </summary>
+        public bool CommandHandled { get; set; }
+
+        /// <summary>
+        /// Was handed but not command (as example --version, --help etc)
+        /// </summary>
+        public bool Handled { get; set; }
+
+    }
+
+}

src/FlowCommandLineTests/CommandLineUnitTests.cs

@@ -16,7 +16,7 @@ public void RunCommand_Success_Empty_ShowHelp () {
             var commandLine = new CommandLine ( fakeProvider );
 
             //act
-            commandLine
+            var result = commandLine
                 .Application ( "TestApplication", "1.0.0" )
                 .RunCommand ();
 
@@ -25,6 +25,9 @@ public void RunCommand_Success_Empty_ShowHelp () {
             Assert.Equal ( 2, messages.Count );
             Assert.Equal ( "TestApplication version 1.0.0", messages.First () );
             Assert.Equal ( " ", messages.ElementAt ( 1 ) );
+            Assert.True ( result.EmptyInput );
+            Assert.False ( result.Handled );
+            Assert.False ( result.CommandHandled );
         }
 
         [Fact]
@@ -37,7 +40,33 @@ public void RunCommand_Success_OnlyDescription_ShowHelp () {
             var commandLine = new CommandLine ( fakeProvider );
 
             //act
-            commandLine
+            var result = commandLine
+                .Application ( "TestApplication", "1.0.0", "Application description!!!!" )
+                .RunCommand ();
+
+            //assert
+            Assert.NotEmpty ( messages );
+            Assert.Equal ( 4, messages.Count );
+            Assert.Equal ( "TestApplication version 1.0.0", messages.First () );
+            Assert.Equal ( " ", messages.ElementAt ( 1 ) );
+            Assert.Equal ( "Application description!!!!", messages.ElementAt ( 2 ) );
+            Assert.Equal ( " ", messages.ElementAt ( 3 ) );
+            Assert.True ( result.EmptyInput );
+            Assert.False ( result.Handled );
+            Assert.False ( result.CommandHandled );
+        }
+
+        [Fact]
+        public void RunCommand_Success_OnlyDescription_ShowHelp_Parameter () {
+            //arrange
+            var messages = new List<string> ();
+            var fakeProvider = A.Fake<ICommandLineProvider> ();
+            A.CallTo ( () => fakeProvider.GetCommandLine () ).Returns ( "--help" );
+            A.CallTo ( () => fakeProvider.WriteLine ( A<string>._ ) ).Invokes ( ( string fake ) => { messages.Add ( fake ); } );
+            var commandLine = new CommandLine ( fakeProvider );
+
+            //act
+            var result = commandLine
                 .Application ( "TestApplication", "1.0.0", "Application description!!!!" )
                 .RunCommand ();
 
@@ -48,6 +77,9 @@ public void RunCommand_Success_OnlyDescription_ShowHelp () {
             Assert.Equal ( " ", messages.ElementAt ( 1 ) );
             Assert.Equal ( "Application description!!!!", messages.ElementAt ( 2 ) );
             Assert.Equal ( " ", messages.ElementAt ( 3 ) );
+            Assert.False ( result.EmptyInput );
+            Assert.True ( result.Handled );
+            Assert.False ( result.CommandHandled );
         }
 
         [Fact]
@@ -60,7 +92,7 @@ public void RunCommand_Success_OnlyExecutable_ShowHelp () {
             var commandLine = new CommandLine ( fakeProvider );
 
             //act
-            commandLine
+            var result = commandLine
                 .Application ( "TestApplication", "1.0.0", applicationExecutable: "testapp" )
                 .RunCommand ();
 
@@ -71,6 +103,9 @@ public void RunCommand_Success_OnlyExecutable_ShowHelp () {
             Assert.Equal ( " ", messages.ElementAt ( 1 ) );
             Assert.Equal ( "usage: testapp [<command>] [<parameters>]", messages.ElementAt ( 2 ) );
             Assert.Equal ( " ", messages.ElementAt ( 3 ) );
+            Assert.True ( result.EmptyInput );
+            Assert.False ( result.Handled );
+            Assert.False ( result.CommandHandled );
         }
 
         public record RunCommand_Success_OnlyCommands_ShowHelp_Class { }
@@ -120,7 +155,7 @@ public void RunCommand_Success_OnlyCommands_SingleCommand () {
             var isCorrect = false;
 
             //act
-            commandLine
+            var result = commandLine
                 .Application ( "TestApplication", "1.0.0" )
                 .AddCommand (
                     "test",
@@ -140,6 +175,9 @@ public void RunCommand_Success_OnlyCommands_SingleCommand () {
 
             //assert
             Assert.True ( isCorrect );
+            Assert.False ( result.EmptyInput );
+            Assert.False ( result.Handled );
+            Assert.True ( result.CommandHandled );
         }
 
         public record RunCommand_Success_IntLongDoubleFloatTypes_Class {
@@ -1144,7 +1182,7 @@ public void RunOptions_Success_ComplexParameters () {
                     "",
                     databaseAdjustments
                 )
-                .RunCommand();
+                .RunCommand ();
 
             //assert
             Assert.NotNull ( result );