Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use OnTestCaseEnd method of Microsoft.TestPlatform.Extensions.EventLogCollector.EventLogDataCollector class

Best Vstest code snippet using Microsoft.TestPlatform.Extensions.EventLogCollector.EventLogDataCollector.OnTestCaseEnd

EventLogDataCollector.cs

Source:EventLogDataCollector.cs

...91    {92        _sessionStartEventHandler = OnSessionStart;93        _sessionEndEventHandler = OnSessionEnd;94        _testCaseStartEventHandler = OnTestCaseStart;95        _testCaseEndEventHandler = OnTestCaseEnd;96        _eventLogDirectories = new List<string>();97        ContextMap = new Dictionary<DataCollectionContext, EventLogSessionContext>();98        _fileHelper = fileHelper;99    }100    internal int MaxEntries { get; private set; }101    internal ISet<string>? EventSources { get; private set; }102    internal ISet<EventLogEntryType>? EntryTypes { get; private set; }103    internal ISet<string>? EventLogNames { get; private set; }104    /// <summary>105    /// Gets the context data.106    /// </summary>107    internal Dictionary<DataCollectionContext, EventLogSessionContext> ContextMap { get; }108    #region DataCollector Members109    /// <summary>110    /// Initializes the data collector111    /// </summary>112    /// <param name="configurationElement">113    /// The XML element containing configuration information for the data collector. Currently,114    /// this data collector does not have any configuration, so we ignore this parameter.115    /// </param>116    /// <param name="events">117    /// Object containing the execution events the data collector registers for118    /// </param>119    /// <param name="dataSink">The sink used by the data collector to send its data</param>120    /// <param name="logger">121    /// Used by the data collector to send warnings, errors, or other messages122    /// </param>123    /// <param name="dataCollectionEnvironmentContext">Provides contextual information about the agent environment</param>124    [MemberNotNull(nameof(_events), nameof(_dataSink), nameof(_logger), nameof(_dataCollectorContext))]125    public override void Initialize(126        XmlElement? configurationElement,127        DataCollectionEvents events,128        DataCollectionSink dataSink,129        DataCollectionLogger logger,130        DataCollectionEnvironmentContext? dataCollectionEnvironmentContext)131    {132        ValidateArg.NotNull(events, nameof(events));133        ValidateArg.NotNull(dataSink, nameof(dataSink));134        ValidateArg.NotNull(logger, nameof(logger));135        ValidateArg.NotNull(dataCollectionEnvironmentContext, nameof(dataCollectionEnvironmentContext));136        _events = events;137        _dataSink = dataSink;138        _logger = logger;139        _dataCollectorContext = dataCollectionEnvironmentContext!.SessionDataCollectionContext;140        // Load the configuration141        CollectorNameValueConfigurationManager nameValueSettings =142            new(configurationElement);143        // Apply the configuration144        ConfigureEventSources(nameValueSettings);145        ConfigureEntryTypes(nameValueSettings);146        ConfigureMaxEntries(nameValueSettings);147        ConfigureEventLogNames(nameValueSettings, _dataCollectorContext);148        // Register for events149        events.SessionStart += _sessionStartEventHandler;150        events.SessionEnd += _sessionEndEventHandler;151        events.TestCaseStart += _testCaseStartEventHandler;152        events.TestCaseEnd += _testCaseEndEventHandler;153    }154    #endregion155    /// <summary>156    /// The write event logs.157    /// </summary>158    /// <param name="eventLogEntries">159    /// The event log entries.160    /// </param>161    /// <param name="maxLogEntries">162    /// Max Log Entries.163    /// </param>164    /// <param name="dataCollectionContext">165    /// The data collection context.166    /// </param>167    /// <param name="requestedDuration">168    /// The requested duration.169    /// </param>170    /// <param name="timeRequestReceived">171    /// The time request received.172    /// </param>173    /// <returns>174    /// The <see cref="string"/>.175    /// </returns>176    internal string WriteEventLogs(List<EventLogEntry> eventLogEntries, int maxLogEntries, DataCollectionContext dataCollectionContext, TimeSpan requestedDuration, DateTime timeRequestReceived)177    {178        // Generate a unique but friendly Directory name in the temp directory179        string eventLogDirName = string.Format(180            CultureInfo.InvariantCulture,181            "{0}-{1}-{2:yyyy}{2:MM}{2:dd}-{2:HH}{2:mm}{2:ss}.{2:fff}",182            "Event Log",183            Environment.MachineName,184            DateTime.UtcNow);185        string eventLogDirPath = Path.Combine(Path.GetTempPath(), eventLogDirName);186        // Create the directory187        _fileHelper.CreateDirectory(eventLogDirPath);188        string eventLogBasePath = Path.Combine(eventLogDirPath, EventLogFileName);189        bool unusedFilenameFound = false;190        string eventLogPath = eventLogBasePath + ".xml";191        if (_fileHelper.Exists(eventLogPath))192        {193            for (int i = 1; !unusedFilenameFound; i++)194            {195                eventLogPath = $"{eventLogBasePath}-{i.ToString(CultureInfo.InvariantCulture)}.xml";196                if (!_fileHelper.Exists(eventLogPath))197                {198                    unusedFilenameFound = true;199                }200            }201        }202        DateTime minDate = DateTime.MinValue;203        // Limit entries to a certain time range if requested204        if (requestedDuration < TimeSpan.MaxValue)205        {206            try207            {208                minDate = timeRequestReceived - requestedDuration;209            }210            catch (ArgumentOutOfRangeException)211            {212                minDate = DateTime.MinValue;213            }214        }215        Stopwatch stopwatch = new();216        stopwatch.Start();217        EventLogXmlWriter.WriteEventLogEntriesToXmlFile(218            eventLogPath,219            eventLogEntries.Where(220                entry => entry.TimeGenerated > minDate && entry.TimeGenerated < DateTime.MaxValue).OrderBy(x => x.TimeGenerated).Take(maxLogEntries).ToList(),221            _fileHelper);222        stopwatch.Stop();223        EqtTrace.Verbose(224            "EventLogDataContainer: Wrote {0} event log entries to file '{1}' in {2} seconds",225            eventLogEntries.Count,226            eventLogPath,227            stopwatch.Elapsed.TotalSeconds.ToString(CultureInfo.InvariantCulture));228        // Write the event log file229        FileTransferInformation fileTransferInformation =230            new(dataCollectionContext, eventLogPath, true, _fileHelper);231        TPDebug.Assert(_dataSink != null, "Initialize should have been called.");232        _dataSink.SendFileAsync(fileTransferInformation);233        EqtTrace.Verbose(234            "EventLogDataContainer: Event log successfully sent for data collection context '{0}'.",235            dataCollectionContext.ToString());236        return eventLogPath;237    }238    #region IDisposable Members239    /// <summary>240    /// Cleans up resources allocated by the data collector241    /// </summary>242    /// <param name="disposing">Not used since this class does not have a finalizer.</param>243    protected override void Dispose(bool disposing)244    {245        if (_isDisposed)246            return;247        base.Dispose(disposing);248        if (disposing)249        {250            // Unregister events251            if (_events != null)252            {253                _events.SessionStart -= _sessionStartEventHandler;254                _events.SessionEnd -= _sessionEndEventHandler;255                _events.TestCaseStart -= _testCaseStartEventHandler;256                _events.TestCaseEnd -= _testCaseEndEventHandler;257            }258            // Unregister EventLogEntry Written.259            foreach (var eventLogContainer in _eventLogContainerMap.Values)260            {261                eventLogContainer.Dispose();262            }263            // Delete all the temp event log directories264            RemoveTempEventLogDirs(_eventLogDirectories);265        }266        _isDisposed = true;267    }268    #endregion269    private static ISet<string> ParseCommaSeparatedList(string commaSeparatedList)270    {271        ISet<string> strings = new HashSet<string>();272        string[] items = commaSeparatedList.Split(new char[] { ',' });273        foreach (string item in items)274        {275            strings.Add(item.Trim());276        }277        return strings;278    }279    private void OnSessionStart(object? sender, SessionStartEventArgs e)280    {281        ValidateArg.NotNull(e, nameof(e));282        ValidateArg.NotNull(e.Context, "SessionStartEventArgs.Context");283        EqtTrace.Verbose("EventLogDataCollector: SessionStart received");284        StartCollectionForContext(e.Context);285    }286    private void OnSessionEnd(object? sender, SessionEndEventArgs e)287    {288        ValidateArg.NotNull(e, nameof(e));289        ValidateArg.NotNull(e.Context, "SessionEndEventArgs.Context");290        EqtTrace.Verbose("EventLogDataCollector: SessionEnd received");291        WriteCollectedEventLogEntries(e.Context, true, TimeSpan.MaxValue, DateTime.UtcNow);292    }293    private void OnTestCaseStart(object? sender, TestCaseStartEventArgs e)294    {295        ValidateArg.NotNull(e, nameof(e));296        ValidateArg.NotNull(e.Context, "TestCaseStartEventArgs.Context");297        if (!e.Context.HasTestCase)298        {299            Debug.Fail("Context is not for a test case");300            ValidateArg.NotNull(e.Context.TestExecId, "TestCaseStartEventArgs.Context.HasTestCase");301        }302        EqtTrace.Verbose("EventLogDataCollector: TestCaseStart received for test '{0}'.", e.TestCaseName);303        StartCollectionForContext(e.Context);304    }305    private void OnTestCaseEnd(object? sender, TestCaseEndEventArgs e)306    {307        ValidateArg.NotNull(e, nameof(e));308        TPDebug.Assert(e.Context != null, "Context is null");309        TPDebug.Assert(e.Context.HasTestCase, "Context is not for a test case");310        EqtTrace.Verbose(311            "EventLogDataCollector: TestCaseEnd received for test '{0}' with Test Outcome: {1}.",312            e.TestCaseName,313            e.TestOutcome);314        WriteCollectedEventLogEntries(e.Context, false, TimeSpan.MaxValue, DateTime.UtcNow);315    }316    private void RemoveTempEventLogDirs(List<string> tempDirs)317    {318        if (tempDirs != null)319        {...

OnTestCaseEnd

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.VisualStudio.TestTools.UnitTesting;7using Microsoft.TestPlatform.Extensions.EventLogCollector;8{9    {10        public void TestMethod1()11        {12            EventLogDataCollector eventLogDataCollector = new EventLogDataCollector();13            eventLogDataCollector.OnTestCaseEnd();14        }15    }16}17Error 1   The type or namespace name 'EventLogDataCollector' does not exist in the namespace 'Microsoft.TestPlatform.Extensions.EventLogCollector' (are you missing an assembly reference?)

OnTestCaseEnd

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.VisualStudio.TestPlatform.ObjectModel;7using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;8using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;9{10    [FriendlyName("EventLogCollector")]11    {12        private string _logFileName;13        public void Initialize(TestLoggerEvents events, string testRunDirectory)14        {15            events.TestRunMessage += TestMessageHandler;16            events.TestRunComplete += TestRunCompleteHandler;17            events.TestResult += TestResultHandler;18            events.TestRunStart += TestRunStartHandler;19            events.TestCaseStart += TestCaseStartHandler;20            events.TestCaseEnd += TestCaseEndHandler;21        }22        public void Initialize(TestLoggerEvents events, Dictionary<string, string> parameters)23        {24            events.TestRunMessage += TestMessageHandler;25            events.TestRunComplete += TestRunCompleteHandler;26            events.TestResult += TestResultHandler;27            events.TestRunStart += TestRunStartHandler;28            events.TestCaseStart += TestCaseStartHandler;29            events.TestCaseEnd += TestCaseEndHandler;30            if (parameters != null)31            {32                foreach (var parameter in parameters)33                {34                    if (string.Equals(parameter.Key, "LogFileName", StringComparison.OrdinalIgnoreCase))35                    {36                        _logFileName = parameter.Value;37                    }38                }39            }40        }41        private void TestMessageHandler(object sender, TestRunMessageEventArgs e)42        {43            Console.WriteLine("TestMessageHandler: " + e.Message);44        }45        private void TestRunCompleteHandler(object sender, TestRunCompleteEventArgs e)46        {47            Console.WriteLine("TestRunCompleteHandler: " + e.IsCanceled + " " + e.IsAborted + " " + e.Error);48        }49        private void TestResultHandler(object sender, TestResultEventArgs e)50        {51            Console.WriteLine("TestResultHandler: " + e.Result.Outcome);52        }53        private void TestRunStartHandler(object sender, TestRunStartEventArgs e)54        {55            Console.WriteLine("TestRunStartHandler: " + e.IsAborted + " " + e.IsBeingDebugged + " " + e.IsDataCollectionEnabled);56        }57        private void TestCaseStartHandler(object sender, TestCaseStartEventArgs e)58        {

OnTestCaseEnd

Using AI Code Generation

1using Microsoft.TestPlatform.Extensions.EventLogCollector;2using Microsoft.VisualStudio.TestPlatform.ObjectModel;3using Microsoft.VisualStudio.TestPlatform.ObjectModel.DataCollection;4using System;5using System.Collections.Generic;6using System.Linq;7using System.Text;8using System.Threading.Tasks;9{10    [DataCollectorFriendlyName("EventLogCollector")]11    {12        private EventLogDataCollectorConfig config;13        private ITestExecutionEnvironment testExecutionEnvironment;14        private DataCollectionEvents events;15        public EventLogDataCollector()16        {17            this.testExecutionEnvironment = new TestExecutionEnvironment();18            this.config = new EventLogDataCollectorConfig(this.testExecutionEnvironment);19        }20        public override void Initialize(21        {22            this.events = events;23            this.events.TestCaseEnd += this.OnTestCaseEnd;24            this.config.Initialize(configurationElement);25        }26        private void OnTestCaseEnd(object sender, TestCaseEndEventArgs e)27        {28            if (e.TestOutcome == TestOutcome.Failed)29            {30                var testCaseResult = e.TestResult;31                var testCase = testCaseResult.TestCase;32                var testCaseFqName = testCase.FullyQualifiedName;33                var testCaseSource = testCase.Source;34                var testCaseDisplayName = testCase.DisplayName;35                var testCaseCodeFilePath = testCase.CodeFilePath;36                var testCaseLineNumber = testCase.LineNumber;37            }38        }39    }40}41using Microsoft.TestPlatform.Extensions.EventLogCollector;42using Microsoft.VisualStudio.TestPlatform.ObjectModel;43using Microsoft.VisualStudio.TestPlatform.ObjectModel.DataCollection;44using System;45using System.Collections.Generic;46using System.Linq;47using System.Text;48using System.Threading.Tasks;

OnTestCaseEnd

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Diagnostics;4using System.Linq;5using System.Text;6using System.Threading.Tasks;7using System.Xml;8using Microsoft.VisualStudio.TestPlatform.ObjectModel.DataCollection;9{10    [DataCollectorFriendlyName("EventLogCollector")]11    {12        private DataCollectionEnvironmentContext context;13        private DataCollectionEvents events;14        private DataCollectionSink dataSink;15        public override void Initialize(16        {17            this.context = context;18            this.events = events;19            this.dataSink = dataSink;20            this.events.TestCaseEnd += this.OnTestCaseEnd;21        }22        private void OnTestCaseEnd(object sender, TestCaseEndEventArgs e)23        {24            var endTime = e.EndTime;25            var testResult = e.TestResult;26            var testResultXml = testResult.ResultXml;27            var xmlDocument = new XmlDocument();28            xmlDocument.LoadXml(testResultXml);29            var testCaseEndTime = xmlDocument.CreateElement("TestCaseEndTime");30            testCaseEndTime.InnerText = endTime.ToString();31            xmlDocument.DocumentElement.AppendChild(testCaseEndTime);32            testResult.ResultXml = xmlDocument.OuterXml;33            this.dataSink.SendTestCaseResult(testResult);34        }35    }36}

OnTestCaseEnd

Using AI Code Generation

1using System;2using System.IO;3using System.Xml;4using System.Xml.Linq;5using System.Xml.XPath;6using System.Linq;7using System.Collections.Generic;8using System.Text;9using System.Diagnostics;10using Microsoft.VisualStudio.TestPlatform.ObjectModel;11using Microsoft.VisualStudio.TestPlatform.ObjectModel.DataCollection;12using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;13{14    [DataCollectorFriendlyName("EventLogCollector")]15    {16        private DataCollectionEnvironmentContext context;17        private DataCollectionEvents events;18        private DataCollectionSink dataSink;19        private Dictionary<string, string> parametersDictionary;20        private string fileName;21        private string filePath;22        private string fileDirectory;23        public override void Initialize(24        {25            this.context = context;26            this.events = events;27            this.dataSink = dataSink;28            this.parametersDictionary = GetDataCollectorConfig(configurationElement);29            if (this.parametersDictionary.ContainsKey("FileName"))30            {31                this.fileName = this.parametersDictionary["FileName"];32            }33            {34                this.fileName = "EventLog.txt";35            }36            if (this.parametersDictionary.ContainsKey("FilePath"))37            {38                this.filePath = this.parametersDictionary["FilePath"];39            }40            {41                this.filePath = @"C:\Users\Public\Documents";42            }43            this.fileDirectory = Path.Combine(this.filePath, this.fileName);44            events.SessionEnd += this.SessionEnded_Handler;45            events.TestCaseEnd += this.TestCaseEnded_Handler;46        }47        public override void SessionEnded()48        {49            this.events.SessionEnd -= this.SessionEnded_Handler;50            this.events.TestCaseEnd -= this.TestCaseEnded_Handler;51        }52        private void SessionEnded_Handler(object sender, SessionEndEventArgs e)53        {54            this.dataSink.SendFileAsync(this.fileDirectory, true, this.context);55        }56        private void TestCaseEnded_Handler(object sender, TestCaseEndEventArgs e)57        {58            string testCaseName = e.TestCase.FullyQualifiedName;59            var logMessages = e.TestResult.Messages.Where(x => x.Category == "EventLog");60            if (logMessages.Count()

OnTestCaseEnd

Using AI Code Generation

1using Microsoft.VisualStudio.TestTools.UnitTesting;2using Microsoft.TestPlatform.Extensions.EventLogCollector;3using System;4using System.Collections.Generic;5using System.Diagnostics;6using System.Linq;7using System.Text;8using System.Threading.Tasks;9{10    {11        public void TestMethod1()12        {13        }14        public void TestCleanup()15        {16            EventLogDataCollector eventLogDataCollector = new EventLogDataCollector();17            eventLogDataCollector.OnTestCaseEnd();18        }19    }20}21using Microsoft.VisualStudio.TestTools.UnitTesting;22using Microsoft.TestPlatform.Extensions.EventLogCollector;23using System;24using System.Collections.Generic;25using System.Diagnostics;26using System.Linq;27using System.Text;28using System.Threading.Tasks;29{30    {31        public void TestMethod1()32        {33        }34        public void TestCleanup()35        {36            EventLogDataCollector eventLogDataCollector = new EventLogDataCollector();37            eventLogDataCollector.OnRunEnd();38        }39    }40}41using Microsoft.VisualStudio.TestTools.UnitTesting;42using Microsoft.TestPlatform.Extensions.EventLogCollector;43using System;44using System.Collections.Generic;45using System.Diagnostics;46using System.Linq;47using System.Text;48using System.Threading.Tasks;49{50    {

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.