Unify reading runsettings by @Youssef1313 in #6422 (backport to rel/3.10) (#6434)

Co-authored-by: Youssef1313 <youssefvictor00@gmail.com>

Author: youssef-backport-bot

src/Platform/Microsoft.Testing.Extensions.VSTestBridge/Configurations/RunSettingsConfigurationProvider.cs

@@ -1,7 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-using Microsoft.Testing.Extensions.VSTestBridge.CommandLine;
+using Microsoft.Testing.Extensions.VSTestBridge.Helpers;
+using Microsoft.Testing.Platform;
 using Microsoft.Testing.Platform.CommandLine;
 using Microsoft.Testing.Platform.Configurations;
 using Microsoft.Testing.Platform.Helpers;
@@ -37,7 +38,7 @@ internal sealed class RunSettingsConfigurationProvider(IFileSystem fileSystem) :
     /// <inheritdoc />
     public bool TryGet(string key, out string? value)
     {
-        if (_runSettingsFileContent is null)
+        if (RoslynString.IsNullOrEmpty(_runSettingsFileContent))
         {
             value = null;
             return false;
@@ -58,16 +59,9 @@ public bool TryGet(string key, out string? value)
     }
 
     /// <inheritdoc />
-    public async Task<IConfigurationProvider> BuildAsync(CommandLineParseResult commandLineParseResult)
+    public Task<IConfigurationProvider> BuildAsync(CommandLineParseResult commandLineParseResult)
     {
-        if (commandLineParseResult.TryGetOptionArgumentList(RunSettingsCommandLineOptionsProvider.RunSettingsOptionName, out string[]? runSettingsFilePath))
-        {
-            if (_fileSystem.ExistFile(runSettingsFilePath[0]))
-            {
-                _runSettingsFileContent = await _fileSystem.ReadAllTextAsync(runSettingsFilePath[0]).ConfigureAwait(false);
-            }
-        }
-
-        return this;
+        _runSettingsFileContent = RunSettingsHelpers.ReadRunSettings(commandLineParseResult, _fileSystem);
+        return Task.FromResult<IConfigurationProvider>(this);
     }
 }

src/Platform/Microsoft.Testing.Extensions.VSTestBridge/Helpers/RunSettingsHelpers.cs

@@ -0,0 +1,55 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Microsoft.Testing.Extensions.VSTestBridge.CommandLine;
+using Microsoft.Testing.Platform;
+using Microsoft.Testing.Platform.CommandLine;
+using Microsoft.Testing.Platform.Helpers;
+
+namespace Microsoft.Testing.Extensions.VSTestBridge.Helpers;
+
+internal static class RunSettingsHelpers
+{
+    // TODO: There are two code paths that read runsettings. One is calling the ICommandLineOptions overload, other is calling the CommandLineParseResult overload.
+    // Figure out if they can/should be unified so that we do one I/O operation instead of two.
+    public static string ReadRunSettings(ICommandLineOptions commandLineOptions, IFileSystem fileSystem)
+    {
+        _ = commandLineOptions.TryGetOptionArgumentList(RunSettingsCommandLineOptionsProvider.RunSettingsOptionName, out string[]? fileNames);
+        return ReadRunSettings(fileNames, fileSystem);
+    }
+
+    public static string ReadRunSettings(CommandLineParseResult commandLineParseResult, IFileSystem fileSystem)
+    {
+        _ = commandLineParseResult.TryGetOptionArgumentList(RunSettingsCommandLineOptionsProvider.RunSettingsOptionName, out string[]? fileNames);
+        return ReadRunSettings(fileNames, fileSystem);
+    }
+
+    private static string ReadRunSettings(string[]? runsettingsFileFromCommandLine, IFileSystem fileSystem)
+    {
+        if (runsettingsFileFromCommandLine is not null &&
+            runsettingsFileFromCommandLine.Length == 1 &&
+            fileSystem.ExistFile(runsettingsFileFromCommandLine[0]))
+        {
+            return fileSystem.ReadAllText(runsettingsFileFromCommandLine[0]);
+        }
+        else
+        {
+            string? envVariableRunSettings = Environment.GetEnvironmentVariable("TESTINGPLATFORM_EXPERIMENTAL_VSTEST_RUNSETTINGS");
+            if (!RoslynString.IsNullOrEmpty(envVariableRunSettings))
+            {
+                return envVariableRunSettings;
+            }
+            else
+            {
+                string? runSettingsFilePath = Environment.GetEnvironmentVariable("TESTINGPLATFORM_VSTESTBRIDGE_RUNSETTINGS_FILE");
+
+                if (!RoslynString.IsNullOrEmpty(runSettingsFilePath) && File.Exists(runSettingsFilePath))
+                {
+                    return fileSystem.ReadAllText(runSettingsFilePath);
+                }
+            }
+        }
+
+        return string.Empty;
+    }
+}

src/Platform/Microsoft.Testing.Extensions.VSTestBridge/ObjectModel/RunSettingsAdapter.cs

@@ -1,9 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-using Microsoft.Testing.Extensions.VSTestBridge.CommandLine;
+using Microsoft.Testing.Extensions.VSTestBridge.Helpers;
 using Microsoft.Testing.Extensions.VSTestBridge.Resources;
-using Microsoft.Testing.Platform;
 using Microsoft.Testing.Platform.CommandLine;
 using Microsoft.Testing.Platform.Configurations;
 using Microsoft.Testing.Platform.Helpers;
@@ -38,31 +37,7 @@ public RunSettingsAdapter(
         ILoggerFactory loggerFactory,
         IMessageLogger messageLogger)
     {
-        string? runSettingsXml = string.Empty;
-
-        if (commandLineOptions.TryGetOptionArgumentList(RunSettingsCommandLineOptionsProvider.RunSettingsOptionName, out string[]? fileNames)
-             && fileNames is not null
-            && fileNames.Length == 1
-            && fileSystem.ExistFile(fileNames[0]))
-        {
-            runSettingsXml = fileSystem.ReadAllText(fileNames[0]);
-        }
-        else
-        {
-            if (!RoslynString.IsNullOrEmpty(Environment.GetEnvironmentVariable("TESTINGPLATFORM_EXPERIMENTAL_VSTEST_RUNSETTINGS")))
-            {
-                runSettingsXml = Environment.GetEnvironmentVariable("TESTINGPLATFORM_EXPERIMENTAL_VSTEST_RUNSETTINGS");
-            }
-            else
-            {
-                string? runSettingsFilePath = Environment.GetEnvironmentVariable("TESTINGPLATFORM_VSTESTBRIDGE_RUNSETTINGS_FILE");
-
-                if (!RoslynString.IsNullOrEmpty(runSettingsFilePath) && File.Exists(runSettingsFilePath))
-                {
-                    runSettingsXml = fileSystem.ReadAllText(runSettingsFilePath);
-                }
-            }
-        }
+        string runSettingsXml = RunSettingsHelpers.ReadRunSettings(commandLineOptions, fileSystem);
 
         XDocument runSettingsDocument = RunSettingsPatcher.Patch(runSettingsXml, configuration, client, commandLineOptions);
         WarnOnUnsupportedEntries(runSettingsDocument, messageLogger);