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

Copied to Clipboard!

How to use IsBoundsEnabledOnLoggerEventQueue method of Microsoft.VisualStudio.TestPlatform.Common.Logging.InternalTestLoggerEvents class

Best Vstest code snippet using Microsoft.VisualStudio.TestPlatform.Common.Logging.InternalTestLoggerEvents.IsBoundsEnabledOnLoggerEventQueue

LocalTestLoggerEvents.cs

Source:LocalTestLoggerEvents.cs

...46    public LocalTestLoggerEvents() {47      // Initialize the queue and pause it.48      // Note: The queue will be resumed when events are enabled.  This is done so all49      //       loggers receive all messages.50      this.isBoundsOnLoggerEventQueueEnabled = IsBoundsEnabledOnLoggerEventQueue();51      this.loggerEventQueue = new JobQueue<Action>(52        this.ProcessQueuedJob,53        "Test Logger",54        GetMaxNumberOfJobsInQueue(),55        GetMaxBytesQueueCanHold(),56        this.isBoundsOnLoggerEventQueueEnabled,57        (message) => EqtTrace.Error(message));58      this.loggerEventQueue.Pause();59    }60    #endregion61    #region Events62    /// <summary>63    /// Raised when a test message is received.64    /// </summary>65    public override event EventHandler<TestRunMessageEventArgs> TestRunMessage;66    /// <summary>67    /// Raised when a test run starts.68    /// </summary>69    public override event EventHandler<TestRunStartEventArgs> TestRunStart;70    /// <summary>71    /// Raised when a test result is received.72    /// </summary>73    public override event EventHandler<TestResultEventArgs> TestResult;74    /// <summary>75    /// Raised when a test run is complete.76    /// </summary>77    public override event EventHandler<TestRunCompleteEventArgs> TestRunComplete;78    /// <summary>79    /// Raised when test discovery starts.80    /// </summary>81    public override event EventHandler<DiscoveryStartEventArgs> DiscoveryStart;82    /// <summary>83    /// Raised when a discovery message is received.84    /// </summary>85    public override event EventHandler<TestRunMessageEventArgs> DiscoveryMessage;86    /// <summary>87    /// Raised when discovered tests are received88    /// </summary>89    public override event EventHandler<DiscoveredTestsEventArgs> DiscoveredTests;90    /// <summary>91    /// Raised when test discovery is complete92    /// </summary>93    public override event EventHandler<DiscoveryCompleteEventArgs> DiscoveryComplete;94    #endregion95    #region IDisposable96    /// <summary>97    /// Waits for all pending messages to be processed by the loggers cleans up.98    /// </summary>99    public void Dispose() {100      if (this.isDisposed) {101        return;102      }103      this.isDisposed = true;104      // Ensure that the queue is processed before returning.105      this.loggerEventQueue.Resume();106      this.loggerEventQueue.Dispose();107    }108    #endregion109    #region Internal Methods110    /// <summary>111    /// Enables sending of events to the loggers which are registered and flushes the queue.112    /// </summary>113    /// <remarks>114    /// By default events are disabled and will not be raised until this method is called.115    /// This is done because during logger initialization, errors could be sent and we do not116    /// want them broadcast out to the loggers until all loggers have been enabled.  Without this117    /// all loggers would not receive the errors which were sent prior to initialization finishing.118    /// </remarks>119    internal void EnableEvents() {120      this.CheckDisposed();121      this.loggerEventQueue.Resume();122      // Allow currently queued events to flush from the queue.  This is done so that information123      // logged during initialization completes processing before we begin other tasks.  This is124      // important for instance when errors are logged during initialization and need to be output125      // to the console before we begin outputting other information to the console.126      this.loggerEventQueue.Flush();127    }128    /// <summary>129    /// Raises a test run message event to the enabled loggers.130    /// </summary>131    /// <param name="args">Arguments to be raised.</param>132    internal void RaiseTestRunMessage(TestRunMessageEventArgs args) {133      if (args == null) {134        throw new ArgumentNullException(nameof(args));135      }136      this.CheckDisposed();137      // Sending 0 size as this event is not expected to contain any data.138      this.SafeInvokeAsync(() => this.TestRunMessage, args, 0, "InternalTestLoggerEvents.SendTestRunMessage");139    }140    internal void WaitForEventCompletion() {141      this.loggerEventQueue.Flush();142    }143    /// <summary>144    /// Raises a test result event to the enabled loggers.145    /// </summary>146    /// <param name="args">Arguments to to be raised.</param>147    internal void RaiseTestResult(TestResultEventArgs args) {148      ValidateArg.NotNull(args, nameof(args));149      this.CheckDisposed();150      // find the approx size of test result151      int resultSize = 0;152      if (this.isBoundsOnLoggerEventQueueEnabled) {153        resultSize = FindTestResultSize(args) * sizeof(char);154      }155      this.SafeInvokeAsync(() => this.TestResult, args, resultSize, "InternalTestLoggerEvents.SendTestResult");156    }157    /// <summary>158    /// Raises the test run start event to enabled loggers.159    /// </summary>160    /// <param name="args">Arguments to be raised.</param>161    internal void RaiseTestRunStart(TestRunStartEventArgs args) {162      ValidateArg.NotNull(args, nameof(args));163      CheckDisposed();164      this.SafeInvokeAsync(() => this.TestRunStart, args, 0, "InternalTestLoggerEvents.SendTestRunStart");165    }166    /// <summary>167    /// Raises a discovery start event to the enabled loggers.168    /// </summary>169    /// <param name="args">Arguments to be raised.</param>170    internal void RaiseDiscoveryStart(DiscoveryStartEventArgs args) {171      ValidateArg.NotNull(args, nameof(args));172      CheckDisposed();173      SafeInvokeAsync(() => this.DiscoveryStart, args, 0, "InternalTestLoggerEvents.SendDiscoveryStart");174    }175    /// <summary>176    /// Raises a discovery message event to the enabled loggers.177    /// </summary>178    /// <param name="args">Arguments to be raised.</param>179    internal void RaiseDiscoveryMessage(TestRunMessageEventArgs args) {180      ValidateArg.NotNull(args, nameof(args));181      this.CheckDisposed();182      // Sending 0 size as this event is not expected to contain any data.183      this.SafeInvokeAsync(() => this.DiscoveryMessage, args, 0, "InternalTestLoggerEvents.SendDiscoveryMessage");184    }185    /// <summary>186    /// Raises discovered tests event to the enabled loggers.187    /// </summary>188    /// <param name="args"> Arguments to be raised. </param>189    internal void RaiseDiscoveredTests(DiscoveredTestsEventArgs args) {190      ValidateArg.NotNull(args, nameof(args));191      CheckDisposed();192      SafeInvokeAsync(() => this.DiscoveredTests, args, 0, "InternalTestLoggerEvents.SendDiscoveredTests");193    }194    /// <summary>195    /// Raises discovery complete event to the enabled loggers.196    /// </summary>197    /// <param name="args"> Arguments to be raised. </param>198    internal void RaiseDiscoveryComplete(DiscoveryCompleteEventArgs args) {199      ValidateArg.NotNull(args, nameof(args));200      CheckDisposed();201      // Sending 0 size as this event is not expected to contain any data.202      SafeInvokeAsync(() => this.DiscoveryComplete, args, 0, "InternalTestLoggerEvents.SendDiscoveryComplete");203      // Wait for the loggers to finish processing the messages for the run.204      this.loggerEventQueue.Flush();205    }206    /// <summary>207    /// Raises test run complete to the enabled loggers208    /// </summary>209    /// <param name="args"> Arguments to be raised </param>210    internal void RaiseTestRunComplete(TestRunCompleteEventArgs args) {211      ValidateArg.NotNull(args, nameof(args));212      CheckDisposed();213      // Size is being send as 0. (It is good to send the size as the job queue uses it)214      SafeInvokeAsync(() => this.TestRunComplete, args, 0, "InternalTestLoggerEvents.SendTestRunComplete");215      // Wait for the loggers to finish processing the messages for the run.216      this.loggerEventQueue.Flush();217    }218    /// <summary>219    /// Raise the test run complete event to test loggers and waits220    /// for the events to be processed.221    /// </summary>222    /// <param name="stats">Specifies the stats of the test run.</param>223    /// <param name="isCanceled">Specifies whether the test run is canceled.</param>224    /// <param name="isAborted">Specifies whether the test run is aborted.</param>225    /// <param name="error">Specifies the error that occurs during the test run.</param>226    /// <param name="attachmentSet">Run level attachment sets</param>227    /// <param name="elapsedTime">Time elapsed in just running the tests.</param>228    internal void CompleteTestRun(ITestRunStatistics stats, bool isCanceled, bool isAborted, Exception error,229      Collection<AttachmentSet> attachmentSet, TimeSpan elapsedTime) {230      this.CheckDisposed();231      var args = new TestRunCompleteEventArgs(stats, isCanceled, isAborted, error, attachmentSet, elapsedTime);232      // Sending 0 size as this event is not expected to contain any data.233      this.SafeInvokeAsync(() => this.TestRunComplete, args, 0, "InternalTestLoggerEvents.SendTestRunComplete");234      // Wait for the loggers to finish processing the messages for the run.235      this.loggerEventQueue.Flush();236    }237    #endregion238    #region Private Members239    /// <summary>240    /// Called when a test run message is sent through the ITestRunMessageLogger which is exported.241    /// </summary>242    private void TestRunMessageHandler(object sender, TestRunMessageEventArgs e) {243      // Broadcast the message to the loggers.244      this.SafeInvokeAsync(() => this.TestRunMessage, e, 0, "InternalTestLoggerEvents.SendMessage");245    }246    /// <summary>247    /// Invokes each of the subscribers of the event and handles exceptions which are thrown248    /// ensuring that each handler is invoked even if one throws.249    /// The actual calling of the subscribers is done on a background thread.250    /// </summary>251    private void SafeInvokeAsync(Func<MulticastDelegate> eventHandlersFactory, EventArgs args, int size,252      string traceDisplayName) {253      ValidateArg.NotNull(eventHandlersFactory, nameof(eventHandlersFactory));254      ValidateArg.NotNull(args, nameof(args));255      // Invoke the handlers on a background thread.256      this.loggerEventQueue.QueueJob(257        () => {258          var eventHandlers = eventHandlersFactory();259          eventHandlers?.SafeInvoke(this, args, traceDisplayName);260        }, size);261    }262    /// <summary>263    /// Method called to process a job which is coming from the logger event queue.264    /// </summary>265    private void ProcessQueuedJob(Action action) {266      action();267    }268    /// <summary>269    /// Throws if we are disposed.270    /// </summary>271    private void CheckDisposed() {272      if (this.isDisposed) {273        throw new ObjectDisposedException(typeof(TestLoggerEvents).FullName);274      }275    }276    /// <summary>277    /// The method parses the config file of vstest.console.exe to see if the Max Job Queue Length is defined.278    /// Return the Max Queue Length so defined or a default value specified by TestPlatformDefaults.DefaultMaxLoggerEventsToCache279    /// </summary>280    private int GetMaxNumberOfJobsInQueue() {281      return GetSetting(TestPlatformDefaults.MaxNumberOfEventsLoggerEventQueueCanHold,282        TestPlatformDefaults.DefaultMaxNumberOfEventsLoggerEventQueueCanHold);283    }284    /// <summary>285    /// The method parses the config file of vstest.console.exe to see if the Max Job Queue size is defined.286    /// Return the Max Queue size so defined or a default value specified by TestPlatformDefaults.DefaultMaxJobQueueSize287    /// </summary>288    private int GetMaxBytesQueueCanHold() {289      return GetSetting(TestPlatformDefaults.MaxBytesLoggerEventQueueCanHold,290        TestPlatformDefaults.DefaultMaxBytesLoggerEventQueueCanHold);291    }292    /// <summary>293    /// Returns whether flow control on logger events queue should be enabled or not. Default is enabled.294    /// </summary>295    private static bool IsBoundsEnabledOnLoggerEventQueue() {296      bool enableBounds;297#if NETFRAMEWORK298            string enableBoundsOnEventQueueIsDefined =299 ConfigurationManager.AppSettings[TestPlatformDefaults.EnableBoundsOnLoggerEventQueue];300#else301      string enableBoundsOnEventQueueIsDefined = null;302#endif303      if (string.IsNullOrEmpty(enableBoundsOnEventQueueIsDefined)) {304        enableBounds = TestPlatformDefaults.DefaultEnableBoundsOnLoggerEventQueue;305      } else {306        if (!(bool.TryParse(enableBoundsOnEventQueueIsDefined, out enableBounds))) {307          enableBounds = TestPlatformDefaults.DefaultEnableBoundsOnLoggerEventQueue;308        }309      }...

IsBoundsEnabledOnLoggerEventQueue

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.VisualStudio.TestPlatform.Common.Logging;7{8    {9        static void Main(string[] args)10        {11            InternalTestLoggerEvents log = new InternalTestLoggerEvents();12            Console.WriteLine(log.IsBoundsEnabledOnLoggerEventQueue());13        }14    }15}16using System;17using System.Collections.Generic;18using System.Linq;19using System.Text;20using System.Threading.Tasks;21using Microsoft.VisualStudio.TestPlatform.Common.Logging;22{23    {24        static void Main(string[] args)25        {26            InternalTestLoggerEvents log = new InternalTestLoggerEvents();27            Console.WriteLine(log.IsBoundsEnabledOnLoggerEventQueue());28        }29    }30}31using System;32using System.Collections.Generic;33using System.Linq;34using System.Text;35using System.Threading.Tasks;36using Microsoft.VisualStudio.TestPlatform.Common.Logging;37{38    {39        static void Main(string[] args)40        {41            InternalTestLoggerEvents log = new InternalTestLoggerEvents();42            Console.WriteLine(log.IsBoundsEnabledOnLoggerEventQueue());43        }44    }45}46using System;47using System.Collections.Generic;48using System.Linq;49using System.Text;50using System.Threading.Tasks;51using Microsoft.VisualStudio.TestPlatform.Common.Logging;52{53    {54        static void Main(string[] args)55        {56            InternalTestLoggerEvents log = new InternalTestLoggerEvents();57            Console.WriteLine(log.IsBoundsEnabledOnLoggerEventQueue());58        }59    }60}61using System;62using System.Collections.Generic;63using System.Linq;64using System.Text;65using System.Threading.Tasks;66using Microsoft.VisualStudio.TestPlatform.Common.Logging;67{68    {69        static void Main(string

IsBoundsEnabledOnLoggerEventQueue

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common.Logging;2using System;3using System.Collections.Generic;4using System.Linq;5using System.Text;6using System.Threading.Tasks;7{8    {9        static void Main(string[] args)10        {11            InternalTestLoggerEvents loggerEvents = new InternalTestLoggerEvents();12            loggerEvents.IsBoundsEnabledOnLoggerEventQueue = true;13        }14    }15}

IsBoundsEnabledOnLoggerEventQueue

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.VisualStudio.TestPlatform.Common.Logging;7using Microsoft.VisualStudio.TestPlatform.ObjectModel;8using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;9using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;10using Microsoft.VisualStudio.TestPlatform.ObjectModel.Adapter;11using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;12using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine.ClientProtocol;13using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine.TesthostProtocol;14using Microsoft.VisualStudio.TestPlatform.ObjectModel.Host;15using Microsoft.VisualStudio.TestPlatform.ObjectModel.Utilities;16using Microsoft.VisualStudio.TestPlatform.Utilities;17using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers;18using Microsoft.VisualStudio.TestPlatform.Utilities.Helpers.Interfaces;19using Microsoft.VisualStudio.TestPlatform.Common;20using Microsoft.VisualStudio.TestPlatform.Common.Interfaces;21using Microsoft.VisualStudio.TestPlatform.Common.ExtensionFramework;22using Microsoft.VisualStudio.TestPlatform.Common.Logging;23using Microsoft.VisualStudio.TestPlatform.Common.Utilities;24using Microsoft.VisualStudio.TestPlatform.Common.Telemetry;25using Microsoft.VisualStudio.TestPlatform.Common.Telemetry.EventHandlers;26using Microsoft.VisualStudio.TestPlatform.Common.Telemetry.Events;27using Microsoft.VisualStudio.TestPlatform.Common.Telemetry.Interfaces;28using Microsoft.VisualStudio.TestPlatform.Common.DataCollection;29using Microsoft.VisualStudio.TestPlatform.Common.DataCollector;30using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.Interfaces;31using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector;32using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector.Interfaces;33using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector.InProcDataCollectionManager;34using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector.InProcDataCollectionManager.Interfaces;35using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector.InProcDataCollectionSink;36using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector.InProcDataCollectionSink.Interfaces;37using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector.InProcDataCollectionSink.InProcDataCollectionSinkManager;38using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector.InProcDataCollectionSink.InProcDataCollectionSinkManager.Interfaces;39using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector.InProcDataCollectionSink.InProcDataCollectionSinkManager.InProcDataCollectionSinkFactory;40using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector.InProcDataCollectionSink.InProcDataCollectionSinkManager.InProcDataCollectionSinkFactory.Interfaces;41using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.InProcDataCollector.InProcDataCollectionSink.InProcDataCollectionSinkManager.InProcDataCollectionSinkFactory.InProcDataCollectionSinkProxy;

IsBoundsEnabledOnLoggerEventQueue

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common.Logging;2using System;3{4    {5        static void Main(string[] args)6        {7            InternalTestLoggerEvents loggerEvents = new InternalTestLoggerEvents();8            Console.WriteLine(loggerEvents.IsBoundsEnabledOnLoggerEventQueue());9        }10    }11}12using Microsoft.VisualStudio.TestPlatform.Common.Logging;13using System;14{15    {16        static void Main(string[] args)17        {18            InternalTestLoggerEvents loggerEvents = new InternalTestLoggerEvents();19            Console.WriteLine(loggerEvents.IsBoundsEnabledOnLoggerEventQueue());20        }21    }22}23using Microsoft.VisualStudio.TestPlatform.Common.Logging;24using System;25{26    {27        static void Main(string[] args)28        {29            InternalTestLoggerEvents loggerEvents = new InternalTestLoggerEvents();30            Console.WriteLine(loggerEvents.IsBoundsEnabledOnLoggerEventQueue());31        }32    }33}34using Microsoft.VisualStudio.TestPlatform.Common.Logging;35using System;36{37    {38        static void Main(string[] args)39        {40            InternalTestLoggerEvents loggerEvents = new InternalTestLoggerEvents();41            Console.WriteLine(loggerEvents.IsBoundsEnabledOnLoggerEventQueue());42        }43    }44}45using Microsoft.VisualStudio.TestPlatform.Common.Logging;46using System;47{48    {49        static void Main(string[] args)50        {51            InternalTestLoggerEvents loggerEvents = new InternalTestLoggerEvents();52            Console.WriteLine(loggerEvents.IsBoundsEnabledOnLoggerEventQueue());53        }54    }55}56using Microsoft.VisualStudio.TestPlatform.Common.Logging;57using System;58{59    {

IsBoundsEnabledOnLoggerEventQueue

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common.Logging;2using Microsoft.VisualStudio.TestPlatform.ObjectModel;3using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;4using System;5using System.Collections.Generic;6using System.Linq;7using System.Text;8using System.Threading.Tasks;9{10    {11        public void Test()12        {13            InternalTestLoggerEvents loggerEvents = new InternalTestLoggerEvents();14            loggerEvents.IsBoundsEnabledOnLoggerEventQueue = true;15        }16    }17}18using Microsoft.VisualStudio.TestPlatform.Common.Logging;19using Microsoft.VisualStudio.TestPlatform.ObjectModel;20using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;21using System;22using System.Collections.Generic;23using System.Linq;24using System.Text;25using System.Threading.Tasks;26{27    {28        public void Test()29        {30            InternalTestLoggerEvents loggerEvents = new InternalTestLoggerEvents();31            loggerEvents.IsBoundsEnabledOnLoggerEventQueue = false;32        }33    }34}35using Microsoft.VisualStudio.TestPlatform.Common.Logging;36using Microsoft.VisualStudio.TestPlatform.ObjectModel;37using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;38using System;39using System.Collections.Generic;40using System.Linq;41using System.Text;42using System.Threading.Tasks;43{44    {45        public void Test()46        {47            InternalTestLoggerEvents loggerEvents = new InternalTestPlatform.Common.Logging.InternalTestLoggerEvents();48            loggerEvents.IsBoundsEnabledOnLoggerEventQueue = true;49        }50    }51}52using Microsoft.VisualStudio.TestPlatform.Common.Logging;53using Microsoft.VisualStudio.TestPlatform.ObjectModel;54using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;55using System;56using System.Collections.Generic;57using System.Linq;58using System.Text;59using System.Threading.Tasks;60{61    {62        public void Test()63        {64            InternalTestLoggerEvents loggerEvents = new InternalTestPlatform.Common.Logging.InternalTestLoggerEvents();65            loggerEvents.IsBoundsEnabledOnLoggerEventQueue = false;66        }67    }68}

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.