KaneAI - World’s First E2E Software Testing Agent.Signup for Private Beta Join TestMu Conference

Automation Advisor
Vstest
Microsoft.VisualStudio.TestPlatform.CrossPlatEngine.Client
DataCollectionRunEventsHandler

How to use DataCollectionRunEventsHandler class of Microsoft.VisualStudio.TestPlatform.CrossPlatEngine.Client package

Best Vstest code snippet using Microsoft.VisualStudio.TestPlatform.CrossPlatEngine.Client.DataCollectionRunEventsHandler

ProxyExecutionManagerWithDataCollection.cs

Source:ProxyExecutionManagerWithDataCollection.cs

...37        public ProxyExecutionManagerWithDataCollection(IRequestData requestData, ITestRequestSender requestSender, ITestRuntimeProvider testHostManager, IProxyDataCollectionManager proxyDataCollectionManager)38            : base(requestData, requestSender, testHostManager)39        {40            this.ProxyDataCollectionManager = proxyDataCollectionManager;41            this.DataCollectionRunEventsHandler = new DataCollectionRunEventsHandler();42            this.requestData = requestData;43            this.dataCollectionEnvironmentVariables = new Dictionary<string, string>();44        }45        /// <summary>46        /// Gets the data collection run events handler.47        /// </summary>48        internal DataCollectionRunEventsHandler DataCollectionRunEventsHandler49        {50            get; private set;51        }52        /// <summary>53        /// Gets the proxy data collection manager.54        /// </summary>55        internal IProxyDataCollectionManager ProxyDataCollectionManager56        {57            get; private set;58        }59        /// <summary>60        /// Ensure that the Execution component of engine is ready for execution usually by loading extensions.61        /// </summary>62        public override void Initialize()63        {64            this.ProxyDataCollectionManager.Initialize();65            try66            {67                var dataCollectionParameters = this.ProxyDataCollectionManager.BeforeTestRunStart(68                                                   resetDataCollectors: true,69                                                   isRunStartingNow: true,70                                                   runEventsHandler: this.DataCollectionRunEventsHandler);71                if (dataCollectionParameters != null)72                {73                    this.dataCollectionEnvironmentVariables = dataCollectionParameters.EnvironmentVariables;74                    this.dataCollectionPort = dataCollectionParameters.DataCollectionEventsPort;75                }76            }77            catch (Exception)78            {79                // On failure in calling BeforeTestRunStart, call AfterTestRunEnd to end DataCollectionProcess80                this.ProxyDataCollectionManager.AfterTestRunEnd(isCanceled: true, runEventsHandler: this.DataCollectionRunEventsHandler);81                throw;82            }83            base.Initialize();84        }85        /// <summary>86        /// Starts the test run87        /// </summary>88        /// <param name="testRunCriteria"> The settings/options for the test run. </param>89        /// <param name="eventHandler"> EventHandler for handling execution events from Engine. </param>90        /// <returns> The process id of the runner executing tests. </returns>91        public override int StartTestRun(TestRunCriteria testRunCriteria, ITestRunEventsHandler eventHandler)92        {93            var currentEventHandler = eventHandler;94            if (this.ProxyDataCollectionManager != null)95            {96                currentEventHandler = new DataCollectionTestRunEventsHandler(eventHandler, this.ProxyDataCollectionManager);97            }98            // Log all the messages that are reported while initializing DataCollectionClient99            if (this.DataCollectionRunEventsHandler.Messages.Count > 0)100            {101                foreach (var message in this.DataCollectionRunEventsHandler.Messages)102                {103                    currentEventHandler.HandleLogMessage(message.Item1, message.Item2);104                }105                this.DataCollectionRunEventsHandler.Messages.Clear();106            }107            return base.StartTestRun(testRunCriteria, currentEventHandler);108        }109        /// <inheritdoc/>110        public override void Cancel()111        {112            try113            {114                this.ProxyDataCollectionManager.AfterTestRunEnd(isCanceled: true, runEventsHandler: this.DataCollectionRunEventsHandler);115            }116            finally117            {118                base.Cancel();119            }120        }121        /// <inheritdoc />122        protected override TestProcessStartInfo UpdateTestProcessStartInfo(TestProcessStartInfo testProcessStartInfo)123        {124            if (testProcessStartInfo.EnvironmentVariables == null)125            {126                testProcessStartInfo.EnvironmentVariables = this.dataCollectionEnvironmentVariables;127            }128            else129            {130                foreach (var kvp in this.dataCollectionEnvironmentVariables)131                {132                    testProcessStartInfo.EnvironmentVariables[kvp.Key] = kvp.Value;133                }134            }135            // Update Telemetry Opt in status because by default in Test Host Telemetry is opted out136            var telemetryOptedIn = this.requestData.IsTelemetryOptedIn ? "true" : "false";137            testProcessStartInfo.Arguments += " --datacollectionport " + this.dataCollectionPort138                                              + " --telemetryoptedin " + telemetryOptedIn;139            return testProcessStartInfo;140        }141    }142    /// <summary>143    /// Handles Log events and stores them in list. Messages in the list will be logged after test execution begins.144    /// </summary>145    internal class DataCollectionRunEventsHandler : ITestMessageEventHandler146    {147        /// <summary>148        /// Initializes a new instance of the <see cref="DataCollectionRunEventsHandler"/> class. 149        /// </summary>150        public DataCollectionRunEventsHandler()151        {152            this.Messages = new List<Tuple<TestMessageLevel, string>>();153        }154        /// <summary>155        /// Gets the cached messages.156        /// </summary>157        public List<Tuple<TestMessageLevel, string>> Messages { get; private set; }158        /// <inheritdoc />159        public void HandleLogMessage(TestMessageLevel level, string message)160        {161            this.Messages.Add(new Tuple<TestMessageLevel, string>(level, message));162        }163        /// <inheritdoc />164        public void HandleRawMessage(string rawMessage)...