How to use GetEnvironmentVariables method of Microsoft.VisualStudio.TestPlatform.Common.DataCollector.DataCollectionManager class

Best Vstest code snippet using Microsoft.VisualStudio.TestPlatform.Common.DataCollector.DataCollectionManager.GetEnvironmentVariables

DataCollectionManager.cs

Source:DataCollectionManager.cs

...159                this.LoadAndInitialize(dataCollectorSettings, settingsXml);160            }161            // Once all data collectors have been initialized, query for environment variables162            bool unloadedAnyCollector;163            var dataCollectorEnvironmentVariables = this.GetEnvironmentVariables(out unloadedAnyCollector);164            foreach (var variable in dataCollectorEnvironmentVariables.Values)165            {166                executionEnvironmentVariables.Add(variable.Name, variable.Value);167            }168            return executionEnvironmentVariables;169        }170        /// <inheritdoc/>171        public void Dispose()172        {173            this.Dispose(true);174            // Use SupressFinalize in case a subclass175            // of this type implements a finalizer.176            GC.SuppressFinalize(this);177        }178        /// <inheritdoc/>179        public Collection<AttachmentSet> SessionEnded(bool isCancelled = false)180        {181            // Return null if datacollection is not enabled.182            if (!this.isDataCollectionEnabled)183            {184                return new Collection<AttachmentSet>();185            }186            if (isCancelled)187            {188                this.attachmentManager.Cancel();189                return new Collection<AttachmentSet>();190            }191            var endEvent = new SessionEndEventArgs(this.dataCollectionEnvironmentContext.SessionDataCollectionContext);192            this.SendEvent(endEvent);193            var result = new List<AttachmentSet>();194            try195            {196                result = this.attachmentManager.GetAttachments(endEvent.Context);197            }198            catch (Exception ex)199            {200                if (EqtTrace.IsErrorEnabled)201                {202                    EqtTrace.Error("DataCollectionManager.SessionEnded: Failed to get attachments : {0}", ex);203                }204                return new Collection<AttachmentSet>(result);205            }206            if (EqtTrace.IsVerboseEnabled)207            {208                this.LogAttachments(result);209            }210            return new Collection<AttachmentSet>(result);211        }212        /// <inheritdoc/>213        public void TestHostLaunched(int processId)214        {215            if (!this.isDataCollectionEnabled)216            {217                return;218            }219            var testHostLaunchedEventArgs = new TestHostLaunchedEventArgs(this.dataCollectionEnvironmentContext.SessionDataCollectionContext, processId);220            this.SendEvent(testHostLaunchedEventArgs);221        }222        /// <inheritdoc/>223        public bool SessionStarted(SessionStartEventArgs sessionStartEventArgs)224        {225            // If datacollectors are not configured or datacollection is not enabled, return false.226            if (!this.isDataCollectionEnabled || this.RunDataCollectors.Count == 0)227            {228                return false;229            }230            sessionStartEventArgs.Context = new DataCollectionContext(this.dataCollectionEnvironmentContext.SessionDataCollectionContext.SessionId);231            this.SendEvent(sessionStartEventArgs);232            return this.events.AreTestCaseEventsSubscribed();233        }234        /// <inheritdoc/>235        public void TestCaseStarted(TestCaseStartEventArgs testCaseStartEventArgs)236        {237            if (!this.isDataCollectionEnabled)238            {239                return;240            }241            var context = new DataCollectionContext(this.dataCollectionEnvironmentContext.SessionDataCollectionContext.SessionId, testCaseStartEventArgs.TestElement);242            testCaseStartEventArgs.Context = context;243            this.SendEvent(testCaseStartEventArgs);244        }245        /// <inheritdoc/>246        public Collection<AttachmentSet> TestCaseEnded(TestCaseEndEventArgs testCaseEndEventArgs)247        {248            if (!this.isDataCollectionEnabled)249            {250                return new Collection<AttachmentSet>();251            }252            var context = new DataCollectionContext(this.dataCollectionEnvironmentContext.SessionDataCollectionContext.SessionId, testCaseEndEventArgs.TestElement);253            testCaseEndEventArgs.Context = context;254            this.SendEvent(testCaseEndEventArgs);255            List<AttachmentSet> result = null;256            try257            {258                result = this.attachmentManager.GetAttachments(testCaseEndEventArgs.Context);259            }260            catch (Exception ex)261            {262                if (EqtTrace.IsErrorEnabled)263                {264                    EqtTrace.Error("DataCollectionManager.TestCaseEnded: Failed to get attachments : {0}", ex);265                }266                return new Collection<AttachmentSet>(result);267            }268            if (EqtTrace.IsVerboseEnabled)269            {270                this.LogAttachments(result);271            }272            return new Collection<AttachmentSet>(result);273        }274        /// <summary>275        /// The dispose.276        /// </summary>277        /// <param name="disposing">278        /// The disposing.279        /// </param>280        protected virtual void Dispose(bool disposing)281        {282            if (!this.disposed)283            {284                if (disposing)285                {286                    CleanupPlugins();287                }288                this.disposed = true;289            }290        }291        private void CleanupPlugins()292        {293            EqtTrace.Info("DataCollectionManager.CleanupPlugins: CleanupPlugins called");294            if (!this.isDataCollectionEnabled)295            {296                return;297            }298            if (EqtTrace.IsVerboseEnabled)299            {300                EqtTrace.Verbose("DataCollectionManager.CleanupPlugins: Cleaning up {0} plugins", this.RunDataCollectors.Count);301            }302            RemoveDataCollectors(new List<DataCollectorInformation>(this.RunDataCollectors.Values));303            EqtTrace.Info("DataCollectionManager.CleanupPlugins: CleanupPlugins finished");304        }305        #region Load and Initialize DataCollectors306        /// <summary>307        /// Tries to get uri of the data collector corresponding to the friendly name. If no such data collector exists return null.308        /// </summary>309        /// <param name="friendlyName">The friendly Name.</param>310        /// <param name="dataCollectorUri">The data collector Uri.</param>311        /// <returns><see cref="bool"/></returns>312        protected virtual bool TryGetUriFromFriendlyName(string friendlyName, out string dataCollectorUri)313        {314            var extensionManager = this.dataCollectorExtensionManager;315            foreach (var extension in extensionManager.TestExtensions)316            {317                if (string.Compare(friendlyName, extension.Metadata.FriendlyName, StringComparison.OrdinalIgnoreCase) == 0)318                {319                    dataCollectorUri = extension.Metadata.ExtensionUri;320                    return true;321                }322            }323            dataCollectorUri = null;324            return false;325        }326        /// <summary>327        /// Gets the extension using uri.328        /// </summary>329        /// <param name="extensionUri">330        /// The extension uri.331        /// </param>332        /// <returns>333        /// The <see cref="DataCollector"/>.334        /// </returns>335        protected virtual DataCollector TryGetTestExtension(string extensionUri)336        {337            return this.DataCollectorExtensionManager.TryGetTestExtension(extensionUri).Value;338        }339        /// <summary>340        /// Loads and initializes data collector using data collector settings.341        /// </summary>342        /// <param name="dataCollectorSettings">343        /// The data collector settings.344        /// </param>345        /// <param name="settingsXml"> runsettings Xml</param>346        private void LoadAndInitialize(DataCollectorSettings dataCollectorSettings, string settingsXml)347        {348            DataCollectorInformation dataCollectorInfo;349            DataCollectorConfig dataCollectorConfig;350            try351            {352                // Look up the extension and initialize it if one is found.353                var extensionManager = this.DataCollectorExtensionManager;354                var dataCollectorUri = string.Empty;355                this.TryGetUriFromFriendlyName(dataCollectorSettings.FriendlyName, out dataCollectorUri);356                DataCollector dataCollector = null;357                if (!string.IsNullOrWhiteSpace(dataCollectorUri))358                {359                    dataCollector = this.TryGetTestExtension(dataCollectorUri);360                }361                if (dataCollector == null)362                {363                    this.LogWarning(string.Format(CultureInfo.CurrentUICulture, Resources.Resources.DataCollectorNotFound, dataCollectorSettings.FriendlyName));364                    return;365                }366                if (this.RunDataCollectors.ContainsKey(dataCollector.GetType()))367                {368                    // Collector is already loaded (may be configured twice). Ignore duplicates and return.369                    return;370                }371                dataCollectorConfig = new DataCollectorConfig(dataCollector.GetType());372                // Attempt to get the data collector information verifying that all of the required metadata for the collector is available.373                dataCollectorInfo = new DataCollectorInformation(374                                                    dataCollector,375                                                    dataCollectorSettings.Configuration,376                                                    dataCollectorConfig,377                                                    this.dataCollectionEnvironmentContext,378                                                    this.attachmentManager,379                                                    this.events,380                                                    this.messageSink,381                                                    settingsXml);382            }383            catch (Exception ex)384            {385                if (EqtTrace.IsErrorEnabled)386                {387                    EqtTrace.Error("DataCollectionManager.LoadAndInitialize: exception while creating data collector {0} : {1}", dataCollectorSettings.FriendlyName, ex);388                }389                // No data collector info, so send the error with no direct association to the collector.390                this.LogWarning(string.Format(CultureInfo.CurrentUICulture, Resources.Resources.DataCollectorInitializationError, dataCollectorSettings.FriendlyName, ex));391                return;392            }393            try394            {395                dataCollectorInfo.InitializeDataCollector();396                lock (this.RunDataCollectors)397                {398                    // Add data collectors to run cache.399                    this.RunDataCollectors[dataCollectorConfig.DataCollectorType] = dataCollectorInfo;400                }401            }402            catch (Exception ex)403            {404                if (EqtTrace.IsErrorEnabled)405                {406                    EqtTrace.Error("DataCollectionManager.LoadAndInitialize: exception while initializing data collector {0} : {1}", dataCollectorSettings.FriendlyName, ex);407                }408                // Log error.409                dataCollectorInfo.Logger.LogError(this.dataCollectionEnvironmentContext.SessionDataCollectionContext, string.Format(CultureInfo.CurrentCulture, Resources.Resources.DataCollectorInitializationError, dataCollectorConfig.FriendlyName, ex));410                // Dispose datacollector.411                dataCollectorInfo.DisposeDataCollector();412            }413        }414        /// <summary>415        /// Finds data collector enabled for the run in data collection settings.416        /// </summary>417        /// <param name="dataCollectionSettings">data collection settings</param>418        /// <returns>List of enabled data collectors</returns>419        private List<DataCollectorSettings> GetDataCollectorsEnabledForRun(DataCollectionRunSettings dataCollectionSettings)420        {421            var runEnabledDataCollectors = new List<DataCollectorSettings>();422            foreach (var settings in dataCollectionSettings.DataCollectorSettingsList)423            {424                if (settings.IsEnabled)425                {426                    if (runEnabledDataCollectors.Any(dcSettings => string.Equals(dcSettings.FriendlyName, settings.FriendlyName, StringComparison.OrdinalIgnoreCase)))427                    {428                        // If Uri or assembly qualified type name is repeated, consider data collector as duplicate and ignore it.429                        this.LogWarning(string.Format(CultureInfo.CurrentUICulture, Resources.Resources.IgnoredDuplicateConfiguration, settings.FriendlyName));430                        continue;431                    }432                    runEnabledDataCollectors.Add(settings);433                }434            }435            return runEnabledDataCollectors;436        }437        #endregion438        /// <summary>439        /// Sends a warning message against the session which is not associated with a data collector.440        /// </summary>441        /// <remarks>442        /// This should only be used when we do not have the data collector info yet.  After we have the data443        /// collector info we can use the data collectors logger for errors.444        /// </remarks>445        /// <param name="warningMessage">The message to be logged.</param>446        private void LogWarning(string warningMessage)447        {448            this.messageSink.SendMessage(new DataCollectionMessageEventArgs(TestMessageLevel.Warning, warningMessage));449        }450        /// <summary>451        /// Sends the event to all data collectors and fires a callback on the sender, letting it452        /// know when all plugins have completed processing the event453        /// </summary>454        /// <param name="args">The context information for the event</param>455        private void SendEvent(DataCollectionEventArgs args)456        {457            ValidateArg.NotNull(args, nameof(args));458            if (!this.isDataCollectionEnabled)459            {460                if (EqtTrace.IsErrorEnabled)461                {462                    EqtTrace.Error("DataCollectionManger:SendEvent: SendEvent called when no collection is enabled.");463                }464                return;465            }466            // do not send events multiple times467            this.events.RaiseEvent(args);468        }469        /// <summary>470        /// The get environment variables.471        /// </summary>472        /// <param name="unloadedAnyCollector">473        /// The unloaded any collector.474        /// </param>475        /// <returns>476        /// Dictionary of variable name as key and collector requested environment variable as value.477        /// </returns>478        private Dictionary<string, DataCollectionEnvironmentVariable> GetEnvironmentVariables(out bool unloadedAnyCollector)479        {480            var failedCollectors = new List<DataCollectorInformation>();481            unloadedAnyCollector = false;482            var dataCollectorEnvironmentVariable = new Dictionary<string, DataCollectionEnvironmentVariable>(StringComparer.OrdinalIgnoreCase);483            foreach (var dataCollectorInfo in this.RunDataCollectors.Values)484            {485                try486                {487                    dataCollectorInfo.SetTestExecutionEnvironmentVariables();488                    this.AddCollectorEnvironmentVariables(dataCollectorInfo, dataCollectorEnvironmentVariable);489                }490                catch (Exception ex)491                {492                    unloadedAnyCollector = true;493                    var friendlyName = dataCollectorInfo.DataCollectorConfig.FriendlyName;494                    failedCollectors.Add(dataCollectorInfo);495                    dataCollectorInfo.Logger.LogError(496                        this.dataCollectionEnvironmentContext.SessionDataCollectionContext,497                        string.Format(CultureInfo.CurrentCulture, Resources.Resources.DataCollectorErrorOnGetVariable, friendlyName, ex));498                    if (EqtTrace.IsErrorEnabled)499                    {500                        EqtTrace.Error("DataCollectionManager.GetEnvironmentVariables: Failed to get variable for Collector '{0}': {1}", friendlyName, ex);501                    }502                }503            }504            this.RemoveDataCollectors(failedCollectors);505            return dataCollectorEnvironmentVariable;506        }507        /// <summary>508        /// Collects environment variable to be set in test process by avoiding duplicates509        /// and detecting override of variable value by multiple adapters.510        /// </summary>511        /// <param name="dataCollectionWrapper">512        /// The data Collection Wrapper.513        /// </param>514        /// <param name="dataCollectorEnvironmentVariables">...

GetEnvironmentVariables

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common.DataCollector;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            DataCollectionManager obj = new DataCollectionManager();12            var result = obj.GetEnvironmentVariables();13            Console.WriteLine(result);14        }15    }16}17using Microsoft.VisualStudio.TestPlatform.Common.DataCollector;18using System;19using System.Collections.Generic;20using System.Linq;21using System.Text;22using System.Threading.Tasks;23{24    {25        static void Main(string[] args)26        {27            DataCollectionManager obj = new DataCollectionManager();28            var result = obj.GetEnvironmentVariables();29            Console.WriteLine(result);30        }31    }32}33using Microsoft.VisualStudio.TestPlatform.Common.DataCollector;34using System;35using System.Collections.Generic;36using System.Linq;37using System.Text;38using System.Threading.Tasks;39{40    {41        static void Main(string[] args)42        {43            DataCollectionManager obj = new DataCollectionManager();44            var result = obj.GetEnvironmentVariables();45            Console.WriteLine(result);46        }47    }48}49using Microsoft.VisualStudio.TestPlatform.Common.DataCollector;50using System;51using System.Collections.Generic;52using System.Linq;53using System.Text;54using System.Threading.Tasks;55{56    {57        static void Main(string[] args)58        {59            DataCollectionManager obj = new DataCollectionManager();60            var result = obj.GetEnvironmentVariables();61            Console.WriteLine(result);62        }63    }64}

GetEnvironmentVariables

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.DataCollector;7using Microsoft.VisualStudio.TestPlatform.ObjectModel.DataCollection;8{9    {10        static void Main(string[] args)11        {12            DataCollectionManager dataCollectionManager = new DataCollectionManager();13            IDictionary<string, string> environmentVariables = dataCollectionManager.GetEnvironmentVariables();14        }15    }16}17Assembly: Microsoft.VisualStudio.TestPlatform.Common (in Microsoft.VisualStudio.TestPlatform.Common.dll)

GetEnvironmentVariables

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common.DataCollector;2using System;3using System.Collections;4using System.Collections.Generic;5using System.Linq;6using System.Text;7using System.Threading.Tasks;8{9    {10        static void Main(string[] args)11        {12            DataCollectionManager dataCollectionManager = new DataCollectionManager();13            IDictionary environmentVariables = dataCollectionManager.GetEnvironmentVariables();14            foreach(DictionaryEntry entry in environmentVariables)15            {16                Console.WriteLine("{0} = {1}", entry.Key, entry.Value);17            }18        }19    }20}

GetEnvironmentVariables

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.Common.DataCollector;2using System;3using System.Collections;4using System.Collections.Generic;5using System.Linq;6using System.Text;7using System.Threading.Tasks;8{9    {10        static void Main(string[] args)11        {12            DataCollectionManager dataCollectionManager = new DataCollectionManager();13            IDictionary environmentVariables = dataCollectionManager.GetEnvironmentVariables();14            Console.WriteLine("Total environment variables are " + environmentVariables.Count);15            Console.ReadLine();16        }17    }18}19public IDictionary GetEnvironmentVariables()20using Microsoft.VisualStudio.TestPlatform.Common.DataCollector;21using System;22using System.Collections;23using System.Collections.Generic;24using System.Linq;25using System.Text;26using System.Threading.Tasks;27{28    {29        static void Main(string[] args)30        {31            DataCollectionManager dataCollectionManager = new DataCollectionManager();32            IDictionary environmentVariables = dataCollectionManager.GetEnvironmentVariables();33            foreach (DictionaryEntry environmentVariable in environmentVariables)34            {35                Console.WriteLine("Key is " + environmentVariable.Key + " and value is " + environmentVariable.Value);36            }37            Console.ReadLine();38        }39    }40}41Key is Path and value is C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\Extensions\TestPlatform42public void SetEnvironmentVariables(IDictionary environmentVariables)43using Microsoft.VisualStudio.TestPlatform.Common.DataCollector;44using System;45using System.Collections;46using System.Collections.Generic;47using System.Linq;48using System.Text;49using System.Threading.Tasks;50{51    {52        static void Main(string[] args)53        {54            DataCollectionManager dataCollectionManager = new DataCollectionManager();

GetEnvironmentVariables

Using AI Code Generation

1using System;2using System.Collections;3using System.Collections.Generic;4using System.Linq;5using System.Text;6using System.Threading.Tasks;7using Microsoft.VisualStudio.TestPlatform.Common.DataCollector;8{9    {10        static void Main(string[] args)11        {12            IDictionary env = DataCollectionManager.GetEnvironmentVariables();13            foreach (DictionaryEntry de in env)14            {15                Console.WriteLine("{0} = {1}", de.Key, de.Value);16            }17            Console.ReadKey();18        }19    }20}

GetEnvironmentVariables

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.DataCollector;7using System.Collections;8{9    {10        static void Main(string[] args)11        {12            DataCollectionManager dataCollectionManager = new DataCollectionManager();13            IDictionary environmentVariables = dataCollectionManager.GetEnvironmentVariables();14            foreach (var key in environmentVariables.Keys)15            {16                Console.WriteLine(key + " : " + environmentVariables[key]);17            }18        }19    }20}21CommonProgramFiles : C:\Program Files (x86)\Common Files22CommonProgramFiles(x86) : C:\Program Files (x86)\Common Files23ProgramFiles : C:\Program Files (x86)24ProgramFiles(x86) : C:\Program Files (x86)25Path : C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\Common7\IDE\Extensions\TestPlatform\Microsoft.VisualStudio.TestPlatform.Extensions.HtmlLogger\Microsoft.VisualStudio.TestPlatform.Extensions.HtmlLogger.dll;C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\Common7\IDE\Extensions\TestPlatform\Microsoft.VisualStudio.TestPlatform.Extensions.TrxLogger\Microsoft.VisualStudio.TestPlatform.Extensions.TrxLogger.dll;C:\Program Files (x

GetEnvironmentVariables

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.DataCollector;7{8    {9        static void Main(string[] args)10        {11            DataCollectionManager dcm = new DataCollectionManager();12            EnvironmentVariableTarget ev = EnvironmentVariableTarget.Process;13            var env = dcm.GetEnvironmentVariables(ev);14            foreach (var item in env)15            {16                Console.WriteLine(item.Key + " " + item.Value);17            }18            Console.ReadLine();19        }20    }21}22VS140COMNTOOLS C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\Tools\23VSINSTALLDIR C:\Program Files (x86)\Microsoft Visual Studio 14.0\24VSSDK150INSTALL C:\Program Files (x86)\Microsoft Visual Studio 14.0\VSSDK25VSToolsPath C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\CommonExtensions\Microsoft\TestWindow\26VSToolsPath2 C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\CommonExtensions\Microsoft\TestWindow\27VSWHERE C:\Program Files (x86)\Microsoft Visual Studio\Installer\vswhere.exe

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.