ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-13 17:23:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

Modify Get Connection String Request to use connection details (#1394)

Browse Source 
* connection string accepts connectionInfo

* get connection string from disconnected scenarios
This commit is contained in:
Vasu Bhog
2022-02-10 20:48:39 -08:00
committed by GitHub
parent 1693843ab0
commit 8120858ad2
4 changed files with 67 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/guide/jsonrpc_protocol.md
View File

@@ -532,7 +532,11 @@ Get a connection string for the provided connection.
/// </summary>
public string OwnerUri { get; set; }
/// Connection info of the connection
/// </summary>
public ConnectionDetails ConnectionDetails { get; set; }
/// <summary>
/// Indicates whether the password should be return in the connection string. Default is false.
/// </summary>
public bool IncludePassword { get; set; }

47
src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs
View File

@@ -1317,27 +1317,34 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection
{
string connectionString = string.Empty;
ConnectionInfo info;
if (TryFindConnection(connStringParams.OwnerUri, out info))
SqlConnectionStringBuilder connStringBuilder;
try
{
// set connection string using connection uri if connection details are undefined
if (connStringParams.ConnectionDetails == null)
{
TryFindConnection(connStringParams.OwnerUri, out info);
connStringBuilder = CreateConnectionStringBuilder(info.ConnectionDetails);
}
// set connection string using connection details
else
{
connStringBuilder = CreateConnectionStringBuilder(connStringParams.ConnectionDetails as ConnectionDetails);
}
if (!connStringParams.IncludePassword)
{
connStringBuilder.Password = ConnectionService.PasswordPlaceholder;
}
// default connection string application name to always be included unless set to false
if (!connStringParams.IncludeApplicationName.HasValue || connStringParams.IncludeApplicationName.Value == true)
{
connStringBuilder.ApplicationName = "sqlops-connection-string";
}
connectionString = connStringBuilder.ConnectionString;
}
catch (Exception e)
{
try
{
SqlConnectionStringBuilder connStringBuilder = CreateConnectionStringBuilder(info.ConnectionDetails);
if (!connStringParams.IncludePassword)
{
connStringBuilder.Password = ConnectionService.PasswordPlaceholder;
}
// default connection string application name to always be included unless set to false
if (!connStringParams.IncludeApplicationName.HasValue || connStringParams.IncludeApplicationName.Value == true)
{
connStringBuilder.ApplicationName = "sqlops-connection-string";
}
connectionString = connStringBuilder.ConnectionString;
}
catch (Exception e)
{
await requestContext.SendError(e.ToString());
}
await requestContext.SendError(e.ToString());
}
await requestContext.SendResult(connectionString);

7
src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/GetConnectionStringParams.cs
View File

@@ -15,6 +15,11 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection.Contracts
/// </summary>
public string OwnerUri { get; set; }
/// <summary>
/// Connection information of the connection
/// </summary>
public ConnectionDetails ConnectionDetails { get; set; }
/// <summary>
/// Indicates whether the password should be return in the connection string
/// default is set to false
@@ -25,6 +30,6 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection.Contracts
/// Indicates whether the application name should be return in the connection string
/// default is set to true
/// </summary>
public bool? IncludeApplicationName { get; set;}
public bool? IncludeApplicationName { get; set; }
}
}

31
test/Microsoft.SqlTools.ServiceLayer.IntegrationTests/Connection/ConnectionServiceTests.cs
View File

@@ -124,6 +124,7 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.Connection
var requestParams = new GetConnectionStringParams()
{
OwnerUri = result.ConnectionInfo.OwnerUri,
ConnectionDetails = null,
IncludePassword = false,
IncludeApplicationName = true
};
@@ -154,11 +155,12 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.Connection
var resultApplicationName = result.ConnectionInfo.ConnectionDetails.ApplicationName;
var requestContext = new Mock<SqlTools.Hosting.Protocol.RequestContext<string>>();
requestContext.Setup(x => x.SendResult(It.Is<string>((connectionString) => !connectionString.Contains("Application Name="+ resultApplicationName))))
requestContext.Setup(x => x.SendResult(It.Is<string>((connectionString) => !connectionString.Contains("Application Name=" + resultApplicationName))))
.Returns(Task.FromResult(new object()));
var requestParams = new GetConnectionStringParams()
{
OwnerUri = result.ConnectionInfo.OwnerUri,
ConnectionDetails = null,
IncludePassword = false,
IncludeApplicationName = false
};
@@ -166,5 +168,32 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.Connection
await service.HandleGetConnectionStringRequest(requestParams, requestContext.Object);
requestContext.VerifyAll();
}
/// <summary>
/// Test HandleGetConnectionStringRequest
/// Using connection details to build connection string
/// </summary>
[Test]
public async Task GetCurrentConnectionStringTestwithConnectionDetails()
{
// If we make a connection to a live database
ConnectionService service = ConnectionService.Instance;
var result = LiveConnectionHelper.InitLiveConnectionInfo();
var resultConnectionDetails = result.ConnectionInfo.ConnectionDetails;
var requestContext = new Mock<SqlTools.Hosting.Protocol.RequestContext<string>>();
requestContext.Setup(x => x.SendResult(It.Is<string>((connectionString) => connectionString.Contains(resultConnectionDetails.ToString()))))
.Returns(Task.FromResult(new object()));
var requestParams = new GetConnectionStringParams()
{
OwnerUri = null,
ConnectionDetails = {ServerName = "testServer", DatabaseName = "testDatabase", UserName = "sa", Password = "password", ApplicationName = "TestApp"},
IncludePassword = true,
IncludeApplicationName = true
};
await service.HandleGetConnectionStringRequest(requestParams, requestContext.Object);
requestContext.VerifyAll();
}
}
}