sqltoolsservice/test/Microsoft.SqlTools.ServiceLayer.UnitTests/Utility/CommandOptionsTests.cs

//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//

using System.IO;
using Microsoft.SqlTools.ServiceLayer.Utility;
using Xunit;

namespace Microsoft.SqlTools.ServiceLayer.UnitTests.Utility
{
    /// <summary>
    /// Tests for the CommandOptions class
    /// </summary>
    public class CommandOptionsTests
    {

        [Fact]
        public void UsageIsShownWhenHelpFlagProvided()
        {
            var args = new string[] {"--help"};
            ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);
            Assert.NotNull(options);

            Assert.True(options.ShouldExit);
            Assert.Equal(options.Locale, string.Empty);
        }

        [Fact]
        public void UsageIsShownWhenBadArgumentsProvided()
        {
            var args = new string[] {"--unknown-argument", "/bad-argument"};
            ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);
            Assert.NotNull(options);

            Assert.True(options.ShouldExit);
            Assert.Equal(options.Locale, string.Empty);
        }

        [Fact]
        public void DefaultValuesAreUsedWhenNoArgumentsAreProvided()
        {
            int? testNo = 1;
            // Test 1: All defaults, no options specified
            {
                var args = new string[] { };
                ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);
                VerifyCommandOptions(options, testNo++);
            }
            // Test 2: All defaults, -logDir as  null 
            {
                var args = new string[] { "--log-dir", null };
                ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);
                VerifyCommandOptions(options, testNo++);
            }
            // Test 3: All defaults, -logDir as  empty string 
            {
                var args = new string[] { "--log-dir", string.Empty };
                ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);
                VerifyCommandOptions(options, testNo++);
            }
            // Test 4: All defaults, -log-file as  null 
            {
                var args = new string[] { "--log-file", null };
                ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);
                VerifyCommandOptions(options, testNo++, logFilePath: null);
            }
            // Test 5: All defaults, -log-file as  empty string 
            {
                var args = new string[] { "--log-file", string.Empty };
                ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);
                VerifyCommandOptions(options, testNo++, logFilePath: string.Empty);
            }
        }

        private static void VerifyCommandOptions(ServiceLayerCommandOptions options, int? testNo = null, string errorMessage = "", string tracingLevel = null, string logFilePath = null, bool shouldExit = false, string locale = "", string logDirectory = null)
        {
            Assert.NotNull(options);
            string MsgPrefix = testNo != null ? $"TestNo:{testNo} ::" : string.Empty;
            Assert.True(errorMessage == options.ErrorMessage, $"{MsgPrefix} options:{nameof(errorMessage)} should be '{errorMessage}'");
            Assert.True(tracingLevel == options.TracingLevel, $"{MsgPrefix} options:{nameof(tracingLevel)} should be '{tracingLevel}'");
            Assert.True(logFilePath == options.LogFilePath, $"{MsgPrefix} options:{nameof(logFilePath)} should be '{logFilePath}'");
            Assert.True(shouldExit == options.ShouldExit, $"{MsgPrefix} options:{nameof(shouldExit)} should be '{shouldExit}'");
            Assert.False(string.IsNullOrWhiteSpace(options.LoggingDirectory));
            if (string.IsNullOrWhiteSpace(logDirectory))
            {
                logDirectory = Path.Combine(options.DefaultLogRoot, options.ServiceName);
            }
            Assert.True(logDirectory == options.LoggingDirectory, $"{MsgPrefix} options:{nameof(logDirectory)} should be '{logDirectory}'");
            Assert.True(options.Locale == locale, $"{MsgPrefix} options:{nameof(locale)} should be '{locale}'");
        }

        [Theory]
        [InlineData("en")]
        [InlineData("es")]
        public void LocaleSetWhenProvided(string locale)
        {
            var args = new string[] {"--locale", locale};
            ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args); ;

            // Asserting all options were properly set 
            Assert.NotNull(options);
            Assert.False(options.ShouldExit);
            Assert.Equal(options.Locale, locale);
        }

        [Fact]
        public void ShouldExitNotSetWhenInvalidLocale()
        {
            string locale = "invalid";
            var args = new string[] { "--locale", locale };
            ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);

            // Asserting all options were properly set 
            Assert.NotNull(options);
            Assert.False(options.ShouldExit);
        }

        [Fact]
        public void LocaleNotSetWhenNotProvided()
        {
            var args = new string[] {};
            ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);

            // Asserting all options were properly set 
            Assert.NotNull(options);
            Assert.False(options.ShouldExit);
            Assert.Equal(options.Locale, string.Empty);
        }

        [Fact]
        public void LoggingDirectorySet()
        {
            string logDir = Directory.GetCurrentDirectory();
            var args = new string[] { "--log-dir", logDir };
            ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);

            // Asserting all options were properly set 
            Assert.NotNull(options);
            Assert.False(options.ShouldExit);
            Assert.Equal(options.LoggingDirectory, logDir);
        }


        [Fact]
        public void TracingLevelSet()
        {
            string expectedLevel = "Critical";
            var args = new string[] { "--tracing-level", expectedLevel };
            ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);

            // Asserting all options were properly set 
            Assert.NotNull(options);
            Assert.False(options.ShouldExit);
            Assert.Equal(options.TracingLevel, expectedLevel);
        }


        [Fact]
        public void LogFilePathSet()
        {
            string expectedFilePath = Path.GetRandomFileName();
            var args = new string[] { "--log-file", expectedFilePath };
            ServiceLayerCommandOptions options = new ServiceLayerCommandOptions(args);

            // Asserting all options were properly set 
            Assert.NotNull(options);
            Assert.False(options.ShouldExit);
            Assert.Equal(options.LogFilePath, expectedFilePath);
        }
    }
}