Assert Conditions now contain an AssertionMetadata object containing delegate durations (#1795)

Author: thomhurst

TUnit.Assertions/AssertConditions/BaseAssertCondition.cs

@@ -30,7 +30,7 @@ public AssertionResult FailWithMessage(string message)
     internal virtual string GetExpectationWithReason()
         => $"{GetExpectation()}{GetBecauseReason()}";
 
-    internal abstract Task<AssertionResult> GetAssertionResult(object? actualValue, Exception? exception, string? actualExpression);
+    internal abstract Task<AssertionResult> GetAssertionResult(object? actualValue, Exception? exception, AssertionMetadata assertionMetadata, string? actualExpression);
 
     internal void SetSubject(string? subject)
         => Subject = subject;
@@ -41,24 +41,30 @@ public abstract class BaseAssertCondition<TActual> : BaseAssertCondition
 
     internal Task<AssertionResult> GetAssertionResult(AssertionData assertionData)
     {
-        return GetAssertionResult(assertionData.Result, assertionData.Exception, assertionData.ActualExpression);
+        return GetAssertionResult(assertionData.Result, assertionData.Exception, new AssertionMetadata
+        {
+            StartTime = assertionData.Start,
+            EndTime = assertionData.End
+        }, assertionData.ActualExpression);
     }
 
-    internal override Task<AssertionResult> GetAssertionResult(object? actualValue, Exception? exception, string? actualExpression)
+    internal override Task<AssertionResult> GetAssertionResult(object? actualValue, Exception? exception,
+        AssertionMetadata assertionMetadata, string? actualExpression)
     {
         if (actualValue is not null && actualValue is not TActual)
         {
             throw new AssertionException($"Expected {typeof(TActual).Name} but received {actualValue.GetType().Name}");
         } 
 
-        return GetAssertionResult((TActual?) actualValue, exception, actualExpression);
+        return GetAssertionResult((TActual?) actualValue, exception, assertionMetadata, actualExpression);
     }
 
     internal TActual? ActualValue { get; private set; }
     internal Exception? Exception { get; private set; }
     public string? ActualExpression { get; private set; }
 
-    public Task<AssertionResult> GetAssertionResult(TActual? actualValue, Exception? exception, string? actualExpression = null)
+    public Task<AssertionResult> GetAssertionResult(TActual? actualValue, Exception? exception,
+        AssertionMetadata assertionMetadata, string? actualExpression = null)
     {
         ActualValue = actualValue;
         Exception = exception;
@@ -69,8 +75,9 @@ public Task<AssertionResult> GetAssertionResult(TActual? actualValue, Exception?
             AssertionScope.GetCurrentAssertionScope()?.RemoveException(exception);
         }
 
-        return GetResult(actualValue, exception);
+        return GetResult(actualValue, exception, assertionMetadata);
     }
 
-    protected abstract Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception);
+    protected abstract Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception,
+        AssertionMetadata assertionMetadata);
 }

TUnit.Assertions/AssertConditions/Connectors/AndAssertCondition.cs

@@ -22,10 +22,10 @@ public AndAssertCondition(BaseAssertCondition condition1, BaseAssertCondition co
     internal override string GetExpectationWithReason()
         => $"{_condition1.GetExpectationWithReason()}{Environment.NewLine} and {_condition2.GetExpectationWithReason()}";
 
-    internal sealed override async Task<AssertionResult> GetAssertionResult(object? actualValue, Exception? exception, string? actualExpression)
+    internal sealed override async Task<AssertionResult> GetAssertionResult(object? actualValue, Exception? exception, AssertionMetadata assertionMetadata, string? actualExpression)
     {
-        return (await _condition1.GetAssertionResult(actualValue, exception, actualExpression))
-            .And(await _condition2.GetAssertionResult(actualValue, exception, actualExpression));
+        return (await _condition1.GetAssertionResult(actualValue, exception, assertionMetadata, actualExpression))
+            .And(await _condition2.GetAssertionResult(actualValue, exception, assertionMetadata, actualExpression));
     }
 
     internal override void SetBecauseReason(BecauseReason becauseReason)

TUnit.Assertions/AssertConditions/Connectors/OrAssertCondition.cs

@@ -21,10 +21,10 @@ public OrAssertCondition(BaseAssertCondition condition1, BaseAssertCondition con
     internal override string GetExpectationWithReason()
         => $"{_condition1.GetExpectationWithReason()}{Environment.NewLine} or {_condition2.GetExpectationWithReason()}";
 
-    internal sealed override async Task<AssertionResult> GetAssertionResult(object? actualValue, Exception? exception, string? actualExpression)
+    internal sealed override async Task<AssertionResult> GetAssertionResult(object? actualValue, Exception? exception, AssertionMetadata assertionMetadata, string? actualExpression)
     {
-        return (await _condition1.GetAssertionResult(actualValue, exception, actualExpression))
-            .Or(await _condition2.GetAssertionResult(actualValue, exception, actualExpression));
+        return (await _condition1.GetAssertionResult(actualValue, exception, assertionMetadata, actualExpression))
+            .Or(await _condition2.GetAssertionResult(actualValue, exception, assertionMetadata, actualExpression));
     }
 
     internal override void SetBecauseReason(BecauseReason becauseReason)

TUnit.Assertions/AssertConditions/DelegateAssertCondition.cs

@@ -15,7 +15,8 @@ public void WithComparer(Func<TException?, AssertionDecision> comparer)
         _customComparers.Add(comparer);
     }
 
-    protected override Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception)
+    protected override Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception,
+        AssertionMetadata assertionMetadata)
     {
         if (exception != null && exception is not TException)
         {

TUnit.Assertions/AssertConditions/EnumerableSatisfiesAssertCondition.cs

@@ -23,7 +23,8 @@ public EnumerableSatisfiesAssertCondition(Func<TInner?, Task<TExpected>?> mapper
     protected override string GetExpectation()
         => $"to satisfy {_assertionBuilderExpression}";
 
-    protected override async Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception)
+    protected override async Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception,
+        AssertionMetadata assertionMetadata)
     {
         if (actualValue is null)
         {
@@ -34,7 +35,7 @@ protected override async Task<AssertionResult> GetResult(TActual? actualValue, E
         foreach (var itemValue in actualValue)
         {
             var currentIndex = i++;
-            var assertionResult = await GetResult(itemValue, exception);
+            var assertionResult = await GetResult(itemValue, exception, assertionMetadata);
             if (assertionResult.IsPassed)
             {
                 continue;
@@ -46,15 +47,15 @@ protected override async Task<AssertionResult> GetResult(TActual? actualValue, E
         return mergedAsserts;
     }
 
-    private async Task<AssertionResult> GetResult(TInner? itemValue, Exception? exception)
+    private async Task<AssertionResult> GetResult(TInner? itemValue, Exception? exception, AssertionMetadata assertionMetadata)
     {
         var innerItemTask = _mapper(itemValue);
         var innerItem = innerItemTask == null ? default : await innerItemTask;
         var innerAssertionBuilder = new ValueAssertionBuilder<TExpected?>(innerItem, "");
         var assertion = _assertionBuilder(innerAssertionBuilder);
         foreach (var baseAssertCondition in assertion.Assertions)
         {
-            var result = await baseAssertCondition.GetAssertionResult(innerItem, exception, "");
+            var result = await baseAssertCondition.GetAssertionResult(innerItem, exception, assertionMetadata, "");
             if (!result.IsPassed)
             {
                 return result;

TUnit.Assertions/AssertConditions/ExpectedValueAssertCondition.cs

@@ -20,7 +20,8 @@ public void WithComparer(Func<TActual?, TExpected?, AssertionDecision> comparer)
         _customComparers.Add(comparer);
     }
 
-    protected override Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception)
+    protected override Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception,
+        AssertionMetadata assertionMetadata)
     {
         var expected = ExpectedValue;
 

TUnit.Assertions/AssertConditions/NotNullExpectedValueAssertCondition.cs

@@ -5,7 +5,8 @@ public class NotNullExpectedValueAssertCondition<TActual> : BaseAssertCondition<
     protected override string GetExpectation()
         => "to not be null";
 
-    protected override Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception)
+    protected override Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception,
+        AssertionMetadata assertionMetadata)
         => AssertionResult
             .FailIf(actualValue is null,
                 "it was");

TUnit.Assertions/AssertConditions/NullExpectedValueAssertCondition.cs

@@ -5,7 +5,8 @@ public class NullExpectedValueAssertCondition<TActual> : BaseAssertCondition<TAc
     protected override string GetExpectation()
         => "to be null";
 
-    protected override Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception)
+    protected override Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception,
+        AssertionMetadata assertionMetadata)
         => AssertionResult
             .FailIf(actualValue is not null,
                 $"found {actualValue}");

TUnit.Assertions/AssertConditions/SatisfiesAssertCondition.cs

@@ -22,7 +22,8 @@ public SatisfiesAssertCondition(Func<TActual, Task<TExpected>?> mapper,
     protected override string GetExpectation()
         => $"to satisfy {_assertionBuilderExpression}";
 
-    protected override async Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception)
+    protected override async Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception,
+        AssertionMetadata assertionMetadata)
     {
         if (actualValue is null)
         {
@@ -39,7 +40,7 @@ protected override async Task<AssertionResult> GetResult(TActual? actualValue, E
 
         foreach (var baseAssertCondition in ((ISource)assertion).Assertions)
         {
-            var result = await baseAssertCondition.GetAssertionResult(innerItem, exception, "");
+            var result = await baseAssertCondition.GetAssertionResult(innerItem, exception, assertionMetadata, "");
 
             if (!result.IsPassed)
             {

TUnit.Assertions/AssertConditions/ValueAssertCondition.cs

@@ -18,7 +18,8 @@ public void WithComparer(Func<TActual?, AssertionDecision> comparer)
         _customComparers.Add(comparer);
     }
 
-    protected override Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception)
+    protected override Task<AssertionResult> GetResult(TActual? actualValue, Exception? exception,
+        AssertionMetadata assertionMetadata)
     {
         if (exception is not null)
         {