Merge pull request #777 from jonsequitur/correct-parent-symbol-on-implicit-argument

set parent symbol when custom parse delegate is called on default value

Author: jonsequitur

src/System.CommandLine.Tests/ArgumentTests.cs

@@ -117,7 +117,7 @@ public void GetDefaultValue_can_return_null()
             }
 
             [Fact]
-            public void validation_failure_message()
+            public void Validation_failure_message_can_be_specified()
             {
                 var argument = new Argument<FileSystemInfo>(result =>
                 {
@@ -188,6 +188,79 @@ public void custom_parsing_of_scalar_value_from_an_argument_with_multiple_tokens
                         .Should()
                         .Be(6);
             }
+
+            [Fact]
+            public void ArgumentResult_Parent_is_set_correctly_when_token_is_present()
+            {
+                ArgumentResult argumentResult = null;
+
+                var command = new Command("the-command")
+                {
+                    new Option<string>(
+                        "-x",
+                        parseArgument: argResult =>
+                        {
+                            argumentResult = argResult;
+                            return null;
+                        })
+                };
+
+                command.Parse("-x abc");
+
+                argumentResult
+                    .Parent
+                    .Should()
+                    .NotBeNull();
+            }
+
+            [Fact]
+            public void Option_ArgumentResult_Parent_is_set_correctly_when_token_is_implicit()
+            {
+                ArgumentResult argumentResult = null;
+
+                var command = new Command("the-command")
+                {
+                    new Option<string>(
+                        "-x",
+                        parseArgument: argResult =>
+                        {
+                            argumentResult = argResult;
+                            return null;
+                        }, isDefault: true)
+                };
+
+                command.Parse("");
+
+                argumentResult
+                    .Parent
+                    .Symbol
+                    .Should()
+                    .Be(command.Options.Single());
+            }
+
+            [Fact]
+            public void Command_ArgumentResult_Parent_is_set_correctly_when_token_is_implicit()
+            {
+                ArgumentResult argumentResult = null;
+
+                var command = new Command("the-command")
+                {
+                    new Argument<string>(
+                        parse: argResult =>
+                        {
+                            argumentResult = argResult;
+                            return null;
+                        }, isDefault: true)
+                };
+
+                command.Parse("");
+
+                argumentResult
+                    .Parent
+                    .Symbol
+                    .Should()
+                    .Be(command);
+            }
         }
 
         protected override Symbol CreateSymbol(string name)

src/System.CommandLine/Argument.cs

@@ -11,7 +11,7 @@ namespace System.CommandLine
 {
     public class Argument : Symbol, IArgument
     {
-        private Func<object> _defaultValueFactory;
+        private Func<ArgumentResult, object> _defaultValueFactory;
         private readonly List<string> _suggestions = new List<string>();
         private readonly List<ISuggestionSource> _suggestionSources = new List<ISuggestionSource>();
         private IArgumentArity _arity;
@@ -115,13 +115,18 @@ bool DefaultConvert(SymbolResult symbol, out object value)
         public void AddValidator(ValidateSymbol<ArgumentResult> validator) => Validators.Add(validator);
 
         public object GetDefaultValue()
+        {
+            return GetDefaultValue(new ArgumentResult(this, null));
+        }
+
+        internal object GetDefaultValue(ArgumentResult argumentResult)
         {
             if (_defaultValueFactory is null)
             {
                 throw new InvalidOperationException($"Argument \"{Name}\" does not have a default value");
             }
 
-            return _defaultValueFactory.Invoke();
+            return _defaultValueFactory.Invoke(argumentResult);
         }
 
         public void SetDefaultValue(object value)
@@ -130,6 +135,16 @@ public void SetDefaultValue(object value)
         }
 
         public void SetDefaultValueFactory(Func<object> getDefaultValue)
+        {
+            if (getDefaultValue == null)
+            {
+                throw new ArgumentNullException(nameof(getDefaultValue));
+            }
+
+            SetDefaultValueFactory(_ => getDefaultValue());
+        }
+        
+        public void SetDefaultValueFactory(Func<ArgumentResult, object> getDefaultValue)
         {
             _defaultValueFactory = getDefaultValue ?? throw new ArgumentNullException(nameof(getDefaultValue));
         }

src/System.CommandLine/Argument{T}.cs

@@ -74,14 +74,7 @@ public Argument(ParseArgument<T> parse, bool isDefault = false) : this()
 
             if (isDefault)
             {
-                SetDefaultValueFactory(() =>
-                {
-                    var argumentResult = new ArgumentResult(
-                        this,
-                        null);
-
-                    return parse(argumentResult);
-                });
+                SetDefaultValueFactory(argumentResult => parse(argumentResult));
             }
 
             ConvertArguments = (ArgumentResult argumentResult, out object value) =>

src/System.CommandLine/Parsing/ArgumentResult.cs

@@ -102,5 +102,8 @@ bool ShouldCheckArity()
                        optionResult.IsImplicit);
             }
         }
+
+        internal override object CreateDefaultArgumentResultAndGetItsValue(Argument argument) => 
+            argument.GetDefaultValue(this);
     }
 }

src/System.CommandLine/Parsing/SymbolResult.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.Collections.Generic;
+using System.CommandLine.Binding;
 using System.Linq;
 
 namespace System.CommandLine.Parsing
@@ -63,11 +64,23 @@ protected internal ValidationMessages ValidationMessages
 
         internal void AddToken(Token token) => _tokens.Add(token);
 
-        internal object GetDefaultValueFor(IArgument argument)
+        internal virtual object GetDefaultValueFor(IArgument argument)
         {
             return _defaultArgumentValues.GetOrAdd(
                 argument,
-                a => a.GetDefaultValue());
+                a => a is Argument arg 
+                         ? CreateDefaultArgumentResultAndGetItsValue(arg) 
+                         : a.GetDefaultValue());
+        }
+        
+        internal virtual object CreateDefaultArgumentResultAndGetItsValue(Argument argument)
+        {
+            if (!(Children.ResultFor(argument) is ArgumentResult result))
+            {
+                result = new ArgumentResult(argument, this);
+            }
+
+            return argument.GetDefaultValue(result);
         }
 
         internal bool UseDefaultValueFor(IArgument argument)