Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use ArgumentEscaper class of Microsoft.TestPlatform.Build.Utils package

Best Vstest code snippet using Microsoft.TestPlatform.Build.Utils.ArgumentEscaper

VSTestTask.cs

Source:VSTestTask.cs

...130            {131                allArgs.Add("--");132                foreach (var arg in this.VSTestCLIRunSettings)133                {134                    allArgs.Add(ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(arg));135                }136            }137        }138        private List<string> AddArgs()139        {140            var isConsoleLoggerEnabled = true;141            var isCollectCodeCoverageEnabled = false;142            var isRunSettingsEnabled = false;143            var allArgs = new List<string>();144            // TODO log arguments in task145            if (!string.IsNullOrEmpty(this.VSTestSetting))146            {147                isRunSettingsEnabled = true;148                allArgs.Add("--settings:" + ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(this.VSTestSetting));149            }150            if (this.VSTestTestAdapterPath != null && this.VSTestTestAdapterPath.Length > 0)151            {152                foreach (var arg in this.VSTestTestAdapterPath)153                {154                    allArgs.Add("--testAdapterPath:" + ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(arg));155                }156            }157            if (!string.IsNullOrEmpty(this.VSTestFramework))158            {159                allArgs.Add("--framework:" + ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(this.VSTestFramework));160            }161            // vstest.console only support x86 and x64 for argument platform162            if (!string.IsNullOrEmpty(this.VSTestPlatform) && !this.VSTestPlatform.Contains("AnyCPU"))163            {164                allArgs.Add("--platform:" + ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(this.VSTestPlatform));165            }166            if (!string.IsNullOrEmpty(this.VSTestTestCaseFilter))167            {168                allArgs.Add("--testCaseFilter:" +169                            ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(this.VSTestTestCaseFilter));170            }171            if (this.VSTestLogger != null && this.VSTestLogger.Length > 0)172            {173                foreach (var arg in this.VSTestLogger)174                {175                    allArgs.Add("--logger:" + ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(arg));176                    if (arg.StartsWith("console", StringComparison.OrdinalIgnoreCase))177                    {178                        isConsoleLoggerEnabled = false;179                    }180                }181            }182            if (!string.IsNullOrEmpty(this.VSTestResultsDirectory))183            {184                allArgs.Add("--resultsDirectory:" +185                            ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(this.VSTestResultsDirectory));186            }187            if (!string.IsNullOrEmpty(this.VSTestListTests))188            {189                allArgs.Add("--listTests");190            }191            if (!string.IsNullOrEmpty(this.VSTestDiag))192            {193                allArgs.Add("--Diag:" + ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(this.VSTestDiag));194            }195            if (string.IsNullOrEmpty(this.TestFileFullPath))196            {197                this.Log.LogError("Test file path cannot be empty or null.");198            }199            else200            {201                allArgs.Add(ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(this.TestFileFullPath));202            }203            // Console logger was not specified by user, but verbosity was, hence add default console logger with verbosity as specified204            if (!string.IsNullOrWhiteSpace(this.VSTestVerbosity) && isConsoleLoggerEnabled)205            {206                var normalTestLogging = new List<string>() {"n", "normal", "d", "detailed", "diag", "diagnostic"};207                var quietTestLogging = new List<string>() {"q", "quiet"};208                string vsTestVerbosity = "minimal";209                if (normalTestLogging.Contains(this.VSTestVerbosity))210                {211                    vsTestVerbosity = "normal";212                }213                else if (quietTestLogging.Contains(this.VSTestVerbosity))214                {215                    vsTestVerbosity = "quiet";216                }217                allArgs.Add("--logger:Console;Verbosity=" + vsTestVerbosity);218            }219            if (!string.IsNullOrEmpty(this.VSTestBlame))220            {221                allArgs.Add("--Blame");222            }223            if (this.VSTestCollect != null && this.VSTestCollect.Length > 0)224            {225                foreach (var arg in this.VSTestCollect)226                {227                    if (arg.Equals("Code Coverage", StringComparison.OrdinalIgnoreCase))228                    {229                        isCollectCodeCoverageEnabled = true;230                    }231                    allArgs.Add("--collect:" + ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(arg));232                }233            }234            if (isCollectCodeCoverageEnabled || isRunSettingsEnabled)235            {236                // Pass TraceDataCollector path to vstest.console as TestAdapterPath if --collect "Code Coverage"237                // or --settings (User can enable code coverage from runsettings) option given.238                // Not parsing the runsettings for two reason:239                //    1. To keep no knowledge of runsettings structure in VSTestTask.240                //    2. Impact of adding adapter path always is minimal. (worst case: loads additional data collector assembly in datacollector process.)241                // This is required due to currently trace datacollector not ships with dotnet sdk, can be remove once we have242                // go code coverage x-plat.243                if (!string.IsNullOrEmpty(this.VSTestTraceDataCollectorDirectoryPath))244                {245                    allArgs.Add("--testAdapterPath:" +246                                ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(this247                                    .VSTestTraceDataCollectorDirectoryPath));248                }249                else250                {251                    if (isCollectCodeCoverageEnabled)252                    {253                        // Not showing message in runsettings scenario, because we are not sure that code coverage is enabled.254                        // User might be using older Microsoft.NET.Test.Sdk which don't have CodeCoverage infra.255                        Console.WriteLine(Resources.UpdateTestSdkForCollectingCodeCoverage);256                    }257                }258            }259            if(!string.IsNullOrWhiteSpace(this.VSTestNoLogo))260            {...

ArgumentEscaperTests.cs

Source:ArgumentEscaperTests.cs

...3{4    using Microsoft.TestPlatform.Build.Utils;5    using Microsoft.VisualStudio.TestTools.UnitTesting;6    [TestClass]7    public class ArgumentEscaperTests8    {9        [TestMethod]10        public void EscapeArgForProcessStartShouldAddDoubleQuoteIfThereIsSpace()11        {12            string stringWithSpace = "Some string";13            string expected = "\"Some string\"";14            string result = ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(stringWithSpace);15            Assert.AreEqual(expected, result);16        }17        [TestMethod]18        public void EscapeArgForProcessStartShouldAddDoubleQuoteIfThereIsSpaceAtEnd()19        {20            string stringWithSpaceAtEnd = "Some string  ";21            string expected = "\"Some string  \"";22            string result = ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(stringWithSpaceAtEnd);23            Assert.AreEqual(expected, result);24        }25        [TestMethod]26        public void EscapeArgForProcessStartShouldHandleForwardSlash()27        {28            string stringWithForwardSlash = "Some/string";29            string expected = "Some/string";30            string result = ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(stringWithForwardSlash);31            Assert.AreEqual(expected, result);32        }33        [TestMethod]34        public void EscapeArgForProcessStartShouldPreserveDoubleQuote()35        {36            string stringWithDoubleQuote = "Some\"string";37            string expected = "Some\\\"string";38            string result = ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(stringWithDoubleQuote);39            Assert.AreEqual(expected, result);40        }41        [TestMethod]42        public void EscapeArgForProcessStartShouldPreserveSingleQuote()43        {44            string stringWithSingleQuote = "Some'string";45            string expected = "Some'string";46            string result = ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(stringWithSingleQuote);47            Assert.AreEqual(expected, result);48        }49        [TestMethod]50        public void EscapeArgForProcessStartShouldPreserveBackSlash()51        {52            string stringWithBackSlash = @"Some\\string";53            string expected = "Some\\\\string";54            string result = ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(stringWithBackSlash);55            Assert.AreEqual(expected, result);56        }57        [TestMethod]58        public void EscapeArgForProcessStartShouldPreserveBackSlashIfStringHasWhiteSpace()59        {60            string stringWithBackSlash = @"Some string With Space\\";61            string expected = @"""Some string With Space\\\\""";62            string result = ArgumentEscaper.HandleEscapeSequenceInArgForProcessStart(stringWithBackSlash);63            Assert.AreEqual(expected, result);64        }65        [TestMethod]66        public void ShouldSurroundWithQuotesShouldReturnFalseIfAlreadySurroundWithQuotes()67        {68            string stringSurroundWithQuotes = "\"" + "some string" + "\"";69            Assert.IsFalse(ArgumentEscaper.ShouldSurroundWithQuotes(stringSurroundWithQuotes));70        }71        [TestMethod]72        public void ShouldSurroundWithQuotesShouldReturnFalseIfItIsNotSurroundWithQuotesAndHasNoWhiteSpace()73        {74            string stringWithoutSpace = "someStringWithNoWhiteSpace";75            Assert.IsFalse(ArgumentEscaper.ShouldSurroundWithQuotes(stringWithoutSpace));76        }77        [TestMethod]78        public void ShouldSurroundWithQuotesShouldReturnTrueIfItIsNotSurroundWithQuotesAndHasWhiteSpace()79        {80            string stringWithSpace = "some String With WhiteSpace";81            Assert.IsTrue(ArgumentEscaper.ShouldSurroundWithQuotes(stringWithSpace));82        }83        [TestMethod]84        public void IsSurroundedWithQuotesShouldReturnTrueIfStringIsSurrondedByQuotes()85        {86            string stringSurroundWithQuotes = "\"" + "some string" + "\"";87            Assert.IsTrue(ArgumentEscaper.IsSurroundedWithQuotes(stringSurroundWithQuotes));88        }89        [TestMethod]90        public void IsSurroundedWithQuotesShouldReturnFalseIfStringIsNotSurrondedByQuotes()91        {92            string stringNotSurroundWithQuotes = "some string";93            Assert.IsFalse(ArgumentEscaper.IsSurroundedWithQuotes(stringNotSurroundWithQuotes));94        }95    }96}...

ArgumentEscaper

Using AI Code Generation

1using Microsoft.TestPlatform.Build.Utils;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            string[] arguments = new string[] { @"C:\Program Files\Microsoft Visual Studio\2019\Enterprise\Common7\IDE\devenv.exe", "/log", @"C:\Users\user1\source\repos\ConsoleApp1\ConsoleApp1\ConsoleApp1.sln" };12            string escapedArguments = ArgumentEscaper.EscapeAndConcatenateArgArrayForProcessStart(arguments);13            Console.WriteLine(escapedArguments);14            Console.ReadLine();15        }16    }17}18using Microsoft.TestPlatform.Build.Utils;19using System;20using System.Collections.Generic;21using System.Linq;22using System.Text;23using System.Threading.Tasks;24{25    {26        static void Main(string[] args)27        {28            string[] arguments = new string[] { @"C:\Program Files\Microsoft Visual Studio\2019\Enterprise\Common7\IDE\devenv.exe", "/log", @"C:\Users\user1\source\repos\ConsoleApp1\ConsoleApp1\ConsoleApp1.sln" };29            string[] escapedArguments = arguments.Select(ArgumentEscaper.EscapeSingleArg).ToArray();30            Console.WriteLine(string.Join(" ", escapedArguments));31            Console.ReadLine();32        }33    }34}35Note: If you want to escape the arguments, then you need to use double quotes(") around the argument as shown in the above code. Otherwise, you will get the following error:

ArgumentEscaper

Using AI Code Generation

1using Microsoft.TestPlatform.Build.Utils;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            string[] testArgs = { "/InIsolation", "/Settings:TestSettings.runsettings", "/TestCaseFilter:Priority=1", "/TestAdapterPath:.", "/logger:trx", "C:\Users\user\source\repos\ClassLibrary1\ClassLibrary1\bin\Debug\ClassLibrary1.dll" };12            var escapedArgs = ArgumentEscaper.EscapeAndConcatenateArgArrayForProcessStart(testArgs);13            Console.WriteLine(escapedArgs);14        }15    }16}

ArgumentEscaper

Using AI Code Generation

1using Microsoft.TestPlatform.Build.Utils;2using System;3using System.Diagnostics;4using System.IO;5using System.Text;6{7    {8        static void Main(string[] args)9        {10            var filePath = @"C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\devenv.exe";11            var arguments = @"/build Debug /project ""C:\Users\Public\Documents\Visual Studio 2015\Projects\ClassLibrary1\ClassLibrary1\ClassLibrary1.csproj""";12            var process = Process.Start(filePath, ArgumentEscaper.EscapeAndConcatenateArgArrayForProcessStart(arguments));13            process.WaitForExit();14        }15    }16}17string currentDirectory = Directory.GetCurrentDirectory();18The type or namespace name 'ClassLibrary1' does not exist in the namespace 'WindowsFormsApplication1' (are you missing an assembly reference?)19string currentDirectory = Directory.GetCurrentDirectory();

ArgumentEscaper

Using AI Code Generation

1using Microsoft.TestPlatform.Build.Utils;2using System;3using System.Diagnostics;4using System.IO;5using System.Text;6{7    {8        static void Main(string[] args)9        {10            string arg = ArgumentEscaper.EscapeAndConcatenateArgArrayForProcessStart(new string[] { "arg1", "arg2", "arg3" });11            Console.WriteLine(arg);12        }13    }14}

ArgumentEscaper

Using AI Code Generation

1using Microsoft.TestPlatform.Build.Utils;2using Microsoft.TestPlatform.Build.Tasks;3{4    public static void Main(string[] args)5    {6        ArgumentEscaper argumentEscaper = new ArgumentEscaper();7        string escapedArg = argumentEscaper.EscapeAndConcatenateArgArrayForProcessStart(args);8        Console.WriteLine(escapedArg);9    }10}11using Microsoft.TestPlatform.Build.Utils;12using Microsoft.TestPlatform.Build.Tasks;13{14    public static void Main(string[] args)15    {16        ArgumentEscaper argumentEscaper = new ArgumentEscaper();17        string escapedArg = argumentEscaper.EscapeAndConcatenateArgArrayForProcessStart(args);18        Console.WriteLine(escapedArg);19    }20}21using Microsoft.TestPlatform.Build.Utils;22using Microsoft.TestPlatform.Build.Tasks;23{24    public static void Main(string[] args)25    {26        ArgumentEscaper argumentEscaper = new ArgumentEscaper();27        string escapedArg = argumentEscaper.EscapeAndConcatenateArgArrayForProcessStart(args);28        Console.WriteLine(escapedArg);29    }30}31using Microsoft.TestPlatform.Build.Utils;32using Microsoft.TestPlatform.Build.Tasks;33{34    public static void Main(string[] args)35    {36        ArgumentEscaper argumentEscaper = new ArgumentEscaper();37        string escapedArg = argumentEscaper.EscapeAndConcatenateArgArrayForProcessStart(args);38        Console.WriteLine(escapedArg);39    }40}41using Microsoft.TestPlatform.Build.Utils;42using Microsoft.TestPlatform.Build.Tasks;43{44    public static void Main(string[] args)45    {

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.