|
| 1 | +/*--------------------------------------------------------------------------------------------- |
| 2 | + * Copyright (c) Microsoft Corporation. All rights reserved. |
| 3 | + *--------------------------------------------------------------------------------------------*/ |
| 4 | + |
| 5 | +using System.Text.Json; |
| 6 | +using Xunit; |
| 7 | +using Xunit.Abstractions; |
| 8 | + |
| 9 | +namespace GitHub.Copilot.Test.E2E; |
| 10 | + |
| 11 | +/// <summary> |
| 12 | +/// E2E tests for the preMcpToolCall hook, verifying meta manipulation scenarios: |
| 13 | +/// setting meta, replacing meta, and removing meta. |
| 14 | +/// </summary> |
| 15 | +public class PreMcpToolCallHookE2ETests(E2ETestFixture fixture, ITestOutputHelper output) |
| 16 | + : E2ETestBase(fixture, "pre_mcp_tool_call_hook", output) |
| 17 | +{ |
| 18 | + private static string FindTestHarnessDir() |
| 19 | + { |
| 20 | + var dir = new DirectoryInfo(AppContext.BaseDirectory); |
| 21 | + while (dir != null) |
| 22 | + { |
| 23 | + var candidate = Path.Combine(dir.FullName, "test", "harness", "test-mcp-meta-echo-server.mjs"); |
| 24 | + if (File.Exists(candidate)) |
| 25 | + return Path.GetDirectoryName(candidate)!; |
| 26 | + dir = dir.Parent; |
| 27 | + } |
| 28 | + throw new InvalidOperationException("Could not find test/harness/test-mcp-meta-echo-server.mjs"); |
| 29 | + } |
| 30 | + |
| 31 | + private static Dictionary<string, McpServerConfig> CreateMetaEchoMcpConfig(string testHarnessDir) => new() |
| 32 | + { |
| 33 | + ["meta-echo"] = new McpStdioServerConfig |
| 34 | + { |
| 35 | + Command = "node", |
| 36 | + Args = [Path.Combine(testHarnessDir, "test-mcp-meta-echo-server.mjs")], |
| 37 | + WorkingDirectory = testHarnessDir, |
| 38 | + Tools = ["*"] |
| 39 | + } |
| 40 | + }; |
| 41 | + |
| 42 | + [Fact] |
| 43 | + public async Task Should_Set_Meta_Via_PreMcpToolCall_Hook() |
| 44 | + { |
| 45 | + var testHarnessDir = FindTestHarnessDir(); |
| 46 | + var hookInputs = new List<PreMcpToolCallHookInput>(); |
| 47 | + |
| 48 | + var session = await CreateSessionAsync(new SessionConfig |
| 49 | + { |
| 50 | + McpServers = CreateMetaEchoMcpConfig(testHarnessDir), |
| 51 | + Hooks = new SessionHooks |
| 52 | + { |
| 53 | + OnPreMcpToolCall = (input, invocation) => |
| 54 | + { |
| 55 | + hookInputs.Add(input); |
| 56 | + using var doc = JsonDocument.Parse("""{"injected":"by-hook","source":"test"}"""); |
| 57 | + return Task.FromResult<PreMcpToolCallHookOutput?>(new PreMcpToolCallHookOutput |
| 58 | + { |
| 59 | + MetaToUse = doc.RootElement.Clone() |
| 60 | + }); |
| 61 | + }, |
| 62 | + }, |
| 63 | + OnPermissionRequest = PermissionHandler.ApproveAll, |
| 64 | + }); |
| 65 | + |
| 66 | + var message = await session.SendAndWaitAsync(new MessageOptions |
| 67 | + { |
| 68 | + Prompt = "Use the meta-echo/echo_meta tool with value 'test-set'. Reply with just the raw tool result." |
| 69 | + }); |
| 70 | + |
| 71 | + Assert.NotNull(message); |
| 72 | + Assert.Contains("injected", message!.Data.Content); |
| 73 | + Assert.Contains("by-hook", message.Data.Content); |
| 74 | + |
| 75 | + Assert.NotEmpty(hookInputs); |
| 76 | + Assert.Equal("meta-echo", hookInputs[0].ServerName); |
| 77 | + Assert.Equal("echo_meta", hookInputs[0].ToolName); |
| 78 | + Assert.False(string.IsNullOrEmpty(hookInputs[0].WorkingDirectory)); |
| 79 | + Assert.True(hookInputs[0].Timestamp > DateTimeOffset.UnixEpoch); |
| 80 | + |
| 81 | + await session.DisposeAsync(); |
| 82 | + } |
| 83 | + |
| 84 | + [Fact] |
| 85 | + public async Task Should_Replace_Meta_Via_PreMcpToolCall_Hook() |
| 86 | + { |
| 87 | + var testHarnessDir = FindTestHarnessDir(); |
| 88 | + var hookInputs = new List<PreMcpToolCallHookInput>(); |
| 89 | + |
| 90 | + var session = await CreateSessionAsync(new SessionConfig |
| 91 | + { |
| 92 | + McpServers = CreateMetaEchoMcpConfig(testHarnessDir), |
| 93 | + Hooks = new SessionHooks |
| 94 | + { |
| 95 | + OnPreMcpToolCall = (input, invocation) => |
| 96 | + { |
| 97 | + hookInputs.Add(input); |
| 98 | + // Completely replace: ignore input.Meta entirely |
| 99 | + using var doc = JsonDocument.Parse("""{"completely":"replaced"}"""); |
| 100 | + return Task.FromResult<PreMcpToolCallHookOutput?>(new PreMcpToolCallHookOutput |
| 101 | + { |
| 102 | + MetaToUse = doc.RootElement.Clone() |
| 103 | + }); |
| 104 | + }, |
| 105 | + }, |
| 106 | + OnPermissionRequest = PermissionHandler.ApproveAll, |
| 107 | + }); |
| 108 | + |
| 109 | + var message = await session.SendAndWaitAsync(new MessageOptions |
| 110 | + { |
| 111 | + Prompt = "Use the meta-echo/echo_meta tool with value 'test-replace'. Reply with just the raw tool result." |
| 112 | + }); |
| 113 | + |
| 114 | + Assert.NotNull(message); |
| 115 | + Assert.Contains("completely", message!.Data.Content); |
| 116 | + Assert.Contains("replaced", message.Data.Content); |
| 117 | + |
| 118 | + Assert.NotEmpty(hookInputs); |
| 119 | + Assert.Equal("meta-echo", hookInputs[0].ServerName); |
| 120 | + Assert.Equal("echo_meta", hookInputs[0].ToolName); |
| 121 | + |
| 122 | + await session.DisposeAsync(); |
| 123 | + } |
| 124 | + |
| 125 | + [Fact] |
| 126 | + public async Task Should_Remove_Meta_Via_PreMcpToolCall_Hook() |
| 127 | + { |
| 128 | + var testHarnessDir = FindTestHarnessDir(); |
| 129 | + var hookInputs = new List<PreMcpToolCallHookInput>(); |
| 130 | + |
| 131 | + var session = await CreateSessionAsync(new SessionConfig |
| 132 | + { |
| 133 | + McpServers = CreateMetaEchoMcpConfig(testHarnessDir), |
| 134 | + Hooks = new SessionHooks |
| 135 | + { |
| 136 | + OnPreMcpToolCall = (input, invocation) => |
| 137 | + { |
| 138 | + hookInputs.Add(input); |
| 139 | + // Return output with null MetaToUse to signal removal |
| 140 | + return Task.FromResult<PreMcpToolCallHookOutput?>(new PreMcpToolCallHookOutput |
| 141 | + { |
| 142 | + MetaToUse = null |
| 143 | + }); |
| 144 | + }, |
| 145 | + }, |
| 146 | + OnPermissionRequest = PermissionHandler.ApproveAll, |
| 147 | + }); |
| 148 | + |
| 149 | + var message = await session.SendAndWaitAsync(new MessageOptions |
| 150 | + { |
| 151 | + Prompt = "Use the meta-echo/echo_meta tool with value 'test-remove'. Reply with just the raw tool result." |
| 152 | + }); |
| 153 | + |
| 154 | + Assert.NotNull(message); |
| 155 | + Assert.Contains("\"meta\":null", message!.Data.Content); |
| 156 | + Assert.Contains("test-remove", message.Data.Content); |
| 157 | + |
| 158 | + Assert.NotEmpty(hookInputs); |
| 159 | + Assert.Equal("meta-echo", hookInputs[0].ServerName); |
| 160 | + Assert.Equal("echo_meta", hookInputs[0].ToolName); |
| 161 | + |
| 162 | + await session.DisposeAsync(); |
| 163 | + } |
| 164 | +} |
0 commit comments