Automation Advisor
Vstest
Microsoft.VisualStudio.TestPlatform.CrossPlatEngine.TestRunAttachmentsProcessing
DataCollectorAttachmentProcessorAppDomain

How to use DataCollectorAttachmentProcessorAppDomain class of Microsoft.VisualStudio.TestPlatform.CrossPlatEngine.TestRunAttachmentsProcessing package

Best Vstest code snippet using Microsoft.VisualStudio.TestPlatform.CrossPlatEngine.TestRunAttachmentsProcessing.DataCollectorAttachmentProcessorAppDomain

DataCollectorAttachmentProcessorAppDomainTests.cs

Source:DataCollectorAttachmentProcessorAppDomainTests.cs

...14using Microsoft.VisualStudio.TestPlatform.ObjectModel.DataCollection;15using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;16using Microsoft.VisualStudio.TestTools.UnitTesting;17using Moq;18namespace Microsoft.TestPlatform.CrossPlatEngine.UnitTests.DataCollectorAttachmentProcessorAppDomainTests;19[TestClass]20public class DataCollectorAttachmentProcessorAppDomainTests21{22    private readonly Mock<IMessageLogger> _loggerMock = new();23    internal static string SomeState = "deafultState";24    [TestMethod]25    public async Task DataCollectorAttachmentProcessorAppDomain_ShouldBeIsolated()26    {27        // arrange28        var invokedDataCollector = new InvokedDataCollector(new Uri("datacollector://AppDomainSample"), "AppDomainSample", typeof(AppDomainSampleDataCollector).AssemblyQualifiedName, typeof(AppDomainSampleDataCollector).Assembly.Location, true);29        var attachmentSet = new AttachmentSet(new Uri("datacollector://AppDomainSample"), string.Empty);30        attachmentSet.Attachments.Add(new UriDataAttachment(new Uri("C:\\temp\\sample"), "sample"));31        Collection<AttachmentSet> attachments = new() { attachmentSet };32        var doc = new XmlDocument();33        doc.LoadXml("<configurationElement/>");34        // act35        using DataCollectorAttachmentProcessorAppDomain dcap = new(invokedDataCollector, _loggerMock.Object);36        Assert.IsTrue(dcap.LoadSucceded);37        await dcap.ProcessAttachmentSetsAsync(doc.DocumentElement, attachments, new Progress<int>((int report) => { }), _loggerMock.Object, CancellationToken.None);38        //Assert39        // If the processor runs in another AppDomain the static state is not shared and should not change.40        Assert.AreEqual("deafultState", SomeState);41    }42    [TestMethod]43    public async Task DataCollectorAttachmentProcessorAppDomain_ShouldCancel()44    {45        // arrange46        var invokedDataCollector = new InvokedDataCollector(new Uri("datacollector://AppDomainSample"), "AppDomainSample", typeof(AppDomainSampleDataCollector).AssemblyQualifiedName, typeof(AppDomainSampleDataCollector).Assembly.Location, true);47        var attachmentSet = new AttachmentSet(new Uri("datacollector://AppDomainSample"), string.Empty);48        attachmentSet.Attachments.Add(new UriDataAttachment(new Uri("C:\\temp\\sample"), "sample"));49        Collection<AttachmentSet> attachments = new() { attachmentSet };50        var doc = new XmlDocument();51        doc.LoadXml("<configurationElement>5000</configurationElement>");52        CancellationTokenSource cts = new();53        // act54        using DataCollectorAttachmentProcessorAppDomain dcap = new(invokedDataCollector, _loggerMock.Object);55        Assert.IsTrue(dcap.LoadSucceded);56        Task runProcessing = dcap.ProcessAttachmentSetsAsync(doc.DocumentElement, attachments, new Progress<int>((int report) => cts.Cancel()), _loggerMock.Object, cts.Token);57        //assert58        await Assert.ThrowsExceptionAsync<OperationCanceledException>(async () => await runProcessing);59    }60    [TestMethod]61    public async Task DataCollectorAttachmentProcessorAppDomain_ShouldReturnCorrectAttachments()62    {63        // arrange64        var invokedDataCollector = new InvokedDataCollector(new Uri("datacollector://AppDomainSample"), "AppDomainSample", typeof(AppDomainSampleDataCollector).AssemblyQualifiedName, typeof(AppDomainSampleDataCollector).Assembly.Location, true);65        var attachmentSet = new AttachmentSet(new Uri("datacollector://AppDomainSample"), "AppDomainSample");66        attachmentSet.Attachments.Add(new UriDataAttachment(new Uri("C:\\temp\\sample"), "sample"));67        Collection<AttachmentSet> attachments = new() { attachmentSet };68        var doc = new XmlDocument();69        doc.LoadXml("<configurationElement/>");70        // act71        using DataCollectorAttachmentProcessorAppDomain dcap = new(invokedDataCollector, _loggerMock.Object);72        Assert.IsTrue(dcap.LoadSucceded);73        var attachmentsResult = await dcap.ProcessAttachmentSetsAsync(doc.DocumentElement, attachments, new Progress<int>(), _loggerMock.Object, CancellationToken.None);74        // assert75        // We return same instance but we're marshaling so we expected different pointers76        Assert.AreNotSame(attachmentSet, attachmentsResult);77        Assert.AreEqual(attachmentSet.DisplayName, attachmentsResult.First().DisplayName);78        Assert.AreEqual(attachmentSet.Uri, attachmentsResult.First().Uri);79        Assert.AreEqual(attachmentSet.Attachments.Count, attachmentsResult.Count);80        Assert.AreEqual(attachmentSet.Attachments[0].Description, attachmentsResult.First().Attachments[0].Description);81        Assert.AreEqual(attachmentSet.Attachments[0].Uri, attachmentsResult.First().Attachments[0].Uri);82        Assert.AreEqual(attachmentSet.Attachments[0].Uri, attachmentsResult.First().Attachments[0].Uri);83    }84    [TestMethod]85    public async Task DataCollectorAttachmentProcessorAppDomain_ShouldReportProgressCorrectly()86    {87        // arrange88        var invokedDataCollector = new InvokedDataCollector(new Uri("datacollector://AppDomainSample"), "AppDomainSample", typeof(AppDomainSampleDataCollector).AssemblyQualifiedName, typeof(AppDomainSampleDataCollector).Assembly.Location, true);89        var attachmentSet = new AttachmentSet(new Uri("datacollector://AppDomainSample"), "AppDomainSample");90        attachmentSet.Attachments.Add(new UriDataAttachment(new Uri("C:\\temp\\sample"), "sample"));91        Collection<AttachmentSet> attachments = new() { attachmentSet };92        var doc = new XmlDocument();93        doc.LoadXml("<configurationElement/>");94        // act95        var progress = new CustomProgress();96        using DataCollectorAttachmentProcessorAppDomain dcap = new(invokedDataCollector, _loggerMock.Object);97        Assert.IsTrue(dcap.LoadSucceded);98        var attachmentsResult = await dcap.ProcessAttachmentSetsAsync(99            doc.DocumentElement,100            attachments,101            progress,102            _loggerMock.Object,103            CancellationToken.None);104        // assert105        progress.CountdownEvent.Wait(new CancellationTokenSource(10000).Token);106        Assert.AreEqual(10, progress.Progress[0]);107        Assert.AreEqual(50, progress.Progress[1]);108        Assert.AreEqual(100, progress.Progress[2]);109    }110    [TestMethod]111    public async Task DataCollectorAttachmentProcessorAppDomain_ShouldLogCorrectly()112    {113        // arrange114        var invokedDataCollector = new InvokedDataCollector(new Uri("datacollector://AppDomainSample"), "AppDomainSample", typeof(AppDomainSampleDataCollector).AssemblyQualifiedName, typeof(AppDomainSampleDataCollector).Assembly.Location, true);115        var attachmentSet = new AttachmentSet(new Uri("datacollector://AppDomainSample"), "AppDomainSample");116        attachmentSet.Attachments.Add(new UriDataAttachment(new Uri("C:\\temp\\sample"), "sample"));117        Collection<AttachmentSet> attachments = new() { attachmentSet };118        var doc = new XmlDocument();119        doc.LoadXml("<configurationElement/>");120        CountdownEvent countdownEvent = new(3);121        List<Tuple<TestMessageLevel, string>> messages = new();122        _loggerMock.Setup(x => x.SendMessage(It.IsAny<TestMessageLevel>(), It.IsAny<string>())).Callback((TestMessageLevel messageLevel, string message)123            =>124        {125            countdownEvent.Signal();126            messages.Add(new Tuple<TestMessageLevel, string>(messageLevel, message));127        });128        // act129        using DataCollectorAttachmentProcessorAppDomain dcap = new(invokedDataCollector, _loggerMock.Object);130        Assert.IsTrue(dcap.LoadSucceded);131        var attachmentsResult = await dcap.ProcessAttachmentSetsAsync(doc.DocumentElement, attachments, new Progress<int>(), _loggerMock.Object, CancellationToken.None);132        // assert133        countdownEvent.Wait(new CancellationTokenSource(10000).Token);134        Assert.AreEqual(3, messages.Count);135        Assert.AreEqual(TestMessageLevel.Informational, messages[0].Item1);136        Assert.AreEqual("Info", messages[0].Item2);137        Assert.AreEqual(TestMessageLevel.Warning, messages[1].Item1);138        Assert.AreEqual("Warning", messages[1].Item2);139        Assert.AreEqual(TestMessageLevel.Error, messages[2].Item1);140        Assert.AreEqual($"line1{Environment.NewLine}line2{Environment.NewLine}line3", messages[2].Item2);141    }142    [TestMethod]143    public void DataCollectorAttachmentProcessorAppDomain_ShouldReportFailureDuringExtensionCreation()144    {145        // arrange146        var invokedDataCollector = new InvokedDataCollector(new Uri("datacollector://AppDomainSampleFailure"), "AppDomainSampleFailure", typeof(AppDomainSampleDataCollectorFailure).AssemblyQualifiedName, typeof(AppDomainSampleDataCollectorFailure).Assembly.Location, true);147        var attachmentSet = new AttachmentSet(new Uri("datacollector://AppDomainSampleFailure"), "AppDomainSampleFailure");148        attachmentSet.Attachments.Add(new UriDataAttachment(new Uri("C:\\temp\\sample"), "sample"));149        Collection<AttachmentSet> attachments = new() { attachmentSet };150        var doc = new XmlDocument();151        doc.LoadXml("<configurationElement/>");152        using ManualResetEventSlim errorReportEvent = new();153        _loggerMock.Setup(x => x.SendMessage(It.IsAny<TestMessageLevel>(), It.IsAny<string>())).Callback((TestMessageLevel messageLevel, string message)154            =>155        {156            if (messageLevel == TestMessageLevel.Error)157            {158                Assert.IsTrue(message.Contains("System.Exception: Failed to create the extension"));159                errorReportEvent.Set();160            }161        });162        // act163        using DataCollectorAttachmentProcessorAppDomain dcap = new(invokedDataCollector, _loggerMock.Object);164        //assert165        errorReportEvent.Wait(new CancellationTokenSource(10000).Token);166        Assert.IsFalse(dcap.LoadSucceded);167    }168    [DataCollectorFriendlyName("AppDomainSample")]169    [DataCollectorTypeUri("datacollector://AppDomainSample")]170    [DataCollectorAttachmentProcessor(typeof(AppDomainDataCollectorAttachmentProcessor))]171    public class AppDomainSampleDataCollector : DataCollector172    {173        public override void Initialize(174            XmlElement? configurationElement,175            DataCollectionEvents events,176            DataCollectionSink dataSink,177            DataCollectionLogger logger,...

DataCollectorAttachmentProcessorAppDomain.cs

Source:DataCollectorAttachmentProcessorAppDomain.cs

...21/// This class is a proxy implementation of IDataCollectorAttachmentProcessor.22/// We cannot load extension directly inside the runner in design mode because we're locking files23/// and in some scenario build or publish can fail.24///25/// DataCollectorAttachmentProcessorAppDomain creates DataCollectorAttachmentProcessorRemoteWrapper in a26/// custom domain.27///28/// IDataCollectorAttachmentProcessor needs to communicate back some information like, report percentage state29/// of the processing, send messages through the IMessageLogger etc...so we have a full duplex communication.30///31/// For this reason we use an anonymous pipe to "listen" to the events from the real implementation and we forward32/// the information to the caller.33/// </summary>34internal class DataCollectorAttachmentProcessorAppDomain : IDataCollectorAttachmentProcessor, IDisposable35{36    private readonly string _pipeShutdownMessagePrefix = Guid.NewGuid().ToString();37    private readonly DataCollectorAttachmentProcessorRemoteWrapper _wrapper;38    private readonly InvokedDataCollector _invokedDataCollector;39    private readonly AppDomain _appDomain;40    private readonly IMessageLogger? _dataCollectorAttachmentsProcessorsLogger;41    private readonly Task _pipeServerReadTask;42    private readonly AnonymousPipeClientStream _pipeClientStream;43    public bool LoadSucceded { get; private set; }44    public string? AssemblyQualifiedName => _wrapper.AssemblyQualifiedName;45    public string? FriendlyName => _wrapper.FriendlyName;46    private IMessageLogger? _processAttachmentSetsLogger;47    private IProgress<int>? _progressReporter;48    public DataCollectorAttachmentProcessorAppDomain(InvokedDataCollector invokedDataCollector, IMessageLogger? dataCollectorAttachmentsProcessorsLogger)49    {50        _invokedDataCollector = invokedDataCollector ?? throw new ArgumentNullException(nameof(invokedDataCollector));51        _appDomain = AppDomain.CreateDomain(invokedDataCollector.Uri.ToString());52        _dataCollectorAttachmentsProcessorsLogger = dataCollectorAttachmentsProcessorsLogger;53        _wrapper = (DataCollectorAttachmentProcessorRemoteWrapper)_appDomain.CreateInstanceFromAndUnwrap(54            typeof(DataCollectorAttachmentProcessorRemoteWrapper).Assembly.Location,55            typeof(DataCollectorAttachmentProcessorRemoteWrapper).FullName,56            false,57            BindingFlags.Default,58            null,59            new[] { _pipeShutdownMessagePrefix },60            null,61            null);62        _pipeClientStream = new AnonymousPipeClientStream(PipeDirection.In, _wrapper.GetClientHandleAsString());63        _pipeServerReadTask = Task.Run(() => PipeReaderTask());64        EqtTrace.Verbose($"DataCollectorAttachmentProcessorAppDomain.ctor: AppDomain '{_appDomain.FriendlyName}' created to host assembly '{invokedDataCollector.FilePath}'");65        InitExtension();66    }67    private void InitExtension()68    {69        try70        {71            LoadSucceded = _wrapper.LoadExtension(_invokedDataCollector.FilePath, _invokedDataCollector.Uri);72            EqtTrace.Verbose($"DataCollectorAttachmentProcessorAppDomain.ctor: Extension '{_invokedDataCollector.Uri}' loaded. LoadSucceded: {LoadSucceded} AssemblyQualifiedName: '{AssemblyQualifiedName}' HasAttachmentProcessor: '{HasAttachmentProcessor}' FriendlyName: '{FriendlyName}'");73        }74        catch (Exception ex)75        {76            EqtTrace.Error($"DataCollectorAttachmentProcessorAppDomain.InitExtension: Exception during extension initialization\n{ex}");77        }78    }79    private void PipeReaderTask()80    {81        try82        {83            using StreamReader sr = new(_pipeClientStream, Encoding.Default, false, 1024, true);84            while (_pipeClientStream?.IsConnected == true)85            {86                try87                {88                    string messagePayload = sr.ReadLine().Replace("\0", Environment.NewLine);89                    if (messagePayload.StartsWith(_pipeShutdownMessagePrefix))90                    {91                        EqtTrace.Info($"DataCollectorAttachmentProcessorAppDomain.PipeReaderTask: Shutdown message received, message: {messagePayload}");92                        return;93                    }94                    string prefix = messagePayload.Substring(0, messagePayload.IndexOf('|'));95                    string message = messagePayload.Substring(messagePayload.IndexOf('|') + 1);96                    switch (prefix)97                    {98                        case AppDomainPipeMessagePrefix.EqtTraceError: EqtTrace.Error(message); break;99                        case AppDomainPipeMessagePrefix.EqtTraceInfo: EqtTrace.Info(message); break;100                        case AppDomainPipeMessagePrefix.LoadExtensionTestMessageLevelInformational:101                        case AppDomainPipeMessagePrefix.LoadExtensionTestMessageLevelWarning:102                        case AppDomainPipeMessagePrefix.LoadExtensionTestMessageLevelError:103                            _dataCollectorAttachmentsProcessorsLogger?104                                .SendMessage((TestMessageLevel)Enum.Parse(typeof(TestMessageLevel), prefix.Substring(prefix.LastIndexOf('.') + 1), false), message);105                            break;106                        case AppDomainPipeMessagePrefix.ProcessAttachmentTestMessageLevelInformational:107                        case AppDomainPipeMessagePrefix.ProcessAttachmentTestMessageLevelWarning:108                        case AppDomainPipeMessagePrefix.ProcessAttachmentTestMessageLevelError:109                            _processAttachmentSetsLogger?110                                .SendMessage((TestMessageLevel)Enum.Parse(typeof(TestMessageLevel), prefix.Substring(prefix.LastIndexOf('.') + 1), false), message);111                            break;112                        case AppDomainPipeMessagePrefix.Report:113                            _progressReporter?.Report(int.Parse(message, CultureInfo.CurrentCulture));114                            break;115                        default:116                            EqtTrace.Error($"DataCollectorAttachmentProcessorAppDomain:PipeReaderTask: Unknown message: {message}");117                            break;118                    }119                }120                catch (Exception ex)121                {122                    EqtTrace.Error($"DataCollectorAttachmentProcessorAppDomain.PipeReaderTask: Exception during the pipe reading, Pipe connected: {_pipeClientStream.IsConnected}\n{ex}");123                }124            }125            EqtTrace.Info($"DataCollectorAttachmentProcessorAppDomain.PipeReaderTask: Exiting from the pipe read loop.");126        }127        catch (Exception ex)128        {129            EqtTrace.Error($"DataCollectorAttachmentProcessorAppDomain.PipeReaderTask: Exception on stream reader for the pipe reading\n{ex}");130        }131    }132    public bool HasAttachmentProcessor => _wrapper.HasAttachmentProcessor;133    public bool SupportsIncrementalProcessing => _wrapper.SupportsIncrementalProcessing;134    public IEnumerable<Uri>? GetExtensionUris() => _wrapper?.GetExtensionUris();135    public async Task<ICollection<AttachmentSet>> ProcessAttachmentSetsAsync(XmlElement configurationElement, ICollection<AttachmentSet> attachments, IProgress<int> progressReporter, IMessageLogger logger, CancellationToken cancellationToken)136    {137        // We register the cancellation and we call cancel inside the AppDomain138        cancellationToken.Register(() => _wrapper.CancelProcessAttachment());139        _processAttachmentSetsLogger = logger;140        _progressReporter = progressReporter;141        var result = await Task.Run(() => _wrapper.ProcessAttachment(configurationElement.OuterXml, JsonDataSerializer.Instance.Serialize(attachments.ToArray()))).ConfigureAwait(false);142        return JsonDataSerializer.Instance.Deserialize<AttachmentSet[]>(result)!;143    }144    public void Dispose()145    {146        _wrapper.Dispose();147        string appDomainName = _appDomain.FriendlyName;148        AppDomain.Unload(_appDomain);149        EqtTrace.Verbose($"DataCollectorAttachmentProcessorAppDomain.Dispose: Unloaded AppDomain '{appDomainName}'");150        if (_pipeServerReadTask?.Wait(TimeSpan.FromSeconds(30)) == false)151        {152            EqtTrace.Error($"DataCollectorAttachmentProcessorAppDomain.Dispose: PipeReaderTask timeout expired");153        }154        // We don't need to close the pipe handle because we're communicating with an in-process pipe and the same handle is closed by AppDomain.Unload(_appDomain);155        // Disposing here will fail for invalid handle during the release but we call it to avoid the GC cleanup inside the finalizer thread156        // where it fails the same.157        //158        // We could also suppress the finalizers159        // GC.SuppressFinalize(_pipeClientStream);160        // GC.SuppressFinalize(_pipeClientStream.SafePipeHandle);161        // but doing so mean relying to an implementation detail,162        // for instance if some changes are done and some other object finalizer will be added;163        // this will run on .NET Framework and it's unexpected but we prefer to rely on the documented semantic:164        // "if I call dispose no finalizers will be called for unmanaged resources hold by this object".165        try166        {...

DataCollectorAttachmentProcessor.cs

Source:DataCollectorAttachmentProcessor.cs

...70        using var logFile = new FileStream(Path.Combine(TempDirectory.Path, "log.txt"), FileMode.Open, FileAccess.Read, FileShare.ReadWrite);71        using var streamReader = new StreamReader(logFile);72        string logFileContent = streamReader.ReadToEnd();73        Assert.IsTrue(Regex.IsMatch(logFileContent, $@"DataCollectorAttachmentsProcessorsFactory: Collector attachment processor 'AttachmentProcessorDataCollector\.SampleDataCollectorAttachmentProcessor, AttachmentProcessorDataCollector, Version=.*, Culture=neutral, PublicKeyToken=null' from file '{extensionPath.Replace(@"\", @"\\")}\\AttachmentProcessorDataCollector.dll' added to the 'run list'"));74        Assert.IsTrue(Regex.IsMatch(logFileContent, @"Invocation of data collector attachment processor AssemblyQualifiedName: 'Microsoft\.VisualStudio\.TestPlatform\.CrossPlatEngine\.TestRunAttachmentsProcessing\.DataCollectorAttachmentProcessorAppDomain, Microsoft\.TestPlatform\.CrossPlatEngine, Version=.*, Culture=neutral, PublicKeyToken=.*' FriendlyName: 'SampleDataCollector'"));75    }76    private static string GetRunsettingsFilePath(string resultsDir)77    {78        var runsettingsPath = Path.Combine(resultsDir, "test_" + Guid.NewGuid() + ".runsettings");79        var dataCollectionAttributes = new Dictionary<string, string>80        {81            { "friendlyName", "SampleDataCollector" },82            { "uri", "my://sample/datacollector" }83        };84        CreateDataCollectionRunSettingsFile(runsettingsPath, dataCollectionAttributes);85        return runsettingsPath;86    }87    private static void CreateDataCollectionRunSettingsFile(string destinationRunsettingsPath, Dictionary<string, string> dataCollectionAttributes)88    {...