Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: don't set DefaultValue to empty string for string[] options #540

Merged
merged 1 commit into from
Aug 26, 2023
Merged

fix: don't set DefaultValue to empty string for string[] options #540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/CommandLineUtils/Conventions/OptionAttributeConventionBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,16 @@ private protected void AddOption(ConventionContext context, CommandOption option
{
if (getter.Invoke(modelAccessor.GetModel()) is IEnumerable<object> values)
{
var count = 0;
foreach (var value in values)
{
count++;
option.TryParse(value?.ToString());
}
option.DefaultValue = string.Join(", ", values.Select(x => x?.ToString()));
if (count > 0)
{
option.DefaultValue = string.Join(", ", values.Select(x => x?.ToString()));
}
}
}
}
Expand Down
27 changes: 27 additions & 0 deletions test/CommandLineUtils.Tests/FilePathExistsAttributeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,5 +174,32 @@ public void ValidatesOnlyFiles()
Assert.Equal(0, CommandLineApplication.Execute<OnlyFile>(context));
Assert.NotEqual(0, CommandLineApplication.Execute<OnlyDir>(context));
}

private class OptionalFileChecks
{
[DirectoryExists]
[Option]
public string[] Dir { get; } = new string[0];

[FileExists]
[Option]
public string? File { get; }

private void OnExecute() { }
}

[Theory]
[InlineData(0, new string[0])]
[InlineData(1, new[] { "-f", "file.txt" })]
[InlineData(1, new[] { "-d", "dir1" })]
public void OnlyValidatesOptionsIfSpecified(int exitCode, string[] args)
{
var context = new DefaultCommandLineContext(
new TestConsole(_output),
AppContext.BaseDirectory,
args);

Assert.Equal(exitCode, CommandLineApplication.Execute<OptionalFileChecks>(context));
}
}
}
92 changes: 68 additions & 24 deletions test/CommandLineUtils.Tests/OptionAttributeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,35 +151,79 @@ private class OptionHasDefaultValues

[Option("-a4")]
public (bool hasValue, string value) Arg4 { get; } = (false, "Yellow");

[Option("-a5")]
public string[] Arg5 { get; } = new string[0];
}

[Fact]
public void KeepsDefaultValues()
{
var app1 = Create<OptionHasDefaultValues>();
app1.Parse("-a1", "z", "-a2", "y");
Assert.Equal("z", app1.Model.Arg1);
Assert.Equal(new[] { "y" }, app1.Model.Arg2);

var app2 = Create<OptionHasDefaultValues>();
app2.Parse("-a1", "z");
Assert.Equal("z", app2.Model.Arg1);
Assert.Equal(new[] { "b", "c" }, app2.Model.Arg2);

var app3 = Create<OptionHasDefaultValues>();
app3.Parse();
Assert.Equal("a", app3.Model.Arg1);
Assert.Equal(new[] { "b", "c" }, app3.Model.Arg2);
Assert.False(app3.Model.Arg3.HasValue, "Should not have value");
Assert.False(app3.Model.Arg4.hasValue, "Should not have value");
Assert.Equal((false, "Yellow"), app3.Model.Arg4);

var app4 = Create<OptionHasDefaultValues>();
app4.Parse("-a3", "-a4");
Assert.True(app4.Model.Arg3.HasValue);
Assert.True(app4.Model.Arg4.hasValue);
Assert.True(app4.Model.Arg3);
Assert.Equal((true, null), app4.Model.Arg4);
{
var app1 = Create<OptionHasDefaultValues>();
app1.Parse("-a1", "z", "-a2", "y");
Assert.Equal("z", app1.Model.Arg1);
Assert.Equal(new[] { "y" }, app1.Model.Arg2);
}

{
var app2 = Create<OptionHasDefaultValues>();
app2.Parse("-a1", "z");
Assert.Equal("z", app2.Model.Arg1);
Assert.Equal(new[] { "b", "c" }, app2.Model.Arg2);
}
{
var app3 = Create<OptionHasDefaultValues>();
app3.Parse();
Assert.Equal("a", app3.Model.Arg1);
Assert.Equal(new[] { "b", "c" }, app3.Model.Arg2);
Assert.False(app3.Model.Arg3.HasValue, "Should not have value");
Assert.False(app3.Model.Arg4.hasValue, "Should not have value");
Assert.Equal((false, "Yellow"), app3.Model.Arg4);
Assert.Equal(Array.Empty<string>(), app3.Model.Arg5);
}

{
var app4 = Create<OptionHasDefaultValues>();
app4.Parse("-a3", "-a4");
Assert.True(app4.Model.Arg3.HasValue);
Assert.True(app4.Model.Arg4.hasValue);
Assert.True(app4.Model.Arg3);
Assert.Equal((true, null), app4.Model.Arg4);
Assert.Equal(Array.Empty<string>(), app4.Model.Arg5);
}

{
var app5 = Create<OptionHasDefaultValues>();
app5.Parse("-a5", "a", "-a5", "b");
Assert.Equal(new[] { "a", "b" }, app5.Model.Arg5);
}
}

private class AppWithMultiValueStringOption
{
[Option("-o1")]
string[] Opt1 { get; }

[Option("-o2")]
string[] Opt2 { get; } = new string[0];
}

[Fact]
public void SetsDefaultValueRightForStringArrayOptions()
{
var app = Create<AppWithMultiValueStringOption>();
app.Parse();
{
var opt1 = app.GetOptions().Single(o => o.ShortName == "o1");
Assert.Null(opt1.DefaultValue);
Assert.Empty(opt1.Values);
}
{
var opt2 = app.GetOptions().Single(o => o.ShortName == "o2");
Assert.Null(opt2.DefaultValue);
Assert.Empty(opt2.Values);
}
}

private class PrivateSetterProgram
Expand Down
Loading