Skip to content

GH4642: Standardize execution status display in report printers #4644

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

Merged
merged 1 commit into from
Nov 2, 2025
Merged

GH4642: Standardize execution status display in report printers #4644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 39 additions & 0 deletions src/Cake.Cli.Tests/Cake.Cli.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<AssemblyName>Cake.Cli.Tests</AssemblyName>
<GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
<IsCakeTestProject>true</IsCakeTestProject>
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>
<!-- Import shared functionality -->
<Import Project="..\Shared.msbuild" />
<!-- Project references -->
<ItemGroup>
<ProjectReference Include="..\Cake.Cli\Cake.Cli.csproj" />
<ProjectReference Include="..\Cake.Core\Cake.Core.csproj" />
<ProjectReference Include="..\Cake.Testing\Cake.Testing.csproj" />
<ProjectReference Include="..\Cake.Testing.Xunit.v3\Cake.Testing.Xunit.v3.csproj" />
</ItemGroup>
<!-- Global packages -->
<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" />
<PackageReference Include="Spectre.Verify.Extensions" />
<PackageReference Include="Spectre.Console.Testing" />
<PackageReference Include="Verify.DiffPlex" />
<PackageReference Include="Verify.XunitV3" />
<PackageReference Include="xunit.v3" />
<PackageReference Include="xunit.runner.visualstudio">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
<PackageReference Include="NSubstitute" />
<PackageReference Include="Castle.Core" />
<PackageReference Include="Microsoft.Extensions.TimeProvider.Testing" />
</ItemGroup>
<ItemGroup>
<Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
</ItemGroup>
<ItemGroup>
<Folder Include="Expectations\" />
</ItemGroup>
</Project>
4 changes: 4 additions & 0 deletions ...ations/CakeSpectreReportPrinterTests.WriteLifeCycleStep_verbosity=Diagnostic.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

────────────────────────────────────────────────────────────────────────────────
Setup
────────────────────────────────────────────────────────────────────────────────
1 change: 1 addition & 0 deletions ...ectations/CakeSpectreReportPrinterTests.WriteLifeCycleStep_verbosity=Minimal.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
emptyString
4 changes: 4 additions & 0 deletions ...pectations/CakeSpectreReportPrinterTests.WriteLifeCycleStep_verbosity=Normal.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

────────────────────────────────────────────────────────────────────────────────
Setup
────────────────────────────────────────────────────────────────────────────────
1 change: 1 addition & 0 deletions ...xpectations/CakeSpectreReportPrinterTests.WriteLifeCycleStep_verbosity=Quiet.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
emptyString
4 changes: 4 additions & 0 deletions ...ectations/CakeSpectreReportPrinterTests.WriteLifeCycleStep_verbosity=Verbose.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

────────────────────────────────────────────────────────────────────────────────
Setup
────────────────────────────────────────────────────────────────────────────────
4 changes: 4 additions & 0 deletions ...ctations/CakeSpectreReportPrinterTests.WriteSkippedStep_verbosity=Diagnostic.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

════════════════════════════════════════════════════════════════════════════════
Skipped Step
════════════════════════════════════════════════════════════════════════════════
1 change: 1 addition & 0 deletions ...xpectations/CakeSpectreReportPrinterTests.WriteSkippedStep_verbosity=Minimal.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
emptyString
1 change: 1 addition & 0 deletions ...Expectations/CakeSpectreReportPrinterTests.WriteSkippedStep_verbosity=Normal.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
emptyString
1 change: 1 addition & 0 deletions .../Expectations/CakeSpectreReportPrinterTests.WriteSkippedStep_verbosity=Quiet.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
emptyString
4 changes: 4 additions & 0 deletions ...xpectations/CakeSpectreReportPrinterTests.WriteSkippedStep_verbosity=Verbose.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

════════════════════════════════════════════════════════════════════════════════
Skipped Step
════════════════════════════════════════════════════════════════════════════════
4 changes: 4 additions & 0 deletions ...ts/Expectations/CakeSpectreReportPrinterTests.WriteStep_verbosity=Diagnostic.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

════════════════════════════════════════════════════════════════════════════════
Test Step
════════════════════════════════════════════════════════════════════════════════
1 change: 1 addition & 0 deletions ...Tests/Expectations/CakeSpectreReportPrinterTests.WriteStep_verbosity=Minimal.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
emptyString
4 changes: 4 additions & 0 deletions ....Tests/Expectations/CakeSpectreReportPrinterTests.WriteStep_verbosity=Normal.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

════════════════════════════════════════════════════════════════════════════════
Test Step
════════════════════════════════════════════════════════════════════════════════
1 change: 1 addition & 0 deletions ...i.Tests/Expectations/CakeSpectreReportPrinterTests.WriteStep_verbosity=Quiet.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
emptyString
4 changes: 4 additions & 0 deletions ...Tests/Expectations/CakeSpectreReportPrinterTests.WriteStep_verbosity=Verbose.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

════════════════════════════════════════════════════════════════════════════════
Test Step
════════════════════════════════════════════════════════════════════════════════
18 changes: 18 additions & 0 deletions ...pectations/CakeSpectreReportPrinterTests.Write_includeReason=False.DotNet8_0.received.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

Task Duration Status
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
SetupExecuted 00:00:00.2220000 Succeeded
SetupSkipped - Skipped
SetupFailed 00:00:00.8880000 Failed
SetupDelegated 00:00:00.4440000 Succeeded
TaskExecuted 00:00:00.1110000 Succeeded
TaskSkipped - Skipped
TaskFailed 00:00:00.4440000 Failed
TaskDelegated 00:00:00.2220000 Succeeded
TeardownExecuted 00:00:00.3330000 Succeeded
TeardownSkipped - Skipped
TeardownFailed 00:00:01.3320000 Failed
TeardownDelegated 00:00:00.6660000 Succeeded
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Total: 00:00:06.6600000

18 changes: 18 additions & 0 deletions ...pectations/CakeSpectreReportPrinterTests.Write_includeReason=False.DotNet9_0.received.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

Task Duration Status
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
SetupExecuted 00:00:00.2220000 Succeeded
SetupSkipped - Skipped
SetupFailed 00:00:00.8880000 Failed
SetupDelegated 00:00:00.4440000 Succeeded
TaskExecuted 00:00:00.1110000 Succeeded
TaskSkipped - Skipped
TaskFailed 00:00:00.4440000 Failed
TaskDelegated 00:00:00.2220000 Succeeded
TeardownExecuted 00:00:00.3330000 Succeeded
TeardownSkipped - Skipped
TeardownFailed 00:00:01.3320000 Failed
TeardownDelegated 00:00:00.6660000 Succeeded
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Total: 00:00:06.6600000

18 changes: 18 additions & 0 deletions ...i.Tests/Expectations/CakeSpectreReportPrinterTests.Write_includeReason=False.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

Task Duration Status
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
SetupExecuted 00:00:00.2220000 Succeeded
SetupSkipped - Skipped
SetupFailed 00:00:00.8880000 Failed
SetupDelegated 00:00:00.4440000 Succeeded
TaskExecuted 00:00:00.1110000 Succeeded
TaskSkipped - Skipped
TaskFailed 00:00:00.4440000 Failed
TaskDelegated 00:00:00.2220000 Succeeded
TeardownExecuted 00:00:00.3330000 Succeeded
TeardownSkipped - Skipped
TeardownFailed 00:00:01.3320000 Failed
TeardownDelegated 00:00:00.6660000 Succeeded
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Total: 00:00:06.6600000

18 changes: 18 additions & 0 deletions ...li.Tests/Expectations/CakeSpectreReportPrinterTests.Write_includeReason=True.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

Task Duration Status Skip Reason
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
SetupExecuted 00:00:00.2220000 Succeeded
SetupSkipped - Skipped Skipped reason
SetupFailed 00:00:00.8880000 Failed
SetupDelegated 00:00:00.4440000 Succeeded
TaskExecuted 00:00:00.1110000 Succeeded
TaskSkipped - Skipped Skipped reason
TaskFailed 00:00:00.4440000 Failed
TaskDelegated 00:00:00.2220000 Succeeded
TeardownExecuted 00:00:00.3330000 Succeeded
TeardownSkipped - Skipped Skipped reason
TeardownFailed 00:00:01.3320000 Failed
TeardownDelegated 00:00:00.6660000 Succeeded
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Total: 00:00:06.6600000

139 changes: 139 additions & 0 deletions src/Cake.Cli.Tests/Unit/CakeSpectreReportPrinterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using Cake.Core;
using Cake.Core.Diagnostics;
using Spectre.Console.Testing;

namespace Cake.Cli.Tests.Unit;

public class CakeSpectreReportPrinterTests
{
public sealed class TheConstructor
{
[Fact]
public void Should_Throw_If_Console_Is_Null()
{
// Given
// When
var result = Record.Exception(() => new CakeSpectreReportPrinter(null));
// Then
AssertEx.IsArgumentNullException(result, "console");
}
}

[Theory]
[InlineData(true)]
[InlineData(false)]
public async Task Write(bool includeReason)
{
// Given
var console = new TestConsole();
var reportPrinter = new CakeSpectreReportPrinter(console);

var executionCategories = Enum
.GetValues<CakeReportEntryCategory>()
.OrderBy(
category => category switch {
CakeReportEntryCategory.Setup => 0,
CakeReportEntryCategory.Task => 1,
CakeReportEntryCategory.Teardown => 9,
_ => 5
})
.ToArray();

var executionStatuses = Enum
.GetValues<CakeTaskExecutionStatus>()
.OrderBy(
status => status switch {
CakeTaskExecutionStatus.Executed => 0,
CakeTaskExecutionStatus.Skipped => 1,
CakeTaskExecutionStatus.Failed => 2,
CakeTaskExecutionStatus.Delegated => 9,
_ => 5
})
.ToArray();

var report = executionCategories
.Aggregate(
new CakeReport(),
(report, category) => executionStatuses.Aggregate(
report,
(report, status) =>
{
report.Add(
$"{category:F}{status:F}",
includeReason && status == CakeTaskExecutionStatus.Skipped ? $"{status:F} reason" : null,
category,
TimeSpan.FromMilliseconds(((int)category + 1) * ((int)status + 1) * 111),
status);
return report;
},
report => report),
report => report);

// When
reportPrinter.Write(report);

// Then
await Verify(console.Output);
}

[Theory]
[InlineData(Verbosity.Quiet)]
[InlineData(Verbosity.Minimal)]
[InlineData(Verbosity.Normal)]
[InlineData(Verbosity.Verbose)]
[InlineData(Verbosity.Diagnostic)]
public async Task WriteStep(Verbosity verbosity)
{
// Given
var console = new TestConsole();
var reportPrinter = new CakeSpectreReportPrinter(console);

// When
reportPrinter.WriteStep("Test Step", verbosity);

// Then
await Verify(console.Output);
}

[Theory]
[InlineData(Verbosity.Quiet)]
[InlineData(Verbosity.Minimal)]
[InlineData(Verbosity.Normal)]
[InlineData(Verbosity.Verbose)]
[InlineData(Verbosity.Diagnostic)]
public async Task WriteLifeCycleStep(Verbosity verbosity)
{
// Given
var console = new TestConsole();
var reportPrinter = new CakeSpectreReportPrinter(console);

// When
reportPrinter.WriteLifeCycleStep("Setup", verbosity);

// Then
await Verify(console.Output);
}

[Theory]
[InlineData(Verbosity.Quiet)]
[InlineData(Verbosity.Minimal)]
[InlineData(Verbosity.Normal)]
[InlineData(Verbosity.Verbose)]
[InlineData(Verbosity.Diagnostic)]
public async Task WriteSkippedStep(Verbosity verbosity)
{
// Given
var console = new TestConsole();
var reportPrinter = new CakeSpectreReportPrinter(console);

// When
reportPrinter.WriteSkippedStep("Skipped Step", verbosity);

// Then
await Verify(console.Output);
}
}
20 changes: 20 additions & 0 deletions src/Cake.Cli.Tests/VerifyConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
using System.Runtime.CompilerServices;
using VerifyTests.DiffPlex;

namespace Cake.Cli.Tests;

/// <summary>
/// Configuration for Verify tests.
/// </summary>
public static class VerifyConfig
{
/// <summary>
/// Initializes the Verify configuration.
/// </summary>
[ModuleInitializer]
public static void Init()
{
DerivePathInfo(Expectations.Initialize);
VerifyDiffPlex.Initialize(OutputType.Compact);
}
}
Loading
Loading