Add client conformance tests (#1102)

Co-authored-by: Stephen Halter <halter73@gmail.com>

tests/ModelContextProtocol.ConformanceClient/ModelContextProtocol.ConformanceClient.csproj

@@ -0,0 +1,23 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <OutputType>Exe</OutputType>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(TargetFramework)' == 'net9.0'">
+    <!-- For better test coverage, only disable reflection in one of the targets -->
+    <JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="../../src/ModelContextProtocol.Core/ModelContextProtocol.Core.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" />
+  </ItemGroup>
+
+</Project>

tests/ModelContextProtocol.ConformanceClient/Program.cs

@@ -0,0 +1,147 @@
+using System.Net;
+using System.Net.Sockets;
+using System.Text;
+using System.Web;
+using Microsoft.Extensions.Logging;
+using ModelContextProtocol.Client;
+
+// This program expects the following command-line arguments:
+// 1. The client conformance test scenario to run (e.g., "tools_call")
+// 2. The endpoint URL (e.g., "http://localhost:3001")
+
+if (args.Length < 2)
+{
+    Console.WriteLine("Usage: dotnet run --project ModelContextProtocol.ConformanceClient.csproj <scenario> [endpoint]");
+    return 1;
+}
+
+var scenario = args[0];
+var endpoint =  args[1];
+
+McpClientOptions options = new()
+{
+    ClientInfo = new()
+    {
+        Name = "ConformanceClient",
+        Version = "1.0.0"
+    }
+};
+
+var consoleLoggerFactory = LoggerFactory.Create(builder =>
+{
+    builder.AddConsole();
+});
+
+// Configure OAuth callback port via environment or pick an ephemeral port.
+var callbackPortEnv = Environment.GetEnvironmentVariable("OAUTH_CALLBACK_PORT");
+int callbackPort = 0;
+if (!string.IsNullOrEmpty(callbackPortEnv) && int.TryParse(callbackPortEnv, out var parsedPort))
+{
+    callbackPort = parsedPort;
+}
+
+if (callbackPort == 0)
+{
+    var tcp = new TcpListener(IPAddress.Loopback, 0);
+    tcp.Start();
+    callbackPort = ((IPEndPoint)tcp.LocalEndpoint).Port;
+    tcp.Stop();
+}
+
+var clientRedirectUri = new Uri($"http://localhost:{callbackPort}/callback");
+
+var clientTransport = new HttpClientTransport(new()
+{
+    Endpoint = new Uri(endpoint),
+    TransportMode = HttpTransportMode.StreamableHttp,
+    OAuth = new()
+    {
+        RedirectUri = clientRedirectUri,
+        // Configure the metadata document URI for CIMD.
+        ClientMetadataDocumentUri = new Uri("https://conformance-test.local/client-metadata.json"),
+        AuthorizationRedirectDelegate = (authUrl, redirectUri, ct) => HandleAuthorizationUrlAsync(authUrl, redirectUri, ct),
+        DynamicClientRegistration = new()
+        {
+            ClientName = "ProtectedMcpClient",
+        },
+    }
+}, loggerFactory: consoleLoggerFactory);
+
+await using var mcpClient = await McpClient.CreateAsync(clientTransport, options, loggerFactory: consoleLoggerFactory);
+
+bool success = true;
+
+switch (scenario)
+{
+    case "tools_call":
+    {
+        var tools = await mcpClient.ListToolsAsync();
+        Console.WriteLine($"Available tools: {string.Join(", ", tools.Select(t => t.Name))}");
+
+        // Call the "add_numbers" tool
+        var toolName = "add_numbers";
+        Console.WriteLine($"Calling tool: {toolName}");
+        var result = await mcpClient.CallToolAsync(toolName: toolName, arguments: new Dictionary<string, object?>
+        {
+            { "a", 5 },
+            { "b", 10 }
+        });
+        success &= !(result.IsError == true);
+        break;
+    }
+    case "auth/scope-step-up":
+    {
+        // Just testing that we can authenticate and list tools
+        var tools = await mcpClient.ListToolsAsync();
+        Console.WriteLine($"Available tools: {string.Join(", ", tools.Select(t => t.Name))}");
+
+        // Call the "test_tool" tool
+        var toolName = tools.FirstOrDefault()?.Name ?? "test-tool";
+        Console.WriteLine($"Calling tool: {toolName}");
+        var result = await mcpClient.CallToolAsync(toolName: toolName, arguments: new Dictionary<string, object?>
+        {
+            { "foo", "bar" },
+        });
+        success &= !(result.IsError == true);
+        break;
+    }
+    default:
+        // No extra processing for other scenarios
+        break;
+}
+
+// Exit code 0 on success, 1 on failure
+return success ? 0 : 1;
+
+// Copied from ProtectedMcpClient sample
+// Simulate a user opening the browser and logging in
+// Copied from OAuthTestBase
+static async Task<string?> HandleAuthorizationUrlAsync(Uri authorizationUrl, Uri redirectUri, CancellationToken cancellationToken)
+{
+    Console.WriteLine("Starting OAuth authorization flow...");
+    Console.WriteLine($"Simulating opening browser to: {authorizationUrl}");
+
+    using var handler = new HttpClientHandler()
+    {
+        AllowAutoRedirect = false,
+    };
+    using var httpClient = new HttpClient(handler);
+    using var redirectResponse = await httpClient.GetAsync(authorizationUrl, cancellationToken);
+    var location = redirectResponse.Headers.Location;
+
+    if (location is not null && !string.IsNullOrEmpty(location.Query))
+    {
+        // Parse query string to extract "code" parameter
+        var query = location.Query.TrimStart('?');
+        foreach (var pair in query.Split('&'))
+        {
+            var parts = pair.Split('=', 2);
+            if (parts.Length == 2 && parts[0] == "code")
+            {
+                return HttpUtility.UrlDecode(parts[1]);
+            }
+        }
+    }
+
+    return null;
+}