ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-02-16 18:47:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

Addressing code review feedback

Browse Source
This commit is contained in:
Mitchell Sternke
2016-08-31 16:04:04 -07:00
parent 3fe6e330fe
commit a30ff33187
3 changed files with 142 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -111,11 +111,19 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection
public ConnectResponse Connect(ConnectParams connectionParams) public ConnectResponse Connect(ConnectParams connectionParams)
{ {
// Validate parameters // Validate parameters
if(connectionParams == null || !connectionParams.IsValid()) string paramValidationErrorMessage;
if (connectionParams == null)
{ {
return new ConnectResponse() return new ConnectResponse()
{ {
Messages = "Error: Invalid connection parameters provided." Messages = "Error: Connection parameters cannot be null."
};
}
else if (!connectionParams.IsValid(out paramValidationErrorMessage))
{
return new ConnectResponse()
{
Messages = paramValidationErrorMessage
}; };
} }
@@ -168,7 +176,7 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection
public bool Disconnect(DisconnectParams disconnectParams) public bool Disconnect(DisconnectParams disconnectParams)
{ {
// Validate parameters // Validate parameters
if (disconnectParams == null || String.IsNullOrEmpty(disconnectParams.OwnerUri)) if (disconnectParams == null || string.IsNullOrEmpty(disconnectParams.OwnerUri))
{ {
return false; return false;
} }
@@ -203,7 +211,7 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection
{ {
// Verify parameters // Verify parameters
var owner = listDatabasesParams.OwnerUri; var owner = listDatabasesParams.OwnerUri;
if (String.IsNullOrEmpty(owner)) if (string.IsNullOrEmpty(owner))
{ {
throw new ArgumentException("OwnerUri cannot be null or empty"); throw new ArgumentException("OwnerUri cannot be null or empty");
} }
@@ -355,11 +363,11 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection
connectionBuilder["Password"] = connectionDetails.Password; connectionBuilder["Password"] = connectionDetails.Password;
// Check for any optional parameters // Check for any optional parameters
if (!String.IsNullOrEmpty(connectionDetails.DatabaseName)) if (!string.IsNullOrEmpty(connectionDetails.DatabaseName))
{ {
connectionBuilder["Initial Catalog"] = connectionDetails.DatabaseName; connectionBuilder["Initial Catalog"] = connectionDetails.DatabaseName;
} }
if (!String.IsNullOrEmpty(connectionDetails.AuthenticationType)) if (!string.IsNullOrEmpty(connectionDetails.AuthenticationType))
{ {
switch(connectionDetails.AuthenticationType) switch(connectionDetails.AuthenticationType)
{ {
@@ -370,7 +378,7 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection
connectionBuilder.IntegratedSecurity = false; connectionBuilder.IntegratedSecurity = false;
break; break;
default: default:
throw new ArgumentException("Invalid value \"" + connectionDetails.AuthenticationType + "\" for AuthenticationType. Valid values are \"Integrated\" and \"SqlLogin\"."); throw new ArgumentException(string.Format("Invalid value \"{0}\" for AuthenticationType. Valid values are \"Integrated\" and \"SqlLogin\".", connectionDetails.AuthenticationType));
} }
} }
if (connectionDetails.Encrypt.HasValue) if (connectionDetails.Encrypt.HasValue)
@@ -397,15 +405,15 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection
{ {
connectionBuilder.ConnectRetryInterval = connectionDetails.ConnectRetryInterval.Value; connectionBuilder.ConnectRetryInterval = connectionDetails.ConnectRetryInterval.Value;
} }
if (!String.IsNullOrEmpty(connectionDetails.ApplicationName)) if (!string.IsNullOrEmpty(connectionDetails.ApplicationName))
{ {
connectionBuilder.ApplicationName = connectionDetails.ApplicationName; connectionBuilder.ApplicationName = connectionDetails.ApplicationName;
} }
if (!String.IsNullOrEmpty(connectionDetails.WorkstationId)) if (!string.IsNullOrEmpty(connectionDetails.WorkstationId))
{ {
connectionBuilder.WorkstationID = connectionDetails.WorkstationId; connectionBuilder.WorkstationID = connectionDetails.WorkstationId;
} }
if (!String.IsNullOrEmpty(connectionDetails.ApplicationIntent)) if (!string.IsNullOrEmpty(connectionDetails.ApplicationIntent))
{ {
ApplicationIntent intent; ApplicationIntent intent;
switch (connectionDetails.ApplicationIntent) switch (connectionDetails.ApplicationIntent)
@@ -417,11 +425,11 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection
intent = ApplicationIntent.ReadWrite; intent = ApplicationIntent.ReadWrite;
break; break;
default: default:
throw new ArgumentException("Invalid value \"" + connectionDetails.ApplicationIntent + "\" for ApplicationIntent. Valid values are \"ReadWrite\" and \"ReadOnly\"."); throw new ArgumentException(string.Format("Invalid value \"{0}\" for ApplicationIntent. Valid values are \"ReadWrite\" and \"ReadOnly\".", connectionDetails.ApplicationIntent));
} }
connectionBuilder.ApplicationIntent = intent; connectionBuilder.ApplicationIntent = intent;
} }
if (!String.IsNullOrEmpty(connectionDetails.CurrentLanguage)) if (!string.IsNullOrEmpty(connectionDetails.CurrentLanguage))
{ {
connectionBuilder.CurrentLanguage = connectionDetails.CurrentLanguage; connectionBuilder.CurrentLanguage = connectionDetails.CurrentLanguage;
} }
@@ -445,11 +453,11 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection
{ {
connectionBuilder.Replication = connectionDetails.Replication.Value; connectionBuilder.Replication = connectionDetails.Replication.Value;
} }
if (!String.IsNullOrEmpty(connectionDetails.AttachDbFilename)) if (!string.IsNullOrEmpty(connectionDetails.AttachDbFilename))
{ {
connectionBuilder.AttachDBFilename = connectionDetails.AttachDbFilename; connectionBuilder.AttachDBFilename = connectionDetails.AttachDbFilename;
} }
if (!String.IsNullOrEmpty(connectionDetails.FailoverPartner)) if (!string.IsNullOrEmpty(connectionDetails.FailoverPartner))
{ {
connectionBuilder.FailoverPartner = connectionDetails.FailoverPartner; connectionBuilder.FailoverPartner = connectionDetails.FailoverPartner;
} }
@@ -465,7 +473,7 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection
{ {
connectionBuilder.PacketSize = connectionDetails.PacketSize.Value; connectionBuilder.PacketSize = connectionDetails.PacketSize.Value;
} }
if (!String.IsNullOrEmpty(connectionDetails.TypeSystemVersion)) if (!string.IsNullOrEmpty(connectionDetails.TypeSystemVersion))
{ {
connectionBuilder.TypeSystemVersion = connectionDetails.TypeSystemVersion; connectionBuilder.TypeSystemVersion = connectionDetails.TypeSystemVersion;
} }

43
src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectParamsExtensions.cs
View File

@@ -15,15 +15,42 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection.Contracts
/// <summary> /// <summary>
/// Check that the fields in ConnectParams are all valid /// Check that the fields in ConnectParams are all valid
/// </summary> /// </summary>
public static bool IsValid(this ConnectParams parameters) public static bool IsValid(this ConnectParams parameters, out string errorMessage)
{ {
return !( errorMessage = string.Empty;
String.IsNullOrEmpty(parameters.OwnerUri) || if (string.IsNullOrEmpty(parameters.OwnerUri))
parameters.Connection == null || {
String.IsNullOrEmpty(parameters.Connection.Password) || errorMessage = "Error: OwnerUri cannot be null or empty.";
String.IsNullOrEmpty(parameters.Connection.ServerName) || }
String.IsNullOrEmpty(parameters.Connection.UserName) else if (parameters.Connection == null)
); {
errorMessage = "Error: Connection details object cannot be null.";
}
else if (string.IsNullOrEmpty(parameters.Connection.ServerName))
{
errorMessage = "Error: ServerName cannot be null or empty.";
}
else if (string.IsNullOrEmpty(parameters.Connection.AuthenticationType) || parameters.Connection.AuthenticationType == "SqlLogin")
{
// For SqlLogin, username/password cannot be empty
if (string.IsNullOrEmpty(parameters.Connection.UserName))
{
errorMessage = "Error: UserName cannot be null or empty when using SqlLogin authentication.";
}
else if( string.IsNullOrEmpty(parameters.Connection.Password))
{
errorMessage = "Error: Password cannot be null or empty when using SqlLogin authentication.";
}
}
if (string.IsNullOrEmpty(errorMessage))
{
return true;
}
else
{
return false;
}
} }
} }
} }

126
test/Microsoft.SqlTools.ServiceLayer.Test/Connection/ConnectionServiceTests.cs
View File

@@ -152,15 +152,19 @@ namespace Microsoft.SqlTools.ServiceLayer.Test.Connection
/// Verify that when connecting with invalid parameters, an error is thrown. /// Verify that when connecting with invalid parameters, an error is thrown.
/// </summary> /// </summary>
[Theory] [Theory]
[InlineDataAttribute(null, "my-server", "test", "sa", "123456")] [InlineData("SqlLogin", null, "my-server", "test", "sa", "123456")]
[InlineDataAttribute("file://my/sample/file.sql", null, "test", "sa", "123456")] [InlineData("SqlLogin", "file://my/sample/file.sql", null, "test", "sa", "123456")]
[InlineDataAttribute("file://my/sample/file.sql", "my-server", "test", null, "123456")] [InlineData("SqlLogin", "file://my/sample/file.sql", "my-server", "test", null, "123456")]
[InlineDataAttribute("file://my/sample/file.sql", "my-server", "test", "sa", null)] [InlineData("SqlLogin", "file://my/sample/file.sql", "my-server", "test", "sa", null)]
[InlineDataAttribute("", "my-server", "test", "sa", "123456")] [InlineData("SqlLogin", "", "my-server", "test", "sa", "123456")]
[InlineDataAttribute("file://my/sample/file.sql", "", "test", "sa", "123456")] [InlineData("SqlLogin", "file://my/sample/file.sql", "", "test", "sa", "123456")]
[InlineDataAttribute("file://my/sample/file.sql", "my-server", "test", "", "123456")] [InlineData("SqlLogin", "file://my/sample/file.sql", "my-server", "test", "", "123456")]
[InlineDataAttribute("file://my/sample/file.sql", "my-server", "test", "sa", "")] [InlineData("SqlLogin", "file://my/sample/file.sql", "my-server", "test", "sa", "")]
public void ConnectingWithInvalidParametersYieldsErrorMessage(string ownerUri, string server, string database, string userName, string password) [InlineData("Integrated", null, "my-server", "test", "sa", "123456")]
[InlineData("Integrated", "file://my/sample/file.sql", null, "test", "sa", "123456")]
[InlineData("Integrated", "", "my-server", "test", "sa", "123456")]
[InlineData("Integrated", "file://my/sample/file.sql", "", "test", "sa", "123456")]
public void ConnectingWithInvalidParametersYieldsErrorMessage(string authType, string ownerUri, string server, string database, string userName, string password)
{ {
// Connect with invalid parameters // Connect with invalid parameters
var connectionResult = var connectionResult =
@@ -172,7 +176,8 @@ namespace Microsoft.SqlTools.ServiceLayer.Test.Connection
ServerName = server, ServerName = server,
DatabaseName = database, DatabaseName = database,
UserName = userName, UserName = userName,
Password = password Password = password,
AuthenticationType = authType
} }
}); });
@@ -181,6 +186,40 @@ namespace Microsoft.SqlTools.ServiceLayer.Test.Connection
Assert.NotEqual(String.Empty, connectionResult.Messages); Assert.NotEqual(String.Empty, connectionResult.Messages);
} }
/// <summary>
/// Verify that when using integrated authentication, the username and/or password can be empty.
/// </summary>
[Theory]
[InlineData(null, null)]
[InlineData(null, "")]
[InlineData("", null)]
[InlineData("", "")]
[InlineData("sa", null)]
[InlineData("sa", "")]
[InlineData(null, "12345678")]
[InlineData("", "12345678")]
public void ConnectingWithNoUsernameOrPasswordWorksForIntegratedAuth(string userName, string password)
{
// Connect
var connectionResult =
TestObjects.GetTestConnectionService()
.Connect(new ConnectParams()
{
OwnerUri = "file:///my/test/file.sql",
Connection = new ConnectionDetails() {
ServerName = "my-server",
DatabaseName = "test",
UserName = userName,
Password = password,
AuthenticationType = "Integrated"
}
});
// check that the connection was successful
Assert.NotEmpty(connectionResult.ConnectionId);
Assert.Null(connectionResult.Messages);
}
/// <summary> /// <summary>
/// Verify that when connecting with a null parameters object, an error is thrown. /// Verify that when connecting with a null parameters object, an error is thrown.
/// </summary> /// </summary>
@@ -201,38 +240,38 @@ namespace Microsoft.SqlTools.ServiceLayer.Test.Connection
/// Verify that optional parameters can be built into a connection string for connecting. /// Verify that optional parameters can be built into a connection string for connecting.
/// </summary> /// </summary>
[Theory] [Theory]
[InlineDataAttribute("AuthenticationType", "Integrated")] [InlineData("AuthenticationType", "Integrated", "Integrated Security")]
[InlineDataAttribute("AuthenticationType", "SqlLogin")] [InlineData("AuthenticationType", "SqlLogin", "Integrated Security")]
[InlineDataAttribute("Encrypt", true)] [InlineData("Encrypt", true, "Encrypt")]
[InlineDataAttribute("Encrypt", false)] [InlineData("Encrypt", false, "Encrypt")]
[InlineDataAttribute("TrustServerCertificate", true)] [InlineData("TrustServerCertificate", true, "TrustServerCertificate")]
[InlineDataAttribute("TrustServerCertificate", false)] [InlineData("TrustServerCertificate", false, "TrustServerCertificate")]
[InlineDataAttribute("PersistSecurityInfo", true)] [InlineData("PersistSecurityInfo", true, "Persist Security Info")]
[InlineDataAttribute("PersistSecurityInfo", false)] [InlineData("PersistSecurityInfo", false, "Persist Security Info")]
[InlineDataAttribute("ConnectTimeout", 15)] [InlineData("ConnectTimeout", 15, "Connect Timeout")]
[InlineDataAttribute("ConnectRetryCount", 1)] [InlineData("ConnectRetryCount", 1, "ConnectRetryCount")]
[InlineDataAttribute("ConnectRetryInterval", 10)] [InlineData("ConnectRetryInterval", 10, "ConnectRetryInterval")]
[InlineDataAttribute("ApplicationName", "vscode-mssql")] [InlineData("ApplicationName", "vscode-mssql", "Application Name")]
[InlineDataAttribute("WorkstationId", "mycomputer")] [InlineData("WorkstationId", "mycomputer", "Workstation ID")]
[InlineDataAttribute("ApplicationIntent", "ReadWrite")] [InlineData("ApplicationIntent", "ReadWrite", "ApplicationIntent")]
[InlineDataAttribute("ApplicationIntent", "ReadOnly")] [InlineData("ApplicationIntent", "ReadOnly", "ApplicationIntent")]
[InlineDataAttribute("CurrentLanguage", "test")] [InlineData("CurrentLanguage", "test", "Current Language")]
[InlineDataAttribute("Pooling", false)] [InlineData("Pooling", false, "Pooling")]
[InlineDataAttribute("Pooling", true)] [InlineData("Pooling", true, "Pooling")]
[InlineDataAttribute("MaxPoolSize", 100)] [InlineData("MaxPoolSize", 100, "Max Pool Size")]
[InlineDataAttribute("MinPoolSize", 0)] [InlineData("MinPoolSize", 0, "Min Pool Size")]
[InlineDataAttribute("LoadBalanceTimeout", 0)] [InlineData("LoadBalanceTimeout", 0, "Load Balance Timeout")]
[InlineDataAttribute("Replication", true)] [InlineData("Replication", true, "Replication")]
[InlineDataAttribute("Replication", false)] [InlineData("Replication", false, "Replication")]
[InlineDataAttribute("AttachDbFilename", "myfile")] [InlineData("AttachDbFilename", "myfile", "AttachDbFilename")]
[InlineDataAttribute("FailoverPartner", "partner")] [InlineData("FailoverPartner", "partner", "Failover Partner")]
[InlineDataAttribute("MultiSubnetFailover", true)] [InlineData("MultiSubnetFailover", true, "MultiSubnetFailover")]
[InlineDataAttribute("MultiSubnetFailover", false)] [InlineData("MultiSubnetFailover", false, "MultiSubnetFailover")]
[InlineDataAttribute("MultipleActiveResultSets", false)] [InlineData("MultipleActiveResultSets", false, "MultipleActiveResultSets")]
[InlineDataAttribute("MultipleActiveResultSets", true)] [InlineData("MultipleActiveResultSets", true, "MultipleActiveResultSets")]
[InlineDataAttribute("PacketSize", 8192)] [InlineData("PacketSize", 8192, "Packet Size")]
[InlineDataAttribute("TypeSystemVersion", "Latest")] [InlineData("TypeSystemVersion", "Latest", "Type System Version")]
public void ConnectingWithOptionalParametersBuildsConnectionString(string propertyName, object propertyValue) public void ConnectingWithOptionalParametersBuildsConnectionString(string propertyName, object propertyValue, string connectionStringMarker)
{ {
// Create a test connection details object and set the property to a specific value // Create a test connection details object and set the property to a specific value
ConnectionDetails details = TestObjects.GetTestConnectionDetails(); ConnectionDetails details = TestObjects.GetTestConnectionDetails();
@@ -243,6 +282,9 @@ namespace Microsoft.SqlTools.ServiceLayer.Test.Connection
string connectionString = ConnectionService.BuildConnectionString(details); string connectionString = ConnectionService.BuildConnectionString(details);
Assert.NotNull(connectionString); Assert.NotNull(connectionString);
Assert.NotEmpty(connectionString); Assert.NotEmpty(connectionString);
// Verify that the parameter is in the connection string
Assert.True(connectionString.Contains(connectionStringMarker));
} }
/// <summary> /// <summary>