Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
45 changes: 41 additions & 4 deletions src/Allure.Net.Commons/AllureApi.cs
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,21 @@ public static void AddGlobalAttachment(
public static void AddGlobalError(Exception error) =>
AddGlobalErrorInternal(
CreateGlobalError(
ModelFunctions.ToStatusDetails(error)
ModelFunctions.ToStatusDetails(error),
GlobalErrorStatus.Broken
)
);

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="error">The error to persist.</param>
/// <param name="status">The status to assign to the error.</param>
public static void AddGlobalError(Exception error, GlobalErrorStatus status) =>
AddGlobalErrorInternal(
CreateGlobalError(
ModelFunctions.ToStatusDetails(error),
status
)
);

Expand All @@ -613,7 +627,21 @@ public static void AddGlobalError(Exception error) =>
public static void AddGlobalError(string message) =>
AddGlobalErrorInternal(
CreateGlobalError(
new StatusDetails { message = message }
new StatusDetails { message = message },
GlobalErrorStatus.Broken
)
);

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="message">The error message to persist.</param>
/// <param name="status">The status to assign to the error.</param>
public static void AddGlobalError(string message, GlobalErrorStatus status) =>
AddGlobalErrorInternal(
CreateGlobalError(
new StatusDetails { message = message },
status
)
);

Expand All @@ -622,7 +650,15 @@ public static void AddGlobalError(string message) =>
/// </summary>
/// <param name="statusDetails">The error details to persist.</param>
public static void AddGlobalError(StatusDetails statusDetails) =>
AddGlobalErrorInternal(CreateGlobalError(statusDetails));
AddGlobalErrorInternal(CreateGlobalError(statusDetails, GlobalErrorStatus.Broken));

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="statusDetails">The error details to persist.</param>
/// <param name="status">The status to assign to the error.</param>
public static void AddGlobalError(StatusDetails statusDetails, GlobalErrorStatus status) =>
AddGlobalErrorInternal(CreateGlobalError(statusDetails, status));

/// <summary>
/// Attaches screen diff images to the current fixture, test, or step.
Expand Down Expand Up @@ -993,7 +1029,7 @@ internal static void AddGlobalErrorInternal(GlobalError error) =>
}
);

static GlobalError CreateGlobalError(StatusDetails? statusDetails)
static GlobalError CreateGlobalError(StatusDetails? statusDetails, GlobalErrorStatus status)
{
statusDetails ??= new StatusDetails();
return new GlobalError
Expand All @@ -1003,6 +1039,7 @@ static GlobalError CreateGlobalError(StatusDetails? statusDetails)
flaky = statusDetails.flaky,
muted = statusDetails.muted,
known = statusDetails.known,
status = status,
timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds()
};
}
Expand Down
21 changes: 21 additions & 0 deletions src/Allure.Net.Commons/Model/allure2.Designer.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions src/Allure.Net.Sdk/Results/FileSystemResultsDestination.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ public FileSystemResultsDestination(string directoryPath, bool indentJson)
namingPolicy: JsonNamingPolicy.CamelCase,
allowIntegerValues: false
),
new JsonStringEnumConverter<GlobalErrorStatus>(
namingPolicy: JsonNamingPolicy.CamelCase,
allowIntegerValues: false
),
},
};
}
Expand Down
11 changes: 11 additions & 0 deletions src/Allure.Net/Internal/InternalAllureExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,17 @@ internal GlobalError ToAllureGlobalError() =>
: exception.GetType().Name,
Trace = exception.ToString()
};

internal GlobalError ToAllureGlobalError(GlobalErrorStatus status) =>
new()
{
Status = status,
Timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds(),
Message = exception.Message is { Length: >0 } message
? message
: exception.GetType().Name,
Trace = exception.ToString()
};
}

extension (MethodBase method)
Expand Down
5 changes: 5 additions & 0 deletions src/Allure.Net/Model/GlobalError.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ namespace Allure.Model;
/// </summary>
public sealed class GlobalError : StatusDetails
{
/// <summary>
/// Gets or sets the classification of the global error.
/// </summary>
public GlobalErrorStatus Status { get; set; } = GlobalErrorStatus.Broken;

/// <summary>
/// Gets or sets the occurrence time as Unix epoch milliseconds.
/// </summary>
Expand Down
17 changes: 17 additions & 0 deletions src/Allure.Net/Model/GlobalErrorStatus.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
namespace Allure.Model;

/// <summary>
/// Classifies a global error based on whether it was caused by an assertion failure.
/// </summary>
public enum GlobalErrorStatus
{
/// <summary>
/// The error was caused by something other than a failed assertion.
/// </summary>
Broken,

/// <summary>
/// The error was caused by a failed assertion.
/// </summary>
Failed,
}
110 changes: 110 additions & 0 deletions src/Allure.Net/api/async/AllureApi.Async.Globals.cs
Original file line number Diff line number Diff line change
Expand Up @@ -664,6 +664,33 @@ public static Task AddGlobalErrorAsync(Exception error, CancellationToken cancel
cancellationToken: cancellationToken
) ?? Task.CompletedTask;

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="error">The error to persist.</param>
/// <param name="status">The status to assign to the error.</param>
public static Task AddGlobalErrorAsync(Exception error, GlobalErrorStatus status) =>
AllureRuntimeRouter.ResolveGlobalScope()?.Operations.Async.AddGlobalErrorAsync(
error.ToAllureGlobalError(status),
cancellationToken: default
) ?? Task.CompletedTask;

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="error">The error to persist.</param>
/// <param name="status">The status to assign to the error.</param>
/// <param name="cancellationToken">A cancellation token.</param>
public static Task AddGlobalErrorAsync(
Exception error,
GlobalErrorStatus status,
CancellationToken cancellationToken
) =>
AllureRuntimeRouter.ResolveGlobalScope()?.Operations.Async.AddGlobalErrorAsync(
error.ToAllureGlobalError(status),
cancellationToken: cancellationToken
) ?? Task.CompletedTask;

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
Expand Down Expand Up @@ -693,6 +720,43 @@ public static Task AddGlobalErrorAsync(string message, CancellationToken cancell
cancellationToken: cancellationToken
) ?? Task.CompletedTask;

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="message">The error message to persist.</param>
/// <param name="status">The status to assign to the error.</param>
public static Task AddGlobalErrorAsync(string message, GlobalErrorStatus status) =>
AllureRuntimeRouter.ResolveGlobalScope()?.Operations.Async.AddGlobalErrorAsync(
error: new()
{
Status = status,
Timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds(),
Message = message,
},
cancellationToken: default
) ?? Task.CompletedTask;

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="message">The error message to persist.</param>
/// <param name="status">The status to assign to the error.</param>
/// <param name="cancellationToken">A cancellation token.</param>
public static Task AddGlobalErrorAsync(
string message,
GlobalErrorStatus status,
CancellationToken cancellationToken
) =>
AllureRuntimeRouter.ResolveGlobalScope()?.Operations.Async.AddGlobalErrorAsync(
error: new()
{
Status = status,
Timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds(),
Message = message,
},
cancellationToken: cancellationToken
) ?? Task.CompletedTask;

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
Expand Down Expand Up @@ -733,4 +797,50 @@ CancellationToken cancellationToken
},
cancellationToken: cancellationToken
) ?? Task.CompletedTask;

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="statusDetails">The error details to persist.</param>
/// <param name="status">The status to assign to the error.</param>
public static Task AddGlobalErrorAsync(StatusDetails statusDetails, GlobalErrorStatus status) =>
AllureRuntimeRouter.ResolveGlobalScope()?.Operations.Async.AddGlobalErrorAsync(
error: new()
{
Status = status,
Timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds(),
Message = statusDetails.Message,
Trace = statusDetails.Trace,
Flaky = statusDetails.Flaky,
Known = statusDetails.Known,
Muted = statusDetails.Muted,
},
cancellationToken: default
) ?? Task.CompletedTask;


/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="statusDetails">The error details to persist.</param>
/// <param name="status">The status to assign to the error.</param>
/// <param name="cancellationToken">A cancellation token.</param>
public static Task AddGlobalErrorAsync(
StatusDetails statusDetails,
GlobalErrorStatus status,
CancellationToken cancellationToken
) =>
AllureRuntimeRouter.ResolveGlobalScope()?.Operations.Async.AddGlobalErrorAsync(
error: new()
{
Status = status,
Timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds(),
Message = statusDetails.Message,
Trace = statusDetails.Trace,
Flaky = statusDetails.Flaky,
Known = statusDetails.Known,
Muted = statusDetails.Muted,
},
cancellationToken: cancellationToken
) ?? Task.CompletedTask;
}
44 changes: 44 additions & 0 deletions src/Allure.Net/api/sync/AllureApi.Sync.Globals.cs
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,16 @@ public static void AddGlobalError(Exception error) =>
error.ToAllureGlobalError()
);

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="error">The error to persist.</param>
/// <param name="status">The status to assign to the error.</param>
public static void AddGlobalError(Exception error, GlobalErrorStatus status) =>
AllureRuntimeRouter.ResolveGlobalScope()?.Operations.Sync.AddGlobalError(
error.ToAllureGlobalError(status)
);

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
Expand All @@ -317,6 +327,21 @@ public static void AddGlobalError(string message) =>
}
);

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="message">The error message to persist.</param>
/// <param name="status">The status to assign to the error.</param>
public static void AddGlobalError(string message, GlobalErrorStatus status) =>
AllureRuntimeRouter.ResolveGlobalScope()?.Operations.Sync.AddGlobalError(
new()
{
Status = status,
Timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds(),
Message = message,
}
);

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
Expand All @@ -333,4 +358,23 @@ public static void AddGlobalError(StatusDetails statusDetails) =>
Muted = statusDetails.Muted,
}
);

/// <summary>
/// Adds a global error not tied to the current fixture, test, or step.
/// </summary>
/// <param name="statusDetails">The error details to persist.</param>
/// <param name="status">The status to assign to the error.</param>
public static void AddGlobalError(StatusDetails statusDetails, GlobalErrorStatus status) =>
AllureRuntimeRouter.ResolveGlobalScope()?.Operations.Sync.AddGlobalError(
new()
{
Status = status,
Timestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds(),
Message = statusDetails.Message,
Trace = statusDetails.Trace,
Flaky = statusDetails.Flaky,
Known = statusDetails.Known,
Muted = statusDetails.Muted,
}
);
}
Loading
Loading