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

Automation Advisor
Vstest
Microsoft.VisualStudio.TestPlatform.Common
RunSettings

How to use RunSettings class of Microsoft.VisualStudio.TestPlatform.Common package

Best Vstest code snippet using Microsoft.VisualStudio.TestPlatform.Common.RunSettings

TestPlatform.cs

Source:TestPlatform.cs

...79            {80                throw new ArgumentNullException(nameof(discoveryCriteria));81            }82            // Update cache with Extension folder's files.83            this.AddExtensionAssemblies(discoveryCriteria.RunSettings);84            // Update extension assemblies from source when design mode is false.85            var runConfiguration = XmlRunSettingsUtilities.GetRunConfigurationNode(discoveryCriteria.RunSettings);86            if (!runConfiguration.DesignMode)87            {88                this.AddExtensionAssembliesFromSource(discoveryCriteria.Sources);89            }90            // Initialize loggers.91            var loggerManager = this.TestEngine.GetLoggerManager(requestData);92            loggerManager.Initialize(discoveryCriteria.RunSettings);93            var testHostManager = this.testHostProviderManager.GetTestHostManagerByRunConfiguration(discoveryCriteria.RunSettings);94            ThrowExceptionIfTestHostManagerIsNull(testHostManager, discoveryCriteria.RunSettings);95            testHostManager.Initialize(TestSessionMessageLogger.Instance, discoveryCriteria.RunSettings);96            var discoveryManager = this.TestEngine.GetDiscoveryManager(requestData, testHostManager, discoveryCriteria);97            discoveryManager.Initialize(options?.SkipDefaultAdapters ?? false);98            return new DiscoveryRequest(requestData, discoveryCriteria, discoveryManager, loggerManager);99        }100        /// <inheritdoc/>101        public ITestRunRequest CreateTestRunRequest(102            IRequestData requestData,103            TestRunCriteria testRunCriteria,104            TestPlatformOptions options)105        {106            if (testRunCriteria == null)107            {108                throw new ArgumentNullException(nameof(testRunCriteria));109            }110            this.AddExtensionAssemblies(testRunCriteria.TestRunSettings);111            var runConfiguration = XmlRunSettingsUtilities.GetRunConfigurationNode(testRunCriteria.TestRunSettings);112            // Update extension assemblies from source when design mode is false.113            if (!runConfiguration.DesignMode)114            {115                this.AddExtensionAssembliesFromSource(testRunCriteria);116            }117            // Initialize loggers.118            var loggerManager = this.TestEngine.GetLoggerManager(requestData);119            loggerManager.Initialize(testRunCriteria.TestRunSettings);120            var testHostManager = this.testHostProviderManager.GetTestHostManagerByRunConfiguration(testRunCriteria.TestRunSettings);121            ThrowExceptionIfTestHostManagerIsNull(testHostManager, testRunCriteria.TestRunSettings);122            testHostManager.Initialize(TestSessionMessageLogger.Instance, testRunCriteria.TestRunSettings);123            // NOTE: The custom launcher should not be set when we have test session info available.124            if (testRunCriteria.TestHostLauncher != null)125            {126                testHostManager.SetCustomLauncher(testRunCriteria.TestHostLauncher);127            }128            var executionManager = this.TestEngine.GetExecutionManager(requestData, testHostManager, testRunCriteria);129            executionManager.Initialize(options?.SkipDefaultAdapters ?? false);130            return new TestRunRequest(requestData, testRunCriteria, executionManager, loggerManager);131        }132        /// <inheritdoc/>133        public void StartTestSession(134            IRequestData requestData,135            StartTestSessionCriteria testSessionCriteria,136            ITestSessionEventsHandler eventsHandler)137        {138            if (testSessionCriteria == null)139            {140                throw new ArgumentNullException(nameof(testSessionCriteria));141            }142            this.AddExtensionAssemblies(testSessionCriteria.RunSettings);143            var runConfiguration = XmlRunSettingsUtilities.GetRunConfigurationNode(testSessionCriteria.RunSettings);144            // Update extension assemblies from source when design mode is false.145            //146            // TODO (copoiena): Is it possible for this code to run if we're not in design mode ?147            // An use case for this would be when running tests with "dotnet test". Usually there's148            // a build involved then.149            if (!runConfiguration.DesignMode)150            {151                return;152            }153            // Initialize loggers.154            var loggerManager = this.TestEngine.GetLoggerManager(requestData);155            loggerManager.Initialize(testSessionCriteria.RunSettings);156            var testHostManager = this.testHostProviderManager.GetTestHostManagerByRunConfiguration(testSessionCriteria.RunSettings);157            ThrowExceptionIfTestHostManagerIsNull(testHostManager, testSessionCriteria.RunSettings);158            testHostManager.Initialize(TestSessionMessageLogger.Instance, testSessionCriteria.RunSettings);159            if (testSessionCriteria.TestHostLauncher != null)160            {161                testHostManager.SetCustomLauncher(testSessionCriteria.TestHostLauncher);162            }163            var testSessionManager = this.TestEngine.GetTestSessionManager(requestData, testHostManager, testSessionCriteria);164            if (testSessionManager == null)165            {166                // The test session manager is null because the combination of runsettings and167                // sources tells us we should run in-process (i.e. in vstest.console). Because168                // of this no session will be created because there's no testhost to be launched.169                // Expecting a subsequent call to execute tests with the same set of parameters.170                eventsHandler.HandleStartTestSessionComplete(null);171                return;172            }173            testSessionManager.Initialize(false);174            testSessionManager.StartSession(testSessionCriteria, eventsHandler);175        }176        /// <summary>177        /// The dispose.178        /// </summary>179        public void Dispose()180        {181            throw new NotImplementedException();182        }183        /// <inheritdoc/>184        public void UpdateExtensions(185            IEnumerable<string> pathToAdditionalExtensions,186            bool skipExtensionFilters)187        {188            this.TestEngine.GetExtensionManager().UseAdditionalExtensions(pathToAdditionalExtensions, skipExtensionFilters);189        }190        /// <inheritdoc/>191        public void ClearExtensions()192        {193            this.TestEngine.GetExtensionManager().ClearExtensions();194        }195        private void ThrowExceptionIfTestHostManagerIsNull(196            ITestRuntimeProvider testHostManager,197            string settingXml)198        {199            if (testHostManager == null)200            {201                EqtTrace.Error("TestPlatform.CreateTestRunRequest: No suitable testHostProvider found for runsettings : {0}", settingXml);202                throw new TestPlatformException(string.Format(CultureInfo.CurrentCulture, ClientResources.NoTestHostProviderFound));203            }204        }205        /// <summary>206        /// Updates the test adapter paths provided through run settings to be used by the test207        /// service.208        /// </summary>209        ///210        /// <param name="runSettings">The run settings.</param>211        private void AddExtensionAssemblies(string runSettings)212        {213            IEnumerable<string> customTestAdaptersPaths = RunSettingsUtilities.GetTestAdaptersPaths(runSettings);214            if (customTestAdaptersPaths != null)215            {216                foreach (string customTestAdaptersPath in customTestAdaptersPaths)217                {218                    var adapterPath = Path.GetFullPath(Environment.ExpandEnvironmentVariables(customTestAdaptersPath));219                    if (!Directory.Exists(adapterPath))220                    {221                        if (EqtTrace.IsWarningEnabled)222                        {223                            EqtTrace.Warning(string.Format("AdapterPath Not Found:", adapterPath));224                        }225                        continue;226                    }227                    var extensionAssemblies = new List<string>(...

ExecutionManager.cs

Source:ExecutionManager.cs

...190        /// </summary>191        private void InitializeDataCollectors(string runSettings, ITestEventsPublisher testEventsPublisher, string defaultCodeBase)192        {193            // Initialize out-proc data collectors if declared in run settings.194            if (DataCollectionTestCaseEventSender.Instance != null && XmlRunSettingsUtilities.IsDataCollectionEnabled(runSettings))195            {196                var outOfProcDataCollectionManager = new ProxyOutOfProcDataCollectionManager(DataCollectionTestCaseEventSender.Instance, testEventsPublisher);197            }198            // Initialize in-proc data collectors if declared in run settings.199            if (XmlRunSettingsUtilities.IsInProcDataCollectionEnabled(runSettings))200            {201                var inProcDataCollectionExtensionManager = new InProcDataCollectionExtensionManager(runSettings, testEventsPublisher, defaultCodeBase, TestPluginCache.Instance);202            }203        }204        private void TestSessionMessageHandler(object sender, TestRunMessageEventArgs e)205        {206            if (this.testMessageEventsHandler != null)207            {208                this.testMessageEventsHandler.HandleLogMessage(e.Level, e.Message);209            }210            else211            {212                if (EqtTrace.IsWarningEnabled)213                {...

RunSettings

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common;2using Microsoft.VisualStudio.TestPlatform.ObjectModel;3using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;4using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;5using System;6using System.Collections.Generic;7using System.Linq;8using System.Text;9using System.Threading.Tasks;10{11    {12        static void Main(string[] args)13        {14            RunSettings runSettings = new RunSettings();15            runSettings.AddRunSettingsNode("<RunSettings><RunConfiguration><TargetFrameworkVersion>Framework45</TargetFrameworkVersion></RunConfiguration></RunSettings>");16            if (runConfiguration != null)17            {18                var targetFrameworkVersion = runConfiguration.SelectSingleNode("TargetFrameworkVersion");19                if (targetFrameworkVersion != null)20                {21                    Console.WriteLine(targetFrameworkVersion.InnerText);22                }23            }24            Console.ReadLine();25        }26    }27}

RunSettings

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common;2using Microsoft.VisualStudio.TestPlatform.ObjectModel;3using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;4using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;5using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;6using System;7using System.Collections.Generic;8using System.Linq;9using System.Text;10using System.Threading.Tasks;11{12    {13        static void Main(string[] args)14        {15            RunSettings settings = new RunSettings();16            var runConfiguration = new RunConfiguration();17            runConfiguration.TargetFrameworkVersion = Framework.DefaultFramework;18            runConfiguration.TargetPlatform = Architecture.X64;19            runConfiguration.TargetPlatformVersion = Environment.OSVersion.Version.ToString();20            runConfiguration.TargetFramework = Framework.DefaultFramework;21            runConfiguration.TargetDevice = "Windows";22            runConfiguration.TargetDeviceArchitecture = Architecture.X64;23            settings.AddRunConfiguration(runConfiguration);24            var logger = new ConsoleLogger();25            var discoveryEvents = new DiscoveryEvents();26            var discoveryRequest = new DiscoveryRequest(settings, logger, discoveryEvents);27            var discoveryManager = TestEngine.GetDiscoveryManager();28            discoveryManager.DiscoverTests(new List<string> { "D:\\TestProject\\TestProject1\\bin\\Debug\\TestProject1.dll" }, discoveryRequest);29            Console.ReadLine();30        }31    }32    {33        public void HandleDiscoveryComplete(DiscoveryCompleteEventArgs discoveryCompleteEventArgs, IEnumerable<TestCase> lastChunk)34        {35            Console.WriteLine("Discovery Complete");36        }37        public void HandleDiscoveredTests(IEnumerable<TestCase> discoveredTestCases)38        {39            Console.WriteLine("Discovered Tests");40        }41        public void HandleRawMessage(string rawMessage)42        {43            Console.WriteLine("Raw Message");44        }45        public void HandleTestRunStatsChange(TestRunChangedEventArgs testRunChangedEventArgs)46        {47            Console.WriteLine("Run Stats Change");48        }49    }50    {51        public void SendMessage(TestMessageLevel testMessageLevel, string message)52        {53            Console.WriteLine(message);54        }55    }56}57runConfiguration.TargetFrameworkVersion = Framework.DefaultFramework;

RunSettings

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common;2using Microsoft.VisualStudio.TestPlatform.Common.Utilities;3using Microsoft.VisualStudio.TestPlatform.ObjectModel;4using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;5using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;6using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;7using System;8using System.Collections.Generic;9using System.Diagnostics;10using System.Linq;11using System.Reflection;12using System.Text;13using System.Threading.Tasks;14{15    {16        static void Main(string[] args)17        {18            var testSettings = new RunSettings();19            testSettings.AddDefaultRunSettings();20            testSettings.UpdateRunSettingsNode(RunSettingsConstants.DataCollectionRunSettingsName, new DataCollectionRunSettings(new List<string>() { "myDataCollector" }).ToXml().OuterXml);21            var testPlatform = TestPlatformFactory.GetTestPlatform();22            var discoveryRequest = testPlatform.CreateDiscoveryRequest(new DiscoveryCriteria(new List<string>() { "test.dll" }, 1, testSettings.SettingsXml));23            var discoveryEvents = new DiscoveryEvents();24            discoveryRequest.DiscoverAsync().GetAwaiter().GetResult();25            discoveryRequest.WaitForCompletion().GetAwaiter().GetResult();26            var testRequest = testPlatform.CreateTestRunRequest(new TestRunCriteria(new List<string>() { "test.dll" }, 1, true, testSettings.SettingsXml));27            var testEvents = new TestEvents();28            testRequest.RunAsync().GetAwaiter().GetResult();29            testRequest.WaitForCompletion().GetAwaiter().GetResult();30        }31    }32}33using Microsoft.VisualStudio.TestPlatform.ObjectModel;34using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;35using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;36using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;37using System;38using System.Collections.Generic;39using System.Diagnostics;40using System.Linq;41using System.Reflection;42using System.Text;43using System.Threading.Tasks;44{45    {46        static void Main(string[] args)47        {48            var testSettings = new RunSettings();49            testSettings.AddDefaultRunSettings();50            testSettings.UpdateRunSettingsNode(RunSettingsConstants.DataCollectionRunSettingsName, new DataCollectionRunSettings(new List<string>() { "myDataCollector" }).ToXml().OuterXml);51            var testPlatform = TestPlatformFactory.GetTestPlatform();52            var discoveryRequest = testPlatform.CreateDiscoveryRequest(new DiscoveryCriteria(new List<string>() { "

RunSettings

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common;2using Microsoft.VisualStudio.TestPlatform.Common.Utilities;3using Microsoft.VisualStudio.TestPlatform.ObjectModel;4using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;5using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;6using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine.ClientProtocol;7using System;8using System.Collections.Generic;9using System.Linq;10using System.Text;11using System.Threading.Tasks;12using System.Xml;13{14    {15        static void Main(string[] args)16        {17            var testPlatform = TestPlatformFactory.GetTestPlatform();18            var testHostManager = testPlatform.GetTestHostManager();19            var testHostLauncher = testHostManager.GetTestHostLauncher();20            var runSettings = new RunSettings();21            runSettings.TestRunParameters.Add("TestAdapterPath", @"C:\Users\username\source\repos\TestProject1\TestProject1\bin\Debug");22            var testRunCriteria = new TestRunCriteria(new List<string> { @"C:\Users\username\source\repos\TestProject1\TestProject1\bin\Debug\TestProject1.dll" }, 1, runSettings);23            var testRunEventsHandler = new TestRunEventsHandler();24            var testRunRequest = testPlatform.CreateTestRunRequest(testRunCriteria, testRunEventsHandler);25            testRunRequest.ExecuteAsync().Wait();26        }27    }28}

RunSettings

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common;2using Microsoft.VisualStudio.TestPlatform.ObjectModel;3using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;4using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;5using System;6using System.Collections.Generic;7using System.Linq;8using System.Text;9using System.Threading.Tasks;10{11    {12        static void Main(string[] args)13        {14            ITestRuntimeProvider testRuntimeProvider = TestRuntimeProviderManager.GetTestRuntimeProvider("vstest.console");15            ITestRuntimeProvider2 testRuntimeProvider2 = testRuntimeProvider as ITestRuntimeProvider2;16            RunConfiguration runConfig = new RunConfiguration();17            runConfig.TargetFrameworkVersion = Framework.DefaultFramework;18            runConfig.TargetPlatform = Architecture.X86;19            runConfig.TargetPlatformVersion = new Version(4, 5);20            RunSettings runSettings = new RunSettings();21            runSettings.RunConfiguration = runConfig;22            TestRunCriteria testRunCriteria = new TestRunCriteria(new List<string> { "1.dll" }, 1, true, runSettings);23            var testRunRequest = testRuntimeProvider2.GetTestRunner(1);24            testRunRequest.InitializeExtensions(new List<string>());25            testRunRequest.ExecuteAsync(testRunCriteria, new TestPlatformEventHandler());26        }27    }28    {29        public void HandleTestRunComplete(TestRunCompleteEventArgs testRunCompleteArgs, 30        {31            throw new NotImplementedException();32        }33        public void HandleTestRunStatsChange(TestRunChangedEventArgs testRunChangedArgs)34        {35            throw new NotImplementedException();36        }37    }38}

RunSettings

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.IO;4using System.Linq;5using System.Text;6using System.Threading.Tasks;7using Microsoft.VisualStudio.TestPlatform.ObjectModel;8using Microsoft.VisualStudio.TestPlatform.ObjectModel.Adapter;9using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;10using Microsoft.VisualStudio.TestPlatform.Common;11using Microsoft.VisualStudio.TestPlatform.Common.Utilities;12using Microsoft.VisualStudio.TestPlatform.Common.Logging;13using Microsoft.VisualStudio.TestPlatform.Common.SettingsProvider;14using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;15using Microsoft.VisualStudio.TestPlatform.ObjectModel.Utilities;16using Microsoft.VisualStudio.TestPlatform.ObjectModel.Host;17using System.Xml;18using System.Xml.Serialization;19using System.Reflection;20{21    {22        static void Main(string[] args)23        {24            var runSettings = new RunSettings();25            runSettings.LoadSettingsXml(@"C:\Users\username\Documents\Visual Studio 2017\Projects\TestProject\TestProject\runsettings.runsettings");26            var runSettingsManager = new RunSettingsManager();27            runSettingsManager.LoadSettings(runSettings.SettingsXml);28            var runConfiguration = runSettingsManager.ActiveRunSettings.GetRunConfiguration();29            var targetRuntime = runConfiguration.TargetFramework;30            Console.WriteLine("Target runtime is: " + targetRuntime);31        }32    }33}

RunSettings

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common;2using Microsoft.VisualStudio.TestPlatform.ObjectModel;3RunSettings runSettings = new RunSettings();4runSettings.LoadSettingsXml(settingsXml);5TestRunParameters testRunParameters = runSettings.TestRunParameters;6string parameterValue = testRunParameters.GetParameter("parameterName");7using Microsoft.VisualStudio.TestPlatform.ObjectModel;8TestRunParameters testRunParameters = new TestRunParameters();9testRunParameters.LoadSettings(settingsXml);10string parameterValue = testRunParameters.GetParameter("parameterName");11using Microsoft.VisualStudio.TestPlatform.ObjectModel;12RunSettings runSettings = new RunSettings();13runSettings.LoadSettingsXml(settingsXml);14string parameterValue = runSettings.GetPropertyValue("parameterName");15using Microsoft.VisualStudio.TestPlatform.ObjectModel;16RunSettings runSettings = new RunSettings();17runSettings.LoadSettingsXml(settingsXml);18string parameterValue = runSettings["parameterName"];19using Microsoft.VisualStudio.TestPlatform.ObjectModel;20RunSettings runSettings = new RunSettings();21runSettings.LoadSettingsXml(settingsXml);22string parameterValue = runSettings.GetPropertyValue("parameterName");23using Microsoft.VisualStudio.TestPlatform.ObjectModel;24RunSettings runSettings = new RunSettings();25runSettings.LoadSettingsXml(settingsXml);26string parameterValue = runSettings["parameterName"];27using Microsoft.VisualStudio.TestPlatform.ObjectModel;

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.