AzurePipelinesReportPrinter.cs

using System;
using System.IO;
using System.Linq;
using System.Text;
using Cake.Common.Build;
using Cake.Core;
using Cake.Core.Diagnostics;
using Cake.Core.IO;
using Cake.Module.Shared;
using JetBrains.Annotations;

namespace Cake.AzurePipelines.Module
{
    /// <summary>
    /// The TF Build/Azure Pipelines report printer.
    /// </summary>
    [UsedImplicitly]
    public class AzurePipelinesReportPrinter : CakeReportPrinterBase
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="AzurePipelinesReportPrinter"/> class.
        /// </summary>
        /// <param name="console">The console.</param>
        /// <param name="context">The context.</param>
        public AzurePipelinesReportPrinter(IConsole console, ICakeContext context)
            : base(console, context)
        {
        }

        /// <summary>
        /// Writes the specified report to a target.
        /// </summary>
        /// <param name="report">The report to write.</param>
        public override void Write(CakeReport report)
        {
            if (report == null)
            {
                throw new ArgumentNullException(nameof(report));
            }

            try
            {
                if (_context.AzurePipelines().IsRunningOnAzurePipelines)
                {
                    WriteToMarkdown(report);
                }

                WriteToConsole(report);
            }
            finally
            {
                _console.ResetColor();
            }
        }

        private void WriteToMarkdown(CakeReport report)
        {
            var includeSkippedReasonColumn = report.Any(r => !string.IsNullOrEmpty(r.SkippedMessage));

            var maxTaskNameLength = 29;
            foreach (var item in report)
            {
                if (item.TaskName.Length > maxTaskNameLength)
                {
                    maxTaskNameLength = item.TaskName.Length;
                }
            }

            maxTaskNameLength++;
            string lineFormat = "|{0,-" + maxTaskNameLength + "}|{1,20}|";

            var sb = new StringBuilder();
            sb.AppendLine("");

            if (includeSkippedReasonColumn)
            {
                sb.AppendLine("|Task|Duration|Status|Skip Reason|");
                sb.AppendLine("|:---|-------:|:-----|:----------|");
            }
            else
            {
                sb.AppendLine("|Task|Duration|Status|");
                sb.AppendLine("|:---|-------:|:-----|");
            }

            var targetName = string.Empty;
            foreach (var item in report)
            {
                if (ShouldWriteTask(item))
                {
                    if (includeSkippedReasonColumn)
                    {
                        sb.AppendLine(string.Format(lineFormat, item.TaskName, FormatDuration(item), item.ExecutionStatus.ToReportStatus(), item.SkippedMessage));
                    }
                    else
                    {
                        sb.AppendLine(string.Format(lineFormat, item.TaskName, FormatDuration(item), item.ExecutionStatus.ToReportStatus()));
                    }
                }

                targetName = item.TaskName; // Use the last task name it is the target name
            }

            sb.AppendLine(string.Empty);
            var b = _context.BuildSystem().AzurePipelines;
            FilePath agentWorkPath = b.Environment.Build.ArtifactStagingDirectory + "/tasksummary.md";
            var absFilePath = agentWorkPath.MakeAbsolute(_context.Environment);
            var file = _context.FileSystem.GetFile(absFilePath);
            using (var writer = new StreamWriter(file.OpenWrite()))
            {
                writer.Write(sb.ToString());
            }

            _console.WriteLine($"##vso[task.addattachment type=Distributedtask.Core.Summary;name=Cake {targetName} Build Summary;]{absFilePath.MakeAbsolute(_context.Environment).FullPath}");
        }
    }
}