CliFx/CliFx.Tests/CliApplicationTests.cs

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using CliFx.Attributes;
using CliFx.Exceptions;
using CliFx.Services;
using FluentAssertions;
using NUnit.Framework;

namespace CliFx.Tests
{
    public partial class CliApplicationTests
    {
        [Command]
        private class TestDefaultCommand : ICommand
        {
            public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
        }

        [Command("command")]
        private class TestNamedCommand : ICommand
        {
            public Task ExecuteAsync(IConsole console) => Task.CompletedTask;
        }

        [Command("faulty command")]
        private class TestFaultyCommand : ICommand
        {
            public Task ExecuteAsync(IConsole console) => Task.FromException(new CommandException(-1337));
        }
    }

    [TestFixture]
    public partial class CliApplicationTests
    {
        private static IEnumerable<TestCaseData> GetTestCases_RunAsync()
        {
            // Specified command is defined

            yield return new TestCaseData(
                new[] {typeof(TestNamedCommand)},
                new[] {"command"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestNamedCommand)},
                new[] {"command", "--help"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestNamedCommand)},
                new[] {"command", "-h"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestNamedCommand)},
                new[] {"command", "-?"}
            );


            // Default command is defined

            yield return new TestCaseData(
                new[] {typeof(TestDefaultCommand)},
                new string[0]
            );

            yield return new TestCaseData(
                new[] {typeof(TestDefaultCommand)},
                new[] {"--version"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestDefaultCommand)},
                new[] {"--help"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestDefaultCommand)},
                new[] {"-h"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestDefaultCommand)},
                new[] {"-?"}
            );

            // Default command is not defined

            yield return new TestCaseData(
                new[] {typeof(TestNamedCommand)},
                new string[0]
            );

            yield return new TestCaseData(
                new[] {typeof(TestNamedCommand)},
                new[] {"--version"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestNamedCommand)},
                new[] {"--help"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestNamedCommand)},
                new[] {"-h"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestNamedCommand)},
                new[] {"-?"}
            );

            // Specified a faulty command

            yield return new TestCaseData(
                new[] {typeof(TestFaultyCommand)},
                new[] {"faulty", "command", "--help"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestFaultyCommand)},
                new[] {"faulty", "command", "-h"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestFaultyCommand)},
                new[] {"faulty", "command", "-?"}
            );
        }

        private static IEnumerable<TestCaseData> GetTestCases_RunAsync_Negative()
        {
            // No commands defined

            yield return new TestCaseData(
                new Type[0],
                new string[0]
            );

            yield return new TestCaseData(
                new Type[0],
                new[] {"--version"}
            );

            yield return new TestCaseData(
                new Type[0],
                new[] {"--help"}
            );

            yield return new TestCaseData(
                new Type[0],
                new[] {"-h"}
            );

            yield return new TestCaseData(
                new Type[0],
                new[] {"-?"}
            );

            yield return new TestCaseData(
                new Type[0],
                new[] {"command"}
            );

            yield return new TestCaseData(
                new Type[0],
                new[] {"faulty", "command"}
            );

            // Specified command is not defined

            yield return new TestCaseData(
                new[] {typeof(TestDefaultCommand)},
                new[] {"command"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestDefaultCommand)},
                new[] {"command", "--help"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestDefaultCommand)},
                new[] {"command", "-h"}
            );

            yield return new TestCaseData(
                new[] {typeof(TestDefaultCommand)},
                new[] {"command", "-?"}
            );

            // Specified a faulty command

            yield return new TestCaseData(
                new[] {typeof(TestFaultyCommand)},
                new[] {"faulty", "command"}
            );
        }

        [Test]
        [TestCaseSource(nameof(GetTestCases_RunAsync))]
        public async Task RunAsync_Test(IReadOnlyList<Type> commandTypes, IReadOnlyList<string> commandLineArguments)
        {
            // Arrange
            var application = new CliApplicationBuilder().WithCommands(commandTypes).Build();

            // Act
            var exitCodeValue = await application.RunAsync(commandLineArguments);

            // Assert
            exitCodeValue.Should().Be(0);
        }

        [Test]
        [TestCaseSource(nameof(GetTestCases_RunAsync_Negative))]
        public async Task RunAsync_Negative_Test(IReadOnlyList<Type> commandTypes, IReadOnlyList<string> commandLineArguments)
        {
            // Arrange
            var application = new CliApplicationBuilder().WithCommands(commandTypes).Build();

            // Act
            var exitCodeValue = await application.RunAsync(commandLineArguments);

            // Assert
            exitCodeValue.Should().NotBe(0);
        }
    }
}