|
| 1 | +// Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | +// Licensed under the MIT license. See LICENSE file in the project root for full license information. |
| 3 | + |
| 4 | +using Microsoft.Testing.Extensions.Reporting; |
| 5 | +using Microsoft.Testing.Extensions.Reporting.Resources; |
| 6 | +using Microsoft.Testing.Platform; |
| 7 | +using Microsoft.Testing.Platform.CommandLine; |
| 8 | +using Microsoft.Testing.Platform.Extensions.Messages; |
| 9 | +using Microsoft.Testing.Platform.Extensions.OutputDevice; |
| 10 | +using Microsoft.Testing.Platform.Extensions.TestHost; |
| 11 | +using Microsoft.Testing.Platform.Helpers; |
| 12 | +using Microsoft.Testing.Platform.OutputDevice; |
| 13 | + |
| 14 | +namespace Microsoft.Testing.Extensions.TrxReport.Abstractions; |
| 15 | + |
| 16 | +internal sealed class AzureDevOpsReporter : |
| 17 | + IDataConsumer, |
| 18 | + IDataProducer, |
| 19 | + IOutputDeviceDataProducer |
| 20 | +{ |
| 21 | + private readonly IOutputDevice _outputDisplay; |
| 22 | + |
| 23 | + private static readonly char[] NewlineCharacters = new char[] { '\r', '\n' }; |
| 24 | + private readonly ICommandLineOptions _commandLine; |
| 25 | + private readonly IEnvironment _environment; |
| 26 | + private string _severity = "error"; |
| 27 | + |
| 28 | + public AzureDevOpsReporter( |
| 29 | + ICommandLineOptions commandLine, |
| 30 | + IEnvironment environment, |
| 31 | + IOutputDevice outputDisplay) |
| 32 | + { |
| 33 | + _commandLine = commandLine; |
| 34 | + _environment = environment; |
| 35 | + _outputDisplay = outputDisplay; |
| 36 | + } |
| 37 | + |
| 38 | + public Type[] DataTypesConsumed { get; } = |
| 39 | + [ |
| 40 | + typeof(TestNodeUpdateMessage) |
| 41 | + ]; |
| 42 | + |
| 43 | + public Type[] DataTypesProduced { get; } = [typeof(SessionFileArtifact)]; |
| 44 | + |
| 45 | + /// <inheritdoc /> |
| 46 | + public string Uid { get; } = nameof(AzureDevOpsReporter); |
| 47 | + |
| 48 | + /// <inheritdoc /> |
| 49 | + public string Version { get; } = AppVersion.DefaultSemVer; |
| 50 | + |
| 51 | + /// <inheritdoc /> |
| 52 | + public string DisplayName { get; } = AzureDevOpsResources.DisplayName; |
| 53 | + |
| 54 | + /// <inheritdoc /> |
| 55 | + public string Description { get; } = AzureDevOpsResources.Description; |
| 56 | + |
| 57 | + /// <inheritdoc /> |
| 58 | + public Task<bool> IsEnabledAsync() |
| 59 | + { |
| 60 | + bool isEnabled = _commandLine.IsOptionSet(AzureDevOpsCommandLineOptions.AzureDevOpsOptionName) |
| 61 | + && string.Equals(_environment.GetEnvironmentVariable("TF_BUILD"), "true", StringComparison.OrdinalIgnoreCase); |
| 62 | + |
| 63 | + if (isEnabled) |
| 64 | + { |
| 65 | + bool found = _commandLine.TryGetOptionArgumentList(AzureDevOpsCommandLineOptions.AzureDevOpsReportSeverity, out string[]? arguments); |
| 66 | + if (found && arguments?.Length > 0) |
| 67 | + { |
| 68 | + if (string.Equals(arguments[0], "warning", StringComparison.OrdinalIgnoreCase)) |
| 69 | + { |
| 70 | + _severity = "warning"; |
| 71 | + } |
| 72 | + } |
| 73 | + } |
| 74 | + |
| 75 | + return Task.FromResult(isEnabled); |
| 76 | + } |
| 77 | + |
| 78 | + public async Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationToken cancellationToken) |
| 79 | + { |
| 80 | + if (cancellationToken.IsCancellationRequested) |
| 81 | + { |
| 82 | + return; |
| 83 | + } |
| 84 | + |
| 85 | + try |
| 86 | + { |
| 87 | + if (value is not TestNodeUpdateMessage nodeUpdateMessage) |
| 88 | + { |
| 89 | + return; |
| 90 | + } |
| 91 | + |
| 92 | + TestNodeStateProperty nodeState = nodeUpdateMessage.TestNode.Properties.Single<TestNodeStateProperty>(); |
| 93 | + |
| 94 | + switch (nodeState) |
| 95 | + { |
| 96 | + case FailedTestNodeStateProperty failed: |
| 97 | + await WriteExceptionAsync(failed.Explanation, failed.Exception); |
| 98 | + break; |
| 99 | + case ErrorTestNodeStateProperty error: |
| 100 | + await WriteExceptionAsync(error.Explanation, error.Exception); |
| 101 | + break; |
| 102 | + case CancelledTestNodeStateProperty cancelled: |
| 103 | + await WriteExceptionAsync(cancelled.Explanation, cancelled.Exception); |
| 104 | + break; |
| 105 | + case TimeoutTestNodeStateProperty timeout: |
| 106 | + await WriteExceptionAsync(timeout.Explanation, timeout.Exception); |
| 107 | + break; |
| 108 | + } |
| 109 | + |
| 110 | + return; |
| 111 | + } |
| 112 | + catch (OperationCanceledException ex) when (ex.CancellationToken == cancellationToken) |
| 113 | + { |
| 114 | + // Do nothing, we're stopping |
| 115 | + } |
| 116 | + |
| 117 | + return; |
| 118 | + } |
| 119 | + |
| 120 | + private async Task WriteExceptionAsync(string? explanation, Exception? exception) |
| 121 | + { |
| 122 | + if (exception == null || exception.StackTrace == null) |
| 123 | + { |
| 124 | + return; |
| 125 | + } |
| 126 | + |
| 127 | + string message = explanation ?? exception.Message; |
| 128 | + |
| 129 | + if (message == null) |
| 130 | + { |
| 131 | + return; |
| 132 | + } |
| 133 | + |
| 134 | + string stackTrace = exception.StackTrace; |
| 135 | + int index = stackTrace.IndexOfAny(NewlineCharacters); |
| 136 | + string firstLine = index == -1 ? stackTrace : stackTrace.Substring(0, index); |
| 137 | + if (firstLine != null) |
| 138 | + { |
| 139 | + (string Code, string File, int LineNumber)? location = GetStackFrameLocation(firstLine); |
| 140 | + if (location != null) |
| 141 | + { |
| 142 | + string root = RootFinder.Find(); |
| 143 | + string file = location.Value.File; |
| 144 | + string relativePath = file.StartsWith(root, StringComparison.CurrentCultureIgnoreCase) ? file.Substring(root.Length) : file; |
| 145 | + |
| 146 | + string err = AzDoEscaper.Escape(message); |
| 147 | + |
| 148 | + string line = $"##vso[task.logissue type={_severity};sourcepath={relativePath};linenumber={location.Value.LineNumber};columnnumber=1]{err}"; |
| 149 | + await _outputDisplay.DisplayAsync(this, new FormattedTextOutputDeviceData(line)); |
| 150 | + } |
| 151 | + } |
| 152 | + } |
| 153 | + |
| 154 | + internal /* for testing */ static (string Code, string File, int LineNumber)? GetStackFrameLocation(string stackTraceLine) |
| 155 | + { |
| 156 | + Match match = StackTraceHelper.GetFrameRegex().Match(stackTraceLine); |
| 157 | + if (!match.Success) |
| 158 | + { |
| 159 | + return null; |
| 160 | + } |
| 161 | + |
| 162 | + bool weHaveFilePathAndCodeLine = !RoslynString.IsNullOrWhiteSpace(match.Groups["code"].Value); |
| 163 | + if (!weHaveFilePathAndCodeLine) |
| 164 | + { |
| 165 | + return null; |
| 166 | + } |
| 167 | + |
| 168 | + if (RoslynString.IsNullOrWhiteSpace(match.Groups["file"].Value)) |
| 169 | + { |
| 170 | + return null; |
| 171 | + } |
| 172 | + |
| 173 | + int line = int.TryParse(match.Groups["line"].Value, out int value) ? value : 0; |
| 174 | + |
| 175 | + return (match.Groups["code"].Value, match.Groups["file"].Value, line); |
| 176 | + } |
| 177 | +} |
0 commit comments