|
| 1 | +using System; |
| 2 | +using System.ComponentModel; |
| 3 | +using System.IO; |
| 4 | +using coverlet.collector.Resources; |
| 5 | +using Coverlet.Collector.Utilities; |
| 6 | +using Coverlet.Collector.Utilities.Interfaces; |
| 7 | +using Microsoft.VisualStudio.TestPlatform.ObjectModel.DataCollection; |
| 8 | + |
| 9 | +namespace Coverlet.Collector.DataCollection |
| 10 | +{ |
| 11 | + /// <summary> |
| 12 | + /// Manages coverage report attachments |
| 13 | + /// </summary> |
| 14 | + internal class AttachmentManager : IDisposable |
| 15 | + { |
| 16 | + private readonly DataCollectionSink _dataSink; |
| 17 | + private readonly TestPlatformEqtTrace _eqtTrace; |
| 18 | + private readonly TestPlatformLogger _logger; |
| 19 | + private readonly DataCollectionContext _dataCollectionContext; |
| 20 | + private readonly IFileHelper _fileHelper; |
| 21 | + private readonly IDirectoryHelper _directoryHelper; |
| 22 | + private readonly string _reportFileName; |
| 23 | + private readonly string _reportDirectory; |
| 24 | + |
| 25 | + public AttachmentManager(DataCollectionSink dataSink, DataCollectionContext dataCollectionContext, TestPlatformLogger logger, TestPlatformEqtTrace eqtTrace, string reportFileName) |
| 26 | + : this(dataSink, |
| 27 | + dataCollectionContext, |
| 28 | + logger, |
| 29 | + eqtTrace, |
| 30 | + reportFileName, |
| 31 | + Guid.NewGuid().ToString(), |
| 32 | + new FileHelper(), |
| 33 | + new DirectoryHelper()) |
| 34 | + { |
| 35 | + } |
| 36 | + |
| 37 | + public AttachmentManager(DataCollectionSink dataSink, DataCollectionContext dataCollectionContext, TestPlatformLogger logger, TestPlatformEqtTrace eqtTrace, string reportFileName, string reportDirectoryName, IFileHelper fileHelper, IDirectoryHelper directoryHelper) |
| 38 | + { |
| 39 | + // Store input variabless |
| 40 | + _dataSink = dataSink; |
| 41 | + _dataCollectionContext = dataCollectionContext; |
| 42 | + _logger = logger; |
| 43 | + _eqtTrace = eqtTrace; |
| 44 | + _reportFileName = reportFileName; |
| 45 | + _fileHelper = fileHelper; |
| 46 | + _directoryHelper = directoryHelper; |
| 47 | + |
| 48 | + // Report directory to store the coverage reports. |
| 49 | + _reportDirectory = Path.Combine(Path.GetTempPath(), reportDirectoryName); |
| 50 | + |
| 51 | + // Register events |
| 52 | + _dataSink.SendFileCompleted += this.OnSendFileCompleted; |
| 53 | + } |
| 54 | + |
| 55 | + /// <summary> |
| 56 | + /// Sends coverage report to test platform |
| 57 | + /// </summary> |
| 58 | + /// <param name="coverageReport">Coverage report</param> |
| 59 | + public void SendCoverageReport(string coverageReport) |
| 60 | + { |
| 61 | + // Save coverage report to file |
| 62 | + string coverageReportPath = this.SaveCoverageReport(coverageReport); |
| 63 | + |
| 64 | + // Send coverage attachment to test platform. |
| 65 | + this.SendAttachment(coverageReportPath); |
| 66 | + } |
| 67 | + |
| 68 | + /// <summary> |
| 69 | + /// Disposes attachment manager |
| 70 | + /// </summary> |
| 71 | + public void Dispose() |
| 72 | + { |
| 73 | + // Unregister events |
| 74 | + try |
| 75 | + { |
| 76 | + if (_dataSink != null) |
| 77 | + { |
| 78 | + _dataSink.SendFileCompleted -= this.OnSendFileCompleted; |
| 79 | + } |
| 80 | + this.CleanupReportDirectory(); |
| 81 | + } |
| 82 | + catch (Exception ex) |
| 83 | + { |
| 84 | + _logger.LogWarning(ex.ToString()); |
| 85 | + } |
| 86 | + } |
| 87 | + |
| 88 | + /// <summary> |
| 89 | + /// Saves coverage report to file system |
| 90 | + /// </summary> |
| 91 | + /// <param name="report">Coverage report</param> |
| 92 | + /// <returns>Coverage report file path</returns> |
| 93 | + private string SaveCoverageReport(string report) |
| 94 | + { |
| 95 | + try |
| 96 | + { |
| 97 | + _directoryHelper.CreateDirectory(_reportDirectory); |
| 98 | + string filePath = Path.Combine(_reportDirectory, _reportFileName); |
| 99 | + _fileHelper.WriteAllText(filePath, report); |
| 100 | + _eqtTrace.Info("{0}: Saved coverage report to path: '{1}'", CoverletConstants.DataCollectorName, filePath); |
| 101 | + |
| 102 | + return filePath; |
| 103 | + } |
| 104 | + catch (Exception ex) |
| 105 | + { |
| 106 | + string errorMessage = string.Format(Resources.FailedToSaveCoverageReport, CoverletConstants.DataCollectorName, _reportFileName, _reportDirectory); |
| 107 | + throw new CoverletDataCollectorException(errorMessage, ex); |
| 108 | + } |
| 109 | + } |
| 110 | + |
| 111 | + /// <summary> |
| 112 | + /// SendFileCompleted event handler |
| 113 | + /// </summary> |
| 114 | + /// <param name="sender">Sender</param> |
| 115 | + /// <param name="e">Event args</param> |
| 116 | + public void OnSendFileCompleted(object sender, AsyncCompletedEventArgs e) |
| 117 | + { |
| 118 | + try |
| 119 | + { |
| 120 | + _eqtTrace.Verbose("{0}: SendFileCompleted received", CoverletConstants.DataCollectorName); |
| 121 | + this.CleanupReportDirectory(); |
| 122 | + } |
| 123 | + catch (Exception ex) |
| 124 | + { |
| 125 | + _logger.LogWarning(ex.ToString()); |
| 126 | + this.Dispose(); |
| 127 | + } |
| 128 | + } |
| 129 | + |
| 130 | + /// <summary> |
| 131 | + /// Sends attachment file to test platform |
| 132 | + /// </summary> |
| 133 | + /// <param name="attachmentPath">Attachment file path</param> |
| 134 | + private void SendAttachment(string attachmentPath) |
| 135 | + { |
| 136 | + if (_fileHelper.Exists(attachmentPath)) |
| 137 | + { |
| 138 | + // Send coverage attachment to test platform. |
| 139 | + _eqtTrace.Verbose("{0}: Sending attachment to test platform", CoverletConstants.DataCollectorName); |
| 140 | + _dataSink.SendFileAsync(_dataCollectionContext, attachmentPath, false); |
| 141 | + } |
| 142 | + else |
| 143 | + { |
| 144 | + _eqtTrace.Warning("{0}: Attachment file does not exist", CoverletConstants.DataCollectorName); |
| 145 | + } |
| 146 | + } |
| 147 | + |
| 148 | + /// <summary> |
| 149 | + /// Cleans up coverage report directory |
| 150 | + /// </summary> |
| 151 | + private void CleanupReportDirectory() |
| 152 | + { |
| 153 | + try |
| 154 | + { |
| 155 | + if (_directoryHelper.Exists(_reportDirectory)) |
| 156 | + { |
| 157 | + _directoryHelper.Delete(_reportDirectory, true); |
| 158 | + _eqtTrace.Verbose("{0}: Deleted report directory: '{1}'", CoverletConstants.DataCollectorName, _reportDirectory); |
| 159 | + } |
| 160 | + } |
| 161 | + catch (Exception ex) |
| 162 | + { |
| 163 | + string errorMessage = string.Format(Resources.FailedToCleanupReportDirectory, CoverletConstants.DataCollectorName, _reportDirectory); |
| 164 | + throw new CoverletDataCollectorException(errorMessage, ex); |
| 165 | + } |
| 166 | + } |
| 167 | + } |
| 168 | +} |
0 commit comments