sqltoolsservice/test/Microsoft.SqlTools.ServiceLayer.UnitTests/UtilityTests/ToSqlScriptTests.cs

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

#nullable disable

using System;
using System.Collections.Generic;
using System.Data.Common;
using System.Text.RegularExpressions;
using Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts;
using Microsoft.SqlTools.ServiceLayer.Utility.SqlScriptFormatters;
using NUnit.Framework;

namespace Microsoft.SqlTools.ServiceLayer.UnitTests.UtilityTests
{
    public partial class ToSqlScriptTests
    {
        #region FormatValue Tests

        [Test]
        public void NullDbCellTest()
        {
            // If: I attempt to format a null db cell
            // Then: It should throw
            DbColumn column = new FormatterTestDbColumn(null);
            Assert.Throws<ArgumentNullException>(() => ToSqlScript.FormatValue(null, column));
        }

        [Test]
        public void NullDbColumnTest()
        {
            // If: I attempt to format a null db column
            // Then: It should throw
            Assert.Throws<ArgumentNullException>(() => ToSqlScript.FormatValue(new DbCellValue(), null));
        }

        public void UnsupportedColumnTest()
        {
            // If: I attempt to format an unsupported datatype
            // Then: It should throw
            DbColumn column = new FormatterTestDbColumn("unsupported");
            Assert.Throws<ArgumentOutOfRangeException>(() => ToSqlScript.FormatValue(new DbCellValue(), column));
        }

        [Test]
        public void NullTest()
        {
            // If: I attempt to format a db cell that contains null
            // Then: I should get the null string back
            DbColumn column = new FormatterTestDbColumn(null);
            string formattedString = ToSqlScript.FormatValue(new DbCellValue(), new FormatterTestDbColumn(null));
            Assert.AreEqual(ToSqlScript.NullString, formattedString);
        }


        [Test]
        public void IntegerNumericTest([Values("BIGINT", "INT", "SMALLINT", "TINYINT")] string dataType)
        {
            // Setup: Build a column and cell for the integer type column
            DbColumn column = new FormatterTestDbColumn(dataType);
            var cell = new DbCellValue { RawObject = (long)123 };

            // If: I attempt to format an integer type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: The output string should be able to be converted back into a long
            Assert.AreEqual(cell.RawObject, long.Parse(output));
        }

        private static readonly object[] decimalTypes =
        {
            new object[] {"MONEY", "MONEY", null, null },
            new object[] {"SMALLMONEY", "SMALLMONEY", null, null },
            new object[] {"NUMERIC", @"NUMERIC\(\d+, \d+\)", 18, 0},
            new object[] {"DECIMAL", @"DECIMAL\(\d+, \d+\)", 18, 0 },
        };

        [Test, TestCaseSource(nameof(decimalTypes))]
        public void DecimalTest(string dataType, string regex, int? precision, int? scale)
        {
            // Setup: Build a column and cell for the decimal type column
            DbColumn column = new FormatterTestDbColumn(dataType, precision, scale);
            var cell = new DbCellValue { RawObject = 123.45m };

            // If: I attempt to format a decimal type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: It should match a something like CAST(123.45 AS MONEY)
            var castRegex = new Regex($@"CAST\([\d\.]+ AS {regex}", RegexOptions.IgnoreCase);
            Assert.True(castRegex.IsMatch(output));
        }

        [Test]
        public void DoubleTest()
        {
            // Setup: Build a column and cell for the approx numeric type column
            DbColumn column = new FormatterTestDbColumn("FLOAT");
            var cell = new DbCellValue { RawObject = 3.14159d };

            // If: I attempt to format a approx numeric type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: The output string should be able to be converted back into a double
            Assert.AreEqual(cell.RawObject, double.Parse(output));
        }

        [Test]
        public void FloatTest()
        {
            // Setup: Build a column and cell for the approx numeric type column
            DbColumn column = new FormatterTestDbColumn("REAL");
            var cell = new DbCellValue { RawObject = (float)3.14159 };

            // If: I attempt to format a approx numeric type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: The output string should be able to be converted back into a double
            Assert.AreEqual(cell.RawObject, float.Parse(output));
        }

        [Test]
        public void DateTimeTest([Values(
            "SMALLDATETIME",
            "DATETIME",
            "DATETIME2",
            "DATE")] string dataType)
        {
            // Setup: Build a column and cell for the datetime type column
            DbColumn column = new FormatterTestDbColumn(dataType);
            var cell = new DbCellValue { RawObject = DateTime.Now };

            // If: I attempt to format a datetime type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: The output string should be able to be converted back into a datetime
            DateTime outputDateTime;
            Assert.True(DateTime.TryParse(GetDateTimeRegex().Match(output).Groups[1].Value, out outputDateTime));
        }

        [Test]
        public void DateTimeOffsetTest()
        {
            // Setup: Build a column and cell for the datetime offset type column
            DbColumn column = new FormatterTestDbColumn("DATETIMEOFFSET");
            var cell = new DbCellValue { RawObject = DateTimeOffset.Now };

            // If: I attempt to format a datetime offset type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: The output string should be able to be converted back into a datetime offset
            DateTimeOffset outputDateTime;
            Assert.True(DateTimeOffset.TryParse(GetDateTimeRegex().Match(output).Groups[1].Value, out outputDateTime));
        }

        [Test]
        public void TimeTest()
        {
            // Setup: Build a column and cell for the time type column
            DbColumn column = new FormatterTestDbColumn("TIME");
            var cell = new DbCellValue { RawObject = TimeSpan.FromHours(12) };

            // If: I attempt to format a time type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: The output string should be able to be converted back into a timespan
            TimeSpan outputDateTime;
            Assert.True(TimeSpan.TryParse(GetDateTimeRegex().Match(output).Groups[1].Value, out outputDateTime));
        }

        private static readonly object[] stringFormats = 
        {
            new object[] {"", "N''"}, // Make sure empty string works
            new object[] {" \t\r\n", "N' \t\r\n'"}, // Test for whitespace
            new object[] {"some text \x9152", "N'some text \x9152'"}, // Test unicode (UTF-8 and UTF-16)
            new object[] {"'", "N''''"}, // Test with escaped character
        };

        [Test, TestCaseSource(nameof(stringFormats))]
        public void StringFormattingTest(string input, string expectedOutput)
        {
            // Setup: Build a column and cell for the string type column
            // NOTE: We're using VARCHAR because it's very general purpose.
            DbColumn column = new FormatterTestDbColumn("VARCHAR");
            var cell = new DbCellValue { RawObject = input };

            // If: I attempt to format a string type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: The output string should be quoted and escaped properly
            Assert.AreEqual(expectedOutput, output);
        }

        [Test]
        
        public void StringTypeTest([Values(
            "CHAR",
            "NCHAR",
            "VARCHAR",
            "TEXT",
            "NTEXT",
            "XML"
            )]string datatype)
        {
            // Setup: Build a column and cell for the string type column
            DbColumn column = new FormatterTestDbColumn(datatype);
            var cell = new DbCellValue { RawObject = "test string" };

            // If: I attempt to format a string type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: The output string should match the output string
            Assert.AreEqual("N'test string'", output);
        }

        [Test]
        public void BinaryTest([Values("BINARY", "VARBINARY", "IMAGE")] string datatype)
        {
            // Setup: Build a column and cell for the string type column
            DbColumn column = new FormatterTestDbColumn(datatype);
            var cell = new DbCellValue
            {
                RawObject = "BENISCOOL"u8.ToArray()
            };

            // If: I attempt to format a string type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: The output string should match the output string
            Assert.True(GetOuputRegex().IsMatch(output));
        }

        [Test]
        public void GuidTest()
        {
            // Setup: Build a column and cell for the string type column
            DbColumn column = new FormatterTestDbColumn("UNIQUEIDENTIFIER");
            var cell = new DbCellValue { RawObject = Guid.NewGuid() };

            // If: I attempt to format a string type column
            string output = ToSqlScript.FormatValue(cell, column);

            // Then: The output string should match the output string
            var regex = GetGuidRegex();
            Assert.True(regex.IsMatch(output));
        }

        #endregion
        
        #region Format Identifier Tests

        [Test]
        public void FormatIdentifierNull()
        {
            // If: I attempt to format null as an identifier
            // Then: I should get an exception thrown
            Assert.Throws<ArgumentNullException>(() => ToSqlScript.FormatIdentifier(null));
        }

        private static readonly object[] bracketEscapes =
        {
            new object[] {"test", "[test]" },          // No escape characters
            new object[] {"]test", "[]]test]" },       // Escape character at beginning
            new object[] {"te]st", "[te]]st]" },       // Escape character in middle
            new object[] {"test]", "[test]]]" },       // Escape character at end
            new object[] {"t]]est", "[t]]]]est]" },    // Multiple escape characters
        };
        
        [Test, TestCaseSource(nameof(bracketEscapes))]
        public void FormatIdentifierTest(string value, string expectedOutput)
        {
            // If: I attempt to format a value as an identifier
            string output = ToSqlScript.FormatIdentifier(value);

            // Then: The output should match the expected output
            Assert.AreEqual(expectedOutput, output);
        }

        private static readonly object[] multiParts =
        {
            new object[] {"test", "[test]" },                          // No splits, no escape characters
            new object[] {"test.test", "[test].[test]" },              // One split, no escape characters
            new object[] {"test.te]st", "[test].[te]]st]" },           // One split, one escape character
            new object[] {"test.test.test", "[test].[test].[test]" },  // Two splits, no escape characters
        };

        [Test, TestCaseSource(nameof(multiParts))]
        public void FormatMultipartIdentifierTest(string value, string expectedOutput)
        {
            // If: I attempt to format a value as a multipart identifier
            string output = ToSqlScript.FormatMultipartIdentifier(value);

            // Then: The output should match the expected output
            Assert.AreEqual(expectedOutput, output);
        }

        public static IEnumerable<object[]> GetMultipartIdentifierArrays
        {
            get
            {
                yield return new object[] {"[test]", new[] {"test"}};                                   // No splits, no escape characters
                yield return new object[] {"[test].[test]", new[] {"test", "test"}};                    // One split, no escape characters
                yield return new object[] {"[test].[te]]st]", new[] {"test", "te]st"}};                 // One split, one escape character
                yield return new object[] {"[test].[test].[test]", new[] {"test", "test", "test"}};     // Two splits, no escape characters
            }
        }
        
        [Test]
        [TestCaseSource(nameof(GetMultipartIdentifierArrays))]
        public void FormatMultipartIdentifierArrayTest(string expectedOutput, string[] splits)
        {
            // If: I attempt to format a value as a multipart identifier
            string output = ToSqlScript.FormatMultipartIdentifier(splits);

            // Then: The output should match the expected output
            Assert.AreEqual(expectedOutput, output);
        }

        #endregion

        #region FormatColumnType Tests

        public static IEnumerable<object[]> FormatColumnTypeData
        {
            get
            {
                yield return new object[] {false, new FormatterTestDbColumn("biGint"), "BIGINT"};
                yield return new object[] {false, new FormatterTestDbColumn("biT"), "BIT"};
                yield return new object[] {false, new FormatterTestDbColumn("deCimal", precision: 18, scale: 0), "DECIMAL(18, 0)"};
                yield return new object[] {false, new FormatterTestDbColumn("deCimal", precision: 22, scale: 2), "DECIMAL(22, 2)"};
                yield return new object[] {false, new FormatterTestDbColumn("inT"), "INT"};
                yield return new object[] {false, new FormatterTestDbColumn("moNey"), "MONEY"};
                yield return new object[] {false, new FormatterTestDbColumn("nuMeric", precision: 18, scale: 0), "NUMERIC(18, 0)"};
                yield return new object[] {false, new FormatterTestDbColumn("nuMeric", precision: 22, scale: 2), "NUMERIC(22, 2)"};
                yield return new object[] {false, new FormatterTestDbColumn("smAllint"), "SMALLINT"};
                yield return new object[] {false, new FormatterTestDbColumn("smAllmoney"), "SMALLMONEY"};
                yield return new object[] {false, new FormatterTestDbColumn("tiNyint"), "TINYINT"};
                yield return new object[] {false, new FormatterTestDbColumn("biNary", size: 255), "BINARY(255)"};
                yield return new object[] {false, new FormatterTestDbColumn("biNary", size: 10), "BINARY(10)"};
                yield return new object[] {false, new FormatterTestDbColumn("vaRbinary", size: 255), "VARBINARY(255)"};
                yield return new object[] {false, new FormatterTestDbColumn("vaRbinary", size: 10), "VARBINARY(10)"};
                yield return new object[] {false, new FormatterTestDbColumn("vaRbinary", size: int.MaxValue), "VARBINARY(MAX)"};
                yield return new object[] {false, new FormatterTestDbColumn("imAge"), "IMAGE"};
                yield return new object[] {false, new FormatterTestDbColumn("smAlldatetime"), "SMALLDATETIME"};
                yield return new object[] {false, new FormatterTestDbColumn("daTetime"), "DATETIME"};
                yield return new object[] {false, new FormatterTestDbColumn("daTetime2", scale: 7), "DATETIME2(7)"};
                yield return new object[] {false, new FormatterTestDbColumn("daTetime2", scale: 0), "DATETIME2(0)"};
                yield return new object[] {false, new FormatterTestDbColumn("daTetimeoffset", scale: 7), "DATETIMEOFFSET(7)"};
                yield return new object[] {false, new FormatterTestDbColumn("daTetimeoffset", scale: 0), "DATETIMEOFFSET(0)"};
                yield return new object[] {false, new FormatterTestDbColumn("tiMe", scale: 7), "TIME(7)"};
                yield return new object[] {false, new FormatterTestDbColumn("flOat"), "FLOAT"};
                yield return new object[] {false, new FormatterTestDbColumn("reAl"), "REAL"};
                yield return new object[] {false, new FormatterTestDbColumn("chAr", size: 1), "CHAR(1)"};
                yield return new object[] {false, new FormatterTestDbColumn("chAr", size: 255), "CHAR(255)"};
                yield return new object[] {false, new FormatterTestDbColumn("ncHar", size: 1), "NCHAR(1)"};
                yield return new object[] {false, new FormatterTestDbColumn("ncHar", size: 255), "NCHAR(255)"};
                yield return new object[] {false, new FormatterTestDbColumn("vaRchar", size: 1), "VARCHAR(1)"};
                yield return new object[] {false, new FormatterTestDbColumn("vaRchar", size: 255), "VARCHAR(255)"};
                yield return new object[] {false, new FormatterTestDbColumn("vaRchar", size: int.MaxValue), "VARCHAR(MAX)"};
                yield return new object[] {false, new FormatterTestDbColumn("nvArchar", size: 1), "NVARCHAR(1)"};
                yield return new object[] {false, new FormatterTestDbColumn("nvArchar", size: 255), "NVARCHAR(255)"};
                yield return new object[] {false, new FormatterTestDbColumn("nvArchar", size: int.MaxValue), "NVARCHAR(MAX)"};
                yield return new object[] {false, new FormatterTestDbColumn("teXt"), "TEXT"};
                yield return new object[] {false, new FormatterTestDbColumn("nteXt"), "NTEXT"};
                yield return new object[] {false, new FormatterTestDbColumn("unIqueidentifier"), "UNIQUEIDENTIFIER"};
                yield return new object[] {false, new FormatterTestDbColumn("sqL_variant"), "SQL_VARIANT"};
                yield return new object[] {false, new FormatterTestDbColumn("somEthing.sys.hierarchyid"), "HIERARCHYID"};
                yield return new object[] {false, new FormatterTestDbColumn("table.geOgraphy"), "GEOGRAPHY"};
                yield return new object[] {false, new FormatterTestDbColumn("table.geOmetry"), "GEOMETRY"};
                yield return new object[] {false, new FormatterTestDbColumn("sySname"), "SYSNAME"};
                yield return new object[] {false, new FormatterTestDbColumn("tiMestamp"), "TIMESTAMP"};
                yield return new object[] {true, new FormatterTestDbColumn("tiMestamp"), "VARBINARY(8)"};
            }
        }
        
        [Test]
        [TestCaseSource(nameof(FormatColumnTypeData))]
        public void FormatColumnType(bool useSemanticEquivalent, DbColumn input, string expectedOutput)
        {
            // If: I supply the input columns 
            string output = ToSqlScript.FormatColumnType(input, useSemanticEquivalent);
            
            // Then: The output should match the expected output
            Assert.AreEqual(expectedOutput, output);
        }

        #endregion
        
        private sealed class FormatterTestDbColumn : DbColumn
        {
            public FormatterTestDbColumn(string dataType, int? precision = null, int? scale = null, int? size = null)
            {
                DataTypeName = dataType;
                NumericPrecision = precision;
                NumericScale = scale;
                ColumnSize = size;
            }
        }

        [GeneratedRegex("0x[0-9A-F]+", RegexOptions.IgnoreCase, "en-CA")]
        private static partial Regex GetOuputRegex();

        [GeneratedRegex("N'[0-9A-F]{8}(-[0-9A-F]{4}){3}-[0-9A-F]{12}'", RegexOptions.IgnoreCase, "en-CA")]
        private static partial Regex GetGuidRegex();

        [GeneratedRegex("N'(.*)'")]
        private static partial Regex GetDateTimeRegex();
    }
}