DataCollector check with only Uri in Runsettings (#2177)

hvinett · singhsarab · commit f0cd370fa400 · 2019-10-01T20:24:36.000+05:30
* Removed friendly name null check
* removed redundant code and added tests for the datacollection manager
* added warning message if friendlyname is incorrect
* Given prority to Uri
* changed naming in resources
* added tests and verified behavior
* changed member variables to functional variables
* added datacollectorsettings as member variable again
diff --git a/src/Microsoft.TestPlatform.Common/DataCollection/DataCollectionManager.cs b/src/Microsoft.TestPlatform.Common/DataCollection/DataCollectionManager.cs
@@ -391,6 +391,24 @@ protected virtual bool TryGetUriFromFriendlyName(string friendlyName, out string
             return false;
         }
 
+        protected virtual bool IsUriValid(string uri)
+        {
+            if (string.IsNullOrEmpty(uri))
+            {
+                return false;
+            }
+
+            var extensionManager = this.dataCollectorExtensionManager;
+            foreach (var extension in extensionManager.TestExtensions)
+            {
+                if (string.Compare(uri, extension.Metadata.ExtensionUri, StringComparison.OrdinalIgnoreCase) == 0)
+                {
+                    return true;
+                }
+            }
+            return false;
+        }
+
         /// <summary>
         /// Gets the extension using uri.
         /// </summary>
@@ -421,8 +439,12 @@ private void LoadAndInitialize(DataCollectorSettings dataCollectorSettings, stri
             {
                 // Look up the extension and initialize it if one is found.
                 var extensionManager = this.DataCollectorExtensionManager;
-                var dataCollectorUri = string.Empty;
-                this.TryGetUriFromFriendlyName(dataCollectorSettings.FriendlyName, out dataCollectorUri);
+                var dataCollectorUri = dataCollectorSettings.Uri?.ToString();
+
+                if (!IsUriValid(dataCollectorUri) && !this.TryGetUriFromFriendlyName(dataCollectorSettings.FriendlyName, out dataCollectorUri))
+                {
+                    this.LogWarning(string.Format(CultureInfo.CurrentUICulture, Resources.Resources.UnableToFetchUriString, dataCollectorSettings.FriendlyName));
+                }
 
                 DataCollector dataCollector = null;
                 if (!string.IsNullOrWhiteSpace(dataCollectorUri))
@@ -699,4 +721,4 @@ private void LogAttachments(List<AttachmentSet> attachmentSets)
             }
         }
     }
-}
+}
diff --git a/src/Microsoft.TestPlatform.Common/Resources/Resources.Designer.cs b/src/Microsoft.TestPlatform.Common/Resources/Resources.Designer.cs
diff --git a/src/Microsoft.TestPlatform.Common/Resources/Resources.resx b/src/Microsoft.TestPlatform.Common/Resources/Resources.resx
@@ -213,6 +213,9 @@
   <data name="TestCaseFilterFormatException" xml:space="preserve">
     <value>Incorrect format for TestCaseFilter {0}. Specify the correct format and try again. Note that the incorrect format can lead to no test getting executed.</value>
   </data>
+  <data name="UnableToFetchUriString" xml:space="preserve">
+    <value>Unable to find a datacollector with friendly name '[0}'.</value>
+  </data>
   <data name="VSInstallationNotFound" xml:space="preserve">
     <value>This option works only with vstest.console.exe installed as part of Visual Studio.</value>
   </data>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.cs.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.cs.xlf
@@ -269,6 +269,11 @@
         <target state="translated">Operace se ruší na základě žádosti.</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.de.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.de.xlf
@@ -269,6 +269,11 @@
         <target state="translated">Der Vorgang wird gemäß Anforderung abgebrochen.</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.es.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.es.xlf
@@ -269,6 +269,11 @@
         <target state="translated">La operación se cancelará como se ha solicitado.</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.fr.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.fr.xlf
@@ -269,6 +269,11 @@
         <target state="translated">Annulation de l'opération, comme demandé.</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.it.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.it.xlf
@@ -269,6 +269,11 @@
         <target state="translated">L'operazione verrà annullata come richiesto.</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.ja.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.ja.xlf
@@ -269,6 +269,11 @@
         <target state="translated">操作のキャンセルが要求されたため、キャンセルしています。</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.ko.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.ko.xlf
@@ -269,6 +269,11 @@
         <target state="translated">요청한 대로 작업을 취소하는 중입니다.</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.pl.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.pl.xlf
@@ -269,6 +269,11 @@
         <target state="translated">Anulowanie operacji zgodnie z żądaniem.</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.pt-BR.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.pt-BR.xlf
@@ -269,6 +269,11 @@
         <target state="translated">Cancelando a operação conforme solicitado.</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.ru.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.ru.xlf
@@ -269,6 +269,11 @@
         <target state="translated">Операция отменяется в соответствии с запросом.</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.tr.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.tr.xlf
@@ -269,6 +269,11 @@
         <target state="translated">İşlem istek üzerine iptal ediliyor.</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.xlf
@@ -146,6 +146,11 @@
         <target state="new">Cancelling the operation as requested.</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.zh-Hans.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.zh-Hans.xlf
@@ -269,6 +269,11 @@
         <target state="translated">按要求取消该操作。</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.zh-Hant.xlf b/src/Microsoft.TestPlatform.Common/Resources/xlf/Resources.zh-Hant.xlf
@@ -269,6 +269,11 @@
         <target state="translated">正在應要求取消作業。</target>
         <note />
       </trans-unit>
+      <trans-unit id="UnableToFetchUriString">
+        <source>Unable to find a datacollector with friendly name '[0}'.</source>
+        <target state="new">Unable to find a datacollector with friendly name '[0}'.</target>
+        <note></note>
+      </trans-unit>
       <trans-unit id="FailedToLoadAdapaterFile">
         <source>Failed to load extensions from file '{0}'. Please use /diag for more information.</source>
         <target state="new">TestPluginDiscoverer: Failed to load extensions from file '{0}'. Please use /diag for more information.</target>
diff --git a/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/DataCollectionLauncherFactory.cs b/src/Microsoft.TestPlatform.CrossPlatEngine/DataCollection/DataCollectionLauncherFactory.cs
@@ -28,7 +28,7 @@ internal static IDataCollectionLauncher GetDataCollectorLauncher(IProcessHelper
                 var dataCollectionRunSettings = XmlRunSettingsUtilities.GetDataCollectionRunSettings(settingsXml);
                 foreach (var dataCollectorSettings in dataCollectionRunSettings.DataCollectorSettingsList)
                 {
-                    if (dataCollectorSettings.FriendlyName.ToLower().Equals("event log"))
+                    if (string.Equals(dataCollectorSettings.FriendlyName, "event Log", StringComparison.OrdinalIgnoreCase) || string.Equals(dataCollectorSettings.Uri?.ToString(), @"datacollector://Microsoft/EventLog/2.0", StringComparison.OrdinalIgnoreCase))
                     {
                         return new DefaultDataCollectionLauncher();
                     }
diff --git a/src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectorSettings.cs b/src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectorSettings.cs
@@ -201,12 +201,6 @@ internal static DataCollectorSettings FromXml(XmlReader reader)
 
             }
 
-            if (string.IsNullOrWhiteSpace(settings.FriendlyName))
-            {
-                throw new SettingsException(
-                    String.Format(CultureInfo.CurrentCulture, Resources.Resources.MissingDataCollectorAttributes, "FriendlyName"));
-            }
-
             reader.Read();
             if (!empty)
             {
diff --git a/test/datacollector.UnitTests/DataCollectionManagerTests.cs b/test/datacollector.UnitTests/DataCollectionManagerTests.cs

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ internal static IDataCollectionLauncher GetDataCollectorLauncher(IProcessHelper`
`28`	`28`	`var dataCollectionRunSettings = XmlRunSettingsUtilities.GetDataCollectionRunSettings(settingsXml);`
`29`	`29`	`foreach (var dataCollectorSettings in dataCollectionRunSettings.DataCollectorSettingsList)`
`30`	`30`	`{`
`31`		`- if (dataCollectorSettings.FriendlyName.ToLower().Equals("event log"))`
	`31`	`+ if (string.Equals(dataCollectorSettings.FriendlyName, "event Log", StringComparison.OrdinalIgnoreCase) \|\| string.Equals(dataCollectorSettings.Uri?.ToString(), @"datacollector://Microsoft/EventLog/2.0", StringComparison.OrdinalIgnoreCase))`
`32`	`32`	`{`
`33`	`33`	`return new DefaultDataCollectionLauncher();`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -201,12 +201,6 @@ internal static DataCollectorSettings FromXml(XmlReader reader)`
`201`	`201`
`202`	`202`	`}`
`203`	`203`
`204`		`- if (string.IsNullOrWhiteSpace(settings.FriendlyName))`
`205`		`- {`
`206`		`- throw new SettingsException(`
`207`		`- String.Format(CultureInfo.CurrentCulture, Resources.Resources.MissingDataCollectorAttributes, "FriendlyName"));`
`208`		`- }`
`209`		`-`
`210`	`204`	`reader.Read();`
`211`	`205`	`if (!empty)`
`212`	`206`	`{`