Merge pull request #781 from jonsequitur/dont-mutate-command-more-than-once-on-implicit-invoke

don't mutate command on subsequent calls to Invoke extension

Author: jonsequitur

src/System.CommandLine.Tests/CommandExtensionsTests.cs

@@ -0,0 +1,56 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.CommandLine.Builder;
+using System.CommandLine.IO;
+using FluentAssertions;
+using Xunit;
+
+namespace System.CommandLine.Tests
+{
+    public class CommandExtensionsTests
+    {
+        [Fact]
+        public void Command_Invoke_can_be_called_more_than_once_for_the_same_command()
+        {
+            var command = new RootCommand("Root command description")
+            {
+                new Command("inner")
+            };
+
+            var console1 = new TestConsole();
+
+            command.Invoke("-h", console1);
+
+            console1.Out.ToString().Should().Contain(command.Description);
+            
+            var console2 = new TestConsole();
+
+            command.Invoke("-h", console2);
+
+            console2.Out.ToString().Should().Contain(command.Description);
+        }
+
+        [Fact]
+        public void When_CommandLineBuilder_is_used_then_Command_Invoke_uses_its_configuration()
+        {
+            var command = new RootCommand();
+
+            new CommandLineBuilder(command)
+                .UseMiddleware(context =>
+                {
+                    context.Console.Out.Write("hello!");
+                })
+                .Build();
+
+            var console = new TestConsole();
+
+            command.Invoke("", console);
+
+            console.Out
+                   .ToString()
+                   .Should()
+                   .Contain("hello!");
+        }
+    }
+}

src/System.CommandLine.Tests/CommandTests.cs

@@ -336,18 +336,31 @@ public void When_multiple_options_are_configured_then_they_must_differ_by_name()
         }
 
         [Fact]
-        public void When_global_options_are_added_then_they_must_differ_from_local_options_by_name()
+        public void Global_options_may_be_added_with_aliases_that_conflict_with_local_options()
         {
             var command = new Command("the-command")
             {
                 new Option("--same")
             };
 
+            command
+                .Invoking(c => c.AddGlobalOption(new Option("--same")))
+                .Should()
+                .NotThrow<ArgumentException>();
+        }
+
+        [Fact]
+        public void Global_options_may_not_have_aliases_conflicting_with_other_global_option_aliases()
+        {
+            var command = new Command("the-command");
+
+            command.AddGlobalOption(new Option("--same"));
+
             command
                 .Invoking(c => c.AddGlobalOption(new Option("--same")))
                 .Should()
                 .Throw<ArgumentException>()
-                .And
+                .Which
                 .Message
                 .Should()
                 .Be("Alias '--same' is already in use.");

src/System.CommandLine/Builder/CommandLineBuilder.cs

@@ -17,6 +17,10 @@ public class CommandLineBuilder : CommandBuilder
         public CommandLineBuilder(Command rootCommand = null)
             : base(rootCommand ?? new RootCommand())
         {
+            if (rootCommand?.ImplicitParser != null)
+            {
+                throw new ArgumentException($"Command \"{rootCommand.Name}\" has already been configured.");
+            }
         }
 
         public bool EnableDirectives { get; set; } = true;
@@ -33,7 +37,7 @@ public Parser Build()
         {
             var rootCommand = Command;
 
-            return new Parser(
+            var parser = new Parser(
                 new CommandLineConfiguration(
                     new[] { rootCommand },
                     enablePosixBundling: EnablePosixBundling,
@@ -44,6 +48,10 @@ public Parser Build()
                                                        .Select(m => m.middleware)
                                                        .ToArray(),
                     helpBuilderFactory: HelpBuilderFactory));
+
+            Command.ImplicitParser = parser;
+
+            return parser;
         }
 
         internal void AddMiddleware(

src/System.CommandLine/Builder/CommandLineBuilderExtensions.cs

@@ -401,7 +401,6 @@ public static CommandLineBuilder UseSuggestDirective(
             return builder;
         }
 
-
         public static CommandLineBuilder UseTypoCorrections(
             this CommandLineBuilder builder, int maxLevenshteinDistance = 3)
         {

src/System.CommandLine/Command.cs

@@ -3,6 +3,7 @@
 
 using System.Collections;
 using System.Collections.Generic;
+using System.CommandLine.Builder;
 using System.CommandLine.Collections;
 using System.CommandLine.Invocation;
 using System.CommandLine.Parsing;
@@ -32,7 +33,6 @@ public Command(string name, string description = null) : base(new[] { name }, de
 
         public void AddGlobalOption(Option option)
         {
-            Children.ThrowIfAnyAliasIsInUse(option);
             _globalOptions.Add(option);
             Children.AddWithoutAliasCollisionCheck(option);
         }
@@ -68,5 +68,7 @@ private protected override void AddSymbol(Symbol symbol)
         IEnumerable<IArgument> ICommand.Arguments => Arguments;
 
         IEnumerable<IOption> ICommand.Options => Options;
+
+        internal Parser ImplicitParser { get; set; }
     }
 }

src/System.CommandLine/CommandExtensions.cs

@@ -42,11 +42,12 @@ public static Task<int> InvokeAsync(
 
         private static InvocationPipeline GetInvocationPipeline(Command command, string[] args)
         {
-            var parser = new CommandLineBuilder(command)
-                         .UseDefaults()
-                         .Build();
+            var parser = command.ImplicitParser ??
+                             new CommandLineBuilder(command)
+                                 .UseDefaults()
+                                 .Build();
 
-            ParseResult parseResult = parser.Parse(args);
+            var parseResult = parser.Parse(args);
 
             return new InvocationPipeline(parseResult);
         }
@@ -62,4 +63,4 @@ public static ParseResult Parse(
             IReadOnlyCollection<char> delimiters = null) =>
             new Parser(command).Parse(commandLine);
     }
-}
+}