-
Notifications
You must be signed in to change notification settings - Fork 263
/
ConnectivityTest.cs
502 lines (437 loc) · 21.5 KB
/
ConnectivityTest.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.Data;
using System.Diagnostics;
using System.Threading;
using Xunit;
namespace Microsoft.Data.SqlClient.ManualTesting.Tests
{
public static class ConnectivityTest
{
private const string COL_SPID = "SPID";
private const string COL_PROGRAM_NAME = "ProgramName";
private const string COL_HOSTNAME = "HostName";
private static readonly string s_databaseName = "d_" + Guid.NewGuid().ToString().Replace('-', '_');
private static readonly string s_tableName = DataTestUtility.GenerateObjectName();
private static readonly string s_connectionString = DataTestUtility.TCPConnectionString;
private static readonly string s_dbConnectionString = new SqlConnectionStringBuilder(s_connectionString) { InitialCatalog = s_databaseName }.ConnectionString;
private static readonly string s_createDatabaseCmd = $"CREATE DATABASE {s_databaseName}";
private static readonly string s_createTableCmd = $"CREATE TABLE {s_tableName} (NAME NVARCHAR(40), AGE INT)";
private static readonly string s_alterDatabaseSingleCmd = $"ALTER DATABASE {s_databaseName} SET SINGLE_USER WITH ROLLBACK IMMEDIATE;";
private static readonly string s_alterDatabaseMultiCmd = $"ALTER DATABASE {s_databaseName} SET MULTI_USER WITH ROLLBACK IMMEDIATE;";
private static readonly string s_selectTableCmd = $"SELECT COUNT(*) FROM {s_tableName}";
private static readonly string s_dropDatabaseCmd = $"DROP DATABASE {s_databaseName}";
// Synapse: Stored procedure sp_who2 does not exist or is not supported.
// Synapse: SqlConnection.ServerProcessId is always retrieved as 0.
[ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsNotAzureSynapse))]
public static void EnvironmentHostNameSPIDTest()
{
SqlConnectionStringBuilder builder = new(DataTestUtility.TCPConnectionString)
{
Pooling = true,
ApplicationName = "HostNameTest"
};
using (SqlConnection sqlConnection = new(builder.ConnectionString))
{
sqlConnection.Open();
int sqlClientSPID = sqlConnection.ServerProcessId;
int sessionSpid;
using (SqlCommand cmd = new("SELECT @@SPID", sqlConnection))
using (SqlDataReader reader = cmd.ExecuteReader())
{
reader.Read();
sessionSpid = reader.GetInt16(0);
}
// Confirm Server process id is same as result of SELECT @@SPID
Assert.Equal(sessionSpid, sqlClientSPID);
// Confirm once again SPID on SqlConnection directly
Assert.Equal(sessionSpid, sqlConnection.ServerProcessId);
using (SqlCommand command = new("sp_who2", sqlConnection))
using (SqlDataReader reader = command.ExecuteReader())
{
while (reader.Read())
{
int programNameOrdinal = reader.GetOrdinal(COL_PROGRAM_NAME);
string programName = reader.GetString(programNameOrdinal);
int spidOrdinal = reader.GetOrdinal(COL_SPID);
string spid = reader.GetString(spidOrdinal);
if (programName != null && programName.Trim().Equals(builder.ApplicationName) && short.Parse(spid) == sessionSpid)
{
// Get the hostname
int hostnameOrdinal = reader.GetOrdinal(COL_HOSTNAME);
string hostnameFromServer = reader.GetString(hostnameOrdinal);
string expectedMachineName = Environment.MachineName.ToUpper();
string hostNameFromServer = hostnameFromServer.Trim().ToUpper();
Assert.Matches(expectedMachineName, hostNameFromServer);
return;
}
}
}
// Confirm Server Process Id stays the same after query execution
Assert.Equal(sessionSpid, sqlConnection.ServerProcessId);
}
Assert.Fail("No non-empty hostname found for the application");
}
[ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup))]
public static async void ConnectionTimeoutInfiniteTest()
{
// Exercise the special-case infinite connect timeout code path
SqlConnectionStringBuilder builder = new(DataTestUtility.TCPConnectionString)
{
ConnectTimeout = 0 // Infinite
};
using SqlConnection conn = new(builder.ConnectionString);
CancellationTokenSource cts = new(30000);
// Will throw TaskCanceledException and fail the test in the event of a hang
await conn.OpenAsync(cts.Token);
}
[ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup))]
public static void ConnectionTimeoutTestWithThread()
{
const int timeoutSec = 5;
const int numOfTry = 2;
const int numOfThreads = 5;
SqlConnectionStringBuilder builder = new(DataTestUtility.TCPConnectionString)
{
DataSource = "invalidhost",
ConnectTimeout = timeoutSec
};
string connStrNotAvailable = builder.ConnectionString;
for (int i = 0; i < numOfThreads; ++i)
{
new ConnectionWorker(connStrNotAvailable, numOfTry);
}
ConnectionWorker.Start();
ConnectionWorker.Stop();
double timeTotal = 0;
foreach (ConnectionWorker w in ConnectionWorker.WorkerList)
{
timeTotal += w.TimeElapsed;
}
double timeElapsed = timeTotal / Convert.ToDouble(ConnectionWorker.WorkerList.Count);
int threshold = timeoutSec * numOfTry * 2 * 1000;
Assert.True(timeElapsed < threshold);
}
// Synapse: Catalog view 'sysprocesses' is not supported in this version.
[ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsNotAzureSynapse))]
public static void LocalProcessIdTest()
{
SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(DataTestUtility.TCPConnectionString);
string sqlProviderName = builder.ApplicationName;
string sqlProviderProcessID = Process.GetCurrentProcess().Id.ToString();
using (SqlConnection sqlConnection = new SqlConnection(builder.ConnectionString))
{
sqlConnection.Open();
string strCommand = $"SELECT PROGRAM_NAME,HOSTPROCESS FROM SYS.SYSPROCESSES WHERE PROGRAM_NAME LIKE ('%{sqlProviderName}%')";
using (SqlCommand command = new SqlCommand(strCommand, sqlConnection))
{
using (SqlDataReader reader = command.ExecuteReader())
{
bool processIdFound = false;
while (reader.Read())
{
Assert.Equal(sqlProviderName, reader.GetString(0).Trim());
if (sqlProviderProcessID == reader.GetString(1).Trim())
{
processIdFound = true;
}
}
Assert.True(processIdFound);
}
}
}
}
public class ConnectionWorker : IDisposable
{
private static List<ConnectionWorker> s_workerList = new();
private ManualResetEventSlim _doneEvent = new(false);
private double _timeElapsed;
private Thread _thread;
private string _connectionString;
private int _numOfTry;
public ConnectionWorker(string connectionString, int numOfTry)
{
s_workerList.Add(this);
_connectionString = connectionString;
_numOfTry = numOfTry;
_thread = new Thread(new ThreadStart(SqlConnectionOpen));
}
public static List<ConnectionWorker> WorkerList => s_workerList;
public double TimeElapsed => _timeElapsed;
public static void Start()
{
foreach (ConnectionWorker w in s_workerList)
{
w._thread.Start();
}
}
public static void Stop()
{
foreach (ConnectionWorker w in s_workerList)
{
w._doneEvent.Wait();
}
}
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
protected virtual void Dispose(bool disposing)
{
if (disposing)
{
_doneEvent.Dispose();
}
}
public void SqlConnectionOpen()
{
Stopwatch sw = new Stopwatch();
double totalTime = 0;
for (int i = 0; i < _numOfTry; ++i)
{
using (SqlConnection con = new(_connectionString))
{
sw.Start();
try
{
con.Open();
}
catch { }
sw.Stop();
}
totalTime += sw.Elapsed.TotalMilliseconds;
sw.Reset();
}
_timeElapsed = totalTime / Convert.ToDouble(_numOfTry);
_doneEvent.Set();
}
}
// Synapse: Parse error at line: 1, column: 59: Incorrect syntax near 'SINGLE_USER' - No support for MULTI_USER
[ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsNotAzureServer))]
public static void ConnectionKilledTest()
{
try
{
// Setup Database and Table.
DataTestUtility.RunNonQuery(s_connectionString, s_createDatabaseCmd);
DataTestUtility.RunNonQuery(s_dbConnectionString, s_createTableCmd);
// Kill all the connections and set Database to SINGLE_USER Mode.
DataTestUtility.RunNonQuery(s_connectionString, s_alterDatabaseSingleCmd, 4);
// Set Database back to MULTI_USER Mode
DataTestUtility.RunNonQuery(s_connectionString, s_alterDatabaseMultiCmd, 4);
// Execute SELECT statement.
DataTestUtility.RunNonQuery(s_dbConnectionString, s_selectTableCmd);
}
finally
{
// Kill all the connections, set Database to SINGLE_USER Mode and drop Database
DataTestUtility.RunNonQuery(s_connectionString, s_alterDatabaseSingleCmd, 4);
DataTestUtility.RunNonQuery(s_connectionString, s_dropDatabaseCmd, 4);
}
}
// Synapse: KILL not supported on Azure Synapse - Parse error at line: 1, column: 6: Incorrect syntax near '105'.
[ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsNotAzureSynapse))]
public static void ConnectionResiliencySPIDTest()
{
SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(DataTestUtility.TCPConnectionString)
{
ConnectRetryCount = 0,
ConnectRetryInterval = 5
};
// No connection resiliency
using (SqlConnection conn = new(builder.ConnectionString))
{
conn.Open();
InternalConnectionWrapper wrapper = new(conn, true, builder.ConnectionString);
using SqlCommand cmd = conn.CreateCommand();
cmd.CommandText = "SELECT @@SPID";
wrapper.KillConnectionByTSql();
bool cmdSuccess = false;
try
{
cmd.ExecuteScalar();
cmdSuccess = true;
}
// Windows always throws SqlException. Unix sometimes throws AggregateException against Azure SQL DB.
catch (Exception ex) when (ex is SqlException || ex is AggregateException) { }
Assert.False(cmdSuccess);
}
builder.ConnectRetryCount = 2;
// Also check SPID changes with connection resiliency
using (SqlConnection conn = new(builder.ConnectionString))
{
conn.Open();
int clientSPID = conn.ServerProcessId;
int serverSPID = 0;
InternalConnectionWrapper wrapper = new(conn, true, builder.ConnectionString);
using SqlCommand cmd = conn.CreateCommand();
cmd.CommandText = "SELECT @@SPID";
using (SqlDataReader reader = cmd.ExecuteReader())
while (reader.Read())
{
serverSPID = reader.GetInt16(0);
}
Assert.Equal(serverSPID, clientSPID);
// Also check SPID after query execution
Assert.Equal(serverSPID, conn.ServerProcessId);
wrapper.KillConnectionByTSql();
// Connection resiliency should reconnect transparently
using (SqlDataReader reader = cmd.ExecuteReader())
while (reader.Read())
{
serverSPID = reader.GetInt16(0);
}
// SPID should match server's SPID
Assert.Equal(serverSPID, conn.ServerProcessId);
}
}
[ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.IsTCPConnectionStringPasswordIncluded))]
public static void ConnectionStringPersistentInfoTest()
{
SqlConnectionStringBuilder connectionStringBuilder = new(DataTestUtility.TCPConnectionString)
{
PersistSecurityInfo = false
};
string cnnString = connectionStringBuilder.ConnectionString;
connectionStringBuilder.Clear();
using (SqlConnection sqlCnn = new(cnnString))
{
sqlCnn.Open();
connectionStringBuilder.ConnectionString = sqlCnn.ConnectionString;
Assert.True(string.IsNullOrEmpty(connectionStringBuilder.Password), "Password must not persist according to set the PersistSecurityInfo by false!");
}
connectionStringBuilder.ConnectionString = DataTestUtility.TCPConnectionString;
connectionStringBuilder.PersistSecurityInfo = true;
cnnString = connectionStringBuilder.ConnectionString;
connectionStringBuilder.Clear();
using (SqlConnection sqlCnn = new(cnnString))
{
sqlCnn.Open();
connectionStringBuilder.ConnectionString = sqlCnn.ConnectionString;
Assert.True(!string.IsNullOrEmpty(connectionStringBuilder.Password), "Password must persist according to set the PersistSecurityInfo by true!");
}
}
[ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup))]
public static void ConnectionOpenDisableRetry()
{
SqlConnectionStringBuilder connectionStringBuilder = new(DataTestUtility.TCPConnectionString)
{
InitialCatalog = "DoesNotExist0982532435423",
Pooling = false,
ConnectTimeout = 15
};
using SqlConnection sqlConnection = new(connectionStringBuilder.ConnectionString);
Stopwatch timer = new();
timer.Start();
Assert.Throws<SqlException>(() => sqlConnection.Open(SqlConnectionOverrides.OpenWithoutRetry));
timer.Stop();
TimeSpan duration = timer.Elapsed;
Assert.True(duration.Seconds < 2, $"Connection Open() without retries took longer than expected. Expected < 2 sec. Took {duration.Seconds} sec.");
timer.Restart();
Assert.Throws<SqlException>(() => sqlConnection.Open());
timer.Stop();
duration = timer.Elapsed;
Assert.True(duration.Seconds > 5, $"Connection Open() with retries took less time than expected. Expect > 5 sec with transient fault handling. Took {duration.Seconds} sec."); // sqlConnection.Open();
}
[PlatformSpecific(TestPlatforms.Windows)]
[ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsSQLAliasSetup))]
public static void ConnectionAliasTest()
{
SqlConnectionStringBuilder builder = new(DataTestUtility.TCPConnectionString)
{
DataSource = DataTestUtility.AliasName
};
using SqlConnection sqlConnection = new(builder.ConnectionString);
Assert.Equal(DataTestUtility.AliasName, builder.DataSource);
try
{
sqlConnection.Open();
Assert.Equal(ConnectionState.Open, sqlConnection.State);
}
catch (SqlException ex)
{
Assert.Fail(ex.Message);
}
}
private static bool CanUseDacConnection()
{
if (!DataTestUtility.IsTCPConnStringSetup())
{
return false;
}
SqlConnectionStringBuilder b = new(DataTestUtility.TCPConnectionString);
if (!DataTestUtility.ParseDataSource(b.DataSource, out string hostname, out int port, out string instanceName))
{
return false;
}
if ("localhost".Equals(hostname.ToLower()) && (port.Equals(-1) || port.Equals(1433)) &&
string.IsNullOrEmpty(instanceName) && b.UserID != null && b.UserID.ToLower().Equals("sa"))
{
return true;
}
return false;
}
[ConditionalFact(nameof(CanUseDacConnection))]
public static void DacConnectionTest()
{
if (!CanUseDacConnection())
{
throw new Exception("Unable to use a DAC connection in this environment. Localhost + sa credentials required.");
}
SqlConnectionStringBuilder b = new(DataTestUtility.TCPConnectionString);
b.DataSource = "admin:localhost";
using SqlConnection sqlConnection = new(b.ConnectionString);
sqlConnection.Open();
}
private static bool UsernamePasswordNonEncryptedConnectionSetup()
{
if (!DataTestUtility.IsTCPConnStringSetup())
{
return false;
}
SqlConnectionStringBuilder b = new(DataTestUtility.TCPConnectionString);
return !string.IsNullOrEmpty(b.UserID) &&
!string.IsNullOrEmpty(b.Password) &&
b.Encrypt == SqlConnectionEncryptOption.Optional &&
(b.Authentication == SqlAuthenticationMethod.NotSpecified || b.Authentication == SqlAuthenticationMethod.SqlPassword);
}
[ConditionalFact(nameof(UsernamePasswordNonEncryptedConnectionSetup))]
public static void SqlPasswordConnectionTest()
{
if (!UsernamePasswordNonEncryptedConnectionSetup())
{
throw new Exception("Sql credentials and non-Encrypted connection required.");
}
SqlConnectionStringBuilder b = new(DataTestUtility.TCPConnectionString);
b.Authentication = SqlAuthenticationMethod.SqlPassword;
// This ensures we are not validating the server certificate when we shouldn't be
// This test may fail if Encrypt = false but the test server requires encryption
b.TrustServerCertificate = false;
using SqlConnection sqlConnection = new(b.ConnectionString);
sqlConnection.Open();
}
[ConditionalFact(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringsSetup), nameof(DataTestUtility.IsNotAzureSynapse))]
public static void ConnectionFireInfoMessageEventOnUserErrorsShouldSucceed()
{
using (var connection = new SqlConnection(DataTestUtility.TCPConnectionString))
{
string command = "print";
string commandParam = "OK";
connection.FireInfoMessageEventOnUserErrors = true;
connection.InfoMessage += (sender, args) =>
{
Assert.Equal(commandParam, args.Message);
};
connection.Open();
using SqlCommand cmd = connection.CreateCommand();
cmd.CommandType = System.Data.CommandType.Text;
cmd.CommandText = $"{command} '{commandParam}'";
cmd.ExecuteNonQuery();
}
}
}
}