Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduce automated test crashes #2968

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Reduce automated test crashes #2968

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
848241d
Converted Threads to long-running Tasks
edwardneal Nov 3, 2024
4bd9b8a
Corrected the instantiation of the cancellation task - missing state …
edwardneal Nov 3, 2024
7c766b4
Changes to TestSqlCommandCancel, eliminating timing-specific cancella…
edwardneal Nov 3, 2024
ad1a572
Responding to code review.
edwardneal Nov 13, 2024
db4945e
Improve cancellation detection
edwardneal Nov 15, 2024
35d4607
Merge upstream
edwardneal Nov 15, 2024
821ea46
Correcting previous merge
edwardneal Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
228 changes: 133 additions & 95 deletions src/Microsoft.Data.SqlClient/tests/ManualTests/AlwaysEncrypted/ApiShould.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1949,19 +1949,15 @@ public void TestBeginAndEndExecuteReaderWithAsyncCallback(string connection, Com
}
}

[SkipOnTargetFramework(TargetFrameworkMonikers.Netcoreapp)]
[ConditionalTheory(typeof(DataTestUtility), nameof(DataTestUtility.AreConnStringSetupForAE))]
[ClassData(typeof(AEConnectionStringProviderWithExecutionMethod))]
public void TestSqlCommandCancel(string connection, string value, int number)
public void TestSqlCommandCancel(string connection, string value)
{
CleanUpTable(connection, _tableName);

string executeMethod = value;
Assert.True(!string.IsNullOrWhiteSpace(executeMethod), @"executeMethod should not be null or empty");

int numberOfCancelCalls = number;
Assert.True(numberOfCancelCalls >= 0, "numberofCancelCalls should be >=0.");

IList<object> values = GetValues(dataHint: 58);
Assert.True(values != null && values.Count >= 3, @"values should not be null and count should be >= 3.");

Expand All @@ -1983,29 +1979,50 @@ public void TestSqlCommandCancel(string connection, string value, int number)

CommandHelper.s_sleepDuringTryFetchInputParameterEncryptionInfo?.SetValue(null, true);

Thread[] threads = new Thread[2];

// Invoke ExecuteReader or ExecuteNonQuery in another thread.
Task[] tasks = new Task[2];
ManualResetEventSlim startWorkloadSignal = new ManualResetEventSlim(false);
ManualResetEventSlim workloadCompleteSignal = new ManualResetEventSlim(false);

/*
* Invoke ExecuteReader or ExecuteNonQuery in another thread.
* Use long-running tasks to create the thread. This enables any failed assertions to propagate, rather than
* allowing the exception to kill the thread and the process.
* These threads should progress in the sequence below:
*
* Workload Thread | Cancel Thread
* ------------------------------------ | -------------
* Start thread | Start thread
* Wait for signal | -
* - | Set signal for workload start
* Start workload execution | Loop, cancelling workload until workload complete signal set
* Throw cancellation exception | -
* Set signal for workload complete | -
* End thread | Finish loop and end thread
*/
if (executeMethod == @"ExecuteReader")
{
threads[0] = new Thread(new ParameterizedThreadStart(Thread_ExecuteReader));
tasks[0] = new Task(Thread_ExecuteReader,
new TestCommandCancelParams(sqlCommand, _tableName, startWorkloadSignal, workloadCompleteSignal),
TaskCreationOptions.LongRunning);
}
else
{
threads[0] = new Thread(new ParameterizedThreadStart(Thread_ExecuteNonQuery));
tasks[0] = new Task(Thread_ExecuteNonQuery,
new TestCommandCancelParams(sqlCommand, _tableName, startWorkloadSignal, workloadCompleteSignal),
TaskCreationOptions.LongRunning);
}

threads[1] = new Thread(new ParameterizedThreadStart(Thread_Cancel));
tasks[1] = new Task(Thread_Cancel,
new TestCommandCancelParams(sqlCommand, _tableName, startWorkloadSignal, workloadCompleteSignal),
TaskCreationOptions.LongRunning);

// Start the execute thread.
threads[0].Start(new TestCommandCancelParams(sqlCommand, _tableName, numberOfCancelCalls));
tasks[0].Start();

// Start the thread which cancels the above command started by the execute thread.
threads[1].Start(new TestCommandCancelParams(sqlCommand, _tableName, numberOfCancelCalls));
tasks[1].Start();

// Wait for the threads to finish.
threads[0].Join();
threads[1].Join();
Task.WaitAll(tasks);

CommandHelper.s_sleepDuringTryFetchInputParameterEncryptionInfo?.SetValue(null, false);

Expand All @@ -2027,37 +2044,48 @@ public void TestSqlCommandCancel(string connection, string value, int number)

Assert.True(rowsAffected == numberOfRows, "Unexpected number of rows affected as returned by EndExecuteReader.");

// Verify the state of the sql command object.
// Verify the state of the sql command object. Also ensure that the exit lock was set (and didn't time out.)
VerifySqlCommandStateAfterCompletionOrCancel(sqlCommand);
Assert.True(workloadCompleteSignal.IsSet);
startWorkloadSignal.Reset();
workloadCompleteSignal.Reset();

CommandHelper.s_sleepDuringRunExecuteReaderTdsForSpDescribeParameterEncryption?.SetValue(null, true);

// Invoke ExecuteReader or ExecuteNonQuery in another thread.
threads = new Thread[2];
tasks = new Task[2];
if (executeMethod == @"ExecuteReader")
{
threads[0] = new Thread(new ParameterizedThreadStart(Thread_ExecuteReader));
tasks[0] = new Task(Thread_ExecuteReader,
new TestCommandCancelParams(sqlCommand, _tableName, startWorkloadSignal, workloadCompleteSignal),
TaskCreationOptions.LongRunning);
}
else
{
threads[0] = new Thread(new ParameterizedThreadStart(Thread_ExecuteNonQuery));
tasks[0] = new Task(Thread_ExecuteNonQuery,
new TestCommandCancelParams(sqlCommand, _tableName, startWorkloadSignal, workloadCompleteSignal),
TaskCreationOptions.LongRunning);
}
threads[1] = new Thread(new ParameterizedThreadStart(Thread_Cancel));
tasks[1] = new Task(Thread_Cancel,
new TestCommandCancelParams(sqlCommand, _tableName, startWorkloadSignal, workloadCompleteSignal),
TaskCreationOptions.LongRunning);

// Start the execute thread.
threads[0].Start(new TestCommandCancelParams(sqlCommand, _tableName, numberOfCancelCalls));
tasks[0].Start();

// Start the thread which cancels the above command started by the execute thread.
threads[1].Start(new TestCommandCancelParams(sqlCommand, _tableName, numberOfCancelCalls));
tasks[1].Start();

// Wait for the threads to finish.
threads[0].Join();
threads[1].Join();
Task.WaitAll(tasks);

CommandHelper.s_sleepDuringRunExecuteReaderTdsForSpDescribeParameterEncryption?.SetValue(null, false);

// Verify the state of the sql command object.
// Verify the state of the sql command object. Also ensure that the exit lock was set (and didn't time out.)
VerifySqlCommandStateAfterCompletionOrCancel(sqlCommand);
Assert.True(workloadCompleteSignal.IsSet);
startWorkloadSignal.Reset();
workloadCompleteSignal.Reset();

rowsAffected = 0;

Expand All @@ -2079,31 +2107,37 @@ public void TestSqlCommandCancel(string connection, string value, int number)

CommandHelper.s_sleepAfterReadDescribeEncryptionParameterResults?.SetValue(null, true);

threads = new Thread[2];
tasks = new Task[2];
if (executeMethod == @"ExecuteReader")
{
threads[0] = new Thread(new ParameterizedThreadStart(Thread_ExecuteReader));
tasks[0] = new Task(Thread_ExecuteReader,
new TestCommandCancelParams(sqlCommand, _tableName, startWorkloadSignal, workloadCompleteSignal),
TaskCreationOptions.LongRunning);
}
else
{
threads[0] = new Thread(new ParameterizedThreadStart(Thread_ExecuteNonQuery));
tasks[0] = new Task(Thread_ExecuteNonQuery,
new TestCommandCancelParams(sqlCommand, _tableName, startWorkloadSignal, workloadCompleteSignal),
TaskCreationOptions.LongRunning);
}
threads[1] = new Thread(new ParameterizedThreadStart(Thread_Cancel));
tasks[1] = new Task(Thread_Cancel,
new TestCommandCancelParams(sqlCommand, _tableName, startWorkloadSignal, workloadCompleteSignal),
TaskCreationOptions.LongRunning);

// Start the execute thread.
threads[0].Start(new TestCommandCancelParams(sqlCommand, _tableName, numberOfCancelCalls));
tasks[0].Start();

// Start the thread which cancels the above command started by the execute thread.
threads[1].Start(new TestCommandCancelParams(sqlCommand, _tableName, numberOfCancelCalls));
tasks[1].Start();

// Wait for the threads to finish.
threads[0].Join();
threads[1].Join();
Task.WaitAll(tasks);

CommandHelper.s_sleepAfterReadDescribeEncryptionParameterResults?.SetValue(null, false);

// Verify the state of the sql command object.
// Verify the state of the sql command object. Also ensure that the exit lock was set (and didn't time out.)
VerifySqlCommandStateAfterCompletionOrCancel(sqlCommand);
Assert.True(workloadCompleteSignal.IsSet);

rowsAffected = 0;

Expand Down Expand Up @@ -3096,47 +3130,76 @@ private void TestCancellationToken(FieldInfo failpoint, SqlCommand sqlCommand, i
Assert.True(rowsAffected == numberOfRows, "Unexpected number of rows affected as returned by EndExecuteReader.");
}

private void Thread_ExecuteReader(object cancelCommandTestParamsObject)
private void Thread_ExecuteReader(object state)
{
TestCommandCancelParams cancelCommandTestParamsObject = state as TestCommandCancelParams;
SqlCommand sqlCommand = cancelCommandTestParamsObject?.SqlCommand;
SqlDataReader reader = null;

Assert.True(cancelCommandTestParamsObject != null, @"cancelCommandTestParamsObject should not be null.");
SqlCommand sqlCommand = ((TestCommandCancelParams)cancelCommandTestParamsObject).SqlCommand as SqlCommand;
Assert.True(sqlCommand != null, "sqlCommand should not be null.");

string.Format(@"SELECT * FROM {0} WHERE FirstName = @FirstName AND CustomerId = @CustomerId", ((TestCommandCancelParams)cancelCommandTestParamsObject).TableName);
using (SqlDataReader reader = sqlCommand.ExecuteReader())
try
{
while (reader.Read())
{
Assert.Throws<InvalidOperationException>(() => sqlCommand.ExecuteReader());
}
// Wait for the cancellation thread to open this lock...
cancelCommandTestParamsObject.StartWorkloadSignal.Wait();

Exception ex = Assert.ThrowsAny<Exception>(() => (reader = sqlCommand.ExecuteReader()).Read());
Assert.Equal(@"Operation cancelled by user.", ex.Message);
}
finally
{
reader?.Dispose();
// ...and unlock the cancellation thread once we finish.
cancelCommandTestParamsObject.WorkloadCompleteSignal.Set();
}
}

private void Thread_ExecuteNonQuery(object cancelCommandTestParamsObject)
private void Thread_ExecuteNonQuery(object state)
{
TestCommandCancelParams cancelCommandTestParamsObject = state as TestCommandCancelParams;
SqlCommand sqlCommand = cancelCommandTestParamsObject?.SqlCommand;

Assert.True(cancelCommandTestParamsObject != null, @"cancelCommandTestParamsObject should not be null.");
SqlCommand sqlCommand = ((TestCommandCancelParams)cancelCommandTestParamsObject).SqlCommand as SqlCommand;
Assert.True(sqlCommand != null, "sqlCommand should not be null.");

string.Format(@"UPDATE {0} SET FirstName = @FirstName WHERE FirstName = @FirstName AND CustomerId = @CustomerId", ((TestCommandCancelParams)cancelCommandTestParamsObject).TableName);
try
{
// Wait for the cancellation thread to open this lock...
cancelCommandTestParamsObject.StartWorkloadSignal.Wait();

Exception ex = Assert.Throws<InvalidOperationException>(() => sqlCommand.ExecuteNonQuery());
Assert.Equal(@"Operation cancelled by user.", ex.Message);
Exception ex = Assert.ThrowsAny<Exception>(() => sqlCommand.ExecuteNonQuery());
Assert.Equal(@"Operation cancelled by user.", ex.Message);
}
finally
{
// ...and unlock the cancellation thread once we finish.
cancelCommandTestParamsObject.WorkloadCompleteSignal.Set();
}
}

private void Thread_Cancel(object cancelCommandTestParamsObject)
private void Thread_Cancel(object state)
{
TestCommandCancelParams cancelCommandTestParamsObject = state as TestCommandCancelParams;
SqlCommand sqlCommand = cancelCommandTestParamsObject?.SqlCommand;
int cancellations = 0;
System.Diagnostics.Stopwatch cancellationStart = new System.Diagnostics.Stopwatch();

Assert.True(cancelCommandTestParamsObject != null, @"cancelCommandTestParamsObject should not be null.");
SqlCommand sqlCommand = ((TestCommandCancelParams)cancelCommandTestParamsObject).SqlCommand as SqlCommand;
Assert.True(sqlCommand != null, "sqlCommand should not be null.");

Thread.Sleep(millisecondsTimeout: 500);
cancellationStart.Start();
cancelCommandTestParamsObject.StartWorkloadSignal.Set();

// Repeatedly cancel.
for (int i = 0; i < ((TestCommandCancelParams)cancelCommandTestParamsObject).NumberofTimesToRunCancel; i++)
// Repeatedly cancel until the other thread signals that it's completed execution
// (or until the command timeout has passed.)
do
{
sqlCommand.Cancel();
}
cancellations++;
} while (!cancelCommandTestParamsObject.WorkloadCompleteSignal.Wait(0)
&& cancellationStart.ElapsedMilliseconds <= sqlCommand.CommandTimeout);
cancellationStart.Stop();
}

public void Dispose()
Expand Down Expand Up @@ -3264,67 +3327,42 @@ internal TestAsyncCallBackStateObject(SqlCommand sqlCommand, int expectedRowsAff
internal class TestCommandCancelParams
{
/// <summary>
/// SqlCommand object.
/// </summary>
private readonly object _sqlCommand;

/// <summary>
/// Name of the test/works as table name
/// </summary>
private readonly string _tableName;

/// <summary>
/// number of times to run cancel.
/// Return the SqlCommand object.
/// </summary>
private readonly int _numberofCancelCommands;
public SqlCommand SqlCommand { get; }

/// <summary>
/// Return the SqlCommand object.
/// Return the table name (usually equal to the name of the test.)
/// </summary>
public object SqlCommand
{
get
{
return _sqlCommand;
}
}
public string TableName { get; }

/// <summary>
/// Return the tablename.
/// Lock set by the thread cancelling the SqlCommand.
/// </summary>
public object TableName
{
get
{
return _tableName;
}
}
public ManualResetEventSlim StartWorkloadSignal { get; }

/// <summary>
/// Return the number of times to run cancel.
/// Lock set by the thread executing the SqlCommand.
/// </summary>
public int NumberofTimesToRunCancel
{
get
{
return _numberofCancelCommands;
}
}
public ManualResetEventSlim WorkloadCompleteSignal { get; }

/// <summary>
/// Constructor.
/// </summary>
/// <param name="sqlCommand"></param>
/// <param name="tableName"></param>
/// <param name="numberofTimesToCancel"></param>
public TestCommandCancelParams(object sqlCommand, string tableName, int numberofTimesToCancel)
/// <param name="numberOfTimesToCancel"></param>
/// <param name="startWorkloadSignal"></param>
/// <param name="workloadCompleteSignal"></param>
public TestCommandCancelParams(SqlCommand sqlCommand, string tableName, ManualResetEventSlim startWorkloadSignal, ManualResetEventSlim workloadCompleteSignal)
{
Assert.True(sqlCommand != null, "sqlCommand should not be null.");
Assert.True(!string.IsNullOrWhiteSpace(tableName), "tableName should not be null or empty.");

_sqlCommand = sqlCommand;
_tableName = tableName;
_numberofCancelCommands = numberofTimesToCancel;
SqlCommand = sqlCommand;
TableName = tableName;
StartWorkloadSignal = startWorkloadSignal;
WorkloadCompleteSignal = workloadCompleteSignal;
}
}
}
6 changes: 2 additions & 4 deletions ...Microsoft.Data.SqlClient/tests/ManualTests/AlwaysEncrypted/TestFixtures/DatabaseHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,10 +299,8 @@ public IEnumerator<object[]> GetEnumerator()
{
foreach (string connStrAE in DataTestUtility.AEConnStrings)
{
yield return new object[] { connStrAE, @"ExecuteReader", 1 };
yield return new object[] { connStrAE, @"ExecuteReader", 3 };
yield return new object[] { connStrAE, @"ExecuteNonQuery", 1 };
yield return new object[] { connStrAE, @"ExecuteNonQuery", 3 };
yield return new object[] { connStrAE, @"ExecuteReader" };
edwardneal marked this conversation as resolved.
Show resolved Hide resolved
yield return new object[] { connStrAE, @"ExecuteNonQuery" };
}
}
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
Expand Down
Loading
Loading