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

Jump to bottom

Add extra properties for test results in dotnet test #3932

Merged
merged 3 commits into from
Oct 11, 2024
Merged

Add extra properties for test results in dotnet test #3932

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a004ff
Add duration property to test result messages in dotnet test
mariam-abdulla Oct 10, 2024
9caa1cc
Add StandardOutput and ErrorOutput properties to test result messages…
mariam-abdulla Oct 11, 2024
a99e95d
Merge branch 'main' into dev/mabdullah/add-extra-properties-for-test-…
mariam-abdulla Oct 11, 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
2 changes: 2 additions & 0 deletions src/Platform/Microsoft.Testing.Extensions.VSTestBridge/ObjectModel/ObjectModelConverters.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,13 @@ public static TestNode ToTestNode(this TestResult testResult, bool isTrxEnabled,
if (testResultMessage.Category == TestResultMessage.StandardErrorCategory)
{
testNode.Properties.Add(new SerializableKeyValuePairStringProperty("vstest.TestCase.StandardError", testResultMessage.Text ?? string.Empty));
testNode.Properties.Add(new StandardErrorProperty(testResultMessage.Text ?? string.Empty));
nohwnd marked this conversation as resolved.
Show resolved Hide resolved
}

if (testResultMessage.Category == TestResultMessage.StandardOutCategory)
{
testNode.Properties.Add(new SerializableKeyValuePairStringProperty("vstest.TestCase.StandardOutput", testResultMessage.Text ?? string.Empty));
testNode.Properties.Add(new StandardOutputProperty(testResultMessage.Text ?? string.Empty));
}
}

Expand Down
13 changes: 13 additions & 0 deletions src/Platform/Microsoft.Testing.Platform/IPC/Serializers/BaseSerializer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,18 @@ protected static void WriteField(Stream stream, ushort id, string? value)
WriteStringValue(stream, value);
}

protected static void WriteField(Stream stream, ushort id, long? value)
{
if (value is null)
{
return;
}

WriteShort(stream, id);
WriteSize<long>(stream);
WriteLong(stream, value.Value);
}

protected static void WriteField(Stream stream, string? value)
{
if (value is null)
Expand Down Expand Up @@ -370,6 +382,7 @@ protected static void WriteAtPosition(Stream stream, int value, long position)
Type type when type == typeof(short) => sizeof(short),
Type type when type == typeof(bool) => sizeof(bool),
Type type when type == typeof(byte) => sizeof(byte),
Type type when type == typeof(long) => sizeof(long),
_ => 0,
};

Expand Down
45 changes: 32 additions & 13 deletions src/Platform/Microsoft.Testing.Platform/ServerMode/DotnetTest/IPC/DotnetTestDataConsumer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ public async Task ConsumeAsync(IDataProducer dataProducer, IData value, Cancella
{
case TestNodeUpdateMessage testNodeUpdateMessage:

GetTestNodeDetails(testNodeUpdateMessage, out byte? state, out string? reason, out string? errorMessage, out string? errorStackTrace);
TestNodeDetails testNodeDetails = GetTestNodeDetails(testNodeUpdateMessage);

switch (state)
switch (testNodeDetails.State)
{
case TestStates.Discovered:
DiscoveredTestMessages discoveredTestMessages = new(
Expand All @@ -73,8 +73,11 @@ public async Task ConsumeAsync(IDataProducer dataProducer, IData value, Cancella
new SuccessfulTestResultMessage(
testNodeUpdateMessage.TestNode.Uid.Value,
testNodeUpdateMessage.TestNode.DisplayName,
state,
reason ?? string.Empty,
testNodeDetails.State,
testNodeDetails.Duration,
testNodeDetails.Reason ?? string.Empty,
testNodeDetails.StandardOutput ?? string.Empty,
testNodeDetails.StandardError ?? string.Empty,
testNodeUpdateMessage.SessionUid.Value),
},
Array.Empty<FailedTestResultMessage>());
Expand All @@ -91,10 +94,13 @@ public async Task ConsumeAsync(IDataProducer dataProducer, IData value, Cancella
new FailedTestResultMessage(
testNodeUpdateMessage.TestNode.Uid.Value,
testNodeUpdateMessage.TestNode.DisplayName,
state,
reason ?? string.Empty,
errorMessage ?? string.Empty,
errorStackTrace ?? string.Empty,
testNodeDetails.State,
testNodeDetails.Duration,
testNodeDetails.Reason ?? string.Empty,
testNodeDetails.ErrorMessage ?? string.Empty,
testNodeDetails.ErrorStackTrace ?? string.Empty,
testNodeDetails.StandardOutput ?? string.Empty,
testNodeDetails.StandardError ?? string.Empty,
testNodeUpdateMessage.SessionUid.Value),
});

Expand Down Expand Up @@ -157,13 +163,17 @@ public async Task ConsumeAsync(IDataProducer dataProducer, IData value, Cancella
}
}

private static void GetTestNodeDetails(TestNodeUpdateMessage testNodeUpdateMessage, out byte? state, out string? reason, out string? errorMessage, out string? errorStackTrace)
private static TestNodeDetails GetTestNodeDetails(TestNodeUpdateMessage testNodeUpdateMessage)
{
state = null;
reason = string.Empty;
errorMessage = string.Empty;
errorStackTrace = string.Empty;
byte? state = null;
long? duration = null;
string? reason = string.Empty;
string? errorMessage = string.Empty;
string? errorStackTrace = string.Empty;

TestNodeStateProperty nodeState = testNodeUpdateMessage.TestNode.Properties.Single<TestNodeStateProperty>();
string? standardOutput = testNodeUpdateMessage.TestNode.Properties.SingleOrDefault<StandardOutputProperty>()?.StandardOutput;
string? standardError = testNodeUpdateMessage.TestNode.Properties.SingleOrDefault<StandardErrorProperty>()?.StandardError;

switch (nodeState)
{
Expand All @@ -173,6 +183,7 @@ private static void GetTestNodeDetails(TestNodeUpdateMessage testNodeUpdateMessa

case PassedTestNodeStateProperty:
state = TestStates.Passed;
duration = testNodeUpdateMessage.TestNode.Properties.SingleOrDefault<TimingProperty>()?.GlobalTiming.Duration.Ticks;
reason = nodeState.Explanation;
break;

Expand All @@ -183,34 +194,42 @@ private static void GetTestNodeDetails(TestNodeUpdateMessage testNodeUpdateMessa

case FailedTestNodeStateProperty failedTestNodeStateProperty:
state = TestStates.Failed;
duration = testNodeUpdateMessage.TestNode.Properties.SingleOrDefault<TimingProperty>()?.GlobalTiming.Duration.Ticks;
reason = nodeState.Explanation;
errorMessage = failedTestNodeStateProperty.Exception?.Message;
errorStackTrace = failedTestNodeStateProperty.Exception?.StackTrace;
break;

case ErrorTestNodeStateProperty errorTestNodeStateProperty:
state = TestStates.Error;
duration = testNodeUpdateMessage.TestNode.Properties.SingleOrDefault<TimingProperty>()?.GlobalTiming.Duration.Ticks;
reason = nodeState.Explanation;
errorMessage = errorTestNodeStateProperty.Exception?.Message;
errorStackTrace = errorTestNodeStateProperty.Exception?.StackTrace;
break;

case TimeoutTestNodeStateProperty timeoutTestNodeStateProperty:
state = TestStates.Timeout;
duration = testNodeUpdateMessage.TestNode.Properties.SingleOrDefault<TimingProperty>()?.GlobalTiming.Duration.Ticks;
reason = nodeState.Explanation;
errorMessage = timeoutTestNodeStateProperty.Exception?.Message;
errorStackTrace = timeoutTestNodeStateProperty.Exception?.StackTrace;
break;

case CancelledTestNodeStateProperty cancelledTestNodeStateProperty:
state = TestStates.Cancelled;
duration = testNodeUpdateMessage.TestNode.Properties.SingleOrDefault<TimingProperty>()?.GlobalTiming.Duration.Ticks;
reason = nodeState.Explanation;
errorMessage = cancelledTestNodeStateProperty.Exception?.Message;
errorStackTrace = cancelledTestNodeStateProperty.Exception?.StackTrace;
break;
}

return new TestNodeDetails(state, duration, reason, errorMessage, errorStackTrace, standardOutput, standardError);
}

public record TestNodeDetails(byte? State, long? Duration, string? Reason, string? ErrorMessage, string? ErrorStackTrace, string? StandardOutput, string? StandardError);

public Task<bool> IsEnabledAsync() => Task.FromResult(true);

public async Task OnTestSessionStartingAsync(SessionUid sessionUid, CancellationToken cancellationToken)
Expand Down
4 changes: 2 additions & 2 deletions ...latform/Microsoft.Testing.Platform/ServerMode/DotnetTest/IPC/Models/TestResultMessages.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

namespace Microsoft.Testing.Platform.IPC.Models;

internal sealed record SuccessfulTestResultMessage(string? Uid, string? DisplayName, byte? State, string? Reason, string? SessionUid);
internal sealed record SuccessfulTestResultMessage(string? Uid, string? DisplayName, byte? State, long? Duration, string? Reason, string? StandardOutput, string? ErrorOutput, string? SessionUid);

internal sealed record FailedTestResultMessage(string? Uid, string? DisplayName, byte? State, string? Reason, string? ErrorMessage, string? ErrorStackTrace, string? SessionUid);
internal sealed record FailedTestResultMessage(string? Uid, string? DisplayName, byte? State, long? Duration, string? Reason, string? ErrorMessage, string? ErrorStackTrace, string? StandardOutput, string? ErrorOutput, string? SessionUid);

internal sealed record TestResultMessages(string? ExecutionId, SuccessfulTestResultMessage[] SuccessfulTestMessages, FailedTestResultMessage[] FailedTestMessages) : IRequest;
18 changes: 12 additions & 6 deletions src/Platform/Microsoft.Testing.Platform/ServerMode/DotnetTest/IPC/ObjectFieldIds.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,19 +66,25 @@ internal static class SuccessfulTestResultMessageFieldsId
public const ushort Uid = 1;
public const ushort DisplayName = 2;
public const ushort State = 3;
public const ushort Reason = 4;
public const ushort SessionUid = 5;
public const ushort Duration = 4;
nohwnd marked this conversation as resolved.
Show resolved Hide resolved
public const ushort Reason = 5;
public const ushort StandardOutput = 6;
public const ushort ErrorOutput = 7;
public const ushort SessionUid = 8;
}

internal static class FailedTestResultMessageFieldsId
{
public const ushort Uid = 1;
public const ushort DisplayName = 2;
public const ushort State = 3;
public const ushort Reason = 4;
public const ushort ErrorMessage = 5;
public const ushort ErrorStackTrace = 6;
public const ushort SessionUid = 7;
public const ushort Duration = 4;
public const ushort Reason = 5;
public const ushort ErrorMessage = 6;
public const ushort ErrorStackTrace = 7;
public const ushort StandardOutput = 8;
public const ushort ErrorOutput = 9;
public const ushort SessionUid = 10;
}

internal static class FileArtifactMessagesFieldsId
Expand Down
Loading