Skip to content

[Microsoft.ClientModel.TestFramework] Update test-proxy tool logic #52589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 12, 2025
Merged

[Microsoft.ClientModel.TestFramework] Update test-proxy tool logic #52589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
636498c
update test proxy tool location
m-redding Sep 11, 2025
974844a
Update sdk/core/Microsoft.ClientModel.TestFramework/src/RecordedTests…
m-redding Sep 11, 2025
80d57f8
fix
m-redding Sep 12, 2025
19347f4
Merge branch 'scmtestframework2' of https://github.com/m-redding/azur…
m-redding Sep 12, 2025
0d43d5c
Merge branch 'Azure:main' into scmtestframework2
m-redding Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions sdk/core/Microsoft.ClientModel.TestFramework/src/Microsoft.ClientModel.TestFramework.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,4 @@
<ItemGroup>
<Compile Include="$(MSBuildThisFileDirectory)/../../System.ClientModel/src/Internal/ContentTypeUtilities.cs" LinkBase="Shared\Core" />
</ItemGroup>

<ItemGroup>
<AssemblyAttribute Include="System.Reflection.AssemblyMetadataAttribute">
<_Parameter1>TestProxyPath</_Parameter1>
<_Parameter2>$(NuGetPackageRoot)\azure.sdk.tools.testproxy\$(TestProxyVersion)\tools\net8.0\any\Azure.Sdk.Tools.TestProxy.dll</_Parameter2>
</AssemblyAttribute>
</ItemGroup>
</Project>
194 changes: 117 additions & 77 deletions sdk/core/Microsoft.ClientModel.TestFramework/src/RecordedTests/TestProxy/TestProxyProcess.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,17 @@ namespace Microsoft.ClientModel.TestFramework;
public class TestProxyProcess
{
private static readonly string s_dotNetExe;
private readonly int? _proxyPortHttp;
private readonly int? _proxyPortHttps;
private readonly Process? _testProxyProcess;
private readonly StringBuilder _errorBuffer = new();
private static readonly object _lock = new();
private static TestProxyProcess? _shared;
private readonly StringBuilder _output = new();
private static readonly bool s_enableDebugProxyLogging;

internal virtual TestProxyAdminClient AdminClient { get; }
internal virtual TestProxyClient ProxyClient { get; }

/// <summary>
/// The IP address used for the test proxy. Uses 127.0.0.1 instead of localhost to avoid SSL callback slowness.
Expand All @@ -39,26 +50,6 @@ public class TestProxyProcess
/// </summary>
public int? ProxyPortHttps => _proxyPortHttps;

private readonly int? _proxyPortHttp;
private readonly int? _proxyPortHttps;
private readonly Process? _testProxyProcess;

/// <summary>
/// Gets the test framework client for interacting with the test proxy.
/// </summary>
internal virtual TestProxyAdminClient AdminClient { get; }

/// <summary>
/// Gets the test proxy client for proxy-specific operations.
/// </summary>
internal virtual TestProxyClient ProxyClient { get; }

private readonly StringBuilder _errorBuffer = new();
private static readonly object _lock = new();
private static TestProxyProcess? _shared;
private readonly StringBuilder _output = new();
private static readonly bool s_enableDebugProxyLogging;

/// <summary>
/// Initializes static members of the <see cref="TestProxyProcess"/> class.
/// Locates the .NET executable and configures debug logging settings.
Expand Down Expand Up @@ -102,24 +93,35 @@ private TestProxyProcess(string? proxyPath, bool debugMode = false)

debugMode |= environmentDebugMode;

ProcessStartInfo testProxyProcessInfo = new ProcessStartInfo(
s_dotNetExe,
$"\"{proxyPath}\" start -u --storage-location=\"{TestEnvironment.RepositoryRoot}\"")
ProcessStartInfo testProxyProcessInfo;

if (proxyPath is not null)
{
UseShellExecute = false,
RedirectStandardOutput = true,
RedirectStandardError = true,
EnvironmentVariables =
{
["ASPNETCORE_URLS"] = $"http://{IpAddress}:0;https://{IpAddress}:0",
["Logging__LogLevel__Azure.Sdk.Tools.TestProxy"] = s_enableDebugProxyLogging ? "Debug" : "Error",
["Logging__LogLevel__Default"] = "Error",
["Logging__LogLevel__Microsoft.AspNetCore"] = s_enableDebugProxyLogging ? "Information" : "Error",
["Logging__LogLevel__Microsoft.Hosting.Lifetime"] = "Information",
["ASPNETCORE_Kestrel__Certificates__Default__Path"] = TestEnvironment.DevCertPath,
["ASPNETCORE_Kestrel__Certificates__Default__Password"] = TestEnvironment.DevCertPassword
}
};
testProxyProcessInfo = new ProcessStartInfo(
s_dotNetExe,
$"\"{proxyPath}\" start -u --storage-location=\"{TestEnvironment.RepositoryRoot}\"");
}
else
{
TryRestoreLocalTools();

testProxyProcessInfo = new ProcessStartInfo(
s_dotNetExe,
$"tool run test-proxy start -u --storage-location=\"{TestEnvironment.RepositoryRoot}\"");
}

testProxyProcessInfo.UseShellExecute = false;
testProxyProcessInfo.RedirectStandardOutput = true;
testProxyProcessInfo.RedirectStandardError = true;

// Set environment variables
testProxyProcessInfo.EnvironmentVariables["ASPNETCORE_URLS"] = $"http://{IpAddress}:0;https://{IpAddress}:0";
testProxyProcessInfo.EnvironmentVariables["Logging__LogLevel__Azure.Sdk.Tools.TestProxy"] = s_enableDebugProxyLogging ? "Debug" : "Error";
testProxyProcessInfo.EnvironmentVariables["Logging__LogLevel__Default"] = "Error";
testProxyProcessInfo.EnvironmentVariables["Logging__LogLevel__Microsoft.AspNetCore"] = s_enableDebugProxyLogging ? "Information" : "Error";
testProxyProcessInfo.EnvironmentVariables["Logging__LogLevel__Microsoft.Hosting.Lifetime"] = "Information";
testProxyProcessInfo.EnvironmentVariables["ASPNETCORE_Kestrel__Certificates__Default__Path"] = TestEnvironment.DevCertPath;
testProxyProcessInfo.EnvironmentVariables["ASPNETCORE_Kestrel__Certificates__Default__Password"] = TestEnvironment.DevCertPassword;

_testProxyProcess = Process.Start(testProxyProcessInfo);

Expand Down Expand Up @@ -168,7 +170,13 @@ private TestProxyProcess(string? proxyPath, bool debugMode = false)

if (_proxyPortHttp == null || _proxyPortHttps == null)
{
CheckForErrors();
if (_errorBuffer.Length > 0)
{
var error = _errorBuffer.ToString();
_errorBuffer.Clear();
throw new InvalidOperationException($"An error occurred in the test proxy: {error}");
}

// if no errors, fallback to this exception
throw new InvalidOperationException("Failed to start the test proxy. One or both of the ports was not populated." + Environment.NewLine +
$"http: {_proxyPortHttp}" + Environment.NewLine +
Expand All @@ -192,6 +200,69 @@ private TestProxyProcess(string? proxyPath, bool debugMode = false)
});
}

private static bool TryParsePort(string? output, string scheme, out int? port)
{
if (output == null)
{
TestContext.Progress.WriteLine("output was null");
port = null;
return false;
}
string nowListeningOn = "Now listening on: ";
int nowListeningOnLength = nowListeningOn.Length;
var index = output.IndexOf($"{nowListeningOn}{scheme}:", StringComparison.CurrentCultureIgnoreCase);
if (index > -1)
{
var start = index + nowListeningOnLength;
var uri = output.Substring(start, output.Length - start).Trim();
port = new Uri(uri).Port;
return true;
}

port = null;
return false;
}

private static void TryRestoreLocalTools()
{
try
{
var currentDir = Directory.GetCurrentDirectory();
while (currentDir != null)
{
var toolsJsonPath = Path.Combine(currentDir, ".config", "dotnet-tools.json");
if (File.Exists(toolsJsonPath))
{
// Found a tools manifest, try to restore
var processInfo = new ProcessStartInfo
{
FileName = s_dotNetExe,
Arguments = "tool restore",
WorkingDirectory = currentDir,
UseShellExecute = false,
RedirectStandardOutput = true,
RedirectStandardError = true,
CreateNoWindow = true
};

using var process = Process.Start(processInfo);
if (process != null)
{
process.WaitForExit(30000);
}
break;
}

var parentDir = Directory.GetParent(currentDir);
currentDir = parentDir?.FullName;
}
}
catch
{
// If restore fails, silently continue - the dotnet test-proxy command will handle it
}
}

/// <summary>
/// Starts the test proxy
/// </summary>
Expand All @@ -209,12 +280,8 @@ public static TestProxyProcess Start(bool debugMode = false)
var shared = _shared;
if (shared == null)
{
shared = new TestProxyProcess(typeof(TestProxyProcess)
.Assembly
.GetCustomAttributes<AssemblyMetadataAttribute>()
.Single(a => a.Key == "TestProxyPath")
.Value,
debugMode);
var proxyPath = GetTestProxyPath();
shared = new TestProxyProcess(proxyPath, debugMode);

AppDomain.CurrentDomain.DomainUnload += (_, _) =>
{
Expand All @@ -228,34 +295,16 @@ public static TestProxyProcess Start(bool debugMode = false)
}
}

/// <summary>
/// Attempts to parse a port number from test proxy output for the specified scheme.
/// </summary>
/// <param name="output">The output line from the test proxy.</param>
/// <param name="scheme">The URI scheme (http or https) to parse.</param>
/// <param name="port">When this method returns, contains the parsed port number if successful; otherwise, null.</param>
/// <returns>true if the port was successfully parsed; otherwise, false.</returns>
private static bool TryParsePort(string? output, string scheme, out int? port)
private static string? GetTestProxyPath()
{
if (output == null)
{
TestContext.Progress.WriteLine("output was null");
port = null;
return false;
}
string nowListeningOn = "Now listening on: ";
int nowListeningOnLength = nowListeningOn.Length;
var index = output.IndexOf($"{nowListeningOn}{scheme}:", StringComparison.CurrentCultureIgnoreCase);
if (index > -1)
// Look for environment variable override
var envPath = Environment.GetEnvironmentVariable("TEST_PROXY_EXE_PATH");
if (!string.IsNullOrEmpty(envPath))
{
var start = index + nowListeningOnLength;
var uri = output.Substring(start, output.Length - start).Trim();
port = new Uri(uri).Port;
return true;
return envPath;
}

port = null;
return false;
return null;
}

/// <summary>
Expand All @@ -278,15 +327,6 @@ public virtual async Task CheckProxyOutputAsync()
}
}

CheckForErrors();
}

/// <summary>
/// Checks for any errors in the error buffer and throws an exception if errors are found.
/// </summary>
/// <exception cref="InvalidOperationException">Thrown when errors are found in the test proxy.</exception>
private void CheckForErrors()
{
if (_errorBuffer.Length > 0)
{
var error = _errorBuffer.ToString();
Expand Down