Mirrors/CliFx
1
0
Fork 0
mirror of https://github.com/Tyrrrz/CliFx.git synced 2025-10-25 15:19:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor

Browse Source
This commit is contained in:
Alexey Golub
2019-06-29 22:02:41 +03:00
parent 79cf994386
commit 74ee927498
10 changed files with 60 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
CliFx.Tests/CliApplicationTests.cs
View File

@@ -1,8 +1,6 @@
using System.Collections.Generic;
using System.Threading.Tasks;
using System.Threading.Tasks;
using CliFx.Services;
using CliFx.Tests.TestObjects;
using Moq;
using NUnit.Framework;
namespace CliFx.Tests
@@ -17,11 +15,13 @@ namespace CliFx.Tests
var command = new TestCommand();
var expectedExitCode = await command.ExecuteAsync();
var commandResolverMock = new Mock<ICommandResolver>();
commandResolverMock.Setup(m => m.ResolveCommand(It.IsAny<IReadOnlyList<string>>())).Returns(command);
var commandResolver = commandResolverMock.Object;
var commandOptionParser = new CommandOptionParser();
var application = new CliApplication(commandResolver);
var typeProvider = new TypeProvider(typeof(TestCommand));
var commandOptionConverter = new CommandOptionConverter();
var commandResolver = new CommandResolver(typeProvider, commandOptionConverter);
var application = new CliApplication(commandOptionParser, commandResolver);
// Act
var exitCodeValue = await application.RunAsync();

7
CliFx.Tests/CliFx.Tests.csproj
View File

@@ -8,10 +8,9 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.0.1" />
<PackageReference Include="NUnit" Version="3.11.0" />
<PackageReference Include="NUnit3TestAdapter" Version="3.11.0" />
<PackageReference Include="Moq" Version="4.11.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" />
<PackageReference Include="NUnit" Version="3.12.0" />
<PackageReference Include="NUnit3TestAdapter" Version="3.13.0" />
<PackageReference Include="CliWrap" Version="2.3.0" />
</ItemGroup>

13
CliFx.Tests/CommandOptionConverterTests.cs
View File

@@ -11,7 +11,7 @@ namespace CliFx.Tests
[TestFixture]
public class CommandOptionConverterTests
{
private static IEnumerable<TestCaseData> GetData_ConvertOption()
private static IEnumerable<TestCaseData> GetTestCases_ConvertOption()
{
yield return new TestCaseData(
new CommandOption("option", "value"),
@@ -171,7 +171,7 @@ namespace CliFx.Tests
}
[Test]
[TestCaseSource(nameof(GetData_ConvertOption))]
[TestCaseSource(nameof(GetTestCases_ConvertOption))]
public void ConvertOption_Test(CommandOption option, Type targetType, object expectedConvertedValue)
{
// Arrange
@@ -181,10 +181,13 @@ namespace CliFx.Tests
var convertedValue = converter.ConvertOption(option, targetType);
// Assert
Assert.That(convertedValue, Is.EqualTo(expectedConvertedValue));
Assert.Multiple(() =>
{
Assert.That(convertedValue, Is.EqualTo(expectedConvertedValue));
if (convertedValue != null)
Assert.That(convertedValue, Is.AssignableTo(targetType));
if (convertedValue != null)
Assert.That(convertedValue, Is.AssignableTo(targetType));
});
}
}
}

25
CliFx.Tests/CommandOptionParserTests.cs
View File

@@ -8,7 +8,7 @@ namespace CliFx.Tests
[TestFixture]
public class CommandOptionParserTests
{
private static IEnumerable<TestCaseData> GetData_ParseOptions()
private static IEnumerable<TestCaseData> GetTestCases_ParseOptions()
{
yield return new TestCaseData(new string[0], CommandOptionSet.Empty);
@@ -154,7 +154,7 @@ namespace CliFx.Tests
}
[Test]
[TestCaseSource(nameof(GetData_ParseOptions))]
[TestCaseSource(nameof(GetTestCases_ParseOptions))]
public void ParseOptions_Test(IReadOnlyList<string> commandLineArguments, CommandOptionSet expectedCommandOptionSet)
{
// Arrange
@@ -164,17 +164,20 @@ namespace CliFx.Tests
var optionSet = parser.ParseOptions(commandLineArguments);
// Assert
Assert.That(optionSet.CommandName, Is.EqualTo(expectedCommandOptionSet.CommandName), "Command name");
Assert.That(optionSet.Options.Count, Is.EqualTo(expectedCommandOptionSet.Options.Count), "Option count");
for (var i = 0; i < optionSet.Options.Count; i++)
Assert.Multiple(() =>
{
Assert.That(optionSet.Options[i].Name, Is.EqualTo(expectedCommandOptionSet.Options[i].Name),
$"Option[{i}] name");
Assert.That(optionSet.CommandName, Is.EqualTo(expectedCommandOptionSet.CommandName), "Command name");
Assert.That(optionSet.Options.Count, Is.EqualTo(expectedCommandOptionSet.Options.Count), "Option count");
Assert.That(optionSet.Options[i].Values, Is.EqualTo(expectedCommandOptionSet.Options[i].Values),
$"Option[{i}] values");
}
for (var i = 0; i < optionSet.Options.Count; i++)
{
Assert.That(optionSet.Options[i].Name, Is.EqualTo(expectedCommandOptionSet.Options[i].Name),
$"Option[{i}] name");
Assert.That(optionSet.Options[i].Values, Is.EqualTo(expectedCommandOptionSet.Options[i].Values),
$"Option[{i}] values");
}
});
}
}
}

48
CliFx.Tests/CommandResolverTests.cs
View File

@@ -3,7 +3,6 @@ using CliFx.Exceptions;
using CliFx.Models;
using CliFx.Services;
using CliFx.Tests.TestObjects;
using Moq;
using NUnit.Framework;
namespace CliFx.Tests
@@ -11,7 +10,7 @@ namespace CliFx.Tests
[TestFixture]
public class CommandResolverTests
{
private static IEnumerable<TestCaseData> GetData_ResolveCommand()
private static IEnumerable<TestCaseData> GetTestCases_ResolveCommand()
{
yield return new TestCaseData(
new CommandOptionSet(new[]
@@ -48,34 +47,28 @@ namespace CliFx.Tests
}
[Test]
[TestCaseSource(nameof(GetData_ResolveCommand))]
[TestCaseSource(nameof(GetTestCases_ResolveCommand))]
public void ResolveCommand_Test(CommandOptionSet commandOptionSet, TestCommand expectedCommand)
{
// Arrange
var commandTypes = new[] {typeof(TestCommand)};
var typeProviderMock = new Mock<ITypeProvider>();
typeProviderMock.Setup(m => m.GetTypes()).Returns(commandTypes);
var typeProvider = typeProviderMock.Object;
var optionParserMock = new Mock<ICommandOptionParser>();
optionParserMock.Setup(m => m.ParseOptions(It.IsAny<IReadOnlyList<string>>())).Returns(commandOptionSet);
var optionParser = optionParserMock.Object;
var typeProvider = new TypeProvider(typeof(TestCommand));
var optionConverter = new CommandOptionConverter();
var resolver = new CommandResolver(typeProvider, optionParser, optionConverter);
var resolver = new CommandResolver(typeProvider, optionConverter);
// Act
var command = resolver.ResolveCommand() as TestCommand;
var command = resolver.ResolveCommand(commandOptionSet) as TestCommand;
// Assert
Assert.That(command, Is.Not.Null);
Assert.That(command.StringOption, Is.EqualTo(expectedCommand.StringOption), nameof(command.StringOption));
Assert.That(command.IntOption, Is.EqualTo(expectedCommand.IntOption), nameof(command.IntOption));
Assert.Multiple(() =>
{
Assert.That(command, Is.Not.Null);
Assert.That(command.StringOption, Is.EqualTo(expectedCommand.StringOption), nameof(command.StringOption));
Assert.That(command.IntOption, Is.EqualTo(expectedCommand.IntOption), nameof(command.IntOption));
});
}
private static IEnumerable<TestCaseData> GetData_ResolveCommand_IsRequired()
private static IEnumerable<TestCaseData> GetTestCases_ResolveCommand_IsRequired()
{
yield return new TestCaseData(CommandOptionSet.Empty);
@@ -88,26 +81,17 @@ namespace CliFx.Tests
}
[Test]
[TestCaseSource(nameof(GetData_ResolveCommand_IsRequired))]
[TestCaseSource(nameof(GetTestCases_ResolveCommand_IsRequired))]
public void ResolveCommand_IsRequired_Test(CommandOptionSet commandOptionSet)
{
// Arrange
var commandTypes = new[] {typeof(TestCommand)};
var typeProviderMock = new Mock<ITypeProvider>();
typeProviderMock.Setup(m => m.GetTypes()).Returns(commandTypes);
var typeProvider = typeProviderMock.Object;
var optionParserMock = new Mock<ICommandOptionParser>();
optionParserMock.Setup(m => m.ParseOptions(It.IsAny<IReadOnlyList<string>>())).Returns(commandOptionSet);
var optionParser = optionParserMock.Object;
var typeProvider = new TypeProvider(typeof(TestCommand));
var optionConverter = new CommandOptionConverter();
var resolver = new CommandResolver(typeProvider, optionParser, optionConverter);
var resolver = new CommandResolver(typeProvider, optionConverter);
// Act & Assert
Assert.Throws<CommandResolveException>(() => resolver.ResolveCommand());
Assert.Throws<CommandResolveException>(() => resolver.ResolveCommand(commandOptionSet));
}
}
}

16
CliFx/CliApplication.cs
View File

@@ -7,25 +7,26 @@ namespace CliFx
{
public partial class CliApplication : ICliApplication
{
private readonly ICommandOptionParser _commandOptionParser;
private readonly ICommandResolver _commandResolver;
public CliApplication(ICommandResolver commandResolver)
public CliApplication(ICommandOptionParser commandOptionParser, ICommandResolver commandResolver)
{
_commandOptionParser = commandOptionParser;
_commandResolver = commandResolver;
}
public CliApplication()
: this(GetDefaultCommandResolver(Assembly.GetCallingAssembly()))
: this(new CommandOptionParser(), GetDefaultCommandResolver(Assembly.GetCallingAssembly()))
{
}
public async Task<int> RunAsync(IReadOnlyList<string> commandLineArguments)
{
// Resolve and execute command
var command = _commandResolver.ResolveCommand(commandLineArguments);
var exitCode = await command.ExecuteAsync();
var optionSet = _commandOptionParser.ParseOptions(commandLineArguments);
var command = _commandResolver.ResolveCommand(optionSet);
// TODO: print message if error?
var exitCode = await command.ExecuteAsync();
return exitCode.Value;
}
@@ -36,10 +37,9 @@ namespace CliFx
private static ICommandResolver GetDefaultCommandResolver(Assembly assembly)
{
var typeProvider = TypeProvider.FromAssembly(assembly);
var commandOptionParser = new CommandOptionParser();
var commandOptionConverter = new CommandOptionConverter();
return new CommandResolver(typeProvider, commandOptionParser, commandOptionConverter);
return new CommandResolver(typeProvider, commandOptionConverter);
}
}
}

9
CliFx/Services/CommandResolver.cs
View File

@@ -11,14 +11,11 @@ namespace CliFx.Services
public class CommandResolver : ICommandResolver
{
private readonly ITypeProvider _typeProvider;
private readonly ICommandOptionParser _commandOptionParser;
private readonly ICommandOptionConverter _commandOptionConverter;
public CommandResolver(ITypeProvider typeProvider,
ICommandOptionParser commandOptionParser, ICommandOptionConverter commandOptionConverter)
public CommandResolver(ITypeProvider typeProvider, ICommandOptionConverter commandOptionConverter)
{
_typeProvider = typeProvider;
_commandOptionParser = commandOptionParser;
_commandOptionConverter = commandOptionConverter;
}
@@ -71,10 +68,8 @@ namespace CliFx.Services
$"Apply {nameof(CommandAttribute)} to give command a name.");
}
public Command ResolveCommand(IReadOnlyList<string> commandLineArguments)
public Command ResolveCommand(CommandOptionSet optionSet)
{
var optionSet = _commandOptionParser.ParseOptions(commandLineArguments);
// Get command type
var commandType = !optionSet.CommandName.IsNullOrWhiteSpace()
? GetCommandType(optionSet.CommandName)

7
CliFx/Services/Extensions.cs
View File

@@ -1,7 +0,0 @@
namespace CliFx.Services
{
public static class Extensions
{
public static Command ResolveCommand(this ICommandResolver commandResolver) => commandResolver.ResolveCommand(new string[0]);
}
}

4
CliFx/Services/ICommandResolver.cs
View File

@@ -1,9 +1,9 @@
using System.Collections.Generic;
using CliFx.Models;
namespace CliFx.Services
{
public interface ICommandResolver
{
Command ResolveCommand(IReadOnlyList<string> commandLineArguments);
Command ResolveCommand(CommandOptionSet optionSet);
}
}

1
Readme.md
View File

@@ -26,7 +26,6 @@ To be added with a stable release...
## Libraries used
- [Moq](https://github.com/Moq/moq4)
- [NUnit](https://github.com/nunit/nunit)
## Donate