|
#pragma warning disable CA1031 // Do not catch general exception types
#pragma warning disable CA1052 // Static holder types should be static
#pragma warning disable CA2007 // Consider calling ConfigureAwait on the awaited task
#pragma warning disable IDE0022 // Use expression body for method
#pragma warning disable IDE0046 // Convert to conditional expression
#pragma warning disable IDE0058 // Expression value is never used
#pragma warning disable IDE0059 // Unnecessary assignment of a value
#pragma warning disable IDE0161 // Convert to file-scoped namespace
#if XUNIT_NULLABLE
#nullable enable
#else
// In case this is source-imported with global nullable enabled but no XUNIT_NULLABLE
#pragma warning disable CS8603
#endif
using System;
using System.ComponentModel;
using System.Globalization;
using System.Threading.Tasks;
namespace Xunit
{
#if XUNIT_VISIBILITY_INTERNAL
internal
#else
public
#endif
partial class Assert
{
/// <summary>
/// Records any exception which is thrown by the given code.
/// </summary>
/// <param name="testCode">The code which may thrown an exception.</param>
/// <returns>Returns the exception that was thrown by the code; null, otherwise.</returns>
#if XUNIT_NULLABLE
protected static Exception? RecordException(Action testCode)
#else
protected static Exception RecordException(Action testCode)
#endif
{
GuardArgumentNotNull(nameof(testCode), testCode);
try
{
testCode();
return null;
}
catch (Exception ex)
{
return ex;
}
}
/// <summary>
/// Records any exception which is thrown by the given code that has
/// a return value. Generally used for testing property accessors.
/// </summary>
/// <param name="testCode">The code which may thrown an exception.</param>
/// <param name="asyncMethodName">The name of the async method the user should've called if they accidentally
/// passed in an async function</param>
/// <returns>Returns the exception that was thrown by the code; null, otherwise.</returns>
#if XUNIT_NULLABLE
protected static Exception? RecordException(
Func<object?> testCode,
#else
protected static Exception RecordException(
Func<object> testCode,
#endif
string asyncMethodName)
{
GuardArgumentNotNull(nameof(testCode), testCode);
var result = default(object);
try
{
result = testCode();
}
catch (Exception ex)
{
return ex;
}
if (result is Task)
throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, "You must call Assert.{0} when testing async code", asyncMethodName));
return null;
}
/// <summary/>
[EditorBrowsable(EditorBrowsableState.Never)]
[Obsolete("You must call Assert.RecordExceptionAsync (and await the result) when testing async code.", true)]
protected static Exception RecordException(Func<Task> testCode)
{
throw new NotImplementedException("You must call Assert.RecordExceptionAsync (and await the result) when testing async code.");
}
/// <summary>
/// Records any exception which is thrown by the given task.
/// </summary>
/// <param name="testCode">The task which may thrown an exception.</param>
/// <returns>Returns the exception that was thrown by the code; null, otherwise.</returns>
#if XUNIT_NULLABLE
protected static async Task<Exception?> RecordExceptionAsync(Func<Task> testCode)
#else
protected static async Task<Exception> RecordExceptionAsync(Func<Task> testCode)
#endif
{
GuardArgumentNotNull(nameof(testCode), testCode);
try
{
await testCode();
return null;
}
catch (Exception ex)
{
return ex;
}
}
}
}
|