sqltoolsservice/test/Microsoft.SqlTools.ServiceLayer.UnitTests/Utility/TestObjects.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;
using System.Collections.Generic;
using System.Data;
using System.Data.Common;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.SqlTools.ServiceLayer.Connection;
using Microsoft.SqlTools.ServiceLayer.Connection.Contracts;
using Microsoft.SqlTools.ServiceLayer.LanguageServices;
using Microsoft.SqlTools.ServiceLayer.Workspace.Contracts;
using Moq;

namespace Microsoft.SqlTools.ServiceLayer.UnitTests.Utility
{
    /// <summary>
    /// Tests for the ServiceHost Connection Service tests
    /// </summary>
    public class TestObjects
    {

        public const string ScriptUri = "file://some/file.sql";

        /// <summary>
        /// Creates a test connection service
        /// </summary>
        public static ConnectionService GetTestConnectionService()
        {
            // use mock database connection
            return new ConnectionService(new TestSqlConnectionFactory());
        }

        /// <summary>
        /// Creates a test connection info instance.
        /// </summary>
        public static ConnectionInfo GetTestConnectionInfo()
        {
            return new ConnectionInfo(
                new TestSqlConnectionFactory(),
                ScriptUri,
                GetTestConnectionDetails());
        }

        public static ConnectParams GetTestConnectionParams(bool useConnectionString = false)
        {
            return new ConnectParams()
            {
                OwnerUri = ScriptUri,
                Connection = GetTestConnectionDetails(useConnectionString)
            };
        }

        public static ServerInfo GetTestServerInfo()
        {
            return new ServerInfo()
            {
                ServerVersion = "14.0.1.0",
                ServerMajorVersion = 14,
                ServerMinorVersion = 0,
                EngineEditionId = 3,
                OsVersion = "Linux (Ubuntu 15.10)",
                IsCloud = false,
                ServerEdition = "Developer Edition",
                ServerLevel = ""
            };
        }

        /// <summary>
        /// Creates a test sql connection factory instance
        /// </summary>
        public static ISqlConnectionFactory GetTestSqlConnectionFactory()
        {
            // use mock database connection
            return new TestSqlConnectionFactory();
        }

        /// <summary>
        /// Creates a test connection details object
        /// </summary>
        public static ConnectionDetails GetTestConnectionDetails(bool useConnectionString = false)
        {
            if (useConnectionString)
            {
                return new ConnectionDetails()
                {
                    ConnectionString = $"User ID=user;PWD={Guid.NewGuid().ToString()};Database=databaseName;Server=serverName"
                };
            }

            return new ConnectionDetails()
            {
                UserName = "user",
                Password = Guid.NewGuid().ToString(),
                DatabaseName = "databaseName",
                ServerName = "serverName"
            };
        }

        /// <summary>
        /// Create a test language service instance
        /// </summary>
        /// <returns></returns>
        public static LanguageService GetTestLanguageService()
        {
            return new LanguageService();
        }

        /// <summary>
        /// Creates and returns a dummy TextDocumentPosition
        /// </summary>
        public static TextDocumentPosition GetTestDocPosition()
        {
            return new TextDocumentPosition
            {
                TextDocument = new TextDocumentIdentifier { Uri = ScriptUri },
                Position = new Position
                {
                    Line = 0,
                    Character = 0
                }
            };
        }
    }

    /// <summary>
    /// Test mock class for IDbCommand
    /// </summary>
    public class TestSqlCommand : DbCommand
    {
        internal TestSqlCommand(TestResultSet[] data)
        {
            Data = data;

            var mockParameterCollection = new Mock<DbParameterCollection>();
            mockParameterCollection.Setup(c => c.Add(It.IsAny<object>()))
                .Callback<object>(d => listParams.Add((DbParameter)d));
            mockParameterCollection.Setup(c => c.AddRange(It.IsAny<Array>()))
                .Callback<Array>(d => listParams.AddRange(d.Cast<DbParameter>()));
            mockParameterCollection.Setup(c => c.Count)
                .Returns(() => listParams.Count);
            DbParameterCollection = mockParameterCollection.Object;
        }

        internal TestResultSet[] Data { get; set; }

        public override void Cancel()
        {
            throw new NotImplementedException();
        }

        public override int ExecuteNonQuery()
        {
            throw new NotImplementedException();
        }

        public override object ExecuteScalar()
        {
            throw new NotImplementedException();
        }

        public override void Prepare()
        {
            throw new NotImplementedException();
        }

        public override string CommandText { get; set; }
        public override int CommandTimeout { get; set; }
        public override CommandType CommandType { get; set; }
        public override UpdateRowSource UpdatedRowSource { get; set; }
        protected override DbConnection DbConnection { get; set; }
        protected override DbParameterCollection DbParameterCollection { get; }
        protected override DbTransaction DbTransaction { get; set; }
        public override bool DesignTimeVisible { get; set; }

        protected override DbParameter CreateDbParameter()
        {
            throw new NotImplementedException();
        }

        protected override DbDataReader ExecuteDbDataReader(CommandBehavior behavior)
        {
            return new TestDbDataReader(Data, false);
        }

        private List<DbParameter> listParams = new List<DbParameter>();
    }

    /// <summary>
    /// Test mock class for IDbCommand (Modified for Edit Data)
    /// </summary>
    public class TestEditDataSqlCommand : TestSqlCommand
    {
        internal TestEditDataSqlCommand(TestResultSet[] data) : base(data)
        {

        }

        /// <summary>
        /// Function to check for duplicates in Data's rows.
        /// Returns the max duplicate count for a unique row value (int).
        /// </summary>
        public override object ExecuteScalar()
        {
            if (Data != null)
            {
                //Get row data and set up row count map.
                object[] rowData = Data[0].Rows[0];
                Dictionary<object, int> rowCountMap = new Dictionary<object, int>();

                //Go through each row value.
                foreach (object rowValue in rowData)
                {
                    if (rowCountMap.ContainsKey(rowValue))
                    {
                        // Add to existing count
                        rowCountMap[rowValue] += 1;
                    }
                    else
                    {
                        // New unique value found, add to map with 1 count.
                        rowCountMap.Add(rowValue, 1);
                    }
                }

                // Find the greatest number of duplicates among unique values
                // in the map and return it.
                int maxCount = 0;
                foreach (var rowCount in rowCountMap)
                {
                    if (rowCount.Value > maxCount)
                    {
                        maxCount = rowCount.Value;
                    }
                }
                return maxCount;
            }
            else
            {
                // Return 0 if Data is not provided.
                return 0;
            }
        }
    }

    /// <summary>
    /// Test mock class for SqlConnection wrapper
    /// </summary>
    public class TestSqlConnection : DbConnection
    {
        private string _database;
        private ConnectionState _state;

        public TestSqlConnection()
        {

        }

        public TestSqlConnection(TestResultSet[] data)
        {
            Data = data;
        }

        internal TestResultSet[] Data { get; set; }

        protected override DbTransaction BeginDbTransaction(IsolationLevel isolationLevel)
        {
            throw new NotImplementedException();
        }

        public override void Close()
        {
            // No Op
            this._state = ConnectionState.Closed;
        }

        public override void Open()
        {
            // No Op, unless credentials are bad
            if(ConnectionString.Contains("invalidUsername"))
            {
                throw new Exception("Invalid credentials provided");
            }
            this._state = ConnectionState.Open;
        }

        public override string ConnectionString { get; set; }
        public override string Database
        {
            get { return _database; }
        }

        public override ConnectionState State
        {
            get { return _state; }
        }

        public override string DataSource { get; }
        public override string ServerVersion { get; }

        protected override DbCommand CreateDbCommand()
        {
            return new TestSqlCommand(Data);
        }

        public override void ChangeDatabase(string databaseName)
        {
            _database = databaseName;
        }

        /// <summary>
        /// Test helper method to set the database value
        /// </summary>
        /// <param name="database"></param>
        public void SetDatabase(string database)
        {
            this._database = database;
        }

        public void SetState(ConnectionState state)
        {
            this._state = state;
        }
    }

    /// <summary>
    /// Test mock class for SqlConnection wrapper (Modified for Edit Data)
    /// </summary>
    public class TestEditDataSqlConnection : TestSqlConnection
    {
        public TestEditDataSqlConnection()
        {

        }

        public TestEditDataSqlConnection(TestResultSet[] data) : base(data)
        {

        }

        protected override DbCommand CreateDbCommand()
        {
            return new TestEditDataSqlCommand(Data);
        }
    }

    /// <summary>
    /// Test mock class for SqlConnection factory
    /// </summary>
    public class TestSqlConnectionFactory : ISqlConnectionFactory
    {
        public DbConnection CreateSqlConnection(string connectionString, string azureAccountToken)
        {
            return new TestSqlConnection(null)
            {
                ConnectionString = connectionString
            };
        }
    }
}