forked from cake-build/cake
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(cake-buildGH-4055) Add Spectre.Console based reporter
Via a new setting, --Settings_UseSpectreConsoleForConsoleOutput, it is now possible to output the task headers, and task summary using Spectre.Console. This allows for the easy addition of a new column in the task summary, which includes information about _why_ any given task has been skipped. The old CakeReportPrinter is still in play, but some implementation has been moved from within the DefaultExecutionStrategy to the reporter class. Depending on the setting mentioned above, either the Spectre.Console version of the reporter will be added to the IoC container, or the old version will be in place. * fixes cake-build#4055
- Loading branch information
Showing
14 changed files
with
369 additions
and
36 deletions.
There are no files selected for viewing
162 changes: 162 additions & 0 deletions
162
src/Cake.Cli/Infrastructure/CakeSpectreReportPrinter.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| // 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 System; | ||
| using System.Collections.Generic; | ||
| using System.Globalization; | ||
| using System.Linq; | ||
| using Cake.Core; | ||
| using Cake.Core.Diagnostics; | ||
| using Spectre.Console; | ||
|
|
||
| namespace Cake.Cli | ||
| { | ||
| /// <summary> | ||
| /// The default report printer. | ||
| /// </summary> | ||
| public sealed class CakeSpectreReportPrinter : ICakeReportPrinter | ||
| { | ||
| private readonly IAnsiConsole _console; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="CakeSpectreReportPrinter"/> class. | ||
| /// </summary> | ||
| /// <param name="console">The console.</param> | ||
| public CakeSpectreReportPrinter(IAnsiConsole console) | ||
| { | ||
| _console = console; | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public void Write(CakeReport report) | ||
| { | ||
| // Create a table | ||
| var table = new Table().Border(TableBorder.SimpleHeavy); | ||
| table.Width(100); | ||
| table.BorderStyle(new Style().Foreground(ConsoleColor.Green)); | ||
|
|
||
| var includeSkippedReasonColumn = report.Any(r => !string.IsNullOrEmpty(r.SkippedMessage)); | ||
| var rowStyle = new Style(ConsoleColor.Green); | ||
|
|
||
| // Add some columns | ||
| table.AddColumn(new TableColumn(new Text("Task", rowStyle)).Footer(new Text("Total:", rowStyle)).PadRight(10)); | ||
| table.AddColumn( | ||
| new TableColumn( | ||
| new Text("Duration", rowStyle)).Footer( | ||
| new Text(FormatTime(GetTotalTime(report)), rowStyle))); | ||
|
|
||
| if (includeSkippedReasonColumn) | ||
| { | ||
| table.AddColumn(new TableColumn(new Text("Skip Reason", rowStyle))); | ||
| } | ||
|
|
||
| foreach (var item in report) | ||
| { | ||
| var itemStyle = GetItemStyle(item); | ||
|
|
||
| if (includeSkippedReasonColumn) | ||
| { | ||
| table.AddRow(new Markup(item.TaskName, itemStyle), | ||
| new Markup(FormatDuration(item), itemStyle), | ||
| new Markup(item.SkippedMessage, itemStyle)); | ||
| } | ||
| else | ||
| { | ||
| table.AddRow(new Markup(item.TaskName, itemStyle), | ||
| new Markup(FormatDuration(item), itemStyle)); | ||
| } | ||
| } | ||
|
|
||
| // Render the table to the console | ||
| _console.Write(table); | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public void WriteStep(string name, Verbosity verbosity) | ||
| { | ||
| if (verbosity < Verbosity.Normal) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var table = new Table().Border(DoubleBorder.Shared); | ||
| table.Width(100); | ||
| table.AddColumn(name); | ||
| _console.Write(new Padder(table).Padding(0, 1, 0, 0)); | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public void WriteLifeCycleStep(string name, Verbosity verbosity) | ||
| { | ||
| if (verbosity < Verbosity.Normal) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| _console.WriteLine(); | ||
|
|
||
| var table = new Table().Border(SingleBorder.Shared); | ||
| table.Width(100); | ||
| table.AddColumn(name); | ||
| _console.Write(table); | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public void WriteSkippedStep(string name, Verbosity verbosity) | ||
| { | ||
| if (verbosity < Verbosity.Verbose) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| _console.WriteLine(); | ||
|
|
||
| var table = new Table().Border(DoubleBorder.Shared); | ||
| table.Width(100); | ||
| table.AddColumn(name); | ||
| _console.Write(table); | ||
| } | ||
|
|
||
| private static string FormatDuration(CakeReportEntry item) | ||
| { | ||
| if (item.ExecutionStatus == CakeTaskExecutionStatus.Skipped) | ||
| { | ||
| return "Skipped"; | ||
| } | ||
|
|
||
| return FormatTime(item.Duration); | ||
| } | ||
|
|
||
| private static Style GetItemStyle(CakeReportEntry item) | ||
| { | ||
| if (item.Category == CakeReportEntryCategory.Setup || item.Category == CakeReportEntryCategory.Teardown) | ||
| { | ||
| return new Style(ConsoleColor.Cyan); | ||
| } | ||
|
|
||
| if (item.ExecutionStatus == CakeTaskExecutionStatus.Failed) | ||
| { | ||
| return new Style(ConsoleColor.Red); | ||
| } | ||
|
|
||
| if (item.ExecutionStatus == CakeTaskExecutionStatus.Executed) | ||
| { | ||
| return new Style(ConsoleColor.Green); | ||
| } | ||
|
|
||
| return new Style(ConsoleColor.Gray); | ||
| } | ||
|
|
||
| private static string FormatTime(TimeSpan time) | ||
| { | ||
| return time.ToString("c", CultureInfo.InvariantCulture); | ||
| } | ||
|
|
||
| private static TimeSpan GetTotalTime(IEnumerable<CakeReportEntry> entries) | ||
| { | ||
| return entries.Select(i => i.Duration) | ||
| .Aggregate(TimeSpan.Zero, (t1, t2) => t1 + t2); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| // 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 Spectre.Console; | ||
| using Spectre.Console.Rendering; | ||
|
|
||
| namespace Cake.Cli | ||
| { | ||
| /// <summary> | ||
| /// A custom Spectre.Console border class, used for outputting information about steps. | ||
| /// </summary> | ||
| public class DoubleBorder : TableBorder | ||
| { | ||
| /// <summary> | ||
| /// Gets a single instance of the DoubleBorder class. | ||
| /// </summary> | ||
| public static DoubleBorder Shared { get; } = new DoubleBorder(); | ||
|
|
||
| /// <summary> | ||
| /// Get information about the custom border. | ||
| /// </summary> | ||
| /// <param name="part">The part that needs a border applied to it.</param> | ||
| /// <returns>A simple double border character.</returns> | ||
| public override string GetPart(TableBorderPart part) | ||
| { | ||
| return part switch | ||
| { | ||
| TableBorderPart.HeaderTop => "=", | ||
| TableBorderPart.FooterBottom => "=", | ||
| _ => string.Empty, | ||
| }; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| // 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 Spectre.Console; | ||
| using Spectre.Console.Rendering; | ||
|
|
||
| namespace Cake.Cli | ||
| { | ||
| /// <summary> | ||
| /// A custom Spectre.Console border class, used for outputting information about steps. | ||
| /// </summary> | ||
| public class SingleBorder : TableBorder | ||
| { | ||
| /// <summary> | ||
| /// Gets a single instance of the SingleBorder class. | ||
| /// </summary> | ||
| public static SingleBorder Shared { get; } = new SingleBorder(); | ||
|
|
||
| /// <summary> | ||
| /// Get information about the custom border. | ||
| /// </summary> | ||
| /// <param name="part">The part that needs a border applied to it.</param> | ||
| /// <returns>A simple single border character.</returns> | ||
| public override string GetPart(TableBorderPart part) | ||
| { | ||
| return part switch | ||
| { | ||
| TableBorderPart.HeaderTop => "-", | ||
| TableBorderPart.FooterBottom => "-", | ||
| _ => string.Empty, | ||
| }; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.