File: ParserTests\MiscTests.cs
Web Access
Project: ..\..\..\test\Microsoft.TemplateEngine.Cli.UnitTests\Microsoft.TemplateEngine.Cli.UnitTests.csproj (Microsoft.TemplateEngine.Cli.UnitTests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.CommandLine;
using System.CommandLine.Completions;
using System.CommandLine.Help;
using System.CommandLine.Parsing;
using Microsoft.TemplateEngine.Cli.Commands;
using Microsoft.TemplateEngine.TestHelper;
 
namespace Microsoft.TemplateEngine.Cli.UnitTests.ParserTests
{
    public class MiscTests : BaseTest
    {
        /// <summary>
        /// This test checks if help aliases are in sync with System.CommandLine.
        /// </summary>
        [Fact]
        public void KnownHelpAliasesAreCorrect()
        {
            var result = new RootCommand().Parse(Constants.KnownHelpAliases[0]);
 
            Option helpOption = result.CommandResult
                .Children
                .OfType<OptionResult>()
                .Select(r => r.Option)
                .Where(o => o is HelpOption)
                .Single();
 
            var aliases = new[] { helpOption.Name }.Concat(helpOption.Aliases);
 
            Assert.Equal(aliases.OrderBy(a => a), TemplateCommand.KnownHelpAliases.OrderBy(a => a));
        }
 
        /// <summary>
        /// This test check if default completion item comparer compares the instances using labels only.
        /// </summary>
        [Fact]
        public void CompletionItemCompareIsAsExpected()
        {
            Assert.Equal(
                new CompletionItem("my-label", kind: "Value", sortText: "sort-text", insertText: "insert-text", documentation: "doc", detail: "det"),
                new CompletionItem("my-label", kind: "Value", sortText: "sort-text", insertText: "insert-text", documentation: "doc", detail: "det"));
 
            Assert.Equal(
              new CompletionItem("my-label", kind: "Value", sortText: "sort-text1", insertText: "insert-text1", documentation: "doc1", detail: "det1"),
              new CompletionItem("my-label", kind: "Value", sortText: "sort-text2", insertText: "insert-text2", documentation: "doc2", detail: "det2"));
 
            Assert.NotEqual(
                 new CompletionItem("my-label", kind: "Value", sortText: "sort-text1", insertText: "insert-text1", documentation: "doc1", detail: "det1"),
                 new CompletionItem("my-label", kind: "Argument", sortText: "sort-text2", insertText: "insert-text2", documentation: "doc2", detail: "det2"));
 
        }
 
        [Theory]
        [InlineData("new --debug:attach", "--debug:attach")]
        [InlineData("new --debug:attach console", "--debug:attach")]
        [InlineData("new --debug:reinit", "--debug:reinit")]
        [InlineData("new --debug:ephemeral-hive", "--debug:ephemeral-hive")]
        [InlineData("new --debug:virtual-hive", "--debug:ephemeral-hive")]
        [InlineData("new --debug:rebuildcache", "--debug:rebuild-cache")]
        [InlineData("new --debug:rebuild-cache", "--debug:rebuild-cache")]
        [InlineData("new --debug:show-config", "--debug:show-config")]
        [InlineData("new --debug:showconfig", "--debug:show-config")]
 
        public void DebugFlagCanBeParsedOnNewLevel(string command, string option)
        {
            Dictionary<string, Func<GlobalArgs, bool>> optionsMap = new()
            {
                { "--debug:attach", args => args.DebugAttach },
                { "--debug:ephemeral-hive", args => args.DebugVirtualizeSettings },
                { "--debug:reinit", args => args.DebugReinit },
                { "--debug:rebuild-cache", args => args.DebugRebuildCache },
                { "--debug:show-config", args => args.DebugShowConfig }
            };
 
            ICliTemplateEngineHost host = CliTestHostFactory.GetVirtualHost(additionalComponents: BuiltInTemplatePackagesProviderFactory.GetComponents(RepoTemplatePackages));
            NewCommand myCommand = (NewCommand)NewCommandFactory.Create("new", _ => host);
            ParseResult parseResult = ParserFactory.CreateParser(myCommand).Parse(command);
            NewCommandArgs args = new(myCommand, parseResult);
 
            Assert.True(optionsMap[option](args));
        }
 
        [Theory]
        [InlineData("new install source --debug:attach", "--debug:attach")]
        [InlineData("new install source --debug:attach --add-source s1", "--debug:attach")]
        [InlineData("new install --debug:reinit source", "--debug:reinit")]
        [InlineData("new install source --debug:ephemeral-hive", "--debug:ephemeral-hive")]
        [InlineData("new install source --debug:virtual-hive", "--debug:ephemeral-hive")]
        [InlineData("new install source --debug:rebuildcache", "--debug:rebuild-cache")]
        [InlineData("new install source --debug:rebuild-cache", "--debug:rebuild-cache")]
        [InlineData("new install source --debug:show-config", "--debug:show-config")]
        [InlineData("new install source --debug:showconfig", "--debug:show-config")]
 
        public void DebugFlagCanBeParsedOnSubcommandLevel(string command, string option)
        {
            Dictionary<string, Func<GlobalArgs, bool>> optionsMap = new()
            {
                { "--debug:attach", args => args.DebugAttach },
                { "--debug:ephemeral-hive", args => args.DebugVirtualizeSettings },
                { "--debug:reinit", args => args.DebugReinit },
                { "--debug:rebuild-cache", args => args.DebugRebuildCache },
                { "--debug:show-config", args => args.DebugShowConfig }
            };
 
            ICliTemplateEngineHost host = CliTestHostFactory.GetVirtualHost(additionalComponents: BuiltInTemplatePackagesProviderFactory.GetComponents(RepoTemplatePackages));
            NewCommand myCommand = (NewCommand)NewCommandFactory.Create("new", _ => host);
            ParseResult parseResult = ParserFactory.CreateParser(myCommand).Parse(command);
            InstallCommandArgs args = new((InstallCommand)parseResult.CommandResult.Command, parseResult);
 
            Assert.True(optionsMap[option](args));
        }
 
        [Theory]
        [InlineData("new console  --framework net5.0 --flag --debug:attach", "--debug:attach")]
        [InlineData("new console --framework net5.0 --debug:attach --flag", "--debug:attach")]
        [InlineData("new console --debug:reinit --framework net5.0 --flag", "--debug:reinit")]
        [InlineData("new console --framework net5.0 --debug:ephemeral-hive --flag", "--debug:ephemeral-hive")]
        [InlineData("new console --framework net5.0 --debug:virtual-hive --flag", "--debug:ephemeral-hive")]
        [InlineData("new console --framework net5.0 --debug:rebuildcache --flag", "--debug:rebuild-cache")]
        [InlineData("new console --framework net5.0 --debug:rebuild-cache --flag", "--debug:rebuild-cache")]
        [InlineData("new console --framework net5.0 --debug:show-config --flag", "--debug:show-config")]
        [InlineData("new console --framework net5.0 --debug:showconfig --flag", "--debug:show-config")]
 
        public void DebugFlagCanBeParsedOnTemplateSubcommandLevel(string command, string option)
        {
            Dictionary<string, Func<GlobalArgs, bool>> optionsMap = new()
            {
                { "--debug:attach", args => args.DebugAttach },
                { "--debug:ephemeral-hive", args => args.DebugVirtualizeSettings },
                { "--debug:reinit", args => args.DebugReinit },
                { "--debug:rebuild-cache", args => args.DebugRebuildCache },
                { "--debug:show-config", args => args.DebugShowConfig }
            };
 
            ICliTemplateEngineHost host = CliTestHostFactory.GetVirtualHost(additionalComponents: BuiltInTemplatePackagesProviderFactory.GetComponents(RepoTemplatePackages));
            NewCommand myCommand = (NewCommand)NewCommandFactory.Create("new", _ => host);
            ParseResult parseResult = myCommand.Parse(command);
            InstantiateCommandArgs args = InstantiateCommandArgs.FromNewCommandArgs(new NewCommandArgs(myCommand, parseResult));
 
            Assert.True(optionsMap[option](args));
            Assert.Equal("console", args.ShortName);
            Assert.Equal(new[] { "--framework", "net5.0", "--flag" }, args.RemainingArguments);
        }
 
        [Fact]
        public void ManuallyAddedOptionIsPreservedOnTemplateSubcommandLevel()
        {
            ICliTemplateEngineHost host = CliTestHostFactory.GetVirtualHost(additionalComponents: BuiltInTemplatePackagesProviderFactory.GetComponents(RepoTemplatePackages));
            NewCommand myCommand = (NewCommand)NewCommandFactory.Create("new", _ => host);
 
            var customOption = new Option<string>("--newOption")
            {
                Recursive = true
            };
            myCommand.Options.Add(customOption);
 
            ParseResult parseResult = myCommand.Parse("new console --newOption val");
            InstantiateCommandArgs args = InstantiateCommandArgs.FromNewCommandArgs(new NewCommandArgs(myCommand, parseResult));
 
            Assert.NotNull(args.ParseResult);
            Assert.Equal("console", args.ShortName);
            Assert.Empty(args.RemainingArguments);
            Assert.Equal("val", args.ParseResult.GetValue(customOption));
        }
 
        [Theory]
        [InlineData("new --output test console", "test")]
        [InlineData("new console --output test", "test")]
        [InlineData("new -o test console", "test")]
        [InlineData("new console -o test", "test")]
        [InlineData("new console --framework net6.0 --output test", "test")]
        [InlineData("--output test new console", null)]
        public void CanParseOutputOption(string command, string? expected)
        {
            ICliTemplateEngineHost host = CliTestHostFactory.GetVirtualHost(additionalComponents: BuiltInTemplatePackagesProviderFactory.GetComponents(RepoTemplatePackages));
 
            RootCommand rootCommand = new();
 
            NewCommand myCommand = (NewCommand)NewCommandFactory.Create("new", _ => host);
            rootCommand.Add(myCommand);
 
            ParseResult parseResult = rootCommand.Parse(command);
            Assert.Equal(expected, parseResult.GetValue(SharedOptions.OutputOption)?.Name);
        }
 
        [Theory]
        [InlineData("new --project $filePath console", "$filePath")]
        [InlineData("new console --project $filePath", "$filePath")]
        [InlineData("new console --framework net6.0 --project $filePath", "$filePath")]
        [InlineData("--project $filePath new console", null)]
        public void CanParseProjectOption(string command, string? expected)
        {
            ICliTemplateEngineHost host = CliTestHostFactory.GetVirtualHost(additionalComponents: BuiltInTemplatePackagesProviderFactory.GetComponents(RepoTemplatePackages));
 
            RootCommand rootCommand = new();
 
            NewCommand myCommand = (NewCommand)NewCommandFactory.Create("new", _ => host);
            rootCommand.Add(myCommand);
 
            // ProjectPathOption uses AcceptExistingOnly validator, so the provided file has to exist!
            string existingFilePath = typeof(object).Assembly.Location;
            command = command.Replace("$filePath", $"\"{existingFilePath}\"");
            expected = expected?.Replace("$filePath", Path.GetFileName(existingFilePath));
 
            ParseResult parseResult = rootCommand.Parse(command);
            Assert.Equal(expected, parseResult.GetValue(SharedOptions.ProjectPathOption)?.Name);
        }
    }
}