mirror of
https://github.com/Tyrrrz/CliFx.git
synced 2025-10-25 15:19:17 +00:00
Compare commits
77 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
671532efce | ||
|
|
5b124345b0 | ||
|
|
b812bd1423 | ||
|
|
c854f5fb8d | ||
|
|
f38bd32510 | ||
|
|
765fa5503e | ||
|
|
57f168723b | ||
|
|
79e1a2e3d7 | ||
|
|
f4f6d04857 | ||
|
|
015ede0d15 | ||
|
|
4fd7f7c3ca | ||
|
|
896dd49eb4 | ||
|
|
4365ad457a | ||
|
|
fb3617980e | ||
|
|
7690aae456 | ||
|
|
076678a08c | ||
|
|
104279d6e9 | ||
|
|
515d51a91d | ||
|
|
4fdf543190 | ||
|
|
4e1ab096c9 | ||
|
|
8aa6911cca | ||
|
|
f0362019ed | ||
|
|
82895f2e42 | ||
|
|
4cf622abe5 | ||
|
|
d4e22a78d6 | ||
|
|
3883c831e9 | ||
|
|
63441688fe | ||
|
|
e48839b938 | ||
|
|
ed87373dc3 | ||
|
|
6ce52c70f7 | ||
|
|
d2b0b16121 | ||
|
|
d67a9fe762 | ||
|
|
ce2a3153e6 | ||
|
|
d4b54231fb | ||
|
|
70bfe0bf91 | ||
|
|
9690c380d3 | ||
|
|
85caa275ae | ||
|
|
32026e59c0 | ||
|
|
486ccb9685 | ||
|
|
7b766f70f3 | ||
|
|
f73e96488f | ||
|
|
af63fa5a1f | ||
|
|
e8f53c9463 | ||
|
|
9564cd5d30 | ||
|
|
ed458c3980 | ||
|
|
25538f99db | ||
|
|
36436e7a4b | ||
|
|
a6070332c9 | ||
|
|
25cbfdb4b8 | ||
|
|
d1b5107c2c | ||
|
|
03873d63cd | ||
|
|
89aba39964 | ||
|
|
ab57a103d1 | ||
|
|
d0b2ebc061 | ||
|
|
857257ca73 | ||
|
|
3587155c7e | ||
|
|
ae05e0db96 | ||
|
|
41c0493e66 | ||
|
|
43a304bb26 | ||
|
|
cd3892bf83 | ||
|
|
3f7c02342d | ||
|
|
c65cdf465e | ||
|
|
b5d67ecf24 | ||
|
|
a94b2296e1 | ||
|
|
fa05e4df3f | ||
|
|
b70b25076e | ||
|
|
0662f341e6 | ||
|
|
80bf477f3b | ||
|
|
e4a502d9d6 | ||
|
|
13b15b98ed | ||
|
|
80465e0e51 | ||
|
|
9a1ce7e7e5 | ||
|
|
b45da64664 | ||
|
|
df01dc055e | ||
|
|
31dd24d189 | ||
|
|
2a76dfe1c8 | ||
|
|
59ee2e34d8 |
3
.github/FUNDING.yml
vendored
3
.github/FUNDING.yml
vendored
@@ -1,4 +1,3 @@
|
|||||||
github: Tyrrrz
|
github: Tyrrrz
|
||||||
patreon: Tyrrrz
|
patreon: Tyrrrz
|
||||||
open_collective: Tyrrrz
|
custom: ['buymeacoffee.com/Tyrrrz', 'tyrrrz.me/donate']
|
||||||
custom: ['buymeacoffee.com/Tyrrrz']
|
|
||||||
25
.github/workflows/CD.yml
vendored
Normal file
25
.github/workflows/CD.yml
vendored
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
name: CD
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Install .NET Core
|
||||||
|
uses: actions/setup-dotnet@v1.4.0
|
||||||
|
with:
|
||||||
|
dotnet-version: 3.1.100
|
||||||
|
|
||||||
|
- name: Pack
|
||||||
|
run: dotnet pack CliFx --configuration Release
|
||||||
|
|
||||||
|
- name: Deploy
|
||||||
|
run: dotnet nuget push CliFx/bin/Release/*.nupkg -s nuget.org -k ${{secrets.NUGET_TOKEN}}
|
||||||
29
.github/workflows/CI.yml
vendored
Normal file
29
.github/workflows/CI.yml
vendored
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
os: [ubuntu-latest, windows-latest, macos-latest]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Install .NET Core
|
||||||
|
uses: actions/setup-dotnet@v1.4.0
|
||||||
|
with:
|
||||||
|
dotnet-version: 3.1.100
|
||||||
|
|
||||||
|
- name: Build & test
|
||||||
|
run: dotnet test --configuration Release
|
||||||
|
|
||||||
|
- name: Upload coverage
|
||||||
|
uses: codecov/codecov-action@v1.0.5
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.CODECOV_TOKEN }}
|
||||||
|
file: CliFx.Tests/bin/Release/Coverage.xml
|
||||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -143,6 +143,7 @@ _TeamCity*
|
|||||||
_NCrunch_*
|
_NCrunch_*
|
||||||
.*crunch*.local.xml
|
.*crunch*.local.xml
|
||||||
nCrunchTemp_*
|
nCrunchTemp_*
|
||||||
|
.ncrunchsolution
|
||||||
|
|
||||||
# MightyMoose
|
# MightyMoose
|
||||||
*.mm.*
|
*.mm.*
|
||||||
|
|||||||
BIN
.screenshots/help.png
Normal file
BIN
.screenshots/help.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
@@ -0,0 +1,5 @@
|
|||||||
|
### v1.1 (16-Mar-2020)
|
||||||
|
|
||||||
|
- Changed `IConsole` interface (and as a result, `SystemConsole` and `VirtualConsole`) to support writing binary data. Instead of `TextReader`/`TextWriter` instances, the streams are now exposed as `StreamReader`/`StreamWriter` which provide the `BaseStream` property that allows raw access. Existing usages inside commands should remain the same because `StreamReader`/`StreamWriter` are compatible with their base classes `TextReader`/`TextWriter`, but if you were using `VirtualConsole` in tests, you may have to update it to the new API. Refer to the readme for more info.
|
||||||
|
- Changed argument binding behavior so that an error is produced if the user provides an argument that doesn't match with any parameter or option. This is done in order to improve user experience, as otherwise the user may make a typo without knowing that their input wasn't taken into account.
|
||||||
|
- Changed argument binding behavior so that options can be set to multiple argument values while specifying them with mixed naming. For example, `--option value1 -o value2 --option value3` would result in the option being set to corresponding three values, assuming `--option` and `-o` match with the same option.
|
||||||
|
|||||||
@@ -1,34 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using BenchmarkDotNet.Attributes;
|
|
||||||
using CliFx.Benchmarks.Commands;
|
|
||||||
|
|
||||||
namespace CliFx.Benchmarks
|
|
||||||
{
|
|
||||||
[CoreJob]
|
|
||||||
[RankColumn]
|
|
||||||
public class Benchmark
|
|
||||||
{
|
|
||||||
private static readonly string[] Arguments = { "--str", "hello world", "-i", "13", "-b" };
|
|
||||||
|
|
||||||
[Benchmark(Description = "CliFx", Baseline = true)]
|
|
||||||
public Task<int> ExecuteWithCliFx() => new CliApplicationBuilder().AddCommand(typeof(CliFxCommand)).Build().RunAsync(Arguments);
|
|
||||||
|
|
||||||
[Benchmark(Description = "System.CommandLine")]
|
|
||||||
public Task<int> ExecuteWithSystemCommandLine() => new SystemCommandLineCommand().ExecuteAsync(Arguments);
|
|
||||||
|
|
||||||
[Benchmark(Description = "McMaster.Extensions.CommandLineUtils")]
|
|
||||||
public int ExecuteWithMcMaster() => McMaster.Extensions.CommandLineUtils.CommandLineApplication.Execute<McMasterCommand>(Arguments);
|
|
||||||
|
|
||||||
// Skipped because this benchmark freezes after a couple of iterations
|
|
||||||
// Probably wasn't designed to run multiple times in single process execution
|
|
||||||
//[Benchmark(Description = "CommandLineParser")]
|
|
||||||
public void ExecuteWithCommandLineParser()
|
|
||||||
{
|
|
||||||
var parsed = CommandLine.Parser.Default.ParseArguments(Arguments, typeof(CommandLineParserCommand));
|
|
||||||
CommandLine.ParserResultExtensions.WithParsed<CommandLineParserCommand>(parsed, c => c.Execute());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Benchmark(Description = "PowerArgs")]
|
|
||||||
public void ExecuteWithPowerArgs() => PowerArgs.Args.InvokeMain<PowerArgsCommand>(Arguments);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
52
CliFx.Benchmarks/Benchmarks.cs
Normal file
52
CliFx.Benchmarks/Benchmarks.cs
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using BenchmarkDotNet.Attributes;
|
||||||
|
using BenchmarkDotNet.Configs;
|
||||||
|
using BenchmarkDotNet.Order;
|
||||||
|
using BenchmarkDotNet.Running;
|
||||||
|
using CliFx.Benchmarks.Commands;
|
||||||
|
using CommandLine;
|
||||||
|
|
||||||
|
namespace CliFx.Benchmarks
|
||||||
|
{
|
||||||
|
[SimpleJob]
|
||||||
|
[RankColumn]
|
||||||
|
[Orderer(SummaryOrderPolicy.FastestToSlowest)]
|
||||||
|
public class Benchmarks
|
||||||
|
{
|
||||||
|
private static readonly string[] Arguments = {"--str", "hello world", "-i", "13", "-b"};
|
||||||
|
|
||||||
|
[Benchmark(Description = "CliFx", Baseline = true)]
|
||||||
|
public async ValueTask<int> ExecuteWithCliFx() =>
|
||||||
|
await new CliApplicationBuilder().AddCommand(typeof(CliFxCommand)).Build().RunAsync(Arguments, new Dictionary<string, string>());
|
||||||
|
|
||||||
|
[Benchmark(Description = "System.CommandLine")]
|
||||||
|
public async Task<int> ExecuteWithSystemCommandLine() =>
|
||||||
|
await new SystemCommandLineCommand().ExecuteAsync(Arguments);
|
||||||
|
|
||||||
|
[Benchmark(Description = "McMaster.Extensions.CommandLineUtils")]
|
||||||
|
public int ExecuteWithMcMaster() =>
|
||||||
|
McMaster.Extensions.CommandLineUtils.CommandLineApplication.Execute<McMasterCommand>(Arguments);
|
||||||
|
|
||||||
|
[Benchmark(Description = "CommandLineParser")]
|
||||||
|
public void ExecuteWithCommandLineParser() =>
|
||||||
|
new Parser()
|
||||||
|
.ParseArguments(Arguments, typeof(CommandLineParserCommand))
|
||||||
|
.WithParsed<CommandLineParserCommand>(c => c.Execute());
|
||||||
|
|
||||||
|
[Benchmark(Description = "PowerArgs")]
|
||||||
|
public void ExecuteWithPowerArgs() =>
|
||||||
|
PowerArgs.Args.InvokeMain<PowerArgsCommand>(Arguments);
|
||||||
|
|
||||||
|
[Benchmark(Description = "Clipr")]
|
||||||
|
public void ExecuteWithClipr() =>
|
||||||
|
clipr.CliParser.Parse<CliprCommand>(Arguments).Execute();
|
||||||
|
|
||||||
|
[Benchmark(Description = "Cocona")]
|
||||||
|
public void ExecuteWithCocona() =>
|
||||||
|
Cocona.CoconaApp.Run<CoconaCommand>(Arguments);
|
||||||
|
|
||||||
|
public static void Main() =>
|
||||||
|
BenchmarkRunner.Run<Benchmarks>(DefaultConfig.Instance.With(ConfigOptions.DisableOptimizationsValidator));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,15 +1,17 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
<Import Project="../CliFx.props" />
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<OutputType>Exe</OutputType>
|
<OutputType>Exe</OutputType>
|
||||||
<TargetFramework>netcoreapp2.2</TargetFramework>
|
<TargetFramework>netcoreapp3.1</TargetFramework>
|
||||||
<LangVersion>latest</LangVersion>
|
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<PackageReference Include="BenchmarkDotNet" Version="0.11.5" />
|
<PackageReference Include="BenchmarkDotNet" Version="0.12.0" />
|
||||||
<PackageReference Include="CommandLineParser" Version="2.6.0" />
|
<PackageReference Include="clipr" Version="1.6.1" />
|
||||||
<PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="2.3.4" />
|
<PackageReference Include="Cocona" Version="1.3.0" />
|
||||||
|
<PackageReference Include="CommandLineParser" Version="2.7.82" />
|
||||||
|
<PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="2.6.0" />
|
||||||
<PackageReference Include="PowerArgs" Version="3.6.0" />
|
<PackageReference Include="PowerArgs" Version="3.6.0" />
|
||||||
<PackageReference Include="System.CommandLine.Experimental" Version="0.3.0-alpha.19317.1" />
|
<PackageReference Include="System.CommandLine.Experimental" Version="0.3.0-alpha.19317.1" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using CliFx.Attributes;
|
using CliFx.Attributes;
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Benchmarks.Commands
|
namespace CliFx.Benchmarks.Commands
|
||||||
{
|
{
|
||||||
@@ -8,7 +7,7 @@ namespace CliFx.Benchmarks.Commands
|
|||||||
public class CliFxCommand : ICommand
|
public class CliFxCommand : ICommand
|
||||||
{
|
{
|
||||||
[CommandOption("str", 's')]
|
[CommandOption("str", 's')]
|
||||||
public string StrOption { get; set; }
|
public string? StrOption { get; set; }
|
||||||
|
|
||||||
[CommandOption("int", 'i')]
|
[CommandOption("int", 'i')]
|
||||||
public int IntOption { get; set; }
|
public int IntOption { get; set; }
|
||||||
@@ -16,6 +15,6 @@ namespace CliFx.Benchmarks.Commands
|
|||||||
[CommandOption("bool", 'b')]
|
[CommandOption("bool", 'b')]
|
||||||
public bool BoolOption { get; set; }
|
public bool BoolOption { get; set; }
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
20
CliFx.Benchmarks/Commands/CliprCommand.cs
Normal file
20
CliFx.Benchmarks/Commands/CliprCommand.cs
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
using clipr;
|
||||||
|
|
||||||
|
namespace CliFx.Benchmarks.Commands
|
||||||
|
{
|
||||||
|
public class CliprCommand
|
||||||
|
{
|
||||||
|
[NamedArgument('s', "str")]
|
||||||
|
public string? StrOption { get; set; }
|
||||||
|
|
||||||
|
[NamedArgument('i', "int")]
|
||||||
|
public int IntOption { get; set; }
|
||||||
|
|
||||||
|
[NamedArgument('b', "bool", Constraint = NumArgsConstraint.Optional, Const = true)]
|
||||||
|
public bool BoolOption { get; set; }
|
||||||
|
|
||||||
|
public void Execute()
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
17
CliFx.Benchmarks/Commands/CoconaCommand.cs
Normal file
17
CliFx.Benchmarks/Commands/CoconaCommand.cs
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
using Cocona;
|
||||||
|
|
||||||
|
namespace CliFx.Benchmarks.Commands
|
||||||
|
{
|
||||||
|
public class CoconaCommand
|
||||||
|
{
|
||||||
|
public void Execute(
|
||||||
|
[Option("str", new []{'s'})]
|
||||||
|
string? strOption,
|
||||||
|
[Option("int", new []{'i'})]
|
||||||
|
int intOption,
|
||||||
|
[Option("bool", new []{'b'})]
|
||||||
|
bool boolOption)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,7 +5,7 @@ namespace CliFx.Benchmarks.Commands
|
|||||||
public class CommandLineParserCommand
|
public class CommandLineParserCommand
|
||||||
{
|
{
|
||||||
[Option('s', "str")]
|
[Option('s', "str")]
|
||||||
public string StrOption { get; set; }
|
public string? StrOption { get; set; }
|
||||||
|
|
||||||
[Option('i', "int")]
|
[Option('i', "int")]
|
||||||
public int IntOption { get; set; }
|
public int IntOption { get; set; }
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ namespace CliFx.Benchmarks.Commands
|
|||||||
public class McMasterCommand
|
public class McMasterCommand
|
||||||
{
|
{
|
||||||
[Option("--str|-s")]
|
[Option("--str|-s")]
|
||||||
public string StrOption { get; set; }
|
public string? StrOption { get; set; }
|
||||||
|
|
||||||
[Option("--int|-i")]
|
[Option("--int|-i")]
|
||||||
public int IntOption { get; set; }
|
public int IntOption { get; set; }
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ namespace CliFx.Benchmarks.Commands
|
|||||||
public class PowerArgsCommand
|
public class PowerArgsCommand
|
||||||
{
|
{
|
||||||
[ArgShortcut("--str"), ArgShortcut("-s")]
|
[ArgShortcut("--str"), ArgShortcut("-s")]
|
||||||
public string StrOption { get; set; }
|
public string? StrOption { get; set; }
|
||||||
|
|
||||||
[ArgShortcut("--int"), ArgShortcut("-i")]
|
[ArgShortcut("--int"), ArgShortcut("-i")]
|
||||||
public int IntOption { get; set; }
|
public int IntOption { get; set; }
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ namespace CliFx.Benchmarks.Commands
|
|||||||
{
|
{
|
||||||
new Option(new[] {"--str", "-s"})
|
new Option(new[] {"--str", "-s"})
|
||||||
{
|
{
|
||||||
Argument = new Argument<string>()
|
Argument = new Argument<string?>()
|
||||||
},
|
},
|
||||||
new Option(new[] {"--int", "-i"})
|
new Option(new[] {"--int", "-i"})
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,12 +0,0 @@
|
|||||||
using BenchmarkDotNet.Configs;
|
|
||||||
using BenchmarkDotNet.Running;
|
|
||||||
|
|
||||||
namespace CliFx.Benchmarks
|
|
||||||
{
|
|
||||||
public static class Program
|
|
||||||
{
|
|
||||||
public static void Main() =>
|
|
||||||
BenchmarkRunner.Run(typeof(Program).Assembly, DefaultConfig.Instance
|
|
||||||
.With(ConfigOptions.DisableOptimizationsValidator));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +1,14 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
<Import Project="../CliFx.props" />
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<OutputType>Exe</OutputType>
|
<OutputType>Exe</OutputType>
|
||||||
<TargetFramework>netcoreapp2.2</TargetFramework>
|
<TargetFramework>netcoreapp3.1</TargetFramework>
|
||||||
<LangVersion>latest</LangVersion>
|
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="2.2.0" />
|
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="3.1.1" />
|
||||||
<PackageReference Include="Newtonsoft.Json" Version="12.0.2" />
|
<PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ using CliFx.Demo.Internal;
|
|||||||
using CliFx.Demo.Models;
|
using CliFx.Demo.Models;
|
||||||
using CliFx.Demo.Services;
|
using CliFx.Demo.Services;
|
||||||
using CliFx.Exceptions;
|
using CliFx.Exceptions;
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Commands
|
namespace CliFx.Demo.Commands
|
||||||
{
|
{
|
||||||
@@ -14,31 +13,25 @@ namespace CliFx.Demo.Commands
|
|||||||
{
|
{
|
||||||
private readonly LibraryService _libraryService;
|
private readonly LibraryService _libraryService;
|
||||||
|
|
||||||
[CommandOption("title", 't', IsRequired = true, Description = "Book title.")]
|
[CommandParameter(0, Name = "title", Description = "Book title.")]
|
||||||
public string Title { get; set; }
|
public string Title { get; set; } = "";
|
||||||
|
|
||||||
[CommandOption("author", 'a', IsRequired = true, Description = "Book author.")]
|
[CommandOption("author", 'a', IsRequired = true, Description = "Book author.")]
|
||||||
public string Author { get; set; }
|
public string Author { get; set; } = "";
|
||||||
|
|
||||||
[CommandOption("published", 'p', Description = "Book publish date.")]
|
[CommandOption("published", 'p', Description = "Book publish date.")]
|
||||||
public DateTimeOffset Published { get; set; }
|
public DateTimeOffset Published { get; set; } = CreateRandomDate();
|
||||||
|
|
||||||
[CommandOption("isbn", 'n', Description = "Book ISBN.")]
|
[CommandOption("isbn", 'n', Description = "Book ISBN.")]
|
||||||
public Isbn Isbn { get; set; }
|
public Isbn Isbn { get; set; } = CreateRandomIsbn();
|
||||||
|
|
||||||
public BookAddCommand(LibraryService libraryService)
|
public BookAddCommand(LibraryService libraryService)
|
||||||
{
|
{
|
||||||
_libraryService = libraryService;
|
_libraryService = libraryService;
|
||||||
}
|
}
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console)
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
{
|
{
|
||||||
// To make the demo simpler, we will just generate random publish date and ISBN if they were not set
|
|
||||||
if (Published == default)
|
|
||||||
Published = CreateRandomDate();
|
|
||||||
if (Isbn == default)
|
|
||||||
Isbn = CreateRandomIsbn();
|
|
||||||
|
|
||||||
if (_libraryService.GetBook(Title) != null)
|
if (_libraryService.GetBook(Title) != null)
|
||||||
throw new CommandException("Book already exists.", 1);
|
throw new CommandException("Book already exists.", 1);
|
||||||
|
|
||||||
@@ -48,7 +41,7 @@ namespace CliFx.Demo.Commands
|
|||||||
console.Output.WriteLine("Book added.");
|
console.Output.WriteLine("Book added.");
|
||||||
console.RenderBook(book);
|
console.RenderBook(book);
|
||||||
|
|
||||||
return Task.CompletedTask;
|
return default;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -65,7 +58,7 @@ namespace CliFx.Demo.Commands
|
|||||||
Random.Next(1, 59),
|
Random.Next(1, 59),
|
||||||
TimeSpan.Zero);
|
TimeSpan.Zero);
|
||||||
|
|
||||||
public static Isbn CreateRandomIsbn() => new Isbn(
|
private static Isbn CreateRandomIsbn() => new Isbn(
|
||||||
Random.Next(0, 999),
|
Random.Next(0, 999),
|
||||||
Random.Next(0, 99),
|
Random.Next(0, 99),
|
||||||
Random.Next(0, 99999),
|
Random.Next(0, 99999),
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ using CliFx.Attributes;
|
|||||||
using CliFx.Demo.Internal;
|
using CliFx.Demo.Internal;
|
||||||
using CliFx.Demo.Services;
|
using CliFx.Demo.Services;
|
||||||
using CliFx.Exceptions;
|
using CliFx.Exceptions;
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Commands
|
namespace CliFx.Demo.Commands
|
||||||
{
|
{
|
||||||
@@ -12,15 +11,15 @@ namespace CliFx.Demo.Commands
|
|||||||
{
|
{
|
||||||
private readonly LibraryService _libraryService;
|
private readonly LibraryService _libraryService;
|
||||||
|
|
||||||
[CommandOption("title", 't', IsRequired = true, Description = "Book title.")]
|
[CommandParameter(0, Name = "title", Description = "Book title.")]
|
||||||
public string Title { get; set; }
|
public string Title { get; set; } = "";
|
||||||
|
|
||||||
public BookCommand(LibraryService libraryService)
|
public BookCommand(LibraryService libraryService)
|
||||||
{
|
{
|
||||||
_libraryService = libraryService;
|
_libraryService = libraryService;
|
||||||
}
|
}
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console)
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
{
|
{
|
||||||
var book = _libraryService.GetBook(Title);
|
var book = _libraryService.GetBook(Title);
|
||||||
|
|
||||||
@@ -29,7 +28,7 @@ namespace CliFx.Demo.Commands
|
|||||||
|
|
||||||
console.RenderBook(book);
|
console.RenderBook(book);
|
||||||
|
|
||||||
return Task.CompletedTask;
|
return default;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,7 +2,6 @@
|
|||||||
using CliFx.Attributes;
|
using CliFx.Attributes;
|
||||||
using CliFx.Demo.Internal;
|
using CliFx.Demo.Internal;
|
||||||
using CliFx.Demo.Services;
|
using CliFx.Demo.Services;
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Commands
|
namespace CliFx.Demo.Commands
|
||||||
{
|
{
|
||||||
@@ -16,7 +15,7 @@ namespace CliFx.Demo.Commands
|
|||||||
_libraryService = libraryService;
|
_libraryService = libraryService;
|
||||||
}
|
}
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console)
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
{
|
{
|
||||||
var library = _libraryService.GetLibrary();
|
var library = _libraryService.GetLibrary();
|
||||||
|
|
||||||
@@ -32,7 +31,7 @@ namespace CliFx.Demo.Commands
|
|||||||
console.RenderBook(book);
|
console.RenderBook(book);
|
||||||
}
|
}
|
||||||
|
|
||||||
return Task.CompletedTask;
|
return default;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,7 +2,6 @@
|
|||||||
using CliFx.Attributes;
|
using CliFx.Attributes;
|
||||||
using CliFx.Demo.Services;
|
using CliFx.Demo.Services;
|
||||||
using CliFx.Exceptions;
|
using CliFx.Exceptions;
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Commands
|
namespace CliFx.Demo.Commands
|
||||||
{
|
{
|
||||||
@@ -11,15 +10,15 @@ namespace CliFx.Demo.Commands
|
|||||||
{
|
{
|
||||||
private readonly LibraryService _libraryService;
|
private readonly LibraryService _libraryService;
|
||||||
|
|
||||||
[CommandOption("title", 't', IsRequired = true, Description = "Book title.")]
|
[CommandParameter(0, Name = "title", Description = "Book title.")]
|
||||||
public string Title { get; set; }
|
public string Title { get; set; } = "";
|
||||||
|
|
||||||
public BookRemoveCommand(LibraryService libraryService)
|
public BookRemoveCommand(LibraryService libraryService)
|
||||||
{
|
{
|
||||||
_libraryService = libraryService;
|
_libraryService = libraryService;
|
||||||
}
|
}
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console)
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
{
|
{
|
||||||
var book = _libraryService.GetBook(Title);
|
var book = _libraryService.GetBook(Title);
|
||||||
|
|
||||||
@@ -30,7 +29,7 @@ namespace CliFx.Demo.Commands
|
|||||||
|
|
||||||
console.Output.WriteLine($"Book {Title} removed.");
|
console.Output.WriteLine($"Book {Title} removed.");
|
||||||
|
|
||||||
return Task.CompletedTask;
|
return default;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,6 +1,5 @@
|
|||||||
using System;
|
using System;
|
||||||
using CliFx.Demo.Models;
|
using CliFx.Demo.Models;
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Internal
|
namespace CliFx.Demo.Internal
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
using System;
|
using System;
|
||||||
using System.Globalization;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Models
|
namespace CliFx.Demo.Models
|
||||||
{
|
{
|
||||||
@@ -24,21 +23,23 @@ namespace CliFx.Demo.Models
|
|||||||
CheckDigit = checkDigit;
|
CheckDigit = checkDigit;
|
||||||
}
|
}
|
||||||
|
|
||||||
public override string ToString() => $"{EanPrefix:000}-{RegistrationGroup:00}-{Registrant:00000}-{Publication:00}-{CheckDigit:0}";
|
public override string ToString() =>
|
||||||
|
$"{EanPrefix:000}-{RegistrationGroup:00}-{Registrant:00000}-{Publication:00}-{CheckDigit:0}";
|
||||||
}
|
}
|
||||||
|
|
||||||
public partial class Isbn
|
public partial class Isbn
|
||||||
{
|
{
|
||||||
public static Isbn Parse(string value)
|
public static Isbn Parse(string value, IFormatProvider formatProvider)
|
||||||
{
|
{
|
||||||
var components = value.Split('-', 5, StringSplitOptions.RemoveEmptyEntries);
|
var components = value.Split('-', 5, StringSplitOptions.RemoveEmptyEntries);
|
||||||
|
|
||||||
return new Isbn(
|
return new Isbn(
|
||||||
int.Parse(components[0], CultureInfo.InvariantCulture),
|
int.Parse(components[0], formatProvider),
|
||||||
int.Parse(components[1], CultureInfo.InvariantCulture),
|
int.Parse(components[1], formatProvider),
|
||||||
int.Parse(components[2], CultureInfo.InvariantCulture),
|
int.Parse(components[2], formatProvider),
|
||||||
int.Parse(components[3], CultureInfo.InvariantCulture),
|
int.Parse(components[3], formatProvider),
|
||||||
int.Parse(components[4], CultureInfo.InvariantCulture));
|
int.Parse(components[4], formatProvider)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
using System.Threading.Tasks;
|
using System;
|
||||||
|
using System.Threading.Tasks;
|
||||||
using CliFx.Demo.Commands;
|
using CliFx.Demo.Commands;
|
||||||
using CliFx.Demo.Services;
|
using CliFx.Demo.Services;
|
||||||
using Microsoft.Extensions.DependencyInjection;
|
using Microsoft.Extensions.DependencyInjection;
|
||||||
@@ -7,7 +8,7 @@ namespace CliFx.Demo
|
|||||||
{
|
{
|
||||||
public static class Program
|
public static class Program
|
||||||
{
|
{
|
||||||
public static Task<int> Main(string[] args)
|
private static IServiceProvider GetServiceProvider()
|
||||||
{
|
{
|
||||||
// We use Microsoft.Extensions.DependencyInjection for injecting dependencies in commands
|
// We use Microsoft.Extensions.DependencyInjection for injecting dependencies in commands
|
||||||
var services = new ServiceCollection();
|
var services = new ServiceCollection();
|
||||||
@@ -21,13 +22,14 @@ namespace CliFx.Demo
|
|||||||
services.AddTransient<BookRemoveCommand>();
|
services.AddTransient<BookRemoveCommand>();
|
||||||
services.AddTransient<BookListCommand>();
|
services.AddTransient<BookListCommand>();
|
||||||
|
|
||||||
var serviceProvider = services.BuildServiceProvider();
|
return services.BuildServiceProvider();
|
||||||
|
|
||||||
return new CliApplicationBuilder()
|
|
||||||
.AddCommandsFromThisAssembly()
|
|
||||||
.UseCommandFactory(schema => (ICommand) serviceProvider.GetRequiredService(schema.Type))
|
|
||||||
.Build()
|
|
||||||
.RunAsync(args);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public static async Task<int> Main() =>
|
||||||
|
await new CliApplicationBuilder()
|
||||||
|
.AddCommandsFromThisAssembly()
|
||||||
|
.UseTypeActivator(GetServiceProvider().GetService)
|
||||||
|
.Build()
|
||||||
|
.RunAsync();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,6 +2,6 @@
|
|||||||
|
|
||||||
Sample command line interface for managing a library of books.
|
Sample command line interface for managing a library of books.
|
||||||
|
|
||||||
This demo project shows basic CliFx functionality such as command routing, option parsing, autogenerated help text, and some other things.
|
This demo project shows basic CliFx functionality such as command routing, argument parsing, autogenerated help text, and some other things.
|
||||||
|
|
||||||
You can get a list of available commands by running `CliFx.Demo --help`.
|
You can get a list of available commands by running `CliFx.Demo --help`.
|
||||||
@@ -25,7 +25,7 @@ namespace CliFx.Demo.Services
|
|||||||
return JsonConvert.DeserializeObject<Library>(data);
|
return JsonConvert.DeserializeObject<Library>(data);
|
||||||
}
|
}
|
||||||
|
|
||||||
public Book GetBook(string title) => GetLibrary().Books.FirstOrDefault(b => b.Title == title);
|
public Book? GetBook(string title) => GetLibrary().Books.FirstOrDefault(b => b.Title == title);
|
||||||
|
|
||||||
public void AddBook(Book book)
|
public void AddBook(Book book)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
<Import Project="../CliFx.props" />
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<OutputType>Exe</OutputType>
|
<OutputType>Exe</OutputType>
|
||||||
<TargetFramework>net46</TargetFramework>
|
<TargetFramework>netcoreapp3.1</TargetFramework>
|
||||||
<Version>1.2.3.4</Version>
|
|
||||||
<LangVersion>latest</LangVersion>
|
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
|
|||||||
23
CliFx.Tests.Dummy/Commands/ConsoleTestCommand.cs
Normal file
23
CliFx.Tests.Dummy/Commands/ConsoleTestCommand.cs
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
using System;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Tests.Dummy.Commands
|
||||||
|
{
|
||||||
|
[Command("console-test")]
|
||||||
|
public class ConsoleTestCommand : ICommand
|
||||||
|
{
|
||||||
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
|
{
|
||||||
|
var input = console.Input.ReadToEnd();
|
||||||
|
|
||||||
|
console.WithColors(ConsoleColor.Black, ConsoleColor.White, () =>
|
||||||
|
{
|
||||||
|
console.Output.WriteLine(input);
|
||||||
|
console.Error.WriteLine(input);
|
||||||
|
});
|
||||||
|
|
||||||
|
return default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
using System.Text;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Dummy.Commands
|
|
||||||
{
|
|
||||||
[Command]
|
|
||||||
public class GreeterCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("target", 't', Description = "Greeting target.")]
|
|
||||||
public string Target { get; set; } = "world";
|
|
||||||
|
|
||||||
[CommandOption('e', Description = "Whether the greeting should be exclaimed.")]
|
|
||||||
public bool IsExclaimed { get; set; }
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
var buffer = new StringBuilder();
|
|
||||||
|
|
||||||
buffer.Append("Hello").Append(' ').Append(Target);
|
|
||||||
|
|
||||||
if (IsExclaimed)
|
|
||||||
buffer.Append('!');
|
|
||||||
|
|
||||||
console.Output.WriteLine(buffer.ToString());
|
|
||||||
|
|
||||||
return Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
19
CliFx.Tests.Dummy/Commands/HelloWorldCommand.cs
Normal file
19
CliFx.Tests.Dummy/Commands/HelloWorldCommand.cs
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Tests.Dummy.Commands
|
||||||
|
{
|
||||||
|
[Command]
|
||||||
|
public class HelloWorldCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("target", EnvironmentVariableName = "ENV_TARGET")]
|
||||||
|
public string Target { get; set; } = "World";
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
|
{
|
||||||
|
console.Output.WriteLine($"Hello {Target}!");
|
||||||
|
|
||||||
|
return default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Dummy.Commands
|
|
||||||
{
|
|
||||||
[Command("log", Description = "Calculate the logarithm of a value.")]
|
|
||||||
public class LogCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("value", 'v', IsRequired = true, Description = "Value whose logarithm is to be found.")]
|
|
||||||
public double Value { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("base", 'b', Description = "Logarithm base.")]
|
|
||||||
public double Base { get; set; } = 10;
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
var result = Math.Log(Value, Base);
|
|
||||||
console.Output.WriteLine(result);
|
|
||||||
|
|
||||||
return Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
using System.Collections.Generic;
|
|
||||||
using System.Linq;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Dummy.Commands
|
|
||||||
{
|
|
||||||
[Command("sum", Description = "Calculate the sum of all input values.")]
|
|
||||||
public class SumCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("values", 'v', IsRequired = true, Description = "Input values.")]
|
|
||||||
public IReadOnlyList<double> Values { get; set; }
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
var result = Values.Sum();
|
|
||||||
console.Output.WriteLine(result);
|
|
||||||
|
|
||||||
return Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,21 +1,21 @@
|
|||||||
using System.Globalization;
|
using System.Reflection;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
|
|
||||||
namespace CliFx.Tests.Dummy
|
namespace CliFx.Tests.Dummy
|
||||||
{
|
{
|
||||||
public static class Program
|
public static partial class Program
|
||||||
{
|
{
|
||||||
public static Task<int> Main(string[] args)
|
public static Assembly Assembly { get; } = typeof(Program).Assembly;
|
||||||
{
|
|
||||||
// Set culture to invariant to maintain consistent format because we rely on it in tests
|
|
||||||
CultureInfo.DefaultThreadCurrentCulture = CultureInfo.InvariantCulture;
|
|
||||||
CultureInfo.DefaultThreadCurrentUICulture = CultureInfo.InvariantCulture;
|
|
||||||
|
|
||||||
return new CliApplicationBuilder()
|
public static string Location { get; } = Assembly.Location;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static partial class Program
|
||||||
|
{
|
||||||
|
public static async Task Main() =>
|
||||||
|
await new CliApplicationBuilder()
|
||||||
.AddCommandsFromThisAssembly()
|
.AddCommandsFromThisAssembly()
|
||||||
.UseDescription("Dummy program used for E2E tests.")
|
|
||||||
.Build()
|
.Build()
|
||||||
.RunAsync(args);
|
.RunAsync();
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
137
CliFx.Tests/ApplicationSpecs.Commands.cs
Normal file
137
CliFx.Tests/ApplicationSpecs.Commands.cs
Normal file
@@ -0,0 +1,137 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class ApplicationSpecs
|
||||||
|
{
|
||||||
|
[Command]
|
||||||
|
private class NonImplementedCommand
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
private class NonAnnotatedCommand : ICommand
|
||||||
|
{
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("dup")]
|
||||||
|
private class DuplicateNameCommandA : ICommand
|
||||||
|
{
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("dup")]
|
||||||
|
private class DuplicateNameCommandB : ICommand
|
||||||
|
{
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class DuplicateParameterOrderCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandParameter(13)]
|
||||||
|
public string? ParameterA { get; set; }
|
||||||
|
|
||||||
|
[CommandParameter(13)]
|
||||||
|
public string? ParameterB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class DuplicateParameterNameCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandParameter(0, Name = "param")]
|
||||||
|
public string? ParameterA { get; set; }
|
||||||
|
|
||||||
|
[CommandParameter(1, Name = "param")]
|
||||||
|
public string? ParameterB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class MultipleNonScalarParametersCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandParameter(0)]
|
||||||
|
public IReadOnlyList<string>? ParameterA { get; set; }
|
||||||
|
|
||||||
|
[CommandParameter(1)]
|
||||||
|
public IReadOnlyList<string>? ParameterB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class NonLastNonScalarParameterCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandParameter(0)]
|
||||||
|
public IReadOnlyList<string>? ParameterA { get; set; }
|
||||||
|
|
||||||
|
[CommandParameter(1)]
|
||||||
|
public string? ParameterB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class DuplicateOptionNamesCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("fruits")]
|
||||||
|
public string? Apples { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("fruits")]
|
||||||
|
public string? Oranges { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class DuplicateOptionShortNamesCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption('x')]
|
||||||
|
public string? OptionA { get; set; }
|
||||||
|
|
||||||
|
[CommandOption('x')]
|
||||||
|
public string? OptionB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class DuplicateOptionEnvironmentVariableNamesCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("option-a", EnvironmentVariableName = "ENV_VAR")]
|
||||||
|
public string? OptionA { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("option-b", EnvironmentVariableName = "ENV_VAR")]
|
||||||
|
public string? OptionB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class ValidCommand : ICommand
|
||||||
|
{
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("hidden", Description = "Description")]
|
||||||
|
private class HiddenPropertiesCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandParameter(13, Name = "param", Description = "Param description")]
|
||||||
|
public string? Parameter { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("option", 'o', Description = "Option description", EnvironmentVariableName = "ENV")]
|
||||||
|
public string? Option { get; set; }
|
||||||
|
|
||||||
|
public string? HiddenA { get; set; }
|
||||||
|
|
||||||
|
public bool? HiddenB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
197
CliFx.Tests/ApplicationSpecs.cs
Normal file
197
CliFx.Tests/ApplicationSpecs.cs
Normal file
@@ -0,0 +1,197 @@
|
|||||||
|
using System;
|
||||||
|
using System.IO;
|
||||||
|
using CliFx.Domain;
|
||||||
|
using CliFx.Exceptions;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class ApplicationSpecs
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public void Application_can_be_created_with_a_default_configuration()
|
||||||
|
{
|
||||||
|
// Act
|
||||||
|
var app = new CliApplicationBuilder()
|
||||||
|
.AddCommandsFromThisAssembly()
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
app.Should().NotBeNull();
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Application_can_be_created_with_a_custom_configuration()
|
||||||
|
{
|
||||||
|
// Act
|
||||||
|
var app = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(ValidCommand))
|
||||||
|
.AddCommandsFrom(typeof(ValidCommand).Assembly)
|
||||||
|
.AddCommands(new[] {typeof(ValidCommand)})
|
||||||
|
.AddCommandsFrom(new[] {typeof(ValidCommand).Assembly})
|
||||||
|
.AddCommandsFromThisAssembly()
|
||||||
|
.AllowDebugMode()
|
||||||
|
.AllowPreviewMode()
|
||||||
|
.UseTitle("test")
|
||||||
|
.UseExecutableName("test")
|
||||||
|
.UseVersionText("test")
|
||||||
|
.UseDescription("test")
|
||||||
|
.UseConsole(new VirtualConsole(Stream.Null))
|
||||||
|
.UseTypeActivator(Activator.CreateInstance)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
app.Should().NotBeNull();
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void At_least_one_command_must_be_defined_in_an_application()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = Array.Empty<Type>();
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Commands_must_implement_the_corresponding_interface()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(NonImplementedCommand)};
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Commands_must_be_annotated_by_an_attribute()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(NonAnnotatedCommand)};
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Commands_must_have_unique_names()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(DuplicateNameCommandA), typeof(DuplicateNameCommandB)};
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Command_parameters_must_have_unique_order()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(DuplicateParameterOrderCommand)};
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Command_parameters_must_have_unique_names()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(DuplicateParameterNameCommand)};
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Command_parameter_can_be_non_scalar_only_if_no_other_such_parameter_is_present()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(MultipleNonScalarParametersCommand)};
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Command_parameter_can_be_non_scalar_only_if_it_is_the_last_in_order()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(NonLastNonScalarParameterCommand)};
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Command_options_must_have_unique_names()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(DuplicateOptionNamesCommand)};
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Command_options_must_have_unique_short_names()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(DuplicateOptionShortNamesCommand)};
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Command_options_must_have_unique_environment_variable_names()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(DuplicateOptionEnvironmentVariableNamesCommand)};
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() => ApplicationSchema.Resolve(commandTypes));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Command_options_and_parameters_must_be_annotated_by_corresponding_attributes()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandTypes = new[] {typeof(HiddenPropertiesCommand)};
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var schema = ApplicationSchema.Resolve(commandTypes);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
schema.Should().BeEquivalentTo(new ApplicationSchema(new[]
|
||||||
|
{
|
||||||
|
new CommandSchema(
|
||||||
|
typeof(HiddenPropertiesCommand),
|
||||||
|
"hidden",
|
||||||
|
"Description",
|
||||||
|
new[]
|
||||||
|
{
|
||||||
|
new CommandParameterSchema(
|
||||||
|
typeof(HiddenPropertiesCommand).GetProperty(nameof(HiddenPropertiesCommand.Parameter)),
|
||||||
|
13,
|
||||||
|
"param",
|
||||||
|
"Param description")
|
||||||
|
},
|
||||||
|
new[]
|
||||||
|
{
|
||||||
|
new CommandOptionSchema(
|
||||||
|
typeof(HiddenPropertiesCommand).GetProperty(nameof(HiddenPropertiesCommand.Option)),
|
||||||
|
"option",
|
||||||
|
'o',
|
||||||
|
"ENV",
|
||||||
|
false,
|
||||||
|
"Option description")
|
||||||
|
})
|
||||||
|
}));
|
||||||
|
|
||||||
|
schema.ToString().Should().NotBeNullOrWhiteSpace(); // this is only for coverage, I'm sorry
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
191
CliFx.Tests/ArgumentBindingSpecs.Commands.cs
Normal file
191
CliFx.Tests/ArgumentBindingSpecs.Commands.cs
Normal file
@@ -0,0 +1,191 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class ArgumentBindingSpecs
|
||||||
|
{
|
||||||
|
[Command]
|
||||||
|
private class AllSupportedTypesCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption(nameof(Object))]
|
||||||
|
public object? Object { get; set; } = 42;
|
||||||
|
|
||||||
|
[CommandOption(nameof(String))]
|
||||||
|
public string? String { get; set; } = "foo bar";
|
||||||
|
|
||||||
|
[CommandOption(nameof(Bool))]
|
||||||
|
public bool Bool { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Char))]
|
||||||
|
public char Char { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Sbyte))]
|
||||||
|
public sbyte Sbyte { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Byte))]
|
||||||
|
public byte Byte { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Short))]
|
||||||
|
public short Short { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Ushort))]
|
||||||
|
public ushort Ushort { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Int))]
|
||||||
|
public int Int { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Uint))]
|
||||||
|
public uint Uint { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Long))]
|
||||||
|
public long Long { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Ulong))]
|
||||||
|
public ulong Ulong { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Float))]
|
||||||
|
public float Float { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Double))]
|
||||||
|
public double Double { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Decimal))]
|
||||||
|
public decimal Decimal { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(DateTime))]
|
||||||
|
public DateTime DateTime { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(DateTimeOffset))]
|
||||||
|
public DateTimeOffset DateTimeOffset { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(TimeSpan))]
|
||||||
|
public TimeSpan TimeSpan { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(CustomEnum))]
|
||||||
|
public CustomEnum CustomEnum { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(IntNullable))]
|
||||||
|
public int? IntNullable { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(CustomEnumNullable))]
|
||||||
|
public CustomEnum? CustomEnumNullable { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(TimeSpanNullable))]
|
||||||
|
public TimeSpan? TimeSpanNullable { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(TestStringConstructable))]
|
||||||
|
public StringConstructable? TestStringConstructable { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(TestStringParseable))]
|
||||||
|
public StringParseable? TestStringParseable { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(TestStringParseableWithFormatProvider))]
|
||||||
|
public StringParseableWithFormatProvider? TestStringParseableWithFormatProvider { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(ObjectArray))]
|
||||||
|
public object[]? ObjectArray { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(StringArray))]
|
||||||
|
public string[]? StringArray { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(IntArray))]
|
||||||
|
public int[]? IntArray { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(CustomEnumArray))]
|
||||||
|
public CustomEnum[]? CustomEnumArray { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(IntNullableArray))]
|
||||||
|
public int?[]? IntNullableArray { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(TestStringConstructableArray))]
|
||||||
|
public StringConstructable[]? TestStringConstructableArray { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(Enumerable))]
|
||||||
|
public IEnumerable? Enumerable { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(StringEnumerable))]
|
||||||
|
public IEnumerable<string>? StringEnumerable { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(StringReadOnlyList))]
|
||||||
|
public IReadOnlyList<string>? StringReadOnlyList { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(StringList))]
|
||||||
|
public List<string>? StringList { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(StringHashSet))]
|
||||||
|
public HashSet<string>? StringHashSet { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class ArrayOptionCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("option", 'o')]
|
||||||
|
public IReadOnlyList<string>? Option { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class RequiredOptionCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption(nameof(OptionA))]
|
||||||
|
public string? OptionA { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(OptionB), IsRequired = true)]
|
||||||
|
public string? OptionB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class ParametersCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandParameter(0)]
|
||||||
|
public string? ParameterA { get; set; }
|
||||||
|
|
||||||
|
[CommandParameter(1)]
|
||||||
|
public string? ParameterB { get; set; }
|
||||||
|
|
||||||
|
[CommandParameter(2)]
|
||||||
|
public IReadOnlyList<string>? ParameterC { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class UnsupportedPropertyTypeCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption(nameof(Option))]
|
||||||
|
public DummyType? Option { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class UnsupportedEnumerablePropertyTypeCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption(nameof(Option))]
|
||||||
|
public CustomEnumerable<string>? Option { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class NoParameterCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption(nameof(OptionA))]
|
||||||
|
public string? OptionA { get; set; }
|
||||||
|
|
||||||
|
[CommandOption(nameof(OptionB))]
|
||||||
|
public string? OptionB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
64
CliFx.Tests/ArgumentBindingSpecs.Types.cs
Normal file
64
CliFx.Tests/ArgumentBindingSpecs.Types.cs
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class ArgumentBindingSpecs
|
||||||
|
{
|
||||||
|
private enum CustomEnum
|
||||||
|
{
|
||||||
|
Value1 = 1,
|
||||||
|
Value2 = 2,
|
||||||
|
Value3 = 3
|
||||||
|
}
|
||||||
|
|
||||||
|
private class StringConstructable
|
||||||
|
{
|
||||||
|
public string Value { get; }
|
||||||
|
|
||||||
|
public StringConstructable(string value)
|
||||||
|
{
|
||||||
|
Value = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private class StringParseable
|
||||||
|
{
|
||||||
|
public string Value { get; }
|
||||||
|
|
||||||
|
private StringParseable(string value)
|
||||||
|
{
|
||||||
|
Value = value;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static StringParseable Parse(string value) => new StringParseable(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
private class StringParseableWithFormatProvider
|
||||||
|
{
|
||||||
|
public string Value { get; }
|
||||||
|
|
||||||
|
private StringParseableWithFormatProvider(string value)
|
||||||
|
{
|
||||||
|
Value = value;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static StringParseableWithFormatProvider Parse(string value, IFormatProvider formatProvider) =>
|
||||||
|
new StringParseableWithFormatProvider(value + " " + formatProvider);
|
||||||
|
}
|
||||||
|
|
||||||
|
private class DummyType
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
public class CustomEnumerable<T> : IEnumerable<T>
|
||||||
|
{
|
||||||
|
private readonly T[] _arr = new T[0];
|
||||||
|
|
||||||
|
public IEnumerator<T> GetEnumerator() => ((IEnumerable<T>) _arr).GetEnumerator();
|
||||||
|
|
||||||
|
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
1076
CliFx.Tests/ArgumentBindingSpecs.cs
Normal file
1076
CliFx.Tests/ArgumentBindingSpecs.cs
Normal file
File diff suppressed because it is too large
Load Diff
315
CliFx.Tests/ArgumentSyntaxSpecs.cs
Normal file
315
CliFx.Tests/ArgumentSyntaxSpecs.cs
Normal file
@@ -0,0 +1,315 @@
|
|||||||
|
using System;
|
||||||
|
using CliFx.Domain;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public class ArgumentSyntaxSpecs
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public void Input_is_empty_if_no_arguments_are_provided()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var args = Array.Empty<string>();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var input = CommandLineInput.Parse(args);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
input.Should().BeEquivalentTo(CommandLineInput.Empty);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static object[][] DirectivesTestData => new[]
|
||||||
|
{
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"[preview]"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddDirective("preview")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"[preview]", "[debug]"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddDirective("preview")
|
||||||
|
.AddDirective("debug")
|
||||||
|
.Build()
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
[Theory]
|
||||||
|
[MemberData(nameof(DirectivesTestData))]
|
||||||
|
internal void Directive_can_be_enabled_by_specifying_its_name_in_square_brackets(string[] arguments, CommandLineInput expectedInput)
|
||||||
|
{
|
||||||
|
// Act
|
||||||
|
var input = CommandLineInput.Parse(arguments);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
input.Should().BeEquivalentTo(expectedInput);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static object[][] OptionsTestData => new[]
|
||||||
|
{
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"--option"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("option")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"--option", "value"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("option", "value")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"--option", "value1", "value2"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("option", "value1", "value2")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"--option", "same value"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("option", "same value")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"--option1", "--option2"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("option1")
|
||||||
|
.AddOption("option2")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"--option1", "value1", "--option2", "value2"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("option1", "value1")
|
||||||
|
.AddOption("option2", "value2")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"--option1", "value1", "value2", "--option2", "value3", "value4"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("option1", "value1", "value2")
|
||||||
|
.AddOption("option2", "value3", "value4")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"--option1", "value1", "value2", "--option2"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("option1", "value1", "value2")
|
||||||
|
.AddOption("option2")
|
||||||
|
.Build()
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
[Theory]
|
||||||
|
[MemberData(nameof(OptionsTestData))]
|
||||||
|
internal void Option_can_be_set_by_specifying_its_name_after_two_dashes(string[] arguments, CommandLineInput expectedInput)
|
||||||
|
{
|
||||||
|
// Act
|
||||||
|
var input = CommandLineInput.Parse(arguments);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
input.Should().BeEquivalentTo(expectedInput);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static object[][] ShortOptionsTestData => new[]
|
||||||
|
{
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-o"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("o")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-o", "value"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("o", "value")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-o", "value1", "value2"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("o", "value1", "value2")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-o", "same value"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("o", "same value")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-a", "-b"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("a")
|
||||||
|
.AddOption("b")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-a", "value1", "-b", "value2"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("a", "value1")
|
||||||
|
.AddOption("b", "value2")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-a", "value1", "value2", "-b", "value3", "value4"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("a", "value1", "value2")
|
||||||
|
.AddOption("b", "value3", "value4")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-a", "value1", "value2", "-b"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("a", "value1", "value2")
|
||||||
|
.AddOption("b")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-abc"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("a")
|
||||||
|
.AddOption("b")
|
||||||
|
.AddOption("c")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-abc", "value"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("a")
|
||||||
|
.AddOption("b")
|
||||||
|
.AddOption("c", "value")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"-abc", "value1", "value2"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddOption("a")
|
||||||
|
.AddOption("b")
|
||||||
|
.AddOption("c", "value1", "value2")
|
||||||
|
.Build()
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
[Theory]
|
||||||
|
[MemberData(nameof(ShortOptionsTestData))]
|
||||||
|
internal void Option_can_be_set_by_specifying_its_short_name_after_a_single_dash(string[] arguments, CommandLineInput expectedInput)
|
||||||
|
{
|
||||||
|
// Act
|
||||||
|
var input = CommandLineInput.Parse(arguments);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
input.Should().BeEquivalentTo(expectedInput);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static object[][] UnboundArgumentsTestData => new[]
|
||||||
|
{
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"foo"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddUnboundArgument("foo")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"foo", "bar"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddUnboundArgument("foo")
|
||||||
|
.AddUnboundArgument("bar")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"[preview]", "foo"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddDirective("preview")
|
||||||
|
.AddUnboundArgument("foo")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"foo", "--option", "value", "-abc"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddUnboundArgument("foo")
|
||||||
|
.AddOption("option", "value")
|
||||||
|
.AddOption("a")
|
||||||
|
.AddOption("b")
|
||||||
|
.AddOption("c")
|
||||||
|
.Build()
|
||||||
|
},
|
||||||
|
|
||||||
|
new object[]
|
||||||
|
{
|
||||||
|
new[] {"[preview]", "[debug]", "foo", "bar", "--option", "value", "-abc"},
|
||||||
|
new CommandLineInputBuilder()
|
||||||
|
.AddDirective("preview")
|
||||||
|
.AddDirective("debug")
|
||||||
|
.AddUnboundArgument("foo")
|
||||||
|
.AddUnboundArgument("bar")
|
||||||
|
.AddOption("option", "value")
|
||||||
|
.AddOption("a")
|
||||||
|
.AddOption("b")
|
||||||
|
.AddOption("c")
|
||||||
|
.Build()
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
[Theory]
|
||||||
|
[MemberData(nameof(UnboundArgumentsTestData))]
|
||||||
|
internal void Any_remaining_arguments_are_treated_as_unbound_arguments(string[] arguments, CommandLineInput expectedInput)
|
||||||
|
{
|
||||||
|
// Act
|
||||||
|
var input = CommandLineInput.Parse(arguments);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
input.Should().BeEquivalentTo(expectedInput);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
27
CliFx.Tests/CancellationSpecs.Commands.cs
Normal file
27
CliFx.Tests/CancellationSpecs.Commands.cs
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
using System;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class CancellationSpecs
|
||||||
|
{
|
||||||
|
[Command("cancel")]
|
||||||
|
private class CancellableCommand : ICommand
|
||||||
|
{
|
||||||
|
public async ValueTask ExecuteAsync(IConsole console)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
await Task.Delay(TimeSpan.FromSeconds(3), console.GetCancellationToken());
|
||||||
|
console.Output.WriteLine("Never printed");
|
||||||
|
}
|
||||||
|
catch (OperationCanceledException)
|
||||||
|
{
|
||||||
|
console.Output.WriteLine("Cancellation requested");
|
||||||
|
throw;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
41
CliFx.Tests/CancellationSpecs.cs
Normal file
41
CliFx.Tests/CancellationSpecs.cs
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.IO;
|
||||||
|
using System.Threading;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class CancellationSpecs
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public async Task Command_can_perform_additional_cleanup_if_cancellation_is_requested()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
using var cts = new CancellationTokenSource();
|
||||||
|
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut, cancellationToken: cts.Token);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(CancellableCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
cts.CancelAfter(TimeSpan.FromSeconds(0.2));
|
||||||
|
|
||||||
|
var exitCode = await application.RunAsync(
|
||||||
|
new[] {"cancel"},
|
||||||
|
new Dictionary<string, string>());
|
||||||
|
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().NotBe(0);
|
||||||
|
stdOutData.Should().Be("Cancellation requested");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
using CliFx.Exceptions;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
public partial class CliApplicationTests
|
|
||||||
{
|
|
||||||
[Command]
|
|
||||||
private class DefaultCommand : ICommand
|
|
||||||
{
|
|
||||||
public Task ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
console.Output.WriteLine("DefaultCommand executed.");
|
|
||||||
return Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
[Command("cmd")]
|
|
||||||
private class NamedCommand : ICommand
|
|
||||||
{
|
|
||||||
public Task ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
console.Output.WriteLine("NamedCommand executed.");
|
|
||||||
return Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Negative
|
|
||||||
public partial class CliApplicationTests
|
|
||||||
{
|
|
||||||
[Command("faulty1")]
|
|
||||||
private class FaultyCommand1 : ICommand
|
|
||||||
{
|
|
||||||
public Task ExecuteAsync(IConsole console) => throw new CommandException(150);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Command("faulty2")]
|
|
||||||
private class FaultyCommand2 : ICommand
|
|
||||||
{
|
|
||||||
public Task ExecuteAsync(IConsole console) => throw new CommandException("FaultyCommand2 error message.", 150);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Command("faulty3")]
|
|
||||||
private class FaultyCommand3 : ICommand
|
|
||||||
{
|
|
||||||
public Task ExecuteAsync(IConsole console) => throw new Exception("FaultyCommand3 error message.");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,174 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.IO;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Services;
|
|
||||||
using FluentAssertions;
|
|
||||||
using NUnit.Framework;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
[TestFixture]
|
|
||||||
public partial class CliApplicationTests
|
|
||||||
{
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_RunAsync()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(DefaultCommand)},
|
|
||||||
new string[0],
|
|
||||||
"DefaultCommand executed."
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(NamedCommand)},
|
|
||||||
new[] {"cmd"},
|
|
||||||
"NamedCommand executed."
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_HelpAndVersion_RunAsync()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(DefaultCommand)},
|
|
||||||
new string[0]
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(DefaultCommand)},
|
|
||||||
new[] {"-h"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(DefaultCommand)},
|
|
||||||
new[] {"--help"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(DefaultCommand)},
|
|
||||||
new[] {"--version"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(NamedCommand)},
|
|
||||||
new string[0]
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(NamedCommand)},
|
|
||||||
new[] {"cmd", "-h"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(FaultyCommand1)},
|
|
||||||
new[] {"faulty1", "-h"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(FaultyCommand2)},
|
|
||||||
new[] {"faulty2", "-h"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(FaultyCommand3)},
|
|
||||||
new[] {"faulty3", "-h"}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_RunAsync_Negative()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new Type[0],
|
|
||||||
new string[0]
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(DefaultCommand)},
|
|
||||||
new[] {"non-existing"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(FaultyCommand1)},
|
|
||||||
new[] {"faulty1"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(FaultyCommand2)},
|
|
||||||
new[] {"faulty2"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(FaultyCommand3)},
|
|
||||||
new[] {"faulty3"}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_RunAsync))]
|
|
||||||
public async Task RunAsync_Test(IReadOnlyList<Type> commandTypes, IReadOnlyList<string> commandLineArguments, string expectedStdOut)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
using (var stdout = new StringWriter())
|
|
||||||
{
|
|
||||||
var console = new VirtualConsole(stdout);
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommands(commandTypes)
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(commandLineArguments);
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().Be(0);
|
|
||||||
stdout.ToString().Trim().Should().Be(expectedStdOut);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_HelpAndVersion_RunAsync))]
|
|
||||||
public async Task RunAsync_HelpAndVersion_Test(IReadOnlyList<Type> commandTypes, IReadOnlyList<string> commandLineArguments)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
using (var stdout = new StringWriter())
|
|
||||||
{
|
|
||||||
var console = new VirtualConsole(stdout);
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommands(commandTypes)
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(commandLineArguments);
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().Be(0);
|
|
||||||
stdout.ToString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_RunAsync_Negative))]
|
|
||||||
public async Task RunAsync_Negative_Test(IReadOnlyList<Type> commandTypes, IReadOnlyList<string> commandLineArguments)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
using (var stderr = new StringWriter())
|
|
||||||
{
|
|
||||||
var console = new VirtualConsole(TextWriter.Null, stderr);
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommands(commandTypes)
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(commandLineArguments);
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stderr.ToString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,25 +1,26 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
<Import Project="../CliFx.props" />
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<TargetFramework>net46</TargetFramework>
|
<TargetFramework>netcoreapp3.1</TargetFramework>
|
||||||
<IsPackable>false</IsPackable>
|
<IsPackable>false</IsPackable>
|
||||||
<IsTestProject>true</IsTestProject>
|
<IsTestProject>true</IsTestProject>
|
||||||
<CollectCoverage>true</CollectCoverage>
|
<CollectCoverage>true</CollectCoverage>
|
||||||
<CoverletOutputFormat>opencover</CoverletOutputFormat>
|
<CoverletOutputFormat>opencover</CoverletOutputFormat>
|
||||||
<CoverletOutput>bin/$(Configuration)/Coverage.xml</CoverletOutput>
|
<CoverletOutput>bin/$(Configuration)/Coverage.xml</CoverletOutput>
|
||||||
<LangVersion>latest</LangVersion>
|
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<PackageReference Include="FluentAssertions" Version="5.8.0" />
|
<Content Include="xunit.runner.json" CopyToOutputDirectory="PreserveNewest" />
|
||||||
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" />
|
</ItemGroup>
|
||||||
<PackageReference Include="NUnit" Version="3.12.0" />
|
|
||||||
<PackageReference Include="NUnit3TestAdapter" Version="3.14.0" />
|
<ItemGroup>
|
||||||
<PackageReference Include="CliWrap" Version="2.3.1" />
|
<PackageReference Include="CliWrap" Version="3.0.0" />
|
||||||
<PackageReference Include="coverlet.msbuild" Version="2.6.3">
|
<PackageReference Include="FluentAssertions" Version="5.10.2" />
|
||||||
<PrivateAssets>all</PrivateAssets>
|
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
|
||||||
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
|
<PackageReference Include="coverlet.msbuild" Version="2.8.0" PrivateAssets="all" />
|
||||||
</PackageReference>
|
<PackageReference Include="xunit" Version="2.4.1" />
|
||||||
|
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
@@ -27,4 +28,12 @@
|
|||||||
<ProjectReference Include="..\CliFx\CliFx.csproj" />
|
<ProjectReference Include="..\CliFx\CliFx.csproj" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<None Include="../CliFx.Tests.Dummy/bin/$(Configuration)/$(TargetFramework)/CliFx.Tests.Dummy.runtimeconfig.json">
|
||||||
|
<Link>CliFx.Tests.Dummy.runtimeconfig.json</Link>
|
||||||
|
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||||
|
<Visible>False</Visible>
|
||||||
|
</None>
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
</Project>
|
</Project>
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
public partial class CommandFactoryTests
|
|
||||||
{
|
|
||||||
[Command]
|
|
||||||
private class TestCommand : ICommand
|
|
||||||
{
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Linq;
|
|
||||||
using CliFx.Models;
|
|
||||||
using CliFx.Services;
|
|
||||||
using FluentAssertions;
|
|
||||||
using NUnit.Framework;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
[TestFixture]
|
|
||||||
public partial class CommandFactoryTests
|
|
||||||
{
|
|
||||||
private static CommandSchema GetCommandSchema(Type commandType) =>
|
|
||||||
new CommandSchemaResolver().GetCommandSchemas(new[] {commandType}).Single();
|
|
||||||
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_CreateCommand()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(GetCommandSchema(typeof(TestCommand)));
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_CreateCommand))]
|
|
||||||
public void CreateCommand_Test(CommandSchema commandSchema)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var factory = new CommandFactory();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var command = factory.CreateCommand(commandSchema);
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
command.Should().BeOfType(commandSchema.Type);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
public partial class CommandInitializerTests
|
|
||||||
{
|
|
||||||
[Command]
|
|
||||||
private class TestCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("int", 'i', IsRequired = true)]
|
|
||||||
public int IntOption { get; set; } = 24;
|
|
||||||
|
|
||||||
[CommandOption("str", 's')]
|
|
||||||
public string StringOption { get; set; } = "foo bar";
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,96 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Linq;
|
|
||||||
using CliFx.Exceptions;
|
|
||||||
using CliFx.Models;
|
|
||||||
using CliFx.Services;
|
|
||||||
using FluentAssertions;
|
|
||||||
using NUnit.Framework;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
[TestFixture]
|
|
||||||
public partial class CommandInitializerTests
|
|
||||||
{
|
|
||||||
private static CommandSchema GetCommandSchema(Type commandType) =>
|
|
||||||
new CommandSchemaResolver().GetCommandSchemas(new[] {commandType}).Single();
|
|
||||||
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_InitializeCommand()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new TestCommand(),
|
|
||||||
GetCommandSchema(typeof(TestCommand)),
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("int", "13")
|
|
||||||
}),
|
|
||||||
new TestCommand {IntOption = 13}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new TestCommand(),
|
|
||||||
GetCommandSchema(typeof(TestCommand)),
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("int", "13"),
|
|
||||||
new CommandOptionInput("str", "hello world")
|
|
||||||
}),
|
|
||||||
new TestCommand {IntOption = 13, StringOption = "hello world"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new TestCommand(),
|
|
||||||
GetCommandSchema(typeof(TestCommand)),
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("i", "13")
|
|
||||||
}),
|
|
||||||
new TestCommand {IntOption = 13}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_InitializeCommand_Negative()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new TestCommand(),
|
|
||||||
GetCommandSchema(typeof(TestCommand)),
|
|
||||||
CommandInput.Empty
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new TestCommand(),
|
|
||||||
GetCommandSchema(typeof(TestCommand)),
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("str", "hello world")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_InitializeCommand))]
|
|
||||||
public void InitializeCommand_Test(ICommand command, CommandSchema commandSchema, CommandInput commandInput, ICommand expectedCommand)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var initializer = new CommandInitializer();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
initializer.InitializeCommand(command, commandSchema, commandInput);
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
command.Should().BeEquivalentTo(expectedCommand, o => o.RespectingRuntimeTypes());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_InitializeCommand_Negative))]
|
|
||||||
public void InitializeCommand_Negative_Test(ICommand command, CommandSchema commandSchema, CommandInput commandInput)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var initializer = new CommandInitializer();
|
|
||||||
|
|
||||||
// Act & Assert
|
|
||||||
initializer.Invoking(i => i.InitializeCommand(command, commandSchema, commandInput))
|
|
||||||
.Should().ThrowExactly<MissingCommandOptionInputException>();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,184 +0,0 @@
|
|||||||
using System.Collections.Generic;
|
|
||||||
using CliFx.Models;
|
|
||||||
using CliFx.Services;
|
|
||||||
using FluentAssertions;
|
|
||||||
using NUnit.Framework;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
[TestFixture]
|
|
||||||
public class CommandInputParserTests
|
|
||||||
{
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_ParseCommandInput()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(new string[0], CommandInput.Empty);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"--option", "value"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("option", "value")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"--option1", "value1", "--option2", "value2"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("option1", "value1"),
|
|
||||||
new CommandOptionInput("option2", "value2")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"--option", "value1", "value2"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value2"})
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"--option", "value1", "--option", "value2"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value2"})
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"-a", "value"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("a", "value")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"-a", "value1", "-b", "value2"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("a", "value1"),
|
|
||||||
new CommandOptionInput("b", "value2")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"-a", "value1", "value2"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("a", new[] {"value1", "value2"})
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"-a", "value1", "-a", "value2"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("a", new[] {"value1", "value2"})
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"--option1", "value1", "-b", "value2"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("option1", "value1"),
|
|
||||||
new CommandOptionInput("b", "value2")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"--switch"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("switch")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"--switch1", "--switch2"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("switch1"),
|
|
||||||
new CommandOptionInput("switch2")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"-s"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("s")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"-a", "-b"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("a"),
|
|
||||||
new CommandOptionInput("b")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"-ab"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("a"),
|
|
||||||
new CommandOptionInput("b")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"-ab", "value"},
|
|
||||||
new CommandInput(new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("a"),
|
|
||||||
new CommandOptionInput("b", "value")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"command"},
|
|
||||||
new CommandInput("command")
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"command", "--option", "value"},
|
|
||||||
new CommandInput("command", new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("option", "value")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"long", "command", "name"},
|
|
||||||
new CommandInput("long command name")
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {"long", "command", "name", "--option", "value"},
|
|
||||||
new CommandInput("long command name", new[]
|
|
||||||
{
|
|
||||||
new CommandOptionInput("option", "value")
|
|
||||||
})
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_ParseCommandInput))]
|
|
||||||
public void ParseCommandInput_Test(IReadOnlyList<string> commandLineArguments, CommandInput expectedCommandInput)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var parser = new CommandInputParser();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var commandInput = parser.ParseCommandInput(commandLineArguments);
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
commandInput.Should().BeEquivalentTo(expectedCommandInput);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
using System;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
public partial class CommandOptionInputConverterTests
|
|
||||||
{
|
|
||||||
private enum TestEnum
|
|
||||||
{
|
|
||||||
Value1,
|
|
||||||
Value2,
|
|
||||||
Value3
|
|
||||||
}
|
|
||||||
|
|
||||||
private class TestStringConstructable
|
|
||||||
{
|
|
||||||
public string Value { get; }
|
|
||||||
|
|
||||||
public TestStringConstructable(string value)
|
|
||||||
{
|
|
||||||
Value = value;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private class TestStringParseable
|
|
||||||
{
|
|
||||||
public string Value { get; }
|
|
||||||
|
|
||||||
private TestStringParseable(string value)
|
|
||||||
{
|
|
||||||
Value = value;
|
|
||||||
}
|
|
||||||
|
|
||||||
public static TestStringParseable Parse(string value) => new TestStringParseable(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
private class TestStringParseableWithFormatProvider
|
|
||||||
{
|
|
||||||
public string Value { get; }
|
|
||||||
|
|
||||||
private TestStringParseableWithFormatProvider(string value)
|
|
||||||
{
|
|
||||||
Value = value;
|
|
||||||
}
|
|
||||||
|
|
||||||
public static TestStringParseableWithFormatProvider Parse(string value, IFormatProvider formatProvider) =>
|
|
||||||
new TestStringParseableWithFormatProvider(value + " " + formatProvider);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Negative
|
|
||||||
public partial class CommandOptionInputConverterTests
|
|
||||||
{
|
|
||||||
private class NonStringParseable
|
|
||||||
{
|
|
||||||
public int Value { get; }
|
|
||||||
|
|
||||||
public NonStringParseable(int value)
|
|
||||||
{
|
|
||||||
Value = value;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,305 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Globalization;
|
|
||||||
using CliFx.Exceptions;
|
|
||||||
using CliFx.Models;
|
|
||||||
using CliFx.Services;
|
|
||||||
using FluentAssertions;
|
|
||||||
using NUnit.Framework;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
[TestFixture]
|
|
||||||
public partial class CommandOptionInputConverterTests
|
|
||||||
{
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_ConvertOptionInput()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "value"),
|
|
||||||
typeof(string),
|
|
||||||
"value"
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "value"),
|
|
||||||
typeof(object),
|
|
||||||
"value"
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "true"),
|
|
||||||
typeof(bool),
|
|
||||||
true
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "false"),
|
|
||||||
typeof(bool),
|
|
||||||
false
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option"),
|
|
||||||
typeof(bool),
|
|
||||||
true
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "a"),
|
|
||||||
typeof(char),
|
|
||||||
'a'
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "15"),
|
|
||||||
typeof(sbyte),
|
|
||||||
(sbyte) 15
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "15"),
|
|
||||||
typeof(byte),
|
|
||||||
(byte) 15
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "15"),
|
|
||||||
typeof(short),
|
|
||||||
(short) 15
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "15"),
|
|
||||||
typeof(ushort),
|
|
||||||
(ushort) 15
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "123"),
|
|
||||||
typeof(int),
|
|
||||||
123
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "123"),
|
|
||||||
typeof(uint),
|
|
||||||
123u
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "123"),
|
|
||||||
typeof(long),
|
|
||||||
123L
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "123"),
|
|
||||||
typeof(ulong),
|
|
||||||
123UL
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "123.45"),
|
|
||||||
typeof(float),
|
|
||||||
123.45f
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "123.45"),
|
|
||||||
typeof(double),
|
|
||||||
123.45
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "123.45"),
|
|
||||||
typeof(decimal),
|
|
||||||
123.45m
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "28 Apr 1995"),
|
|
||||||
typeof(DateTime),
|
|
||||||
new DateTime(1995, 04, 28)
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "28 Apr 1995"),
|
|
||||||
typeof(DateTimeOffset),
|
|
||||||
new DateTimeOffset(new DateTime(1995, 04, 28))
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "00:14:59"),
|
|
||||||
typeof(TimeSpan),
|
|
||||||
new TimeSpan(00, 14, 59)
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "value2"),
|
|
||||||
typeof(TestEnum),
|
|
||||||
TestEnum.Value2
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "666"),
|
|
||||||
typeof(int?),
|
|
||||||
666
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option"),
|
|
||||||
typeof(int?),
|
|
||||||
null
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "value3"),
|
|
||||||
typeof(TestEnum?),
|
|
||||||
TestEnum.Value3
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option"),
|
|
||||||
typeof(TestEnum?),
|
|
||||||
null
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "01:00:00"),
|
|
||||||
typeof(TimeSpan?),
|
|
||||||
new TimeSpan(01, 00, 00)
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option"),
|
|
||||||
typeof(TimeSpan?),
|
|
||||||
null
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "value"),
|
|
||||||
typeof(TestStringConstructable),
|
|
||||||
new TestStringConstructable("value")
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "value"),
|
|
||||||
typeof(TestStringParseable),
|
|
||||||
TestStringParseable.Parse("value")
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "value"),
|
|
||||||
typeof(TestStringParseableWithFormatProvider),
|
|
||||||
TestStringParseableWithFormatProvider.Parse("value", CultureInfo.InvariantCulture)
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value2"}),
|
|
||||||
typeof(string[]),
|
|
||||||
new[] {"value1", "value2"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value2"}),
|
|
||||||
typeof(object[]),
|
|
||||||
new[] {"value1", "value2"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"47", "69"}),
|
|
||||||
typeof(int[]),
|
|
||||||
new[] {47, 69}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value3"}),
|
|
||||||
typeof(TestEnum[]),
|
|
||||||
new[] {TestEnum.Value1, TestEnum.Value3}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"1337", "2441"}),
|
|
||||||
typeof(int?[]),
|
|
||||||
new int?[] {1337, 2441}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value2"}),
|
|
||||||
typeof(TestStringConstructable[]),
|
|
||||||
new[] {new TestStringConstructable("value1"), new TestStringConstructable("value2")}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value2"}),
|
|
||||||
typeof(IEnumerable),
|
|
||||||
new[] {"value1", "value2"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value2"}),
|
|
||||||
typeof(IEnumerable<string>),
|
|
||||||
new[] {"value1", "value2"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value2"}),
|
|
||||||
typeof(IReadOnlyList<string>),
|
|
||||||
new[] {"value1", "value2"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value2"}),
|
|
||||||
typeof(List<string>),
|
|
||||||
new List<string> {"value1", "value2"}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", new[] {"value1", "value2"}),
|
|
||||||
typeof(HashSet<string>),
|
|
||||||
new HashSet<string> {"value1", "value2"}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_ConvertOptionInput_Negative()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "1234.5"),
|
|
||||||
typeof(int)
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new CommandOptionInput("option", "123"),
|
|
||||||
typeof(NonStringParseable)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_ConvertOptionInput))]
|
|
||||||
public void ConvertOptionInput_Test(CommandOptionInput optionInput, Type targetType, object expectedConvertedValue)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var converter = new CommandOptionInputConverter();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var convertedValue = converter.ConvertOptionInput(optionInput, targetType);
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
convertedValue.Should().BeEquivalentTo(expectedConvertedValue);
|
|
||||||
convertedValue?.Should().BeAssignableTo(targetType);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_ConvertOptionInput_Negative))]
|
|
||||||
public void ConvertOptionInput_Negative_Test(CommandOptionInput optionInput, Type targetType)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var converter = new CommandOptionInputConverter();
|
|
||||||
|
|
||||||
// Act & Assert
|
|
||||||
converter.Invoking(c => c.ConvertOptionInput(optionInput, targetType))
|
|
||||||
.Should().ThrowExactly<InvalidCommandOptionInputException>();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
public partial class CommandSchemaResolverTests
|
|
||||||
{
|
|
||||||
[Command("cmd", Description = "NormalCommand1 description.")]
|
|
||||||
private class NormalCommand1 : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("option-a", 'a')]
|
|
||||||
public int OptionA { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("option-b", IsRequired = true)]
|
|
||||||
public string OptionB { get; set; }
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
|
|
||||||
[Command(Description = "NormalCommand2 description.")]
|
|
||||||
private class NormalCommand2 : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("option-c", Description = "OptionC description.")]
|
|
||||||
public bool OptionC { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("option-d", 'd')]
|
|
||||||
public DateTimeOffset OptionD { get; set; }
|
|
||||||
|
|
||||||
public string NotAnOption { get; set; }
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Negative
|
|
||||||
public partial class CommandSchemaResolverTests
|
|
||||||
{
|
|
||||||
[Command("conflict")]
|
|
||||||
private class ConflictingCommand1 : ICommand
|
|
||||||
{
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
|
|
||||||
[Command("conflict")]
|
|
||||||
private class ConflictingCommand2 : ICommand
|
|
||||||
{
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
|
|
||||||
[Command]
|
|
||||||
private class InvalidCommand1
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
[Command]
|
|
||||||
private class InvalidCommand2 : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("conflict")]
|
|
||||||
public string ConflictingOption1 { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("conflict")]
|
|
||||||
public string ConflictingOption2 { get; set; }
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
|
|
||||||
[Command]
|
|
||||||
private class InvalidCommand3 : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption('c')]
|
|
||||||
public string ConflictingOption1 { get; set; }
|
|
||||||
|
|
||||||
[CommandOption('c')]
|
|
||||||
public string ConflictingOption2 { get; set; }
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,94 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using CliFx.Exceptions;
|
|
||||||
using CliFx.Models;
|
|
||||||
using CliFx.Services;
|
|
||||||
using FluentAssertions;
|
|
||||||
using NUnit.Framework;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
[TestFixture]
|
|
||||||
public partial class CommandSchemaResolverTests
|
|
||||||
{
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_GetCommandSchemas()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new[] {typeof(NormalCommand1), typeof(NormalCommand2)},
|
|
||||||
new[]
|
|
||||||
{
|
|
||||||
new CommandSchema(typeof(NormalCommand1), "cmd", "NormalCommand1 description.",
|
|
||||||
new[]
|
|
||||||
{
|
|
||||||
new CommandOptionSchema(typeof(NormalCommand1).GetProperty(nameof(NormalCommand1.OptionA)),
|
|
||||||
"option-a", 'a', false, null),
|
|
||||||
new CommandOptionSchema(typeof(NormalCommand1).GetProperty(nameof(NormalCommand1.OptionB)),
|
|
||||||
"option-b", null, true, null)
|
|
||||||
}),
|
|
||||||
new CommandSchema(typeof(NormalCommand2), null, "NormalCommand2 description.",
|
|
||||||
new[]
|
|
||||||
{
|
|
||||||
new CommandOptionSchema(typeof(NormalCommand2).GetProperty(nameof(NormalCommand2.OptionC)),
|
|
||||||
"option-c", null, false, "OptionC description."),
|
|
||||||
new CommandOptionSchema(typeof(NormalCommand2).GetProperty(nameof(NormalCommand2.OptionD)),
|
|
||||||
"option-d", 'd', false, null)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_GetCommandSchemas_Negative()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(new object[]
|
|
||||||
{
|
|
||||||
new Type[0]
|
|
||||||
});
|
|
||||||
|
|
||||||
yield return new TestCaseData(new object[]
|
|
||||||
{
|
|
||||||
new[] {typeof(ConflictingCommand1), typeof(ConflictingCommand2)}
|
|
||||||
});
|
|
||||||
|
|
||||||
yield return new TestCaseData(new object[]
|
|
||||||
{
|
|
||||||
new[] {typeof(InvalidCommand1)}
|
|
||||||
});
|
|
||||||
|
|
||||||
yield return new TestCaseData(new object[]
|
|
||||||
{
|
|
||||||
new[] {typeof(InvalidCommand2)}
|
|
||||||
});
|
|
||||||
|
|
||||||
yield return new TestCaseData(new object[]
|
|
||||||
{
|
|
||||||
new[] {typeof(InvalidCommand3)}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_GetCommandSchemas))]
|
|
||||||
public void GetCommandSchemas_Test(IReadOnlyList<Type> commandTypes, IReadOnlyList<CommandSchema> expectedCommandSchemas)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var commandSchemaResolver = new CommandSchemaResolver();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var commandSchemas = commandSchemaResolver.GetCommandSchemas(commandTypes);
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
commandSchemas.Should().BeEquivalentTo(expectedCommandSchemas);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_GetCommandSchemas_Negative))]
|
|
||||||
public void GetCommandSchemas_Negative_Test(IReadOnlyList<Type> commandTypes)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var resolver = new CommandSchemaResolver();
|
|
||||||
|
|
||||||
// Act & Assert
|
|
||||||
resolver.Invoking(r => r.GetCommandSchemas(commandTypes))
|
|
||||||
.Should().ThrowExactly<InvalidCommandSchemaException>();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
72
CliFx.Tests/ConsoleSpecs.cs
Normal file
72
CliFx.Tests/ConsoleSpecs.cs
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
using System;
|
||||||
|
using System.IO;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliWrap;
|
||||||
|
using CliWrap.Buffered;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public class ConsoleSpecs
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public async Task Real_implementation_of_console_maps_directly_to_system_console()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var command = "Hello world" | Cli.Wrap("dotnet")
|
||||||
|
.WithArguments(a => a
|
||||||
|
.Add(Dummy.Program.Location)
|
||||||
|
.Add("console-test"));
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var result = await command.ExecuteBufferedAsync();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
result.StandardOutput.TrimEnd().Should().Be("Hello world");
|
||||||
|
result.StandardError.TrimEnd().Should().Be("Hello world");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Fake_implementation_of_console_can_be_used_to_execute_commands_in_isolation()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
using var stdIn = new MemoryStream(Console.InputEncoding.GetBytes("input"));
|
||||||
|
using var stdOut = new MemoryStream();
|
||||||
|
using var stdErr = new MemoryStream();
|
||||||
|
|
||||||
|
var console = new VirtualConsole(
|
||||||
|
input: stdIn,
|
||||||
|
output: stdOut,
|
||||||
|
error: stdErr);
|
||||||
|
|
||||||
|
// Act
|
||||||
|
console.Output.Write("output");
|
||||||
|
console.Error.Write("error");
|
||||||
|
|
||||||
|
var stdInData = console.Input.ReadToEnd();
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray());
|
||||||
|
var stdErrData = console.Error.Encoding.GetString(stdErr.ToArray());
|
||||||
|
|
||||||
|
console.ResetColor();
|
||||||
|
console.ForegroundColor = ConsoleColor.DarkMagenta;
|
||||||
|
console.BackgroundColor = ConsoleColor.DarkMagenta;
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdInData.Should().Be("input");
|
||||||
|
stdOutData.Should().Be("output");
|
||||||
|
stdErrData.Should().Be("error");
|
||||||
|
|
||||||
|
console.Input.Should().NotBeSameAs(Console.In);
|
||||||
|
console.Output.Should().NotBeSameAs(Console.Out);
|
||||||
|
console.Error.Should().NotBeSameAs(Console.Error);
|
||||||
|
|
||||||
|
console.IsInputRedirected.Should().BeTrue();
|
||||||
|
console.IsOutputRedirected.Should().BeTrue();
|
||||||
|
console.IsErrorRedirected.Should().BeTrue();
|
||||||
|
|
||||||
|
console.ForegroundColor.Should().NotBe(Console.ForegroundColor);
|
||||||
|
console.BackgroundColor.Should().NotBe(Console.BackgroundColor);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
public partial class DelegateCommandFactoryTests
|
|
||||||
{
|
|
||||||
[Command]
|
|
||||||
private class TestCommand : ICommand
|
|
||||||
{
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Linq;
|
|
||||||
using CliFx.Models;
|
|
||||||
using CliFx.Services;
|
|
||||||
using FluentAssertions;
|
|
||||||
using NUnit.Framework;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
[TestFixture]
|
|
||||||
public partial class DelegateCommandFactoryTests
|
|
||||||
{
|
|
||||||
private static CommandSchema GetCommandSchema(Type commandType) =>
|
|
||||||
new CommandSchemaResolver().GetCommandSchemas(new[] {commandType}).Single();
|
|
||||||
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_CreateCommand()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(
|
|
||||||
new Func<CommandSchema, ICommand>(schema => (ICommand) Activator.CreateInstance(schema.Type)),
|
|
||||||
GetCommandSchema(typeof(TestCommand))
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_CreateCommand))]
|
|
||||||
public void CreateCommand_Test(Func<CommandSchema, ICommand> factoryMethod, CommandSchema commandSchema)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var factory = new DelegateCommandFactory(factoryMethod);
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var command = factory.CreateCommand(commandSchema);
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
command.Should().BeOfType(commandSchema.Type);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
37
CliFx.Tests/DependencyInjectionSpecs.Commands.cs
Normal file
37
CliFx.Tests/DependencyInjectionSpecs.Commands.cs
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class DependencyInjectionSpecs
|
||||||
|
{
|
||||||
|
[Command]
|
||||||
|
private class WithoutDependenciesCommand : ICommand
|
||||||
|
{
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
private class DependencyA
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
private class DependencyB
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class WithDependenciesCommand : ICommand
|
||||||
|
{
|
||||||
|
private readonly DependencyA _dependencyA;
|
||||||
|
private readonly DependencyB _dependencyB;
|
||||||
|
|
||||||
|
public WithDependenciesCommand(DependencyA dependencyA, DependencyB dependencyB)
|
||||||
|
{
|
||||||
|
_dependencyA = dependencyA;
|
||||||
|
_dependencyB = dependencyB;
|
||||||
|
}
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
58
CliFx.Tests/DependencyInjectionSpecs.cs
Normal file
58
CliFx.Tests/DependencyInjectionSpecs.cs
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
using CliFx.Exceptions;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class DependencyInjectionSpecs
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public void Default_type_activator_can_initialize_a_command_if_it_has_a_parameterless_constructor()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var activator = new DefaultTypeActivator();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var obj = activator.CreateInstance(typeof(WithoutDependenciesCommand));
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
obj.Should().BeOfType<WithoutDependenciesCommand>();
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Default_type_activator_cannot_initialize_a_command_if_it_does_not_have_a_parameterless_constructor()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var activator = new DefaultTypeActivator();
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() =>
|
||||||
|
activator.CreateInstance(typeof(WithDependenciesCommand)));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Delegate_type_activator_can_initialize_a_command_using_a_custom_function()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var activator = new DelegateTypeActivator(_ =>
|
||||||
|
new WithDependenciesCommand(new DependencyA(), new DependencyB()));
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var obj = activator.CreateInstance(typeof(WithDependenciesCommand));
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
obj.Should().BeOfType<WithDependenciesCommand>();
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Delegate_type_activator_throws_if_the_underlying_function_returns_null()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var activator = new DelegateTypeActivator(_ => null);
|
||||||
|
|
||||||
|
// Act & assert
|
||||||
|
Assert.Throws<CliFxException>(() =>
|
||||||
|
activator.CreateInstance(typeof(WithDependenciesCommand)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
14
CliFx.Tests/DirectivesSpecs.Commands.cs
Normal file
14
CliFx.Tests/DirectivesSpecs.Commands.cs
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class DirectivesSpecs
|
||||||
|
{
|
||||||
|
[Command("cmd")]
|
||||||
|
private class NamedCommand : ICommand
|
||||||
|
{
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
36
CliFx.Tests/DirectivesSpecs.cs
Normal file
36
CliFx.Tests/DirectivesSpecs.cs
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.IO;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class DirectivesSpecs
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public async Task Preview_directive_can_be_enabled_to_print_provided_arguments_as_they_were_parsed()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(NamedCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.AllowPreviewMode()
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var exitCode = await application.RunAsync(
|
||||||
|
new[] {"[preview]", "cmd", "param", "-abc", "--option", "foo"},
|
||||||
|
new Dictionary<string, string>());
|
||||||
|
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().Be(0);
|
||||||
|
stdOutData.Should().ContainAll("cmd", "<param>", "[-a]", "[-b]", "[-c]", "[--option foo]");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using CliWrap;
|
|
||||||
using FluentAssertions;
|
|
||||||
using NUnit.Framework;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
[TestFixture]
|
|
||||||
public class DummyTests
|
|
||||||
{
|
|
||||||
private static string DummyFilePath => typeof(Dummy.Program).Assembly.Location;
|
|
||||||
|
|
||||||
private static string DummyVersionText => typeof(Dummy.Program).Assembly.GetName().Version.ToString();
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCase("", "Hello world")]
|
|
||||||
[TestCase("-t .NET", "Hello .NET")]
|
|
||||||
[TestCase("-e", "Hello world!")]
|
|
||||||
[TestCase("sum -v 1 2", "3")]
|
|
||||||
[TestCase("sum -v 2.75 3.6 4.18", "10.53")]
|
|
||||||
[TestCase("sum -v 4 -v 16", "20")]
|
|
||||||
[TestCase("sum --values 2 5 --values 3", "10")]
|
|
||||||
[TestCase("log -v 100", "2")]
|
|
||||||
[TestCase("log --value 256 --base 2", "8")]
|
|
||||||
public async Task CliApplication_RunAsync_Test(string arguments, string expectedOutput)
|
|
||||||
{
|
|
||||||
// Arrange & Act
|
|
||||||
var result = await Cli.Wrap(DummyFilePath)
|
|
||||||
.SetArguments(arguments)
|
|
||||||
.EnableExitCodeValidation()
|
|
||||||
.EnableStandardErrorValidation()
|
|
||||||
.ExecuteAsync();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
result.StandardOutput.Trim().Should().Be(expectedOutput);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCase("--version")]
|
|
||||||
public async Task CliApplication_RunAsync_ShowVersion_Test(string arguments)
|
|
||||||
{
|
|
||||||
// Arrange & Act
|
|
||||||
var result = await Cli.Wrap(DummyFilePath)
|
|
||||||
.SetArguments(arguments)
|
|
||||||
.EnableExitCodeValidation()
|
|
||||||
.EnableStandardErrorValidation()
|
|
||||||
.ExecuteAsync();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
result.StandardOutput.Trim().Should().Be(DummyVersionText);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCase("--help")]
|
|
||||||
[TestCase("-h")]
|
|
||||||
[TestCase("sum -h")]
|
|
||||||
[TestCase("sum --help")]
|
|
||||||
[TestCase("log -h")]
|
|
||||||
[TestCase("log --help")]
|
|
||||||
public async Task CliApplication_RunAsync_ShowHelp_Test(string arguments)
|
|
||||||
{
|
|
||||||
// Arrange & Act
|
|
||||||
var result = await Cli.Wrap(DummyFilePath)
|
|
||||||
.SetArguments(arguments)
|
|
||||||
.EnableExitCodeValidation()
|
|
||||||
.EnableStandardErrorValidation()
|
|
||||||
.ExecuteAsync();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
result.StandardOutput.Trim().Should().NotBeNullOrWhiteSpace();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
27
CliFx.Tests/EnvironmentVariablesSpecs.Commands.cs
Normal file
27
CliFx.Tests/EnvironmentVariablesSpecs.Commands.cs
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class EnvironmentVariablesSpecs
|
||||||
|
{
|
||||||
|
[Command]
|
||||||
|
private class EnvironmentVariableCollectionCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("opt", EnvironmentVariableName = "ENV_OPT")]
|
||||||
|
public IReadOnlyList<string>? Option { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command]
|
||||||
|
private class EnvironmentVariableCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("opt", EnvironmentVariableName = "ENV_OPT")]
|
||||||
|
public string? Option { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
96
CliFx.Tests/EnvironmentVariablesSpecs.cs
Normal file
96
CliFx.Tests/EnvironmentVariablesSpecs.cs
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.IO;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Domain;
|
||||||
|
using CliWrap;
|
||||||
|
using CliWrap.Buffered;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class EnvironmentVariablesSpecs
|
||||||
|
{
|
||||||
|
// This test uses a real application to make sure environment variables are actually read correctly
|
||||||
|
[Fact]
|
||||||
|
public async Task Option_can_use_a_specific_environment_variable_as_fallback()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var command = Cli.Wrap("dotnet")
|
||||||
|
.WithArguments(a => a
|
||||||
|
.Add(Dummy.Program.Location))
|
||||||
|
.WithEnvironmentVariables(e => e
|
||||||
|
.Set("ENV_TARGET", "Mars"));
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var stdOut = await command.ExecuteBufferedAsync().Select(r => r.StandardOutput);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOut.TrimEnd().Should().Be("Hello Mars!");
|
||||||
|
}
|
||||||
|
|
||||||
|
// This test uses a real application to make sure environment variables are actually read correctly
|
||||||
|
[Fact]
|
||||||
|
public async Task Option_only_uses_environment_variable_as_fallback_if_the_value_was_not_directly_provided()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var command = Cli.Wrap("dotnet")
|
||||||
|
.WithArguments(a => a
|
||||||
|
.Add(Dummy.Program.Location)
|
||||||
|
.Add("--target")
|
||||||
|
.Add("Jupiter"))
|
||||||
|
.WithEnvironmentVariables(e => e
|
||||||
|
.Set("ENV_TARGET", "Mars"));
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var stdOut = await command.ExecuteBufferedAsync().Select(r => r.StandardOutput);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOut.TrimEnd().Should().Be("Hello Jupiter!");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Option_of_non_scalar_type_can_take_multiple_separated_values_from_an_environment_variable()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var schema = ApplicationSchema.Resolve(new[] {typeof(EnvironmentVariableCollectionCommand)});
|
||||||
|
|
||||||
|
var input = CommandLineInput.Empty;
|
||||||
|
var envVars = new Dictionary<string, string>
|
||||||
|
{
|
||||||
|
["ENV_OPT"] = $"foo{Path.PathSeparator}bar"
|
||||||
|
};
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var command = schema.InitializeEntryPoint(input, envVars);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
command.Should().BeEquivalentTo(new EnvironmentVariableCollectionCommand
|
||||||
|
{
|
||||||
|
Option = new[] {"foo", "bar"}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Option_of_scalar_type_can_only_take_a_single_value_from_an_environment_variable_even_if_it_contains_separators()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var schema = ApplicationSchema.Resolve(new[] {typeof(EnvironmentVariableCommand)});
|
||||||
|
|
||||||
|
var input = CommandLineInput.Empty;
|
||||||
|
var envVars = new Dictionary<string, string>
|
||||||
|
{
|
||||||
|
["ENV_OPT"] = $"foo{Path.PathSeparator}bar"
|
||||||
|
};
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var command = schema.InitializeEntryPoint(input, envVars);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
command.Should().BeEquivalentTo(new EnvironmentVariableCommand
|
||||||
|
{
|
||||||
|
Option = $"foo{Path.PathSeparator}bar"
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
31
CliFx.Tests/ErrorReportingSpecs.Commands.cs
Normal file
31
CliFx.Tests/ErrorReportingSpecs.Commands.cs
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
using System;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
using CliFx.Exceptions;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class ErrorReportingSpecs
|
||||||
|
{
|
||||||
|
[Command("exc")]
|
||||||
|
private class GenericExceptionCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("msg", 'm')]
|
||||||
|
public string? Message { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => throw new Exception(Message);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("exc")]
|
||||||
|
private class CommandExceptionCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("code", 'c')]
|
||||||
|
public int ExitCode { get; set; } = 1337;
|
||||||
|
|
||||||
|
[CommandOption("msg", 'm')]
|
||||||
|
public string? Message { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => throw new CommandException(Message, ExitCode);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
84
CliFx.Tests/ErrorReportingSpecs.cs
Normal file
84
CliFx.Tests/ErrorReportingSpecs.cs
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.IO;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class ErrorReportingSpecs
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public async Task Command_may_throw_a_generic_exception_which_exits_and_prints_full_error_details()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdErr = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(error: stdErr);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(GenericExceptionCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var exitCode = await application.RunAsync(
|
||||||
|
new[] {"exc", "-m", "Kaput"},
|
||||||
|
new Dictionary<string, string>());
|
||||||
|
|
||||||
|
var stdErrData = console.Error.Encoding.GetString(stdErr.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().NotBe(0);
|
||||||
|
stdErrData.Should().Contain("Kaput");
|
||||||
|
stdErrData.Length.Should().BeGreaterThan("Kaput".Length);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Command_may_throw_a_specialized_exception_which_exits_with_custom_code_and_prints_minimal_error_details()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdErr = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(error: stdErr);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(CommandExceptionCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var exitCode = await application.RunAsync(
|
||||||
|
new[] {"exc", "-m", "Kaput", "-c", "69"},
|
||||||
|
new Dictionary<string, string>());
|
||||||
|
|
||||||
|
var stdErrData = console.Error.Encoding.GetString(stdErr.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().Be(69);
|
||||||
|
stdErrData.Should().Be("Kaput");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Command_may_throw_a_specialized_exception_without_error_message_which_exits_and_prints_full_error_details()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdErr = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(error: stdErr);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(CommandExceptionCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var exitCode = await application.RunAsync(
|
||||||
|
new[] {"exc", "-m", "Kaput"},
|
||||||
|
new Dictionary<string, string>());
|
||||||
|
|
||||||
|
var stdErrData = console.Error.Encoding.GetString(stdErr.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().NotBe(0);
|
||||||
|
stdErrData.Should().NotBeEmpty();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
public partial class HelpTextRendererTests
|
|
||||||
{
|
|
||||||
[Command(Description = "DefaultCommand description.")]
|
|
||||||
private class DefaultCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("option-a", 'a', Description = "OptionA description.")]
|
|
||||||
public string OptionA { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("option-b", 'b', Description = "OptionB description.")]
|
|
||||||
public string OptionB { get; set; }
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
|
|
||||||
[Command("cmd", Description = "NamedCommand description.")]
|
|
||||||
private class NamedCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("option-c", 'c', Description = "OptionC description.")]
|
|
||||||
public string OptionC { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("option-d", 'd', Description = "OptionD description.")]
|
|
||||||
public string OptionD { get; set; }
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
|
|
||||||
[Command("cmd sub", Description = "NamedSubCommand description.")]
|
|
||||||
private class NamedSubCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("option-e", 'e', Description = "OptionE description.")]
|
|
||||||
public string OptionE { get; set; }
|
|
||||||
|
|
||||||
public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,105 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.IO;
|
|
||||||
using System.Linq;
|
|
||||||
using CliFx.Models;
|
|
||||||
using CliFx.Services;
|
|
||||||
using FluentAssertions;
|
|
||||||
using NUnit.Framework;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
[TestFixture]
|
|
||||||
public partial class HelpTextRendererTests
|
|
||||||
{
|
|
||||||
private static HelpTextSource CreateHelpTextSource(IReadOnlyList<Type> availableCommandTypes, Type targetCommandType)
|
|
||||||
{
|
|
||||||
var commandSchemaResolver = new CommandSchemaResolver();
|
|
||||||
|
|
||||||
var applicationMetadata = new ApplicationMetadata("TestApp", "testapp", "1.0", null);
|
|
||||||
var availableCommandSchemas = commandSchemaResolver.GetCommandSchemas(availableCommandTypes);
|
|
||||||
var targetCommandSchema = availableCommandSchemas.Single(s => s.Type == targetCommandType);
|
|
||||||
|
|
||||||
return new HelpTextSource(applicationMetadata, availableCommandSchemas, targetCommandSchema);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static IEnumerable<TestCaseData> GetTestCases_RenderHelpText()
|
|
||||||
{
|
|
||||||
yield return new TestCaseData(
|
|
||||||
CreateHelpTextSource(
|
|
||||||
new[] {typeof(DefaultCommand), typeof(NamedCommand), typeof(NamedSubCommand)},
|
|
||||||
typeof(DefaultCommand)),
|
|
||||||
|
|
||||||
new[]
|
|
||||||
{
|
|
||||||
"Usage",
|
|
||||||
"[command]", "[options]",
|
|
||||||
"Options",
|
|
||||||
"-a|--option-a", "OptionA description.",
|
|
||||||
"-b|--option-b", "OptionB description.",
|
|
||||||
"-h|--help", "Shows help text.",
|
|
||||||
"--version", "Shows version information.",
|
|
||||||
"Commands",
|
|
||||||
"cmd", "NamedCommand description.",
|
|
||||||
"You can run", "to show help on a specific command."
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
CreateHelpTextSource(
|
|
||||||
new[] {typeof(DefaultCommand), typeof(NamedCommand), typeof(NamedSubCommand)},
|
|
||||||
typeof(NamedCommand)),
|
|
||||||
|
|
||||||
new[]
|
|
||||||
{
|
|
||||||
"Description",
|
|
||||||
"NamedCommand description.",
|
|
||||||
"Usage",
|
|
||||||
"cmd", "[command]", "[options]",
|
|
||||||
"Options",
|
|
||||||
"-c|--option-c", "OptionC description.",
|
|
||||||
"-d|--option-d", "OptionD description.",
|
|
||||||
"-h|--help", "Shows help text.",
|
|
||||||
"Commands",
|
|
||||||
"sub", "NamedSubCommand description.",
|
|
||||||
"You can run", "to show help on a specific command."
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
yield return new TestCaseData(
|
|
||||||
CreateHelpTextSource(
|
|
||||||
new[] {typeof(DefaultCommand), typeof(NamedCommand), typeof(NamedSubCommand)},
|
|
||||||
typeof(NamedSubCommand)),
|
|
||||||
|
|
||||||
new[]
|
|
||||||
{
|
|
||||||
"Description",
|
|
||||||
"NamedSubCommand description.",
|
|
||||||
"Usage",
|
|
||||||
"cmd sub", "[options]",
|
|
||||||
"Options",
|
|
||||||
"-e|--option-e", "OptionE description.",
|
|
||||||
"-h|--help", "Shows help text."
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
[TestCaseSource(nameof(GetTestCases_RenderHelpText))]
|
|
||||||
public void RenderHelpText_Test(HelpTextSource source, IReadOnlyList<string> expectedSubstrings)
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
using (var stdout = new StringWriter())
|
|
||||||
{
|
|
||||||
var renderer = new HelpTextRenderer();
|
|
||||||
var console = new VirtualConsole(stdout);
|
|
||||||
|
|
||||||
// Act
|
|
||||||
renderer.RenderHelpText(console, source);
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
stdout.ToString().Should().ContainAll(expectedSubstrings);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
96
CliFx.Tests/HelpTextSpecs.Commands.cs
Normal file
96
CliFx.Tests/HelpTextSpecs.Commands.cs
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class HelpTextSpecs
|
||||||
|
{
|
||||||
|
[Command(Description = "DefaultCommand description.")]
|
||||||
|
private class DefaultCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("option-a", 'a', Description = "OptionA description.")]
|
||||||
|
public string? OptionA { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("option-b", 'b', Description = "OptionB description.")]
|
||||||
|
public string? OptionB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("cmd", Description = "NamedCommand description.")]
|
||||||
|
private class NamedCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandParameter(0, Name = "param-a", Description = "ParameterA description.")]
|
||||||
|
public string? ParameterA { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("option-c", 'c', Description = "OptionC description.")]
|
||||||
|
public string? OptionC { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("option-d", 'd', Description = "OptionD description.")]
|
||||||
|
public string? OptionD { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("cmd sub", Description = "NamedSubCommand description.")]
|
||||||
|
private class NamedSubCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandParameter(0, Name = "param-b", Description = "ParameterB description.")]
|
||||||
|
public string? ParameterB { get; set; }
|
||||||
|
|
||||||
|
[CommandParameter(1, Name = "param-c", Description = "ParameterC description.")]
|
||||||
|
public string? ParameterC { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("option-e", 'e', Description = "OptionE description.")]
|
||||||
|
public string? OptionE { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("cmd-with-params")]
|
||||||
|
private class ParametersCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandParameter(0, Name = "first")]
|
||||||
|
public string? ParameterA { get; set; }
|
||||||
|
|
||||||
|
[CommandParameter(10)]
|
||||||
|
public int? ParameterB { get; set; }
|
||||||
|
|
||||||
|
[CommandParameter(20, Description = "A list of numbers", Name = "third list")]
|
||||||
|
public IEnumerable<int>? ParameterC { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("option", 'o')]
|
||||||
|
public string? Option { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("cmd-with-req-opts")]
|
||||||
|
private class RequiredOptionsCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("option-f", 'f', IsRequired = true)]
|
||||||
|
public string? OptionF { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("option-g", 'g', IsRequired = true)]
|
||||||
|
public IEnumerable<int>? OptionG { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("option-h", 'h')]
|
||||||
|
public string? OptionH { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("cmd-with-env-vars")]
|
||||||
|
private class EnvironmentVariableCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("option-a", 'a', IsRequired = true, EnvironmentVariableName = "ENV_OPT_A")]
|
||||||
|
public string? OptionA { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("option-b", 'b', EnvironmentVariableName = "ENV_OPT_B")]
|
||||||
|
public string? OptionB { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
246
CliFx.Tests/HelpTextSpecs.cs
Normal file
246
CliFx.Tests/HelpTextSpecs.cs
Normal file
@@ -0,0 +1,246 @@
|
|||||||
|
using System.IO;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class HelpTextSpecs
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public async Task Version_information_can_be_requested_by_providing_the_version_option_without_other_arguments()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(DefaultCommand))
|
||||||
|
.AddCommand(typeof(NamedCommand))
|
||||||
|
.AddCommand(typeof(NamedSubCommand))
|
||||||
|
.UseVersionText("v6.9")
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var exitCode = await application.RunAsync(new[] {"--version"});
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().Be(0);
|
||||||
|
stdOutData.Should().Be("v6.9");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Help_text_can_be_requested_by_providing_the_help_option()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(DefaultCommand))
|
||||||
|
.AddCommand(typeof(NamedCommand))
|
||||||
|
.AddCommand(typeof(NamedSubCommand))
|
||||||
|
.UseTitle("AppTitle")
|
||||||
|
.UseVersionText("AppVer")
|
||||||
|
.UseDescription("AppDesc")
|
||||||
|
.UseExecutableName("AppExe")
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
await application.RunAsync(new[] {"--help"});
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOutData.Should().ContainAll(
|
||||||
|
"AppTitle", "AppVer",
|
||||||
|
"AppDesc",
|
||||||
|
"Usage",
|
||||||
|
"AppExe", "[command]", "[options]",
|
||||||
|
"Options",
|
||||||
|
"-a|--option-a", "OptionA description.",
|
||||||
|
"-b|--option-b", "OptionB description.",
|
||||||
|
"-h|--help", "Shows help text.",
|
||||||
|
"--version", "Shows version information.",
|
||||||
|
"Commands",
|
||||||
|
"cmd", "NamedCommand description.",
|
||||||
|
"You can run", "to show help on a specific command."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Help_text_can_be_requested_on_a_specific_named_command()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(DefaultCommand))
|
||||||
|
.AddCommand(typeof(NamedCommand))
|
||||||
|
.AddCommand(typeof(NamedSubCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
await application.RunAsync(new[] {"cmd", "--help"});
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOutData.Should().ContainAll(
|
||||||
|
"Description",
|
||||||
|
"NamedCommand description.",
|
||||||
|
"Usage",
|
||||||
|
"cmd", "[command]", "<param-a>", "[options]",
|
||||||
|
"Parameters",
|
||||||
|
"* param-a", "ParameterA description.",
|
||||||
|
"Options",
|
||||||
|
"-c|--option-c", "OptionC description.",
|
||||||
|
"-d|--option-d", "OptionD description.",
|
||||||
|
"-h|--help", "Shows help text.",
|
||||||
|
"Commands",
|
||||||
|
"sub", "SubCommand description.",
|
||||||
|
"You can run", "to show help on a specific command."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Help_text_can_be_requested_on_a_specific_named_sub_command()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(DefaultCommand))
|
||||||
|
.AddCommand(typeof(NamedCommand))
|
||||||
|
.AddCommand(typeof(NamedSubCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
await application.RunAsync(new[] {"cmd", "sub", "--help"});
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOutData.Should().ContainAll(
|
||||||
|
"Description",
|
||||||
|
"SubCommand description.",
|
||||||
|
"Usage",
|
||||||
|
"cmd sub", "<param-b>", "<param-c>", "[options]",
|
||||||
|
"Parameters",
|
||||||
|
"* param-b", "ParameterB description.",
|
||||||
|
"* param-c", "ParameterC description.",
|
||||||
|
"Options",
|
||||||
|
"-e|--option-e", "OptionE description.",
|
||||||
|
"-h|--help", "Shows help text."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Help_text_can_be_requested_without_specifying_command_even_if_default_command_is_not_defined()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(NamedCommand))
|
||||||
|
.AddCommand(typeof(NamedSubCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
await application.RunAsync(new[] {"--help"});
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOutData.Should().ContainAll(
|
||||||
|
"Usage",
|
||||||
|
"[command]",
|
||||||
|
"Options",
|
||||||
|
"-h|--help", "Shows help text.",
|
||||||
|
"--version", "Shows version information.",
|
||||||
|
"Commands",
|
||||||
|
"cmd", "NamedCommand description.",
|
||||||
|
"You can run", "to show help on a specific command."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Help_text_shows_usage_format_which_lists_all_parameters()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(ParametersCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
await application.RunAsync(new[] {"cmd-with-params", "--help"});
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOutData.Should().ContainAll(
|
||||||
|
"Usage",
|
||||||
|
"cmd-with-params", "<first>", "<parameterb>", "<third list...>", "[options]"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Help_text_shows_usage_format_which_lists_all_required_options()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(RequiredOptionsCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
await application.RunAsync(new[] {"cmd-with-req-opts", "--help"});
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOutData.Should().ContainAll(
|
||||||
|
"Usage",
|
||||||
|
"cmd-with-req-opts", "--option-f <value>", "--option-g <values...>", "[options]",
|
||||||
|
"Options",
|
||||||
|
"* -f|--option-f",
|
||||||
|
"* -g|--option-g",
|
||||||
|
"-h|--option-h"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Help_text_lists_environment_variable_names_for_options_that_have_them_defined()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(EnvironmentVariableCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
await application.RunAsync(new[] {"cmd-with-env-vars", "--help"});
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOutData.Should().ContainAll(
|
||||||
|
"Options",
|
||||||
|
"* -a|--option-a", "Environment variable:", "ENV_OPT_A",
|
||||||
|
"-b|--option-b", "Environment variable:", "ENV_OPT_B"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
51
CliFx.Tests/RoutingSpecs.Commands.cs
Normal file
51
CliFx.Tests/RoutingSpecs.Commands.cs
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class RoutingSpecs
|
||||||
|
{
|
||||||
|
[Command]
|
||||||
|
private class DefaultCommand : ICommand
|
||||||
|
{
|
||||||
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
|
{
|
||||||
|
console.Output.WriteLine("Hello world!");
|
||||||
|
return default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("concat", Description = "Concatenate strings.")]
|
||||||
|
private class ConcatCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption('i', IsRequired = true, Description = "Input strings.")]
|
||||||
|
public IReadOnlyList<string> Inputs { get; set; }
|
||||||
|
|
||||||
|
[CommandOption('s', Description = "String separator.")]
|
||||||
|
public string Separator { get; set; } = "";
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
|
{
|
||||||
|
console.Output.WriteLine(string.Join(Separator, Inputs));
|
||||||
|
return default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
[Command("div", Description = "Divide one number by another.")]
|
||||||
|
private class DivideCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("dividend", 'D', IsRequired = true, Description = "The number to divide.")]
|
||||||
|
public double Dividend { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("divisor", 'd', IsRequired = true, Description = "The number to divide by.")]
|
||||||
|
public double Divisor { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
|
{
|
||||||
|
console.Output.WriteLine(Dividend / Divisor);
|
||||||
|
return default;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
90
CliFx.Tests/RoutingSpecs.cs
Normal file
90
CliFx.Tests/RoutingSpecs.cs
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.IO;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public partial class RoutingSpecs
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public async Task Default_command_is_executed_if_provided_arguments_do_not_match_any_named_command()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(DefaultCommand))
|
||||||
|
.AddCommand(typeof(ConcatCommand))
|
||||||
|
.AddCommand(typeof(DivideCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var exitCode = await application.RunAsync(
|
||||||
|
Array.Empty<string>(),
|
||||||
|
new Dictionary<string, string>());
|
||||||
|
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().Be(0);
|
||||||
|
stdOutData.Should().Be("Hello world!");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Help_text_is_printed_if_no_arguments_were_provided_and_default_command_is_not_defined()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(ConcatCommand))
|
||||||
|
.AddCommand(typeof(DivideCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.UseDescription("This will be visible in help")
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var exitCode = await application.RunAsync(
|
||||||
|
Array.Empty<string>(),
|
||||||
|
new Dictionary<string, string>());
|
||||||
|
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().Be(0);
|
||||||
|
stdOutData.Should().Contain("This will be visible in help");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task Specific_named_command_is_executed_if_provided_arguments_match_its_name()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
await using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(DefaultCommand))
|
||||||
|
.AddCommand(typeof(ConcatCommand))
|
||||||
|
.AddCommand(typeof(DivideCommand))
|
||||||
|
.UseConsole(console)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var exitCode = await application.RunAsync(
|
||||||
|
new[] {"concat", "-i", "foo", "bar", "-s", ", "},
|
||||||
|
new Dictionary<string, string>());
|
||||||
|
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray()).TrimEnd();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().Be(0);
|
||||||
|
stdOutData.Should().Be("foo, bar");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
54
CliFx.Tests/UtilitiesSpecs.cs
Normal file
54
CliFx.Tests/UtilitiesSpecs.cs
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
using System.IO;
|
||||||
|
using System.Linq;
|
||||||
|
using CliFx.Utilities;
|
||||||
|
using FluentAssertions;
|
||||||
|
using Xunit;
|
||||||
|
|
||||||
|
namespace CliFx.Tests
|
||||||
|
{
|
||||||
|
public class UtilitiesSpecs
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public void Progress_ticker_can_be_used_to_report_progress_to_console()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut, isOutputRedirected: false);
|
||||||
|
|
||||||
|
var ticker = console.CreateProgressTicker();
|
||||||
|
|
||||||
|
var progressValues = Enumerable.Range(0, 100).Select(p => p / 100.0).ToArray();
|
||||||
|
var progressStringValues = progressValues.Select(p => p.ToString("P2")).ToArray();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
foreach (var progress in progressValues)
|
||||||
|
ticker.Report(progress);
|
||||||
|
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray());
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOutData.Should().ContainAll(progressStringValues);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Progress_ticker_does_not_write_to_console_if_output_is_redirected()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
using var stdOut = new MemoryStream();
|
||||||
|
var console = new VirtualConsole(output: stdOut);
|
||||||
|
|
||||||
|
var ticker = console.CreateProgressTicker();
|
||||||
|
|
||||||
|
var progressValues = Enumerable.Range(0, 100).Select(p => p / 100.0).ToArray();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
foreach (var progress in progressValues)
|
||||||
|
ticker.Report(progress);
|
||||||
|
|
||||||
|
var stdOutData = console.Output.Encoding.GetString(stdOut.ToArray());
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
stdOutData.Should().BeEmpty();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
5
CliFx.Tests/xunit.runner.json
Normal file
5
CliFx.Tests/xunit.runner.json
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://xunit.net/schema/current/xunit.runner.schema.json",
|
||||||
|
"methodDisplayOptions": "all",
|
||||||
|
"methodDisplay": "method"
|
||||||
|
}
|
||||||
11
CliFx.props
Normal file
11
CliFx.props
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
<Project>
|
||||||
|
|
||||||
|
<PropertyGroup>
|
||||||
|
<Version>1.1</Version>
|
||||||
|
<Company>Tyrrrz</Company>
|
||||||
|
<Copyright>Copyright (C) Alexey Golub</Copyright>
|
||||||
|
<LangVersion>latest</LangVersion>
|
||||||
|
<Nullable>enable</Nullable>
|
||||||
|
</PropertyGroup>
|
||||||
|
|
||||||
|
</Project>
|
||||||
31
CliFx.sln
31
CliFx.sln
@@ -7,18 +7,19 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CliFx", "CliFx\CliFx.csproj
|
|||||||
EndProject
|
EndProject
|
||||||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CliFx.Tests", "CliFx.Tests\CliFx.Tests.csproj", "{268CF863-65A5-49BB-93CF-08972B7756DC}"
|
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CliFx.Tests", "CliFx.Tests\CliFx.Tests.csproj", "{268CF863-65A5-49BB-93CF-08972B7756DC}"
|
||||||
EndProject
|
EndProject
|
||||||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CliFx.Tests.Dummy", "CliFx.Tests.Dummy\CliFx.Tests.Dummy.csproj", "{4904B3EB-3286-4F1B-8B74-6FF051C8E787}"
|
|
||||||
EndProject
|
|
||||||
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{3AAE8166-BB8E-49DA-844C-3A0EE6BD40A0}"
|
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{3AAE8166-BB8E-49DA-844C-3A0EE6BD40A0}"
|
||||||
ProjectSection(SolutionItems) = preProject
|
ProjectSection(SolutionItems) = preProject
|
||||||
Changelog.md = Changelog.md
|
Changelog.md = Changelog.md
|
||||||
License.txt = License.txt
|
License.txt = License.txt
|
||||||
Readme.md = Readme.md
|
Readme.md = Readme.md
|
||||||
|
CliFx.props = CliFx.props
|
||||||
EndProjectSection
|
EndProjectSection
|
||||||
EndProject
|
EndProject
|
||||||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CliFx.Benchmarks", "CliFx.Benchmarks\CliFx.Benchmarks.csproj", "{8ACD6DC2-D768-4850-9223-5B7C83A78513}"
|
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CliFx.Benchmarks", "CliFx.Benchmarks\CliFx.Benchmarks.csproj", "{8ACD6DC2-D768-4850-9223-5B7C83A78513}"
|
||||||
EndProject
|
EndProject
|
||||||
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CliFx.Demo", "CliFx.Demo\CliFx.Demo.csproj", "{AAB6844C-BF71-448F-A11B-89AEE459AB15}"
|
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CliFx.Demo", "CliFx.Demo\CliFx.Demo.csproj", "{AAB6844C-BF71-448F-A11B-89AEE459AB15}"
|
||||||
|
EndProject
|
||||||
|
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CliFx.Tests.Dummy", "CliFx.Tests.Dummy\CliFx.Tests.Dummy.csproj", "{F717347D-8656-44DA-A4A2-BE515E8C4655}"
|
||||||
EndProject
|
EndProject
|
||||||
Global
|
Global
|
||||||
GlobalSection(SolutionConfigurationPlatforms) = preSolution
|
GlobalSection(SolutionConfigurationPlatforms) = preSolution
|
||||||
@@ -54,18 +55,6 @@ Global
|
|||||||
{268CF863-65A5-49BB-93CF-08972B7756DC}.Release|x64.Build.0 = Release|Any CPU
|
{268CF863-65A5-49BB-93CF-08972B7756DC}.Release|x64.Build.0 = Release|Any CPU
|
||||||
{268CF863-65A5-49BB-93CF-08972B7756DC}.Release|x86.ActiveCfg = Release|Any CPU
|
{268CF863-65A5-49BB-93CF-08972B7756DC}.Release|x86.ActiveCfg = Release|Any CPU
|
||||||
{268CF863-65A5-49BB-93CF-08972B7756DC}.Release|x86.Build.0 = Release|Any CPU
|
{268CF863-65A5-49BB-93CF-08972B7756DC}.Release|x86.Build.0 = Release|Any CPU
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Debug|x64.ActiveCfg = Debug|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Debug|x64.Build.0 = Debug|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Debug|x86.ActiveCfg = Debug|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Debug|x86.Build.0 = Debug|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Release|Any CPU.Build.0 = Release|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Release|x64.ActiveCfg = Release|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Release|x64.Build.0 = Release|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Release|x86.ActiveCfg = Release|Any CPU
|
|
||||||
{4904B3EB-3286-4F1B-8B74-6FF051C8E787}.Release|x86.Build.0 = Release|Any CPU
|
|
||||||
{8ACD6DC2-D768-4850-9223-5B7C83A78513}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
{8ACD6DC2-D768-4850-9223-5B7C83A78513}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||||
{8ACD6DC2-D768-4850-9223-5B7C83A78513}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
{8ACD6DC2-D768-4850-9223-5B7C83A78513}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||||
{8ACD6DC2-D768-4850-9223-5B7C83A78513}.Debug|x64.ActiveCfg = Debug|Any CPU
|
{8ACD6DC2-D768-4850-9223-5B7C83A78513}.Debug|x64.ActiveCfg = Debug|Any CPU
|
||||||
@@ -90,6 +79,18 @@ Global
|
|||||||
{AAB6844C-BF71-448F-A11B-89AEE459AB15}.Release|x64.Build.0 = Release|Any CPU
|
{AAB6844C-BF71-448F-A11B-89AEE459AB15}.Release|x64.Build.0 = Release|Any CPU
|
||||||
{AAB6844C-BF71-448F-A11B-89AEE459AB15}.Release|x86.ActiveCfg = Release|Any CPU
|
{AAB6844C-BF71-448F-A11B-89AEE459AB15}.Release|x86.ActiveCfg = Release|Any CPU
|
||||||
{AAB6844C-BF71-448F-A11B-89AEE459AB15}.Release|x86.Build.0 = Release|Any CPU
|
{AAB6844C-BF71-448F-A11B-89AEE459AB15}.Release|x86.Build.0 = Release|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Debug|x64.ActiveCfg = Debug|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Debug|x64.Build.0 = Debug|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Debug|x86.ActiveCfg = Debug|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Debug|x86.Build.0 = Debug|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Release|x64.ActiveCfg = Release|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Release|x64.Build.0 = Release|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Release|x86.ActiveCfg = Release|Any CPU
|
||||||
|
{F717347D-8656-44DA-A4A2-BE515E8C4655}.Release|x86.Build.0 = Release|Any CPU
|
||||||
EndGlobalSection
|
EndGlobalSection
|
||||||
GlobalSection(SolutionProperties) = preSolution
|
GlobalSection(SolutionProperties) = preSolution
|
||||||
HideSolutionNode = FALSE
|
HideSolutionNode = FALSE
|
||||||
|
|||||||
38
CliFx/ApplicationConfiguration.cs
Normal file
38
CliFx/ApplicationConfiguration.cs
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
|
||||||
|
namespace CliFx
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Configuration of an application.
|
||||||
|
/// </summary>
|
||||||
|
public class ApplicationConfiguration
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Command types defined in this application.
|
||||||
|
/// </summary>
|
||||||
|
public IReadOnlyList<Type> CommandTypes { get; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Whether debug mode is allowed in this application.
|
||||||
|
/// </summary>
|
||||||
|
public bool IsDebugModeAllowed { get; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Whether preview mode is allowed in this application.
|
||||||
|
/// </summary>
|
||||||
|
public bool IsPreviewModeAllowed { get; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Initializes an instance of <see cref="ApplicationConfiguration"/>.
|
||||||
|
/// </summary>
|
||||||
|
public ApplicationConfiguration(
|
||||||
|
IReadOnlyList<Type> commandTypes,
|
||||||
|
bool isDebugModeAllowed, bool isPreviewModeAllowed)
|
||||||
|
{
|
||||||
|
CommandTypes = commandTypes;
|
||||||
|
IsDebugModeAllowed = isDebugModeAllowed;
|
||||||
|
IsPreviewModeAllowed = isPreviewModeAllowed;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,4 @@
|
|||||||
using CliFx.Internal;
|
namespace CliFx
|
||||||
|
|
||||||
namespace CliFx.Models
|
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Metadata associated with an application.
|
/// Metadata associated with an application.
|
||||||
@@ -25,17 +23,17 @@ namespace CliFx.Models
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Application description.
|
/// Application description.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string Description { get; }
|
public string? Description { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initializes an instance of <see cref="ApplicationMetadata"/>.
|
/// Initializes an instance of <see cref="ApplicationMetadata"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public ApplicationMetadata(string title, string executableName, string versionText, string description)
|
public ApplicationMetadata(string title, string executableName, string versionText, string? description)
|
||||||
{
|
{
|
||||||
Title = title.GuardNotNull(nameof(title));
|
Title = title;
|
||||||
ExecutableName = executableName.GuardNotNull(nameof(executableName));
|
ExecutableName = executableName;
|
||||||
VersionText = versionText.GuardNotNull(nameof(versionText));
|
VersionText = versionText;
|
||||||
Description = description; // can be null
|
Description = description;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -10,27 +10,29 @@ namespace CliFx.Attributes
|
|||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Command name.
|
/// Command name.
|
||||||
|
/// If the name is not set, the command is treated as a default command, i.e. the one that gets executed when the user
|
||||||
|
/// does not specify a command name in the arguments.
|
||||||
|
/// All commands in an application must have different names. Likewise, only one command without a name is allowed.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string Name { get; }
|
public string? Name { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Command description, which is used in help text.
|
/// Command description, which is used in help text.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string Description { get; set; }
|
public string? Description { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initializes an instance of <see cref="CommandAttribute"/>.
|
/// Initializes an instance of <see cref="CommandAttribute"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public CommandAttribute(string name)
|
public CommandAttribute(string name)
|
||||||
{
|
{
|
||||||
Name = name; // can be null
|
Name = name;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initializes an instance of <see cref="CommandAttribute"/>.
|
/// Initializes an instance of <see cref="CommandAttribute"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public CommandAttribute()
|
public CommandAttribute()
|
||||||
: this(null)
|
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,11 +10,15 @@ namespace CliFx.Attributes
|
|||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Option name.
|
/// Option name.
|
||||||
|
/// Either <see cref="Name"/> or <see cref="ShortName"/> must be set.
|
||||||
|
/// All options in a command must have different names (comparison is not case-sensitive).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string Name { get; }
|
public string? Name { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Option short name.
|
/// Option short name.
|
||||||
|
/// Either <see cref="Name"/> or <see cref="ShortName"/> must be set.
|
||||||
|
/// All options in a command must have different short names (comparison is case-sensitive).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public char? ShortName { get; }
|
public char? ShortName { get; }
|
||||||
|
|
||||||
@@ -26,15 +30,20 @@ namespace CliFx.Attributes
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Option description, which is used in help text.
|
/// Option description, which is used in help text.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string Description { get; set; }
|
public string? Description { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Environment variable that will be used as fallback if no option value is specified.
|
||||||
|
/// </summary>
|
||||||
|
public string? EnvironmentVariableName { get; set; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initializes an instance of <see cref="CommandOptionAttribute"/>.
|
/// Initializes an instance of <see cref="CommandOptionAttribute"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public CommandOptionAttribute(string name, char? shortName)
|
private CommandOptionAttribute(string? name, char? shortName)
|
||||||
{
|
{
|
||||||
Name = name; // can be null
|
Name = name;
|
||||||
ShortName = shortName; // can be null
|
ShortName = shortName;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -57,7 +66,7 @@ namespace CliFx.Attributes
|
|||||||
/// Initializes an instance of <see cref="CommandOptionAttribute"/>.
|
/// Initializes an instance of <see cref="CommandOptionAttribute"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public CommandOptionAttribute(char shortName)
|
public CommandOptionAttribute(char shortName)
|
||||||
: this(null, shortName)
|
: this(null, (char?) shortName)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
37
CliFx/Attributes/CommandParameterAttribute.cs
Normal file
37
CliFx/Attributes/CommandParameterAttribute.cs
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
using System;
|
||||||
|
|
||||||
|
namespace CliFx.Attributes
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Annotates a property that defines a command parameter.
|
||||||
|
/// </summary>
|
||||||
|
[AttributeUsage(AttributeTargets.Property)]
|
||||||
|
public class CommandParameterAttribute : Attribute
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Order of this parameter compared to other parameters.
|
||||||
|
/// All parameters in a command must have different order.
|
||||||
|
/// Parameter whose type is a non-scalar (e.g. array), must be the last in order and only one such parameter is allowed.
|
||||||
|
/// </summary>
|
||||||
|
public int Order { get; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Parameter name, which is only used in help text.
|
||||||
|
/// If this isn't specified, property name is used instead.
|
||||||
|
/// </summary>
|
||||||
|
public string? Name { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Parameter description, which is used in help text.
|
||||||
|
/// </summary>
|
||||||
|
public string? Description { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Initializes an instance of <see cref="CommandParameterAttribute"/>.
|
||||||
|
/// </summary>
|
||||||
|
public CommandParameterAttribute(int order)
|
||||||
|
{
|
||||||
|
Order = order;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,144 +1,209 @@
|
|||||||
using System;
|
using System;
|
||||||
|
using System.Collections;
|
||||||
using System.Collections.Generic;
|
using System.Collections.Generic;
|
||||||
|
using System.Diagnostics;
|
||||||
using System.Linq;
|
using System.Linq;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Domain;
|
||||||
using CliFx.Exceptions;
|
using CliFx.Exceptions;
|
||||||
using CliFx.Internal;
|
|
||||||
using CliFx.Models;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx
|
namespace CliFx
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Default implementation of <see cref="ICliApplication"/>.
|
/// Command line application facade.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class CliApplication : ICliApplication
|
public class CliApplication
|
||||||
{
|
{
|
||||||
private readonly ApplicationMetadata _metadata;
|
private readonly ApplicationMetadata _metadata;
|
||||||
private readonly ApplicationConfiguration _configuration;
|
private readonly ApplicationConfiguration _configuration;
|
||||||
|
|
||||||
private readonly IConsole _console;
|
private readonly IConsole _console;
|
||||||
private readonly ICommandInputParser _commandInputParser;
|
private readonly ITypeActivator _typeActivator;
|
||||||
private readonly ICommandSchemaResolver _commandSchemaResolver;
|
|
||||||
private readonly ICommandFactory _commandFactory;
|
private readonly HelpTextWriter _helpTextWriter;
|
||||||
private readonly ICommandInitializer _commandInitializer;
|
|
||||||
private readonly IHelpTextRenderer _helpTextRenderer;
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initializes an instance of <see cref="CliApplication"/>.
|
/// Initializes an instance of <see cref="CliApplication"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public CliApplication(ApplicationMetadata metadata, ApplicationConfiguration configuration,
|
public CliApplication(
|
||||||
IConsole console, ICommandInputParser commandInputParser, ICommandSchemaResolver commandSchemaResolver,
|
ApplicationMetadata metadata, ApplicationConfiguration configuration,
|
||||||
ICommandFactory commandFactory, ICommandInitializer commandInitializer, IHelpTextRenderer helpTextRenderer)
|
IConsole console, ITypeActivator typeActivator)
|
||||||
{
|
{
|
||||||
_metadata = metadata.GuardNotNull(nameof(metadata));
|
_metadata = metadata;
|
||||||
_configuration = configuration.GuardNotNull(nameof(configuration));
|
_configuration = configuration;
|
||||||
|
_console = console;
|
||||||
|
_typeActivator = typeActivator;
|
||||||
|
|
||||||
_console = console.GuardNotNull(nameof(console));
|
_helpTextWriter = new HelpTextWriter(metadata, console);
|
||||||
_commandInputParser = commandInputParser.GuardNotNull(nameof(commandInputParser));
|
|
||||||
_commandSchemaResolver = commandSchemaResolver.GuardNotNull(nameof(commandSchemaResolver));
|
|
||||||
_commandFactory = commandFactory.GuardNotNull(nameof(commandFactory));
|
|
||||||
_commandInitializer = commandInitializer.GuardNotNull(nameof(commandInitializer));
|
|
||||||
_helpTextRenderer = helpTextRenderer.GuardNotNull(nameof(helpTextRenderer));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
private async ValueTask<int?> HandleDebugDirectiveAsync(CommandLineInput commandLineInput)
|
||||||
public async Task<int> RunAsync(IReadOnlyList<string> commandLineArguments)
|
|
||||||
{
|
{
|
||||||
commandLineArguments.GuardNotNull(nameof(commandLineArguments));
|
var isDebugMode = _configuration.IsDebugModeAllowed && commandLineInput.IsDebugDirectiveSpecified;
|
||||||
|
if (!isDebugMode)
|
||||||
|
return null;
|
||||||
|
|
||||||
|
_console.WithForegroundColor(ConsoleColor.Green, () =>
|
||||||
|
_console.Output.WriteLine($"Attach debugger to PID {Process.GetCurrentProcess().Id} to continue."));
|
||||||
|
|
||||||
|
while (!Debugger.IsAttached)
|
||||||
|
await Task.Delay(100);
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
private int? HandlePreviewDirective(ApplicationSchema applicationSchema, CommandLineInput commandLineInput)
|
||||||
|
{
|
||||||
|
var isPreviewMode = _configuration.IsPreviewModeAllowed && commandLineInput.IsPreviewDirectiveSpecified;
|
||||||
|
if (!isPreviewMode)
|
||||||
|
return null;
|
||||||
|
|
||||||
|
var commandSchema = applicationSchema.TryFindCommand(commandLineInput, out var argumentOffset);
|
||||||
|
|
||||||
|
_console.Output.WriteLine("Parser preview:");
|
||||||
|
|
||||||
|
// Command name
|
||||||
|
if (commandSchema != null && argumentOffset > 0)
|
||||||
|
{
|
||||||
|
_console.WithForegroundColor(ConsoleColor.Cyan, () =>
|
||||||
|
_console.Output.Write(commandSchema.Name));
|
||||||
|
|
||||||
|
_console.Output.Write(' ');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parameters
|
||||||
|
foreach (var parameter in commandLineInput.UnboundArguments.Skip(argumentOffset))
|
||||||
|
{
|
||||||
|
_console.Output.Write('<');
|
||||||
|
|
||||||
|
_console.WithForegroundColor(ConsoleColor.White, () =>
|
||||||
|
_console.Output.Write(parameter));
|
||||||
|
|
||||||
|
_console.Output.Write('>');
|
||||||
|
_console.Output.Write(' ');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Options
|
||||||
|
foreach (var option in commandLineInput.Options)
|
||||||
|
{
|
||||||
|
_console.Output.Write('[');
|
||||||
|
|
||||||
|
_console.WithForegroundColor(ConsoleColor.White, () =>
|
||||||
|
_console.Output.Write(option));
|
||||||
|
|
||||||
|
_console.Output.Write(']');
|
||||||
|
_console.Output.Write(' ');
|
||||||
|
}
|
||||||
|
|
||||||
|
_console.Output.WriteLine();
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
private int? HandleVersionOption(CommandLineInput commandLineInput)
|
||||||
|
{
|
||||||
|
// Version option is available only on the default command (i.e. when arguments are not specified)
|
||||||
|
var shouldRenderVersion = !commandLineInput.UnboundArguments.Any() && commandLineInput.IsVersionOptionSpecified;
|
||||||
|
if (!shouldRenderVersion)
|
||||||
|
return null;
|
||||||
|
|
||||||
|
_console.Output.WriteLine(_metadata.VersionText);
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
private int? HandleHelpOption(ApplicationSchema applicationSchema, CommandLineInput commandLineInput)
|
||||||
|
{
|
||||||
|
// Help is rendered either when it's requested or when the user provides no arguments and there is no default command
|
||||||
|
var shouldRenderHelp =
|
||||||
|
commandLineInput.IsHelpOptionSpecified ||
|
||||||
|
!applicationSchema.Commands.Any(c => c.IsDefault) && !commandLineInput.UnboundArguments.Any() && !commandLineInput.Options.Any();
|
||||||
|
|
||||||
|
if (!shouldRenderHelp)
|
||||||
|
return null;
|
||||||
|
|
||||||
|
// Get the command schema that matches the input or use a dummy default command as a fallback
|
||||||
|
var commandSchema =
|
||||||
|
applicationSchema.TryFindCommand(commandLineInput) ??
|
||||||
|
CommandSchema.StubDefaultCommand;
|
||||||
|
|
||||||
|
_helpTextWriter.Write(applicationSchema, commandSchema);
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
private async ValueTask<int> HandleCommandExecutionAsync(
|
||||||
|
ApplicationSchema applicationSchema,
|
||||||
|
CommandLineInput commandLineInput,
|
||||||
|
IReadOnlyDictionary<string, string> environmentVariables)
|
||||||
|
{
|
||||||
|
await applicationSchema
|
||||||
|
.InitializeEntryPoint(commandLineInput, environmentVariables, _typeActivator)
|
||||||
|
.ExecuteAsync(_console);
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Runs the application with specified command line arguments and environment variables, and returns the exit code.
|
||||||
|
/// </summary>
|
||||||
|
public async ValueTask<int> RunAsync(
|
||||||
|
IReadOnlyList<string> commandLineArguments,
|
||||||
|
IReadOnlyDictionary<string, string> environmentVariables)
|
||||||
|
{
|
||||||
try
|
try
|
||||||
{
|
{
|
||||||
// Get schemas for all available command types
|
var applicationSchema = ApplicationSchema.Resolve(_configuration.CommandTypes);
|
||||||
var availableCommandSchemas = _commandSchemaResolver.GetCommandSchemas(_configuration.CommandTypes);
|
var commandLineInput = CommandLineInput.Parse(commandLineArguments);
|
||||||
|
|
||||||
// Parse command input from arguments
|
return
|
||||||
var commandInput = _commandInputParser.ParseCommandInput(commandLineArguments);
|
await HandleDebugDirectiveAsync(commandLineInput) ??
|
||||||
|
HandlePreviewDirective(applicationSchema, commandLineInput) ??
|
||||||
// Find command schema matching the name specified in the input
|
HandleVersionOption(commandLineInput) ??
|
||||||
var targetCommandSchema = availableCommandSchemas.FindByName(commandInput.CommandName);
|
HandleHelpOption(applicationSchema, commandLineInput) ??
|
||||||
|
await HandleCommandExecutionAsync(applicationSchema, commandLineInput, environmentVariables);
|
||||||
// Handle cases where requested command is not defined
|
|
||||||
if (targetCommandSchema == null)
|
|
||||||
{
|
|
||||||
var isError = false;
|
|
||||||
|
|
||||||
// If specified a command - show error
|
|
||||||
if (commandInput.IsCommandSpecified())
|
|
||||||
{
|
|
||||||
isError = true;
|
|
||||||
|
|
||||||
_console.WithForegroundColor(ConsoleColor.Red,
|
|
||||||
() => _console.Error.WriteLine($"Specified command [{commandInput.CommandName}] is not defined."));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get parent command schema
|
|
||||||
var parentCommandSchema = availableCommandSchemas.FindParent(commandInput.CommandName);
|
|
||||||
|
|
||||||
// Show help for parent command if it's defined
|
|
||||||
if (parentCommandSchema != null)
|
|
||||||
{
|
|
||||||
var helpTextSource = new HelpTextSource(_metadata, availableCommandSchemas, parentCommandSchema);
|
|
||||||
_helpTextRenderer.RenderHelpText(_console, helpTextSource);
|
|
||||||
}
|
|
||||||
// Otherwise show help for a stub default command
|
|
||||||
else
|
|
||||||
{
|
|
||||||
var helpTextSource = new HelpTextSource(_metadata,
|
|
||||||
availableCommandSchemas.Concat(CommandSchema.StubDefaultCommand).ToArray(),
|
|
||||||
CommandSchema.StubDefaultCommand);
|
|
||||||
|
|
||||||
_helpTextRenderer.RenderHelpText(_console, helpTextSource);
|
|
||||||
}
|
|
||||||
|
|
||||||
return isError ? -1 : 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Show version if it was requested without specifying a command
|
|
||||||
if (commandInput.IsVersionRequested() && !commandInput.IsCommandSpecified())
|
|
||||||
{
|
|
||||||
_console.Output.WriteLine(_metadata.VersionText);
|
|
||||||
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Show help if it was requested
|
|
||||||
if (commandInput.IsHelpRequested())
|
|
||||||
{
|
|
||||||
var helpTextSource = new HelpTextSource(_metadata, availableCommandSchemas, targetCommandSchema);
|
|
||||||
_helpTextRenderer.RenderHelpText(_console, helpTextSource);
|
|
||||||
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create an instance of the command
|
|
||||||
var command = _commandFactory.CreateCommand(targetCommandSchema);
|
|
||||||
|
|
||||||
// Populate command with options according to its schema
|
|
||||||
_commandInitializer.InitializeCommand(command, targetCommandSchema, commandInput);
|
|
||||||
|
|
||||||
// Execute command
|
|
||||||
await command.ExecuteAsync(_console);
|
|
||||||
|
|
||||||
return 0;
|
|
||||||
}
|
}
|
||||||
catch (Exception ex)
|
catch (Exception ex)
|
||||||
{
|
{
|
||||||
// We want to catch exceptions in order to print errors and return correct exit codes.
|
// We want to catch exceptions in order to print errors and return correct exit codes.
|
||||||
// Also, by doing this we get rid of the annoying Windows troubleshooting dialog that shows up on unhandled exceptions.
|
// Doing this also gets rid of the annoying Windows troubleshooting dialog that shows up on unhandled exceptions.
|
||||||
|
|
||||||
// In case we catch a CliFx-specific exception, we want to just show the error message, not the stack trace.
|
// Prefer showing message without stack trace on exceptions coming from CliFx or on CommandException
|
||||||
// Stack trace isn't very useful to the user if the exception is not really coming from their code.
|
var errorMessage = !string.IsNullOrWhiteSpace(ex.Message) && (ex is CliFxException || ex is CommandException)
|
||||||
|
? ex.Message
|
||||||
|
: ex.ToString();
|
||||||
|
|
||||||
// CommandException is the same, but it also lets users specify exit code so we want to return that instead of default.
|
_console.WithForegroundColor(ConsoleColor.Red, () => _console.Error.WriteLine(errorMessage));
|
||||||
|
|
||||||
var message = ex is CliFxException && !ex.Message.IsNullOrWhiteSpace() ? ex.Message : ex.ToString();
|
return ex is CommandException commandException
|
||||||
var exitCode = ex is CommandException commandEx ? commandEx.ExitCode : ex.HResult;
|
? commandException.ExitCode
|
||||||
|
: ex.HResult;
|
||||||
_console.WithForegroundColor(ConsoleColor.Red, () => _console.Error.WriteLine(message));
|
|
||||||
|
|
||||||
return exitCode;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Runs the application with specified command line arguments and returns the exit code.
|
||||||
|
/// Environment variables are retrieved automatically.
|
||||||
|
/// </summary>
|
||||||
|
public async ValueTask<int> RunAsync(IReadOnlyList<string> commandLineArguments)
|
||||||
|
{
|
||||||
|
var environmentVariables = Environment.GetEnvironmentVariables()
|
||||||
|
.Cast<DictionaryEntry>()
|
||||||
|
.ToDictionary(e => (string) e.Key, e => (string) e.Value, StringComparer.OrdinalIgnoreCase);
|
||||||
|
|
||||||
|
return await RunAsync(commandLineArguments, environmentVariables);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Runs the application and returns the exit code.
|
||||||
|
/// Command line arguments and environment variables are retrieved automatically.
|
||||||
|
/// </summary>
|
||||||
|
public async ValueTask<int> RunAsync()
|
||||||
|
{
|
||||||
|
var commandLineArguments = Environment.GetCommandLineArgs()
|
||||||
|
.Skip(1)
|
||||||
|
.ToArray();
|
||||||
|
|
||||||
|
return await RunAsync(commandLineArguments);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -3,155 +3,171 @@ using System.Collections.Generic;
|
|||||||
using System.IO;
|
using System.IO;
|
||||||
using System.Linq;
|
using System.Linq;
|
||||||
using System.Reflection;
|
using System.Reflection;
|
||||||
using CliFx.Internal;
|
using CliFx.Domain;
|
||||||
using CliFx.Models;
|
|
||||||
using CliFx.Services;
|
|
||||||
|
|
||||||
namespace CliFx
|
namespace CliFx
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Default implementation of <see cref="ICliApplicationBuilder"/>.
|
/// Builds an instance of <see cref="CliApplication"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public partial class CliApplicationBuilder : ICliApplicationBuilder
|
public partial class CliApplicationBuilder
|
||||||
{
|
{
|
||||||
private readonly HashSet<Type> _commandTypes = new HashSet<Type>();
|
private readonly HashSet<Type> _commandTypes = new HashSet<Type>();
|
||||||
|
|
||||||
private string _title;
|
private bool _isDebugModeAllowed = true;
|
||||||
private string _executableName;
|
private bool _isPreviewModeAllowed = true;
|
||||||
private string _versionText;
|
private string? _title;
|
||||||
private string _description;
|
private string? _executableName;
|
||||||
private IConsole _console;
|
private string? _versionText;
|
||||||
private ICommandFactory _commandFactory;
|
private string? _description;
|
||||||
|
private IConsole? _console;
|
||||||
|
private ITypeActivator? _typeActivator;
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <summary>
|
||||||
public ICliApplicationBuilder AddCommand(Type commandType)
|
/// Adds a command of specified type to the application.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder AddCommand(Type commandType)
|
||||||
{
|
{
|
||||||
commandType.GuardNotNull(nameof(commandType));
|
|
||||||
|
|
||||||
_commandTypes.Add(commandType);
|
_commandTypes.Add(commandType);
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <summary>
|
||||||
public ICliApplicationBuilder AddCommandsFrom(Assembly commandAssembly)
|
/// Adds multiple commands to the application.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder AddCommands(IEnumerable<Type> commandTypes)
|
||||||
{
|
{
|
||||||
commandAssembly.GuardNotNull(nameof(commandAssembly));
|
|
||||||
|
|
||||||
var commandTypes = commandAssembly.ExportedTypes.Where(t => t.Implements(typeof(ICommand)));
|
|
||||||
|
|
||||||
foreach (var commandType in commandTypes)
|
foreach (var commandType in commandTypes)
|
||||||
AddCommand(commandType);
|
AddCommand(commandType);
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <summary>
|
||||||
public ICliApplicationBuilder UseTitle(string title)
|
/// Adds commands from the specified assembly to the application.
|
||||||
|
/// Only adds public valid command types.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder AddCommandsFrom(Assembly commandAssembly)
|
||||||
{
|
{
|
||||||
_title = title.GuardNotNull(nameof(title));
|
foreach (var commandType in commandAssembly.ExportedTypes.Where(CommandSchema.IsCommandType))
|
||||||
|
AddCommand(commandType);
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <summary>
|
||||||
public ICliApplicationBuilder UseExecutableName(string executableName)
|
/// Adds commands from the specified assemblies to the application.
|
||||||
|
/// Only adds public valid command types.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder AddCommandsFrom(IEnumerable<Assembly> commandAssemblies)
|
||||||
{
|
{
|
||||||
_executableName = executableName.GuardNotNull(nameof(executableName));
|
foreach (var commandAssembly in commandAssemblies)
|
||||||
|
AddCommandsFrom(commandAssembly);
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <summary>
|
||||||
public ICliApplicationBuilder UseVersionText(string versionText)
|
/// Adds commands from the calling assembly to the application.
|
||||||
|
/// Only adds public valid command types.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder AddCommandsFromThisAssembly() => AddCommandsFrom(Assembly.GetCallingAssembly());
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Specifies whether debug mode (enabled with [debug] directive) is allowed in the application.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder AllowDebugMode(bool isAllowed = true)
|
||||||
{
|
{
|
||||||
_versionText = versionText.GuardNotNull(nameof(versionText));
|
_isDebugModeAllowed = isAllowed;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <summary>
|
||||||
public ICliApplicationBuilder UseDescription(string description)
|
/// Specifies whether preview mode (enabled with [preview] directive) is allowed in the application.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder AllowPreviewMode(bool isAllowed = true)
|
||||||
{
|
{
|
||||||
_description = description; // can be null
|
_isPreviewModeAllowed = isAllowed;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <summary>
|
||||||
public ICliApplicationBuilder UseConsole(IConsole console)
|
/// Sets application title, which appears in the help text.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder UseTitle(string title)
|
||||||
{
|
{
|
||||||
_console = console.GuardNotNull(nameof(console));
|
_title = title;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <summary>
|
||||||
public ICliApplicationBuilder UseCommandFactory(ICommandFactory factory)
|
/// Sets application executable name, which appears in the help text.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder UseExecutableName(string executableName)
|
||||||
{
|
{
|
||||||
_commandFactory = factory.GuardNotNull(nameof(factory));
|
_executableName = executableName;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
private void SetFallbackValues()
|
/// <summary>
|
||||||
|
/// Sets application version text, which appears in the help text and when the user requests version information.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder UseVersionText(string versionText)
|
||||||
{
|
{
|
||||||
if (_title.IsNullOrWhiteSpace())
|
_versionText = versionText;
|
||||||
{
|
return this;
|
||||||
// Entry assembly is null in tests
|
|
||||||
UseTitle(EntryAssembly?.GetName().Name ?? "App");
|
|
||||||
}
|
|
||||||
|
|
||||||
if (_executableName.IsNullOrWhiteSpace())
|
|
||||||
{
|
|
||||||
// Entry assembly is null in tests
|
|
||||||
var entryAssemblyLocation = EntryAssembly?.Location;
|
|
||||||
|
|
||||||
// Set different executable name depending on location
|
|
||||||
if (!entryAssemblyLocation.IsNullOrWhiteSpace())
|
|
||||||
{
|
|
||||||
// Prepend 'dotnet' to assembly file name if the entry assembly is a dll file (extension needs to be kept)
|
|
||||||
if (string.Equals(Path.GetExtension(entryAssemblyLocation), ".dll", StringComparison.OrdinalIgnoreCase))
|
|
||||||
{
|
|
||||||
UseExecutableName("dotnet " + Path.GetFileName(entryAssemblyLocation));
|
|
||||||
}
|
|
||||||
// Otherwise just use assembly file name without extension
|
|
||||||
else
|
|
||||||
{
|
|
||||||
UseExecutableName(Path.GetFileNameWithoutExtension(entryAssemblyLocation));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// If location is null then just use a stub
|
|
||||||
else
|
|
||||||
{
|
|
||||||
UseExecutableName("app");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (_versionText.IsNullOrWhiteSpace())
|
|
||||||
{
|
|
||||||
// Entry assembly is null in tests
|
|
||||||
UseVersionText(EntryAssembly?.GetName().Version.ToString() ?? "1.0");
|
|
||||||
}
|
|
||||||
|
|
||||||
if (_console == null)
|
|
||||||
{
|
|
||||||
UseConsole(new SystemConsole());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (_commandFactory == null)
|
|
||||||
{
|
|
||||||
UseCommandFactory(new CommandFactory());
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <summary>
|
||||||
public ICliApplication Build()
|
/// Sets application description, which appears in the help text.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder UseDescription(string? description)
|
||||||
{
|
{
|
||||||
// Use defaults for required parameters that were not configured
|
_description = description;
|
||||||
SetFallbackValues();
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Configures the application to use the specified implementation of <see cref="IConsole"/>.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder UseConsole(IConsole console)
|
||||||
|
{
|
||||||
|
_console = console;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Configures the application to use the specified implementation of <see cref="ITypeActivator"/>.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder UseTypeActivator(ITypeActivator typeActivator)
|
||||||
|
{
|
||||||
|
_typeActivator = typeActivator;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Configures the application to use the specified function for activating types.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplicationBuilder UseTypeActivator(Func<Type, object> typeActivator) =>
|
||||||
|
UseTypeActivator(new DelegateTypeActivator(typeActivator));
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Creates an instance of <see cref="CliApplication"/> using configured parameters.
|
||||||
|
/// Default values are used in place of parameters that were not specified.
|
||||||
|
/// </summary>
|
||||||
|
public CliApplication Build()
|
||||||
|
{
|
||||||
|
_title ??= GetDefaultTitle() ?? "App";
|
||||||
|
_executableName ??= GetDefaultExecutableName() ?? "app";
|
||||||
|
_versionText ??= GetDefaultVersionText() ?? "v1.0";
|
||||||
|
_console ??= new SystemConsole();
|
||||||
|
_typeActivator ??= new DefaultTypeActivator();
|
||||||
|
|
||||||
// Project parameters to expected types
|
|
||||||
var metadata = new ApplicationMetadata(_title, _executableName, _versionText, _description);
|
var metadata = new ApplicationMetadata(_title, _executableName, _versionText, _description);
|
||||||
var configuration = new ApplicationConfiguration(_commandTypes.ToArray());
|
var configuration = new ApplicationConfiguration(_commandTypes.ToArray(), _isDebugModeAllowed, _isPreviewModeAllowed);
|
||||||
|
|
||||||
return new CliApplication(metadata, configuration,
|
return new CliApplication(metadata, configuration, _console, _typeActivator);
|
||||||
_console, new CommandInputParser(), new CommandSchemaResolver(),
|
|
||||||
_commandFactory, new CommandInitializer(), new HelpTextRenderer());
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -159,6 +175,28 @@ namespace CliFx
|
|||||||
{
|
{
|
||||||
private static readonly Lazy<Assembly> LazyEntryAssembly = new Lazy<Assembly>(Assembly.GetEntryAssembly);
|
private static readonly Lazy<Assembly> LazyEntryAssembly = new Lazy<Assembly>(Assembly.GetEntryAssembly);
|
||||||
|
|
||||||
|
// Entry assembly is null in tests
|
||||||
private static Assembly EntryAssembly => LazyEntryAssembly.Value;
|
private static Assembly EntryAssembly => LazyEntryAssembly.Value;
|
||||||
|
|
||||||
|
private static string? GetDefaultTitle() => EntryAssembly?.GetName().Name;
|
||||||
|
|
||||||
|
private static string? GetDefaultExecutableName()
|
||||||
|
{
|
||||||
|
var entryAssemblyLocation = EntryAssembly?.Location;
|
||||||
|
|
||||||
|
// If it's a .dll assembly, prepend 'dotnet' and keep the file extension
|
||||||
|
if (string.Equals(Path.GetExtension(entryAssemblyLocation), ".dll", StringComparison.OrdinalIgnoreCase))
|
||||||
|
{
|
||||||
|
return "dotnet " + Path.GetFileName(entryAssemblyLocation);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Otherwise just use assembly file name without extension
|
||||||
|
return Path.GetFileNameWithoutExtension(entryAssemblyLocation);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static string? GetDefaultVersionText() =>
|
||||||
|
EntryAssembly != null
|
||||||
|
? $"v{EntryAssembly.GetName().Version}"
|
||||||
|
: null;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,23 +1,44 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
<Import Project="../CliFx.props" />
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<TargetFrameworks>net45;netstandard2.0</TargetFrameworks>
|
<TargetFrameworks>netstandard2.1;netstandard2.0;net45</TargetFrameworks>
|
||||||
<LangVersion>latest</LangVersion>
|
|
||||||
<Version>0.0.2</Version>
|
|
||||||
<Company>Tyrrrz</Company>
|
|
||||||
<Authors>$(Company)</Authors>
|
<Authors>$(Company)</Authors>
|
||||||
<Copyright>Copyright (C) Alexey Golub</Copyright>
|
|
||||||
<Description>Declarative framework for CLI applications</Description>
|
<Description>Declarative framework for CLI applications</Description>
|
||||||
<PackageTags>command line executable interface framework parser arguments net core</PackageTags>
|
<PackageTags>command line executable interface framework parser arguments net core</PackageTags>
|
||||||
<PackageProjectUrl>https://github.com/Tyrrrz/CliFx</PackageProjectUrl>
|
<PackageProjectUrl>https://github.com/Tyrrrz/CliFx</PackageProjectUrl>
|
||||||
<PackageReleaseNotes>https://github.com/Tyrrrz/CliFx/blob/master/Changelog.md</PackageReleaseNotes>
|
<PackageReleaseNotes>https://github.com/Tyrrrz/CliFx/blob/master/Changelog.md</PackageReleaseNotes>
|
||||||
<PackageIconUrl>https://raw.githubusercontent.com/Tyrrrz/CliFx/master/favicon.png</PackageIconUrl>
|
<PackageIcon>favicon.png</PackageIcon>
|
||||||
<PackageLicenseExpression>LGPL-3.0-only</PackageLicenseExpression>
|
<PackageLicenseExpression>MIT</PackageLicenseExpression>
|
||||||
<RepositoryUrl>https://github.com/Tyrrrz/CliFx</RepositoryUrl>
|
|
||||||
<RepositoryType>git</RepositoryType>
|
|
||||||
<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
|
<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
|
||||||
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
|
<GenerateDocumentationFile>True</GenerateDocumentationFile>
|
||||||
<DocumentationFile>bin/$(Configuration)/$(TargetFramework)/$(AssemblyName).xml</DocumentationFile>
|
<PublishRepositoryUrl>True</PublishRepositoryUrl>
|
||||||
|
<EmbedUntrackedSources>True</EmbedUntrackedSources>
|
||||||
|
<IncludeSymbols>True</IncludeSymbols>
|
||||||
|
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
|
||||||
|
<_Parameter1>$(AssemblyName).Tests</_Parameter1>
|
||||||
|
</AssemblyAttribute>
|
||||||
|
<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
|
||||||
|
<_Parameter1>$(AssemblyName).Analyzers</_Parameter1>
|
||||||
|
</AssemblyAttribute>
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<None Include="../favicon.png" Pack="True" PackagePath="" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0" PrivateAssets="all" />
|
||||||
|
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="all" />
|
||||||
|
<PackageReference Include="Nullable" Version="1.2.1" PrivateAssets="all" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0' or '$(TargetFramework)' == 'net45'">
|
||||||
|
<PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.3" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
</Project>
|
</Project>
|
||||||
29
CliFx/DefaultTypeActivator.cs
Normal file
29
CliFx/DefaultTypeActivator.cs
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
using System;
|
||||||
|
using System.Text;
|
||||||
|
using CliFx.Exceptions;
|
||||||
|
|
||||||
|
namespace CliFx
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Type activator that uses the <see cref="Activator"/> class to instantiate objects.
|
||||||
|
/// </summary>
|
||||||
|
public class DefaultTypeActivator : ITypeActivator
|
||||||
|
{
|
||||||
|
/// <inheritdoc />
|
||||||
|
public object CreateInstance(Type type)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
return Activator.CreateInstance(type);
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.Append($"Failed to create an instance of {type.FullName}.").Append(" ")
|
||||||
|
.AppendLine("The type must have a public parameter-less constructor in order to be instantiated by the default activator.")
|
||||||
|
.Append($"To supply a custom activator (for example when using dependency injection), call {nameof(CliApplicationBuilder)}.{nameof(CliApplicationBuilder.UseTypeActivator)}(...).")
|
||||||
|
.ToString(), ex);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
27
CliFx/DelegateTypeActivator.cs
Normal file
27
CliFx/DelegateTypeActivator.cs
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
using System;
|
||||||
|
using System.Text;
|
||||||
|
using CliFx.Exceptions;
|
||||||
|
|
||||||
|
namespace CliFx
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Type activator that uses the specified delegate to instantiate objects.
|
||||||
|
/// </summary>
|
||||||
|
public class DelegateTypeActivator : ITypeActivator
|
||||||
|
{
|
||||||
|
private readonly Func<Type, object> _func;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Initializes an instance of <see cref="DelegateTypeActivator"/>.
|
||||||
|
/// </summary>
|
||||||
|
public DelegateTypeActivator(Func<Type, object> func) => _func = func;
|
||||||
|
|
||||||
|
/// <inheritdoc />
|
||||||
|
public object CreateInstance(Type type) =>
|
||||||
|
_func(type) ?? throw new CliFxException(new StringBuilder()
|
||||||
|
.Append($"Failed to create an instance of type {type.FullName}, received <null> instead.").Append(" ")
|
||||||
|
.Append("Make sure that the provided type activator was configured correctly.").Append(" ")
|
||||||
|
.Append("If you are using a dependency container, make sure that this type is registered.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
}
|
||||||
267
CliFx/Domain/ApplicationSchema.cs
Normal file
267
CliFx/Domain/ApplicationSchema.cs
Normal file
@@ -0,0 +1,267 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
using System.Text;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
using CliFx.Exceptions;
|
||||||
|
using CliFx.Internal;
|
||||||
|
|
||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal partial class ApplicationSchema
|
||||||
|
{
|
||||||
|
public IReadOnlyList<CommandSchema> Commands { get; }
|
||||||
|
|
||||||
|
public ApplicationSchema(IReadOnlyList<CommandSchema> commands)
|
||||||
|
{
|
||||||
|
Commands = commands;
|
||||||
|
}
|
||||||
|
|
||||||
|
public CommandSchema? TryFindParentCommand(string? childCommandName)
|
||||||
|
{
|
||||||
|
// Default command has no parent
|
||||||
|
if (string.IsNullOrWhiteSpace(childCommandName))
|
||||||
|
return null;
|
||||||
|
|
||||||
|
// Try to find the parent command by repeatedly biting off chunks of its name
|
||||||
|
var route = childCommandName.Split(' ');
|
||||||
|
for (var i = route.Length - 1; i >= 1; i--)
|
||||||
|
{
|
||||||
|
var potentialParentCommandName = string.Join(" ", route.Take(i));
|
||||||
|
var matchingParentCommand = Commands.FirstOrDefault(c => c.MatchesName(potentialParentCommandName));
|
||||||
|
|
||||||
|
if (matchingParentCommand != null)
|
||||||
|
return matchingParentCommand;
|
||||||
|
}
|
||||||
|
|
||||||
|
// If there's no parent - fall back to default command
|
||||||
|
return Commands.FirstOrDefault(c => c.IsDefault);
|
||||||
|
}
|
||||||
|
|
||||||
|
public IReadOnlyList<CommandSchema> GetChildCommands(string? parentCommandName) =>
|
||||||
|
!string.IsNullOrWhiteSpace(parentCommandName) || Commands.Any(c => c.IsDefault)
|
||||||
|
? Commands.Where(c => TryFindParentCommand(c.Name)?.MatchesName(parentCommandName) == true).ToArray()
|
||||||
|
: Commands.Where(c => !string.IsNullOrWhiteSpace(c.Name) && TryFindParentCommand(c.Name) == null).ToArray();
|
||||||
|
|
||||||
|
// TODO: this out parameter is not a really nice design
|
||||||
|
public CommandSchema? TryFindCommand(CommandLineInput commandLineInput, out int argumentOffset)
|
||||||
|
{
|
||||||
|
// Try to find the command that contains the most of the input arguments in its name
|
||||||
|
for (var i = commandLineInput.UnboundArguments.Count; i >= 0; i--)
|
||||||
|
{
|
||||||
|
var potentialCommandName = string.Join(" ", commandLineInput.UnboundArguments.Take(i));
|
||||||
|
var matchingCommand = Commands.FirstOrDefault(c => c.MatchesName(potentialCommandName));
|
||||||
|
|
||||||
|
if (matchingCommand != null)
|
||||||
|
{
|
||||||
|
argumentOffset = i;
|
||||||
|
return matchingCommand;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
argumentOffset = 0;
|
||||||
|
return Commands.FirstOrDefault(c => c.IsDefault);
|
||||||
|
}
|
||||||
|
|
||||||
|
public CommandSchema? TryFindCommand(CommandLineInput commandLineInput) =>
|
||||||
|
TryFindCommand(commandLineInput, out _);
|
||||||
|
|
||||||
|
public ICommand InitializeEntryPoint(
|
||||||
|
CommandLineInput commandLineInput,
|
||||||
|
IReadOnlyDictionary<string, string> environmentVariables,
|
||||||
|
ITypeActivator activator)
|
||||||
|
{
|
||||||
|
var command = TryFindCommand(commandLineInput, out var argumentOffset);
|
||||||
|
if (command == null)
|
||||||
|
{
|
||||||
|
throw new CliFxException(
|
||||||
|
$"Can't find a command that matches arguments [{string.Join(" ", commandLineInput.UnboundArguments)}].");
|
||||||
|
}
|
||||||
|
|
||||||
|
var parameterValues = argumentOffset == 0
|
||||||
|
? commandLineInput.UnboundArguments.Select(a => a.Value).ToArray()
|
||||||
|
: commandLineInput.UnboundArguments.Skip(argumentOffset).Select(a => a.Value).ToArray();
|
||||||
|
|
||||||
|
return command.CreateInstance(parameterValues, commandLineInput.Options, environmentVariables, activator);
|
||||||
|
}
|
||||||
|
|
||||||
|
public ICommand InitializeEntryPoint(
|
||||||
|
CommandLineInput commandLineInput,
|
||||||
|
IReadOnlyDictionary<string, string> environmentVariables) =>
|
||||||
|
InitializeEntryPoint(commandLineInput, environmentVariables, new DefaultTypeActivator());
|
||||||
|
|
||||||
|
public ICommand InitializeEntryPoint(CommandLineInput commandLineInput) =>
|
||||||
|
InitializeEntryPoint(commandLineInput, new Dictionary<string, string>());
|
||||||
|
|
||||||
|
public override string ToString() => string.Join(Environment.NewLine, Commands);
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class ApplicationSchema
|
||||||
|
{
|
||||||
|
private static void ValidateParameters(CommandSchema command)
|
||||||
|
{
|
||||||
|
var duplicateOrderGroup = command.Parameters
|
||||||
|
.GroupBy(a => a.Order)
|
||||||
|
.FirstOrDefault(g => g.Count() > 1);
|
||||||
|
|
||||||
|
if (duplicateOrderGroup != null)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Command {command.Type.FullName} contains two or more parameters that have the same order ({duplicateOrderGroup.Key}):")
|
||||||
|
.AppendBulletList(duplicateOrderGroup.Select(o => o.Property.Name))
|
||||||
|
.AppendLine()
|
||||||
|
.Append("Parameters in a command must all have unique order.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
var duplicateNameGroup = command.Parameters
|
||||||
|
.Where(a => !string.IsNullOrWhiteSpace(a.Name))
|
||||||
|
.GroupBy(a => a.Name, StringComparer.OrdinalIgnoreCase)
|
||||||
|
.FirstOrDefault(g => g.Count() > 1);
|
||||||
|
|
||||||
|
if (duplicateNameGroup != null)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Command {command.Type.FullName} contains two or more parameters that have the same name ({duplicateNameGroup.Key}):")
|
||||||
|
.AppendBulletList(duplicateNameGroup.Select(o => o.Property.Name))
|
||||||
|
.AppendLine()
|
||||||
|
.Append("Parameters in a command must all have unique names.").Append(" ")
|
||||||
|
.Append("Comparison is NOT case-sensitive.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
var nonScalarParameters = command.Parameters
|
||||||
|
.Where(p => !p.IsScalar)
|
||||||
|
.ToArray();
|
||||||
|
|
||||||
|
if (nonScalarParameters.Length > 1)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Command [{command.Type.FullName}] contains two or more parameters of an enumerable type:")
|
||||||
|
.AppendBulletList(nonScalarParameters.Select(o => o.Property.Name))
|
||||||
|
.AppendLine()
|
||||||
|
.AppendLine("There can only be one parameter of an enumerable type in a command.")
|
||||||
|
.Append("Note, the string type is not considered enumerable in this context.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
var nonLastNonScalarParameter = command.Parameters
|
||||||
|
.OrderByDescending(a => a.Order)
|
||||||
|
.Skip(1)
|
||||||
|
.LastOrDefault(p => !p.IsScalar);
|
||||||
|
|
||||||
|
if (nonLastNonScalarParameter != null)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Command {command.Type.FullName} contains a parameter of an enumerable type which doesn't appear last in order:")
|
||||||
|
.AppendLine($"- {nonLastNonScalarParameter.Property.Name}")
|
||||||
|
.AppendLine()
|
||||||
|
.Append("Parameter of an enumerable type must always come last to avoid ambiguity.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void ValidateOptions(CommandSchema command)
|
||||||
|
{
|
||||||
|
var duplicateNameGroup = command.Options
|
||||||
|
.Where(o => !string.IsNullOrWhiteSpace(o.Name))
|
||||||
|
.GroupBy(o => o.Name, StringComparer.OrdinalIgnoreCase)
|
||||||
|
.FirstOrDefault(g => g.Count() > 1);
|
||||||
|
|
||||||
|
if (duplicateNameGroup != null)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Command {command.Type.FullName} contains two or more options that have the same name ({duplicateNameGroup.Key}):")
|
||||||
|
.AppendBulletList(duplicateNameGroup.Select(o => o.Property.Name))
|
||||||
|
.AppendLine()
|
||||||
|
.Append("Options in a command must all have unique names.").Append(" ")
|
||||||
|
.Append("Comparison is NOT case-sensitive.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
var duplicateShortNameGroup = command.Options
|
||||||
|
.Where(o => o.ShortName != null)
|
||||||
|
.GroupBy(o => o.ShortName)
|
||||||
|
.FirstOrDefault(g => g.Count() > 1);
|
||||||
|
|
||||||
|
if (duplicateShortNameGroup != null)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Command {command.Type.FullName} contains two or more options that have the same short name ({duplicateShortNameGroup.Key}):")
|
||||||
|
.AppendBulletList(duplicateShortNameGroup.Select(o => o.Property.Name))
|
||||||
|
.AppendLine()
|
||||||
|
.Append("Options in a command must all have unique short names.").Append(" ")
|
||||||
|
.Append("Comparison is case-sensitive.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
var duplicateEnvironmentVariableNameGroup = command.Options
|
||||||
|
.Where(o => !string.IsNullOrWhiteSpace(o.EnvironmentVariableName))
|
||||||
|
.GroupBy(o => o.EnvironmentVariableName, StringComparer.OrdinalIgnoreCase)
|
||||||
|
.FirstOrDefault(g => g.Count() > 1);
|
||||||
|
|
||||||
|
if (duplicateEnvironmentVariableNameGroup != null)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Command {command.Type.FullName} contains two or more options that have the same environment variable name ({duplicateEnvironmentVariableNameGroup.Key}):")
|
||||||
|
.AppendBulletList(duplicateEnvironmentVariableNameGroup.Select(o => o.Property.Name))
|
||||||
|
.AppendLine()
|
||||||
|
.Append("Options in a command must all have unique environment variable names.").Append(" ")
|
||||||
|
.Append("Comparison is NOT case-sensitive.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void ValidateCommands(IReadOnlyList<CommandSchema> commands)
|
||||||
|
{
|
||||||
|
if (!commands.Any())
|
||||||
|
{
|
||||||
|
throw new CliFxException("There are no commands configured for this application.");
|
||||||
|
}
|
||||||
|
|
||||||
|
var duplicateNameGroup = commands
|
||||||
|
.GroupBy(c => c.Name, StringComparer.OrdinalIgnoreCase)
|
||||||
|
.FirstOrDefault(g => g.Count() > 1);
|
||||||
|
|
||||||
|
if (duplicateNameGroup != null)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Application contains two or more commands that have the same name ({duplicateNameGroup.Key}):")
|
||||||
|
.AppendBulletList(duplicateNameGroup.Select(o => o.Type.FullName))
|
||||||
|
.AppendLine()
|
||||||
|
.Append("Commands must all have unique names. Likewise, there must not be more than one command without a name.").Append(" ")
|
||||||
|
.Append("Comparison is NOT case-sensitive.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static ApplicationSchema Resolve(IReadOnlyList<Type> commandTypes)
|
||||||
|
{
|
||||||
|
var commands = new List<CommandSchema>();
|
||||||
|
|
||||||
|
foreach (var commandType in commandTypes)
|
||||||
|
{
|
||||||
|
var command = CommandSchema.TryResolve(commandType);
|
||||||
|
if (command == null)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.Append($"Command {commandType.FullName} is not a valid command type.").Append(" ")
|
||||||
|
.AppendLine("In order to be a valid command type it must:")
|
||||||
|
.AppendLine($" - Be annotated with {typeof(CommandAttribute).FullName}")
|
||||||
|
.AppendLine($" - Implement {typeof(ICommand).FullName}")
|
||||||
|
.AppendLine(" - Not be an abstract class")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
ValidateParameters(command);
|
||||||
|
ValidateOptions(command);
|
||||||
|
|
||||||
|
commands.Add(command);
|
||||||
|
}
|
||||||
|
|
||||||
|
ValidateCommands(commands);
|
||||||
|
|
||||||
|
return new ApplicationSchema(commands);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
176
CliFx/Domain/CommandArgumentSchema.cs
Normal file
176
CliFx/Domain/CommandArgumentSchema.cs
Normal file
@@ -0,0 +1,176 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Globalization;
|
||||||
|
using System.Linq;
|
||||||
|
using System.Reflection;
|
||||||
|
using System.Text;
|
||||||
|
using CliFx.Exceptions;
|
||||||
|
using CliFx.Internal;
|
||||||
|
|
||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal abstract partial class CommandArgumentSchema
|
||||||
|
{
|
||||||
|
public PropertyInfo Property { get; }
|
||||||
|
|
||||||
|
public string? Description { get; }
|
||||||
|
|
||||||
|
public bool IsScalar => GetEnumerableArgumentUnderlyingType() == null;
|
||||||
|
|
||||||
|
protected CommandArgumentSchema(PropertyInfo property, string? description)
|
||||||
|
{
|
||||||
|
Property = property;
|
||||||
|
Description = description;
|
||||||
|
}
|
||||||
|
|
||||||
|
private Type? GetEnumerableArgumentUnderlyingType() =>
|
||||||
|
Property.PropertyType != typeof(string)
|
||||||
|
? Property.PropertyType.GetEnumerableUnderlyingType()
|
||||||
|
: null;
|
||||||
|
|
||||||
|
private object Convert(IReadOnlyList<string> values)
|
||||||
|
{
|
||||||
|
var targetType = Property.PropertyType;
|
||||||
|
var enumerableUnderlyingType = GetEnumerableArgumentUnderlyingType();
|
||||||
|
|
||||||
|
// Scalar
|
||||||
|
if (enumerableUnderlyingType == null)
|
||||||
|
{
|
||||||
|
if (values.Count > 1)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Can't convert a sequence of values [{string.Join(", ", values)}] to type {targetType.FullName}.")
|
||||||
|
.Append("Target type is not enumerable and can't accept more than one value.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
return ConvertScalar(values.SingleOrDefault(), targetType);
|
||||||
|
}
|
||||||
|
// Non-scalar
|
||||||
|
else
|
||||||
|
{
|
||||||
|
return ConvertNonScalar(values, targetType, enumerableUnderlyingType);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public void Inject(ICommand command, IReadOnlyList<string> values) =>
|
||||||
|
Property.SetValue(command, Convert(values));
|
||||||
|
|
||||||
|
public void Inject(ICommand command, params string[] values) =>
|
||||||
|
Inject(command, (IReadOnlyList<string>) values);
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandArgumentSchema
|
||||||
|
{
|
||||||
|
private static readonly IFormatProvider ConversionFormatProvider = CultureInfo.InvariantCulture;
|
||||||
|
|
||||||
|
private static readonly IReadOnlyDictionary<Type, Func<string, object>> PrimitiveConverters =
|
||||||
|
new Dictionary<Type, Func<string?, object>>
|
||||||
|
{
|
||||||
|
[typeof(object)] = v => v,
|
||||||
|
[typeof(string)] = v => v,
|
||||||
|
[typeof(bool)] = v => string.IsNullOrWhiteSpace(v) || bool.Parse(v),
|
||||||
|
[typeof(char)] = v => v.Single(),
|
||||||
|
[typeof(sbyte)] = v => sbyte.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(byte)] = v => byte.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(short)] = v => short.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(ushort)] = v => ushort.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(int)] = v => int.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(uint)] = v => uint.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(long)] = v => long.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(ulong)] = v => ulong.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(float)] = v => float.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(double)] = v => double.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(decimal)] = v => decimal.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(DateTime)] = v => DateTime.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(DateTimeOffset)] = v => DateTimeOffset.Parse(v, ConversionFormatProvider),
|
||||||
|
[typeof(TimeSpan)] = v => TimeSpan.Parse(v, ConversionFormatProvider),
|
||||||
|
};
|
||||||
|
|
||||||
|
private static ConstructorInfo? GetStringConstructor(Type type) =>
|
||||||
|
type.GetConstructor(new[] {typeof(string)});
|
||||||
|
|
||||||
|
private static MethodInfo? GetStaticParseMethod(Type type) =>
|
||||||
|
type.GetMethod("Parse",
|
||||||
|
BindingFlags.Public | BindingFlags.Static,
|
||||||
|
null, new[] {typeof(string)}, null);
|
||||||
|
|
||||||
|
private static MethodInfo? GetStaticParseMethodWithFormatProvider(Type type) =>
|
||||||
|
type.GetMethod("Parse",
|
||||||
|
BindingFlags.Public | BindingFlags.Static,
|
||||||
|
null, new[] {typeof(string), typeof(IFormatProvider)}, null);
|
||||||
|
|
||||||
|
private static object ConvertScalar(string? value, Type targetType)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
// Primitive
|
||||||
|
var primitiveConverter = PrimitiveConverters.GetValueOrDefault(targetType);
|
||||||
|
if (primitiveConverter != null)
|
||||||
|
return primitiveConverter(value);
|
||||||
|
|
||||||
|
// Enum
|
||||||
|
if (targetType.IsEnum)
|
||||||
|
return Enum.Parse(targetType, value, true);
|
||||||
|
|
||||||
|
// Nullable
|
||||||
|
var nullableUnderlyingType = targetType.GetNullableUnderlyingType();
|
||||||
|
if (nullableUnderlyingType != null)
|
||||||
|
return !string.IsNullOrWhiteSpace(value)
|
||||||
|
? ConvertScalar(value, nullableUnderlyingType)
|
||||||
|
: null;
|
||||||
|
|
||||||
|
// String-constructable
|
||||||
|
var stringConstructor = GetStringConstructor(targetType);
|
||||||
|
if (stringConstructor != null)
|
||||||
|
return stringConstructor.Invoke(new object[] {value});
|
||||||
|
|
||||||
|
// String-parseable (with format provider)
|
||||||
|
var parseMethodWithFormatProvider = GetStaticParseMethodWithFormatProvider(targetType);
|
||||||
|
if (parseMethodWithFormatProvider != null)
|
||||||
|
return parseMethodWithFormatProvider.Invoke(null, new object[] {value, ConversionFormatProvider});
|
||||||
|
|
||||||
|
// String-parseable (without format provider)
|
||||||
|
var parseMethod = GetStaticParseMethod(targetType);
|
||||||
|
if (parseMethod != null)
|
||||||
|
return parseMethod.Invoke(null, new object[] {value});
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Failed to convert value '{value ?? "<null>"}' to type {targetType.FullName}.")
|
||||||
|
.Append(ex.Message)
|
||||||
|
.ToString(), ex);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Can't convert value '{value ?? "<null>"}' to type {targetType.FullName}.")
|
||||||
|
.Append("Target type is not supported by CliFx.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
private static object ConvertNonScalar(IReadOnlyList<string> values, Type targetEnumerableType, Type targetElementType)
|
||||||
|
{
|
||||||
|
var array = values
|
||||||
|
.Select(v => ConvertScalar(v, targetElementType))
|
||||||
|
.ToNonGenericArray(targetElementType);
|
||||||
|
|
||||||
|
var arrayType = array.GetType();
|
||||||
|
|
||||||
|
// Assignable from an array
|
||||||
|
if (targetEnumerableType.IsAssignableFrom(arrayType))
|
||||||
|
return array;
|
||||||
|
|
||||||
|
// Constructable from an array
|
||||||
|
var arrayConstructor = targetEnumerableType.GetConstructor(new[] {arrayType});
|
||||||
|
if (arrayConstructor != null)
|
||||||
|
return arrayConstructor.Invoke(new object[] {array});
|
||||||
|
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine($"Can't convert a sequence of values [{string.Join(", ", values)}] to type {targetEnumerableType.FullName}.")
|
||||||
|
.AppendLine($"Underlying element type is [{targetElementType.FullName}].")
|
||||||
|
.Append("Target type must either be assignable from an array or have a public constructor that takes a single array argument.")
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
20
CliFx/Domain/CommandDirectiveInput.cs
Normal file
20
CliFx/Domain/CommandDirectiveInput.cs
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
using System;
|
||||||
|
|
||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal class CommandDirectiveInput
|
||||||
|
{
|
||||||
|
public string Name { get; }
|
||||||
|
|
||||||
|
public bool IsDebugDirective => string.Equals(Name, "debug", StringComparison.OrdinalIgnoreCase);
|
||||||
|
|
||||||
|
public bool IsPreviewDirective => string.Equals(Name, "preview", StringComparison.OrdinalIgnoreCase);
|
||||||
|
|
||||||
|
public CommandDirectiveInput(string name)
|
||||||
|
{
|
||||||
|
Name = name;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override string ToString() => $"[{Name}]";
|
||||||
|
}
|
||||||
|
}
|
||||||
163
CliFx/Domain/CommandLineInput.cs
Normal file
163
CliFx/Domain/CommandLineInput.cs
Normal file
@@ -0,0 +1,163 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
using System.Text;
|
||||||
|
using CliFx.Internal;
|
||||||
|
|
||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal partial class CommandLineInput
|
||||||
|
{
|
||||||
|
public IReadOnlyList<CommandDirectiveInput> Directives { get; }
|
||||||
|
|
||||||
|
public IReadOnlyList<CommandUnboundArgumentInput> UnboundArguments { get; }
|
||||||
|
|
||||||
|
public IReadOnlyList<CommandOptionInput> Options { get; }
|
||||||
|
|
||||||
|
public bool IsDebugDirectiveSpecified => Directives.Any(d => d.IsDebugDirective);
|
||||||
|
|
||||||
|
public bool IsPreviewDirectiveSpecified => Directives.Any(d => d.IsPreviewDirective);
|
||||||
|
|
||||||
|
public bool IsHelpOptionSpecified => Options.Any(o => o.IsHelpOption);
|
||||||
|
|
||||||
|
public bool IsVersionOptionSpecified => Options.Any(o => o.IsVersionOption);
|
||||||
|
|
||||||
|
public CommandLineInput(
|
||||||
|
IReadOnlyList<CommandDirectiveInput> directives,
|
||||||
|
IReadOnlyList<CommandUnboundArgumentInput> unboundArguments,
|
||||||
|
IReadOnlyList<CommandOptionInput> options)
|
||||||
|
{
|
||||||
|
Directives = directives;
|
||||||
|
UnboundArguments = unboundArguments;
|
||||||
|
Options = options;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override string ToString()
|
||||||
|
{
|
||||||
|
var buffer = new StringBuilder();
|
||||||
|
|
||||||
|
foreach (var directive in Directives)
|
||||||
|
{
|
||||||
|
buffer.AppendIfNotEmpty(' ');
|
||||||
|
buffer.Append(directive);
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach (var argument in UnboundArguments)
|
||||||
|
{
|
||||||
|
buffer.AppendIfNotEmpty(' ');
|
||||||
|
buffer.Append(argument);
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach (var option in Options)
|
||||||
|
{
|
||||||
|
buffer.AppendIfNotEmpty(' ');
|
||||||
|
buffer.Append(option);
|
||||||
|
}
|
||||||
|
|
||||||
|
return buffer.ToString();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandLineInput
|
||||||
|
{
|
||||||
|
public static CommandLineInput Parse(IReadOnlyList<string> commandLineArguments)
|
||||||
|
{
|
||||||
|
var builder = new CommandLineInputBuilder();
|
||||||
|
|
||||||
|
var currentOptionAlias = "";
|
||||||
|
var currentOptionValues = new List<string>();
|
||||||
|
|
||||||
|
bool TryParseDirective(string argument)
|
||||||
|
{
|
||||||
|
if (!string.IsNullOrWhiteSpace(currentOptionAlias))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (!argument.StartsWith("[", StringComparison.OrdinalIgnoreCase) ||
|
||||||
|
!argument.EndsWith("]", StringComparison.OrdinalIgnoreCase))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
var directive = argument.Substring(1, argument.Length - 2);
|
||||||
|
builder.AddDirective(directive);
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool TryParseArgument(string argument)
|
||||||
|
{
|
||||||
|
if (!string.IsNullOrWhiteSpace(currentOptionAlias))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
builder.AddUnboundArgument(argument);
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool TryParseOptionName(string argument)
|
||||||
|
{
|
||||||
|
if (!argument.StartsWith("--", StringComparison.OrdinalIgnoreCase))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (!string.IsNullOrWhiteSpace(currentOptionAlias))
|
||||||
|
builder.AddOption(currentOptionAlias, currentOptionValues);
|
||||||
|
|
||||||
|
currentOptionAlias = argument.Substring(2);
|
||||||
|
currentOptionValues = new List<string>();
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool TryParseOptionShortName(string argument)
|
||||||
|
{
|
||||||
|
if (!argument.StartsWith("-", StringComparison.OrdinalIgnoreCase))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
foreach (var c in argument.Substring(1))
|
||||||
|
{
|
||||||
|
if (!string.IsNullOrWhiteSpace(currentOptionAlias))
|
||||||
|
builder.AddOption(currentOptionAlias, currentOptionValues);
|
||||||
|
|
||||||
|
currentOptionAlias = c.AsString();
|
||||||
|
currentOptionValues = new List<string>();
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool TryParseOptionValue(string argument)
|
||||||
|
{
|
||||||
|
if (string.IsNullOrWhiteSpace(currentOptionAlias))
|
||||||
|
return false;
|
||||||
|
|
||||||
|
currentOptionValues.Add(argument);
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach (var argument in commandLineArguments)
|
||||||
|
{
|
||||||
|
var _ =
|
||||||
|
TryParseOptionName(argument) ||
|
||||||
|
TryParseOptionShortName(argument) ||
|
||||||
|
TryParseDirective(argument) ||
|
||||||
|
TryParseArgument(argument) ||
|
||||||
|
TryParseOptionValue(argument);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!string.IsNullOrWhiteSpace(currentOptionAlias))
|
||||||
|
builder.AddOption(currentOptionAlias, currentOptionValues);
|
||||||
|
|
||||||
|
return builder.Build();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandLineInput
|
||||||
|
{
|
||||||
|
private static IReadOnlyList<CommandDirectiveInput> EmptyDirectives { get; } = new CommandDirectiveInput[0];
|
||||||
|
|
||||||
|
private static IReadOnlyList<CommandUnboundArgumentInput> EmptyUnboundArguments { get; } = new CommandUnboundArgumentInput[0];
|
||||||
|
|
||||||
|
private static IReadOnlyList<CommandOptionInput> EmptyOptions { get; } = new CommandOptionInput[0];
|
||||||
|
|
||||||
|
public static CommandLineInput Empty { get; } = new CommandLineInput(EmptyDirectives, EmptyUnboundArguments, EmptyOptions);
|
||||||
|
}
|
||||||
|
}
|
||||||
43
CliFx/Domain/CommandLineInputBuilder.cs
Normal file
43
CliFx/Domain/CommandLineInputBuilder.cs
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
|
||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal class CommandLineInputBuilder
|
||||||
|
{
|
||||||
|
private readonly List<CommandDirectiveInput> _directives = new List<CommandDirectiveInput>();
|
||||||
|
private readonly List<CommandUnboundArgumentInput> _unboundArguments = new List<CommandUnboundArgumentInput>();
|
||||||
|
private readonly List<CommandOptionInput> _options = new List<CommandOptionInput>();
|
||||||
|
|
||||||
|
public CommandLineInputBuilder AddDirective(CommandDirectiveInput directive)
|
||||||
|
{
|
||||||
|
_directives.Add(directive);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public CommandLineInputBuilder AddDirective(string directive) =>
|
||||||
|
AddDirective(new CommandDirectiveInput(directive));
|
||||||
|
|
||||||
|
public CommandLineInputBuilder AddUnboundArgument(CommandUnboundArgumentInput unboundArgument)
|
||||||
|
{
|
||||||
|
_unboundArguments.Add(unboundArgument);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public CommandLineInputBuilder AddUnboundArgument(string unboundArgument) =>
|
||||||
|
AddUnboundArgument(new CommandUnboundArgumentInput(unboundArgument));
|
||||||
|
|
||||||
|
public CommandLineInputBuilder AddOption(CommandOptionInput option)
|
||||||
|
{
|
||||||
|
_options.Add(option);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public CommandLineInputBuilder AddOption(string optionAlias, IReadOnlyList<string> values) =>
|
||||||
|
AddOption(new CommandOptionInput(optionAlias, values));
|
||||||
|
|
||||||
|
public CommandLineInputBuilder AddOption(string optionAlias, params string[] values) =>
|
||||||
|
AddOption(optionAlias, (IReadOnlyList<string>) values);
|
||||||
|
|
||||||
|
public CommandLineInput Build() => new CommandLineInput(_directives, _unboundArguments, _options);
|
||||||
|
}
|
||||||
|
}
|
||||||
48
CliFx/Domain/CommandOptionInput.cs
Normal file
48
CliFx/Domain/CommandOptionInput.cs
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Text;
|
||||||
|
using CliFx.Internal;
|
||||||
|
|
||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal class CommandOptionInput
|
||||||
|
{
|
||||||
|
public string Alias { get; }
|
||||||
|
|
||||||
|
public IReadOnlyList<string> Values { get; }
|
||||||
|
|
||||||
|
public bool IsHelpOption => CommandOptionSchema.HelpOption.MatchesNameOrShortName(Alias);
|
||||||
|
|
||||||
|
public bool IsVersionOption => CommandOptionSchema.VersionOption.MatchesNameOrShortName(Alias);
|
||||||
|
|
||||||
|
public CommandOptionInput(string alias, IReadOnlyList<string> values)
|
||||||
|
{
|
||||||
|
Alias = alias;
|
||||||
|
Values = values;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override string ToString()
|
||||||
|
{
|
||||||
|
var buffer = new StringBuilder();
|
||||||
|
|
||||||
|
buffer.Append(Alias.Length > 1 ? "--" : "-");
|
||||||
|
buffer.Append(Alias);
|
||||||
|
|
||||||
|
foreach (var value in Values)
|
||||||
|
{
|
||||||
|
buffer.AppendIfNotEmpty(' ');
|
||||||
|
|
||||||
|
var isEscaped = value.Contains(" ");
|
||||||
|
|
||||||
|
if (isEscaped)
|
||||||
|
buffer.Append('"');
|
||||||
|
|
||||||
|
buffer.Append(value);
|
||||||
|
|
||||||
|
if (isEscaped)
|
||||||
|
buffer.Append('"');
|
||||||
|
}
|
||||||
|
|
||||||
|
return buffer.ToString();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
105
CliFx/Domain/CommandOptionSchema.cs
Normal file
105
CliFx/Domain/CommandOptionSchema.cs
Normal file
@@ -0,0 +1,105 @@
|
|||||||
|
using System;
|
||||||
|
using System.Linq;
|
||||||
|
using System.Reflection;
|
||||||
|
using System.Text;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
using CliFx.Internal;
|
||||||
|
|
||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal partial class CommandOptionSchema : CommandArgumentSchema
|
||||||
|
{
|
||||||
|
public string? Name { get; }
|
||||||
|
|
||||||
|
public char? ShortName { get; }
|
||||||
|
|
||||||
|
public string DisplayName => !string.IsNullOrWhiteSpace(Name)
|
||||||
|
? Name
|
||||||
|
: ShortName?.AsString()!;
|
||||||
|
|
||||||
|
public string? EnvironmentVariableName { get; }
|
||||||
|
|
||||||
|
public bool IsRequired { get; }
|
||||||
|
|
||||||
|
public CommandOptionSchema(
|
||||||
|
PropertyInfo property,
|
||||||
|
string? name,
|
||||||
|
char? shortName,
|
||||||
|
string? environmentVariableName,
|
||||||
|
bool isRequired,
|
||||||
|
string? description)
|
||||||
|
: base(property, description)
|
||||||
|
{
|
||||||
|
Name = name;
|
||||||
|
ShortName = shortName;
|
||||||
|
EnvironmentVariableName = environmentVariableName;
|
||||||
|
IsRequired = isRequired;
|
||||||
|
}
|
||||||
|
|
||||||
|
public bool MatchesName(string? name) =>
|
||||||
|
!string.IsNullOrWhiteSpace(Name) &&
|
||||||
|
string.Equals(Name, name, StringComparison.OrdinalIgnoreCase);
|
||||||
|
|
||||||
|
public bool MatchesShortName(char shortName) =>
|
||||||
|
ShortName != null &&
|
||||||
|
ShortName == shortName;
|
||||||
|
|
||||||
|
public bool MatchesNameOrShortName(string alias) =>
|
||||||
|
MatchesName(alias) ||
|
||||||
|
alias.Length == 1 && MatchesShortName(alias.Single());
|
||||||
|
|
||||||
|
public bool MatchesEnvironmentVariableName(string environmentVariableName) =>
|
||||||
|
!string.IsNullOrWhiteSpace(EnvironmentVariableName) &&
|
||||||
|
string.Equals(EnvironmentVariableName, environmentVariableName, StringComparison.OrdinalIgnoreCase);
|
||||||
|
|
||||||
|
public override string ToString()
|
||||||
|
{
|
||||||
|
var buffer = new StringBuilder();
|
||||||
|
|
||||||
|
if (!string.IsNullOrWhiteSpace(Name))
|
||||||
|
{
|
||||||
|
buffer.Append("--");
|
||||||
|
buffer.Append(Name);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!string.IsNullOrWhiteSpace(Name) && ShortName != null)
|
||||||
|
buffer.Append('|');
|
||||||
|
|
||||||
|
if (ShortName != null)
|
||||||
|
{
|
||||||
|
buffer.Append('-');
|
||||||
|
buffer.Append(ShortName);
|
||||||
|
}
|
||||||
|
|
||||||
|
return buffer.ToString();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandOptionSchema
|
||||||
|
{
|
||||||
|
public static CommandOptionSchema? TryResolve(PropertyInfo property)
|
||||||
|
{
|
||||||
|
var attribute = property.GetCustomAttribute<CommandOptionAttribute>();
|
||||||
|
if (attribute == null)
|
||||||
|
return null;
|
||||||
|
|
||||||
|
return new CommandOptionSchema(
|
||||||
|
property,
|
||||||
|
attribute.Name,
|
||||||
|
attribute.ShortName,
|
||||||
|
attribute.EnvironmentVariableName,
|
||||||
|
attribute.IsRequired,
|
||||||
|
attribute.Description
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandOptionSchema
|
||||||
|
{
|
||||||
|
public static CommandOptionSchema HelpOption { get; } =
|
||||||
|
new CommandOptionSchema(null!, "help", 'h', null, false, "Shows help text.");
|
||||||
|
|
||||||
|
public static CommandOptionSchema VersionOption { get; } =
|
||||||
|
new CommandOptionSchema(null!, "version", null, null, false, "Shows version information.");
|
||||||
|
}
|
||||||
|
}
|
||||||
53
CliFx/Domain/CommandParameterSchema.cs
Normal file
53
CliFx/Domain/CommandParameterSchema.cs
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
using System.Reflection;
|
||||||
|
using System.Text;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal partial class CommandParameterSchema : CommandArgumentSchema
|
||||||
|
{
|
||||||
|
public int Order { get; }
|
||||||
|
|
||||||
|
public string? Name { get; }
|
||||||
|
|
||||||
|
public string DisplayName => !string.IsNullOrWhiteSpace(Name)
|
||||||
|
? Name
|
||||||
|
: Property.Name.ToLowerInvariant();
|
||||||
|
|
||||||
|
public CommandParameterSchema(PropertyInfo property, int order, string? name, string? description)
|
||||||
|
: base(property, description)
|
||||||
|
{
|
||||||
|
Order = order;
|
||||||
|
Name = name;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override string ToString()
|
||||||
|
{
|
||||||
|
var buffer = new StringBuilder();
|
||||||
|
|
||||||
|
buffer
|
||||||
|
.Append('<')
|
||||||
|
.Append(DisplayName)
|
||||||
|
.Append('>');
|
||||||
|
|
||||||
|
return buffer.ToString();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandParameterSchema
|
||||||
|
{
|
||||||
|
public static CommandParameterSchema? TryResolve(PropertyInfo property)
|
||||||
|
{
|
||||||
|
var attribute = property.GetCustomAttribute<CommandParameterAttribute>();
|
||||||
|
if (attribute == null)
|
||||||
|
return null;
|
||||||
|
|
||||||
|
return new CommandParameterSchema(
|
||||||
|
property,
|
||||||
|
attribute.Order,
|
||||||
|
attribute.Name,
|
||||||
|
attribute.Description
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
230
CliFx/Domain/CommandSchema.cs
Normal file
230
CliFx/Domain/CommandSchema.cs
Normal file
@@ -0,0 +1,230 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.IO;
|
||||||
|
using System.Linq;
|
||||||
|
using System.Reflection;
|
||||||
|
using System.Text;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
using CliFx.Exceptions;
|
||||||
|
using CliFx.Internal;
|
||||||
|
|
||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal partial class CommandSchema
|
||||||
|
{
|
||||||
|
public Type Type { get; }
|
||||||
|
|
||||||
|
public string? Name { get; }
|
||||||
|
|
||||||
|
public bool IsDefault => string.IsNullOrWhiteSpace(Name);
|
||||||
|
|
||||||
|
public string? Description { get; }
|
||||||
|
|
||||||
|
public IReadOnlyList<CommandParameterSchema> Parameters { get; }
|
||||||
|
|
||||||
|
public IReadOnlyList<CommandOptionSchema> Options { get; }
|
||||||
|
|
||||||
|
public CommandSchema(
|
||||||
|
Type type,
|
||||||
|
string? name,
|
||||||
|
string? description,
|
||||||
|
IReadOnlyList<CommandParameterSchema> parameters,
|
||||||
|
IReadOnlyList<CommandOptionSchema> options)
|
||||||
|
{
|
||||||
|
Type = type;
|
||||||
|
Name = name;
|
||||||
|
Description = description;
|
||||||
|
Options = options;
|
||||||
|
Parameters = parameters;
|
||||||
|
}
|
||||||
|
|
||||||
|
public bool MatchesName(string? name) => string.Equals(name, Name, StringComparison.OrdinalIgnoreCase);
|
||||||
|
|
||||||
|
private void InjectParameters(ICommand command, IReadOnlyList<string> parameterInputs)
|
||||||
|
{
|
||||||
|
// All inputs must be bound
|
||||||
|
var remainingParameterInputs = parameterInputs.ToList();
|
||||||
|
|
||||||
|
// Scalar parameters
|
||||||
|
var scalarParameters = Parameters
|
||||||
|
.OrderBy(p => p.Order)
|
||||||
|
.TakeWhile(p => p.IsScalar)
|
||||||
|
.ToArray();
|
||||||
|
|
||||||
|
for (var i = 0; i < scalarParameters.Length; i++)
|
||||||
|
{
|
||||||
|
var scalarParameter = scalarParameters[i];
|
||||||
|
|
||||||
|
var scalarParameterInput = i < parameterInputs.Count
|
||||||
|
? parameterInputs[i]
|
||||||
|
: throw new CliFxException($"Missing value for parameter <{scalarParameter.DisplayName}>.");
|
||||||
|
|
||||||
|
scalarParameter.Inject(command, scalarParameterInput);
|
||||||
|
remainingParameterInputs.Remove(scalarParameterInput);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Non-scalar parameter (only one is allowed)
|
||||||
|
var nonScalarParameter = Parameters
|
||||||
|
.OrderBy(p => p.Order)
|
||||||
|
.FirstOrDefault(p => !p.IsScalar);
|
||||||
|
|
||||||
|
if (nonScalarParameter != null)
|
||||||
|
{
|
||||||
|
var nonScalarParameterInputs = parameterInputs.Skip(scalarParameters.Length).ToArray();
|
||||||
|
nonScalarParameter.Inject(command, nonScalarParameterInputs);
|
||||||
|
remainingParameterInputs.Clear();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ensure all inputs were bound
|
||||||
|
if (remainingParameterInputs.Any())
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine("Unrecognized parameters provided:")
|
||||||
|
.AppendBulletList(remainingParameterInputs)
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void InjectOptions(
|
||||||
|
ICommand command,
|
||||||
|
IReadOnlyList<CommandOptionInput> optionInputs,
|
||||||
|
IReadOnlyDictionary<string, string> environmentVariables)
|
||||||
|
{
|
||||||
|
// All inputs must be bound
|
||||||
|
var remainingOptionInputs = optionInputs.ToList();
|
||||||
|
|
||||||
|
// All required options must be set
|
||||||
|
var unsetRequiredOptions = Options.Where(o => o.IsRequired).ToList();
|
||||||
|
|
||||||
|
// Environment variables
|
||||||
|
foreach (var environmentVariable in environmentVariables)
|
||||||
|
{
|
||||||
|
var option = Options.FirstOrDefault(o => o.MatchesEnvironmentVariableName(environmentVariable.Key));
|
||||||
|
|
||||||
|
if (option != null)
|
||||||
|
{
|
||||||
|
var values = option.IsScalar
|
||||||
|
? new[] {environmentVariable.Value}
|
||||||
|
: environmentVariable.Value.Split(Path.PathSeparator);
|
||||||
|
|
||||||
|
option.Inject(command, values);
|
||||||
|
unsetRequiredOptions.Remove(option);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: refactor this part? I wrote this while sick
|
||||||
|
// Direct input
|
||||||
|
foreach (var option in Options)
|
||||||
|
{
|
||||||
|
var inputs = optionInputs
|
||||||
|
.Where(i => option.MatchesNameOrShortName(i.Alias))
|
||||||
|
.ToArray();
|
||||||
|
|
||||||
|
if (inputs.Any())
|
||||||
|
{
|
||||||
|
option.Inject(command, inputs.SelectMany(i => i.Values).ToArray());
|
||||||
|
|
||||||
|
foreach (var input in inputs)
|
||||||
|
remainingOptionInputs.Remove(input);
|
||||||
|
|
||||||
|
unsetRequiredOptions.Remove(option);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ensure all required options were set
|
||||||
|
if (unsetRequiredOptions.Any())
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine("Missing values for some of the required options:")
|
||||||
|
.AppendBulletList(unsetRequiredOptions.Select(o => o.DisplayName))
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ensure all inputs were bound
|
||||||
|
if (remainingOptionInputs.Any())
|
||||||
|
{
|
||||||
|
throw new CliFxException(new StringBuilder()
|
||||||
|
.AppendLine("Unrecognized options provided:")
|
||||||
|
.AppendBulletList(remainingOptionInputs.Select(o => o.Alias).Distinct())
|
||||||
|
.ToString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public ICommand CreateInstance(
|
||||||
|
IReadOnlyList<string> parameterInputs,
|
||||||
|
IReadOnlyList<CommandOptionInput> optionInputs,
|
||||||
|
IReadOnlyDictionary<string, string> environmentVariables,
|
||||||
|
ITypeActivator activator)
|
||||||
|
{
|
||||||
|
var command = (ICommand) activator.CreateInstance(Type);
|
||||||
|
|
||||||
|
InjectParameters(command, parameterInputs);
|
||||||
|
InjectOptions(command, optionInputs, environmentVariables);
|
||||||
|
|
||||||
|
return command;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override string ToString()
|
||||||
|
{
|
||||||
|
var buffer = new StringBuilder();
|
||||||
|
|
||||||
|
if (!string.IsNullOrWhiteSpace(Name))
|
||||||
|
buffer.Append(Name);
|
||||||
|
|
||||||
|
foreach (var parameter in Parameters)
|
||||||
|
{
|
||||||
|
buffer.AppendIfNotEmpty(' ');
|
||||||
|
buffer.Append(parameter);
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach (var option in Options)
|
||||||
|
{
|
||||||
|
buffer.AppendIfNotEmpty(' ');
|
||||||
|
buffer.Append(option);
|
||||||
|
}
|
||||||
|
|
||||||
|
return buffer.ToString();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandSchema
|
||||||
|
{
|
||||||
|
public static bool IsCommandType(Type type) =>
|
||||||
|
type.Implements(typeof(ICommand)) &&
|
||||||
|
type.IsDefined(typeof(CommandAttribute)) &&
|
||||||
|
!type.IsAbstract &&
|
||||||
|
!type.IsInterface;
|
||||||
|
|
||||||
|
public static CommandSchema? TryResolve(Type type)
|
||||||
|
{
|
||||||
|
if (!IsCommandType(type))
|
||||||
|
return null;
|
||||||
|
|
||||||
|
var attribute = type.GetCustomAttribute<CommandAttribute>();
|
||||||
|
|
||||||
|
var parameters = type.GetProperties()
|
||||||
|
.Select(CommandParameterSchema.TryResolve)
|
||||||
|
.Where(p => p != null)
|
||||||
|
.ToArray();
|
||||||
|
|
||||||
|
var options = type.GetProperties()
|
||||||
|
.Select(CommandOptionSchema.TryResolve)
|
||||||
|
.Where(o => o != null)
|
||||||
|
.ToArray();
|
||||||
|
|
||||||
|
return new CommandSchema(
|
||||||
|
type,
|
||||||
|
attribute?.Name,
|
||||||
|
attribute?.Description,
|
||||||
|
parameters,
|
||||||
|
options
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandSchema
|
||||||
|
{
|
||||||
|
public static CommandSchema StubDefaultCommand { get; } =
|
||||||
|
new CommandSchema(null!, null, null, new CommandParameterSchema[0], new CommandOptionSchema[0]);
|
||||||
|
}
|
||||||
|
}
|
||||||
14
CliFx/Domain/CommandUnboundArgumentInput.cs
Normal file
14
CliFx/Domain/CommandUnboundArgumentInput.cs
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal class CommandUnboundArgumentInput
|
||||||
|
{
|
||||||
|
public string Value { get; }
|
||||||
|
|
||||||
|
public CommandUnboundArgumentInput(string value)
|
||||||
|
{
|
||||||
|
Value = value;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override string ToString() => Value;
|
||||||
|
}
|
||||||
|
}
|
||||||
332
CliFx/Domain/HelpTextWriter.cs
Normal file
332
CliFx/Domain/HelpTextWriter.cs
Normal file
@@ -0,0 +1,332 @@
|
|||||||
|
using System;
|
||||||
|
using System.Linq;
|
||||||
|
using CliFx.Internal;
|
||||||
|
|
||||||
|
namespace CliFx.Domain
|
||||||
|
{
|
||||||
|
internal class HelpTextWriter
|
||||||
|
{
|
||||||
|
private readonly ApplicationMetadata _metadata;
|
||||||
|
private readonly IConsole _console;
|
||||||
|
|
||||||
|
public HelpTextWriter(ApplicationMetadata metadata, IConsole console)
|
||||||
|
{
|
||||||
|
_metadata = metadata;
|
||||||
|
_console = console;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void Write(ApplicationSchema applicationSchema, CommandSchema command)
|
||||||
|
{
|
||||||
|
var column = 0;
|
||||||
|
var row = 0;
|
||||||
|
|
||||||
|
var childCommands = applicationSchema.GetChildCommands(command.Name);
|
||||||
|
|
||||||
|
bool IsEmpty() => column == 0 && row == 0;
|
||||||
|
|
||||||
|
void Render(string text)
|
||||||
|
{
|
||||||
|
_console.Output.Write(text);
|
||||||
|
|
||||||
|
column += text.Length;
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderNewLine()
|
||||||
|
{
|
||||||
|
_console.Output.WriteLine();
|
||||||
|
|
||||||
|
column = 0;
|
||||||
|
row++;
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderMargin(int lines = 1)
|
||||||
|
{
|
||||||
|
if (!IsEmpty())
|
||||||
|
{
|
||||||
|
for (var i = 0; i < lines; i++)
|
||||||
|
RenderNewLine();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderIndent(int spaces = 2)
|
||||||
|
{
|
||||||
|
Render(' '.Repeat(spaces));
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderColumnIndent(int spaces = 20, int margin = 2)
|
||||||
|
{
|
||||||
|
if (column + margin < spaces)
|
||||||
|
{
|
||||||
|
RenderIndent(spaces - column);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
Render(" ");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderWithColor(string text, ConsoleColor foregroundColor)
|
||||||
|
{
|
||||||
|
_console.WithForegroundColor(foregroundColor, () => Render(text));
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderHeader(string text)
|
||||||
|
{
|
||||||
|
RenderWithColor(text, ConsoleColor.Magenta);
|
||||||
|
RenderNewLine();
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderApplicationInfo()
|
||||||
|
{
|
||||||
|
if (!command.IsDefault)
|
||||||
|
return;
|
||||||
|
|
||||||
|
// Title and version
|
||||||
|
RenderWithColor(_metadata.Title, ConsoleColor.Yellow);
|
||||||
|
Render(" ");
|
||||||
|
RenderWithColor(_metadata.VersionText, ConsoleColor.Yellow);
|
||||||
|
RenderNewLine();
|
||||||
|
|
||||||
|
// Description
|
||||||
|
if (!string.IsNullOrWhiteSpace(_metadata.Description))
|
||||||
|
{
|
||||||
|
Render(_metadata.Description);
|
||||||
|
RenderNewLine();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderDescription()
|
||||||
|
{
|
||||||
|
if (string.IsNullOrWhiteSpace(command.Description))
|
||||||
|
return;
|
||||||
|
|
||||||
|
RenderMargin();
|
||||||
|
RenderHeader("Description");
|
||||||
|
|
||||||
|
RenderIndent();
|
||||||
|
Render(command.Description);
|
||||||
|
RenderNewLine();
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderUsage()
|
||||||
|
{
|
||||||
|
RenderMargin();
|
||||||
|
RenderHeader("Usage");
|
||||||
|
|
||||||
|
// Exe name
|
||||||
|
RenderIndent();
|
||||||
|
Render(_metadata.ExecutableName);
|
||||||
|
|
||||||
|
// Command name
|
||||||
|
if (!string.IsNullOrWhiteSpace(command.Name))
|
||||||
|
{
|
||||||
|
Render(" ");
|
||||||
|
RenderWithColor(command.Name, ConsoleColor.Cyan);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Child command placeholder
|
||||||
|
if (childCommands.Any())
|
||||||
|
{
|
||||||
|
Render(" ");
|
||||||
|
RenderWithColor("[command]", ConsoleColor.Cyan);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parameters
|
||||||
|
foreach (var parameter in command.Parameters)
|
||||||
|
{
|
||||||
|
Render(" ");
|
||||||
|
Render(parameter.IsScalar
|
||||||
|
? $"<{parameter.DisplayName}>"
|
||||||
|
: $"<{parameter.DisplayName}...>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Required options
|
||||||
|
var requiredOptionSchemas = command.Options
|
||||||
|
.Where(o => o.IsRequired)
|
||||||
|
.ToArray();
|
||||||
|
|
||||||
|
foreach (var option in requiredOptionSchemas)
|
||||||
|
{
|
||||||
|
Render(" ");
|
||||||
|
if (!string.IsNullOrWhiteSpace(option.Name))
|
||||||
|
{
|
||||||
|
RenderWithColor($"--{option.Name}", ConsoleColor.White);
|
||||||
|
Render(" ");
|
||||||
|
Render(option.IsScalar
|
||||||
|
? "<value>"
|
||||||
|
: "<values...>");
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
RenderWithColor($"-{option.ShortName}", ConsoleColor.White);
|
||||||
|
Render(" ");
|
||||||
|
Render(option.IsScalar
|
||||||
|
? "<value>"
|
||||||
|
: "<values...>");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Options placeholder
|
||||||
|
if (command.Options.Count != requiredOptionSchemas.Length)
|
||||||
|
{
|
||||||
|
Render(" ");
|
||||||
|
RenderWithColor("[options]", ConsoleColor.White);
|
||||||
|
}
|
||||||
|
|
||||||
|
RenderNewLine();
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderParameters()
|
||||||
|
{
|
||||||
|
if (!command.Parameters.Any())
|
||||||
|
return;
|
||||||
|
|
||||||
|
RenderMargin();
|
||||||
|
RenderHeader("Parameters");
|
||||||
|
|
||||||
|
var parameters = command.Parameters
|
||||||
|
.OrderBy(p => p.Order)
|
||||||
|
.ToArray();
|
||||||
|
|
||||||
|
foreach (var parameter in parameters)
|
||||||
|
{
|
||||||
|
RenderWithColor("* ", ConsoleColor.Red);
|
||||||
|
RenderWithColor($"{parameter.DisplayName}", ConsoleColor.White);
|
||||||
|
|
||||||
|
RenderColumnIndent();
|
||||||
|
|
||||||
|
// Description
|
||||||
|
if (!string.IsNullOrWhiteSpace(parameter.Description))
|
||||||
|
{
|
||||||
|
Render(parameter.Description);
|
||||||
|
}
|
||||||
|
|
||||||
|
RenderNewLine();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderOptions()
|
||||||
|
{
|
||||||
|
RenderMargin();
|
||||||
|
RenderHeader("Options");
|
||||||
|
|
||||||
|
var options = command.Options
|
||||||
|
.OrderByDescending(o => o.IsRequired)
|
||||||
|
.ToList();
|
||||||
|
|
||||||
|
// Add built-in options
|
||||||
|
options.Add(CommandOptionSchema.HelpOption);
|
||||||
|
if (command.IsDefault)
|
||||||
|
options.Add(CommandOptionSchema.VersionOption);
|
||||||
|
|
||||||
|
foreach (var option in options)
|
||||||
|
{
|
||||||
|
if (option.IsRequired)
|
||||||
|
{
|
||||||
|
RenderWithColor("* ", ConsoleColor.Red);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
RenderIndent();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Short name
|
||||||
|
if (option.ShortName != null)
|
||||||
|
{
|
||||||
|
RenderWithColor($"-{option.ShortName}", ConsoleColor.White);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delimiter
|
||||||
|
if (!string.IsNullOrWhiteSpace(option.Name) && option.ShortName != null)
|
||||||
|
{
|
||||||
|
Render("|");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Name
|
||||||
|
if (!string.IsNullOrWhiteSpace(option.Name))
|
||||||
|
{
|
||||||
|
RenderWithColor($"--{option.Name}", ConsoleColor.White);
|
||||||
|
}
|
||||||
|
|
||||||
|
RenderColumnIndent();
|
||||||
|
|
||||||
|
// Description
|
||||||
|
if (!string.IsNullOrWhiteSpace(option.Description))
|
||||||
|
{
|
||||||
|
Render(option.Description);
|
||||||
|
Render(" ");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Environment variable
|
||||||
|
if (!string.IsNullOrWhiteSpace(option.EnvironmentVariableName))
|
||||||
|
{
|
||||||
|
Render($"(Environment variable: {option.EnvironmentVariableName}).");
|
||||||
|
Render(" ");
|
||||||
|
}
|
||||||
|
|
||||||
|
RenderNewLine();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void RenderChildCommands()
|
||||||
|
{
|
||||||
|
if (!childCommands.Any())
|
||||||
|
return;
|
||||||
|
|
||||||
|
RenderMargin();
|
||||||
|
RenderHeader("Commands");
|
||||||
|
|
||||||
|
foreach (var childCommand in childCommands)
|
||||||
|
{
|
||||||
|
var relativeCommandName =
|
||||||
|
string.IsNullOrWhiteSpace(childCommand.Name) || string.IsNullOrWhiteSpace(command.Name)
|
||||||
|
? childCommand.Name
|
||||||
|
: childCommand.Name.Substring(command.Name.Length + 1);
|
||||||
|
|
||||||
|
// Name
|
||||||
|
RenderIndent();
|
||||||
|
RenderWithColor(relativeCommandName, ConsoleColor.Cyan);
|
||||||
|
|
||||||
|
// Description
|
||||||
|
if (!string.IsNullOrWhiteSpace(childCommand.Description))
|
||||||
|
{
|
||||||
|
RenderColumnIndent();
|
||||||
|
Render(childCommand.Description);
|
||||||
|
}
|
||||||
|
|
||||||
|
RenderNewLine();
|
||||||
|
}
|
||||||
|
|
||||||
|
RenderMargin();
|
||||||
|
|
||||||
|
// Child command help tip
|
||||||
|
Render("You can run `");
|
||||||
|
Render(_metadata.ExecutableName);
|
||||||
|
|
||||||
|
if (!string.IsNullOrWhiteSpace(command.Name))
|
||||||
|
{
|
||||||
|
Render(" ");
|
||||||
|
RenderWithColor(command.Name, ConsoleColor.Cyan);
|
||||||
|
}
|
||||||
|
|
||||||
|
Render(" ");
|
||||||
|
RenderWithColor("[command]", ConsoleColor.Cyan);
|
||||||
|
|
||||||
|
Render(" ");
|
||||||
|
RenderWithColor("--help", ConsoleColor.White);
|
||||||
|
|
||||||
|
Render("` to show help on a specific command.");
|
||||||
|
|
||||||
|
RenderNewLine();
|
||||||
|
}
|
||||||
|
|
||||||
|
_console.ResetColor();
|
||||||
|
RenderApplicationInfo();
|
||||||
|
RenderDescription();
|
||||||
|
RenderUsage();
|
||||||
|
RenderParameters();
|
||||||
|
RenderOptions();
|
||||||
|
RenderChildCommands();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,12 +5,12 @@ namespace CliFx.Exceptions
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Domain exception thrown within CliFx.
|
/// Domain exception thrown within CliFx.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public abstract class CliFxException : Exception
|
public class CliFxException : Exception
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initializes an instance of <see cref="CliFxException"/>.
|
/// Initializes an instance of <see cref="CliFxException"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
protected CliFxException(string message)
|
public CliFxException(string? message)
|
||||||
: base(message)
|
: base(message)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
@@ -18,7 +18,7 @@ namespace CliFx.Exceptions
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initializes an instance of <see cref="CliFxException"/>.
|
/// Initializes an instance of <see cref="CliFxException"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
protected CliFxException(string message, Exception innerException)
|
public CliFxException(string? message, Exception? innerException)
|
||||||
: base(message, innerException)
|
: base(message, innerException)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
using System;
|
using System;
|
||||||
using CliFx.Internal;
|
|
||||||
|
|
||||||
namespace CliFx.Exceptions
|
namespace CliFx.Exceptions
|
||||||
{
|
{
|
||||||
@@ -8,7 +7,7 @@ namespace CliFx.Exceptions
|
|||||||
/// Use this exception if you want to report an error that occured during execution of a command.
|
/// Use this exception if you want to report an error that occured during execution of a command.
|
||||||
/// This exception also allows specifying exit code which will be returned to the calling process.
|
/// This exception also allows specifying exit code which will be returned to the calling process.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class CommandException : CliFxException
|
public class CommandException : Exception
|
||||||
{
|
{
|
||||||
private const int DefaultExitCode = -100;
|
private const int DefaultExitCode = -100;
|
||||||
|
|
||||||
@@ -20,16 +19,18 @@ namespace CliFx.Exceptions
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initializes an instance of <see cref="CommandException"/>.
|
/// Initializes an instance of <see cref="CommandException"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public CommandException(string message, Exception innerException, int exitCode = DefaultExitCode)
|
public CommandException(string? message, Exception? innerException, int exitCode = DefaultExitCode)
|
||||||
: base(message, innerException)
|
: base(message, innerException)
|
||||||
{
|
{
|
||||||
ExitCode = exitCode.GuardNotZero(nameof(exitCode));
|
ExitCode = exitCode != 0
|
||||||
|
? exitCode
|
||||||
|
: throw new ArgumentException("Exit code must not be zero in order to signify failure.");
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Initializes an instance of <see cref="CommandException"/>.
|
/// Initializes an instance of <see cref="CommandException"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public CommandException(string message, int exitCode = DefaultExitCode)
|
public CommandException(string? message, int exitCode = DefaultExitCode)
|
||||||
: this(message, null, exitCode)
|
: this(message, null, exitCode)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,26 +0,0 @@
|
|||||||
using System;
|
|
||||||
|
|
||||||
namespace CliFx.Exceptions
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Thrown when a command option can't be converted to target type specified in its schema.
|
|
||||||
/// </summary>
|
|
||||||
public class InvalidCommandOptionInputException : CliFxException
|
|
||||||
{
|
|
||||||
/// <summary>
|
|
||||||
/// Initializes an instance of <see cref="InvalidCommandOptionInputException"/>.
|
|
||||||
/// </summary>
|
|
||||||
public InvalidCommandOptionInputException(string message)
|
|
||||||
: base(message)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Initializes an instance of <see cref="InvalidCommandOptionInputException"/>.
|
|
||||||
/// </summary>
|
|
||||||
public InvalidCommandOptionInputException(string message, Exception innerException)
|
|
||||||
: base(message, innerException)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user