Test run parameter added as part of CLI runsettings args (#2251)

* test run parameter added as second class argument

* regex is used to match test run paramterer node

* added exception for invaild test run parameter argument

* regex constants moved to constants

* unit tests are added for regex pattern match

* added special character test cases

* formatted

* resource string is changed

* formatted

src/Microsoft.TestPlatform.Common/Utilities/RunSettingsProviderExtensions.cs

@@ -12,6 +12,8 @@ namespace Microsoft.VisualStudio.TestPlatform.Common.Utilities
     using Microsoft.VisualStudio.TestPlatform.ObjectModel;
     using Microsoft.VisualStudio.TestPlatform.ObjectModel.Utilities;
     using Microsoft.VisualStudio.TestPlatform.Common;
+    using System.Collections.Generic;
+    using System.Text.RegularExpressions;
 
     /// <summary>
     /// Utilities to get the run settings from the provider and the commandline options specified.
@@ -20,6 +22,31 @@ internal static class RunSettingsProviderExtensions
     {
         public const string EmptyRunSettings = @"<RunSettings><RunConfiguration></RunConfiguration></RunSettings>";
 
+        /// <summary>
+        /// Pattern used to find parameter node.
+        /// </summary>
+        private const string ParameterString = "Parameter";
+
+        /// <summary>
+        /// Pattern that indicates Attribute name.
+        /// </summary>
+        private const string AttributeNameString = "AttrName";
+
+        /// <summary>
+        /// Pattern that indicates  Attribute value.
+        /// </summary>
+        private const string AttributeValueString = "AttrValue";
+
+        /// <summary>
+        /// Attribute name key for test run parameter node
+        /// </summary>
+        private const string NameString = "name";
+
+        /// <summary>
+        /// Attribute value key for test run parameter node
+        /// </summary>
+        private const string ValueString = "value";
+
         public static void UpdateRunSettings(this IRunSettingsProvider runSettingsProvider, string runsettingsXml)
         {
             ValidateArg.NotNull(runSettingsProvider, nameof(runSettingsProvider));
@@ -62,6 +89,61 @@ public static void UpdateRunSettingsNode(this IRunSettingsProvider runSettingsPr
             runSettingsProvider.UpdateRunSettings(xmlDocument.OuterXml);
         }
 
+        /// <summary>
+        /// Matches with test run parameter node pattern and returns that match.
+        /// </summary>
+        /// <param name="runSettingsProvider"></param>
+        /// <param name="node"></param>
+        /// <returns></returns>
+        public static Match GetTestRunParameterNodeMatch(this IRunSettingsProvider runSettingsProvider, string node)
+        {
+            var attrName = $"(?<{AttributeNameString}>\\w+)";
+            var attrValue = $"(?<{AttributeValueString}>.+)";
+            Regex regex = new Regex($"{Constants.TestRunParametersName}.{ParameterString}\\(name\\s*=\\s*\"{attrName}\"\\s*,\\s*value\\s*=\\s*\"{attrValue}\"\\)");
+            Match match = regex.Match(node);
+            return match;
+        }
+
+        /// <summary>
+        /// If test run parameter exists already it will override with new value otherwise this will add new test run parameter.
+        /// </summary>
+        /// <param name="runSettingsProvider"></param>
+        /// <param name="match"></param>
+        public static void UpdateTestRunParameterSettingsNode(this IRunSettingsProvider runSettingsProvider, Match match)
+        {
+            ValidateArg.NotNull(runSettingsProvider, nameof(runSettingsProvider));
+
+            var xmlDocument = runSettingsProvider.GetRunSettingXmlDocument();
+            XmlNode testRunParameterNode = GetXmlNode(xmlDocument, Constants.TestRunParametersName) ?? xmlDocument.CreateElement(Constants.TestRunParametersName);
+            var attrName = match.Groups[AttributeNameString].Value;
+            var attrValue = match.Groups[AttributeValueString].Value;
+
+            if (!TryOverrideAttributeValue(testRunParameterNode, attrName, attrValue))
+            {
+                XmlElement element = xmlDocument.CreateElement(ParameterString);
+                element.SetAttribute(NameString, attrName);
+                element.SetAttribute(ValueString, attrValue);
+                testRunParameterNode.AppendChild(element);
+                xmlDocument.DocumentElement.AppendChild(testRunParameterNode);
+            }
+
+            runSettingsProvider.UpdateRunSettings(xmlDocument.OuterXml);
+        }
+
+        private static bool TryOverrideAttributeValue(XmlNode xmlNode, string attrName, string attrValue)
+        {
+            foreach (XmlNode node in xmlNode.ChildNodes)
+            {
+                if (string.Compare(node.Attributes[NameString].Value, attrName) == 0)
+                {
+                    node.Attributes[ValueString].Value = attrValue;
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
         public static void UpdateRunSettingsNodeInnerXml(this IRunSettingsProvider runSettingsProvider, string key, string xml)
         {
             ValidateArg.NotNull(runSettingsProvider, nameof(runSettingsProvider));
@@ -133,7 +215,7 @@ private static XmlNode CreateNode(XmlDocument doc, string xPath)
             }
 
             return node;
-        }        
+        }
 
         private static XmlDocument GetRunSettingXmlDocument(this IRunSettingsProvider runSettingsProvider)
         {

src/Microsoft.TestPlatform.ObjectModel/Constants.cs

@@ -121,6 +121,9 @@ public static class Constants
 
         public const string DataCollectorSettingName = "DataCollector";
 
+        /// <summary>
+        /// Pattern used to find test run parameter node.
+        /// </summary>
         public const string TestRunParametersName = "TestRunParameters";
 
         /// <summary>

src/vstest.console/Processors/CLIRunSettingsArgumentProcessor.cs

@@ -13,6 +13,7 @@ namespace Microsoft.VisualStudio.TestPlatform.CommandLine.Processors
     using Microsoft.VisualStudio.TestPlatform.Common.Utilities;
 
     using CommandLineResources = Microsoft.VisualStudio.TestPlatform.CommandLine.Resources.Resources;
+    using System.Text.RegularExpressions;
 
     /// <summary>
     /// The argument processor for runsettings passed as argument through cli
@@ -139,14 +140,22 @@ private void CreateOrOverwriteRunSettings(IRunSettingsProvider runSettingsProvid
 
             for (int index = 0; index < length; index++)
             {
-                var keyValuePair = args[index];
-                var indexOfSeparator = keyValuePair.IndexOf("=");
-                if (indexOfSeparator <= 0 || indexOfSeparator >= keyValuePair.Length - 1)
+                var arg = args[index];
+
+                if (UpdateTestRunParameterNode(runSettingsProvider, arg))
                 {
                     continue;
                 }
-                var key = keyValuePair.Substring(0, indexOfSeparator).Trim();
-                var value = keyValuePair.Substring(indexOfSeparator + 1);
+
+                var indexOfSeparator = arg.IndexOf("=");
+
+                if (indexOfSeparator <= 0 || indexOfSeparator >= arg.Length - 1)
+                {
+                    continue;
+                }
+
+                var key = arg.Substring(0, indexOfSeparator).Trim();
+                var value = arg.Substring(indexOfSeparator + 1);
 
                 if (string.IsNullOrWhiteSpace(key))
                 {
@@ -160,6 +169,25 @@ private void CreateOrOverwriteRunSettings(IRunSettingsProvider runSettingsProvid
             }
         }
 
+        private bool UpdateTestRunParameterNode(IRunSettingsProvider runSettingsProvider, string node)
+        {
+            if (!node.Contains(Constants.TestRunParametersName))
+            {
+                return false;
+            }
+
+            var match = runSettingsProvider.GetTestRunParameterNodeMatch(node);
+
+            if (string.Compare(match.Value, node) == 0)
+            {
+                runSettingsProvider.UpdateTestRunParameterSettingsNode(match);
+                return true;
+            }
+
+            var exceptionMessage = string.Format(CommandLineResources.InvalidTestRunParameterArgument, node);
+            throw new CommandLineException(exceptionMessage);
+        }
+
         private void UpdateFrameworkAndPlatform(string key, string value)
         {
             if (key.Equals(FrameworkArgumentExecutor.RunSettingsPath))

src/vstest.console/Resources/Resources.resx

@@ -734,4 +734,8 @@
   <data name="TestSourcesDiscovered" xml:space="preserve">
     <value>A total of {0} test files matched the specified pattern.</value>
   </data>
+  <data name="InvalidTestRunParameterArgument" xml:space="preserve">
+    <value>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</value>
+  </data>
 </root>

src/vstest.console/Resources/xlf/Resources.cs.xlf

@@ -1656,6 +1656,13 @@
         <target state="translated">Celkový počet testovacích souborů, které odpovídají zadanému vzoru: {0}</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.de.xlf

@@ -1656,6 +1656,13 @@
         <target state="translated">Insgesamt {0} Testdateien stimmten mit dem angegebenen Muster überein.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.es.xlf

@@ -1659,6 +1659,13 @@
         <target state="translated">{0} archivos de prueba en total coincidieron con el patrón especificado.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.fr.xlf

@@ -1656,6 +1656,13 @@
         <target state="translated">Au total, {0} fichiers de test ont correspondu au modèle spécifié.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.it.xlf

@@ -1656,6 +1656,13 @@
         <target state="translated">Un totale di {0} file di test corrisponde al criterio specificato.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.ja.xlf

@@ -1656,6 +1656,13 @@
         <target state="translated">合計 {0} 個のテスト ファイルが指定されたパターンと一致しました。</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.ko.xlf

@@ -1656,6 +1656,13 @@
         <target state="translated">지정된 패턴과 일치한 총 테스트 파일 수는 {0}개입니다.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.pl.xlf

@@ -1656,6 +1656,13 @@
         <target state="translated">Łączna liczba plików testowych dopasowanych do określonego wzorca: {0}.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.pt-BR.xlf

@@ -1656,6 +1656,13 @@ Altere o prefixo de nível de diagnóstico do agente de console, como mostrado a
         <target state="translated">{0} arquivos de teste no total corresponderam ao padrão especificado.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.ru.xlf

@@ -1656,6 +1656,13 @@
         <target state="translated">Общее количество тестовых файлов ({0}), соответствующих указанному шаблону.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.tr.xlf

@@ -1656,6 +1656,13 @@ Günlükler için izleme düzeyini aşağıda gösterildiği gibi değiştirin
         <target state="translated">Toplam {0} test dosyası belirtilen desenle eşleşti.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/vstest.console/Resources/xlf/Resources.xlf

@@ -847,6 +847,13 @@
         <target state="new">A total of {0} test source files are discovered.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="InvalidTestRunParameterArgument">
+        <source>The test run parameter argument '{0}' is invalid. Please use the format below.
+     Format: TestRunParameters.Parameter(name=\"&lt;name&gt;\", value=\"&lt;value&gt;\")</source>
+        <target state="new">The test run parameter argument '{0}' is invalid. Please use the format below.
+Format : TestRunParameters.Parameter(name="&lt;name&gt;", value="&lt;value&gt;")</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>