- Notifications
You must be signed in to change notification settings - Fork945
Add initial conformance test#48
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,362 @@ | ||
| //go:build conformance | ||
| package conformance_test | ||
| import ( | ||
| "bufio" | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| "reflect" | ||
| "strings" | ||
| "testing" | ||
| "github.com/docker/docker/api/types/container" | ||
| "github.com/docker/docker/api/types/network" | ||
| "github.com/docker/docker/client" | ||
| "github.com/docker/docker/pkg/stdcopy" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
| type maintainer string | ||
| const ( | ||
| anthropic maintainer = "anthropic" | ||
| github maintainer = "github" | ||
| ) | ||
| type testLogWriter struct { | ||
| t *testing.T | ||
| } | ||
| func (w testLogWriter) Write(p []byte) (n int, err error) { | ||
| w.t.Log(string(p)) | ||
| return len(p), nil | ||
| } | ||
| func start(t *testing.T, m maintainer) server { | ||
| var image string | ||
| if m == github { | ||
| image = "github/github-mcp-server" | ||
| } else { | ||
| image = "mcp/github" | ||
| } | ||
| ctx := context.Background() | ||
| dockerClient, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation()) | ||
| require.NoError(t, err) | ||
| containerCfg := &container.Config{ | ||
| OpenStdin: true, | ||
| AttachStdin: true, | ||
| AttachStdout: true, | ||
| AttachStderr: true, | ||
| Env: []string{ | ||
| fmt.Sprintf("GITHUB_PERSONAL_ACCESS_TOKEN=%s", os.Getenv("GITHUB_PERSONAL_ACCESS_TOKEN")), | ||
| }, | ||
| Image: image, | ||
| } | ||
| resp, err := dockerClient.ContainerCreate( | ||
| ctx, | ||
| containerCfg, | ||
| &container.HostConfig{}, | ||
| &network.NetworkingConfig{}, | ||
| nil, | ||
| "") | ||
| require.NoError(t, err) | ||
| t.Cleanup(func() { | ||
| require.NoError(t, dockerClient.ContainerRemove(ctx, resp.ID, container.RemoveOptions{Force: true})) | ||
| }) | ||
| hijackedResponse, err := dockerClient.ContainerAttach(ctx, resp.ID, container.AttachOptions{ | ||
| Stream: true, | ||
| Stdin: true, | ||
| Stdout: true, | ||
| Stderr: true, | ||
| }) | ||
| require.NoError(t, err) | ||
| t.Cleanup(func() { hijackedResponse.Close() }) | ||
| require.NoError(t, dockerClient.ContainerStart(ctx, resp.ID, container.StartOptions{})) | ||
| serverStart := make(chan serverStartResult) | ||
| go func() { | ||
| prOut, pwOut := io.Pipe() | ||
| prErr, pwErr := io.Pipe() | ||
| go func() { | ||
| // Ignore error, we should be done? | ||
| // TODO: maybe check for use of closed network connection specifically | ||
| _, _ = stdcopy.StdCopy(pwOut, pwErr, hijackedResponse.Reader) | ||
| pwOut.Close() | ||
| pwErr.Close() | ||
| }() | ||
| bufferedStderr := bufio.NewReader(prErr) | ||
| line, err := bufferedStderr.ReadString('\n') | ||
| if err != nil { | ||
| serverStart <- serverStartResult{err: err} | ||
| } | ||
| if strings.TrimSpace(line) != "GitHub MCP Server running on stdio" { | ||
| serverStart <- serverStartResult{ | ||
| err: fmt.Errorf("unexpected server output: %s", line), | ||
| } | ||
| return | ||
| } | ||
| serverStart <- serverStartResult{ | ||
| server: server{ | ||
| m: m, | ||
| log: testLogWriter{t}, | ||
| stdin: hijackedResponse.Conn, | ||
| stdout: bufio.NewReader(prOut), | ||
| }, | ||
| } | ||
| }() | ||
| t.Logf("waiting for %s server to start...", m) | ||
| serveResult := <-serverStart | ||
| require.NoError(t, serveResult.err, "expected the server to start successfully") | ||
| return serveResult.server | ||
| } | ||
| func TestCapabilities(t *testing.T) { | ||
| anthropicServer := start(t, anthropic) | ||
| githubServer := start(t, github) | ||
| req := newInitializeRequest( | ||
| initializeRequestParams{ | ||
| ProtocolVersion: "2025-03-26", | ||
| Capabilities: clientCapabilities{}, | ||
| ClientInfo: clientInfo{ | ||
| Name: "ConformanceTest", | ||
| Version: "0.0.1", | ||
| }, | ||
| }, | ||
| ) | ||
| require.NoError(t, anthropicServer.send(req)) | ||
| var anthropicInitializeResponse initializeResponse | ||
| require.NoError(t, anthropicServer.receive(&anthropicInitializeResponse)) | ||
| require.NoError(t, githubServer.send(req)) | ||
| var ghInitializeResponse initializeResponse | ||
| require.NoError(t, githubServer.receive(&ghInitializeResponse)) | ||
| // Any capabilities in the anthropic response should be present in the github response | ||
| // (though the github response may have additional capabilities) | ||
| if diff := diffNonNilFields(anthropicInitializeResponse.Result.Capabilities, ghInitializeResponse.Result.Capabilities, ""); diff != "" { | ||
| t.Errorf("capabilities mismatch:\n%s", diff) | ||
| } | ||
| } | ||
| func diffNonNilFields(a, b interface{}, path string) string { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Don't look too closely. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Avert your eyes. CollaboratorAuthor
| ||
| var sb strings.Builder | ||
| va := reflect.ValueOf(a) | ||
| vb := reflect.ValueOf(b) | ||
| if !va.IsValid() { | ||
| return "" | ||
| } | ||
| if va.Kind() == reflect.Ptr { | ||
| if va.IsNil() { | ||
| return "" | ||
| } | ||
| if !vb.IsValid() || vb.IsNil() { | ||
| sb.WriteString(path + "\n") | ||
| return sb.String() | ||
| } | ||
| va = va.Elem() | ||
| vb = vb.Elem() | ||
| } | ||
| if va.Kind() != reflect.Struct || vb.Kind() != reflect.Struct { | ||
| return "" | ||
| } | ||
| t := va.Type() | ||
| for i := range va.NumField() { | ||
| field := t.Field(i) | ||
| if !field.IsExported() { | ||
| continue | ||
| } | ||
| subPath := field.Name | ||
| if path != "" { | ||
| subPath = fmt.Sprintf("%s.%s", path, field.Name) | ||
| } | ||
| fieldA := va.Field(i) | ||
| fieldB := vb.Field(i) | ||
| switch fieldA.Kind() { | ||
| case reflect.Ptr: | ||
| if fieldA.IsNil() { | ||
| continue // not required | ||
| } | ||
| if fieldB.IsNil() { | ||
| sb.WriteString(subPath + "\n") | ||
| continue | ||
| } | ||
| sb.WriteString(diffNonNilFields(fieldA.Interface(), fieldB.Interface(), subPath)) | ||
| case reflect.Struct: | ||
| sb.WriteString(diffNonNilFields(fieldA.Interface(), fieldB.Interface(), subPath)) | ||
| default: | ||
| zero := reflect.Zero(fieldA.Type()) | ||
| if !reflect.DeepEqual(fieldA.Interface(), zero.Interface()) { | ||
| // fieldA is non-zero; now check that fieldB matches | ||
| if !reflect.DeepEqual(fieldA.Interface(), fieldB.Interface()) { | ||
| sb.WriteString(subPath + "\n") | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return sb.String() | ||
| } | ||
| type serverStartResult struct { | ||
| server server | ||
| err error | ||
| } | ||
| type server struct { | ||
| m maintainer | ||
| log io.Writer | ||
| stdin io.Writer | ||
| stdout *bufio.Reader | ||
| } | ||
| func (s server) send(req request) error { | ||
| b, err := req.marshal() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| fmt.Fprintf(s.log, "sending %s: %s\n", s.m, string(b)) | ||
| n, err := s.stdin.Write(append(b, '\n')) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if n != len(b)+1 { | ||
| return fmt.Errorf("wrote %d bytes, expected %d", n, len(b)+1) | ||
| } | ||
| return nil | ||
| } | ||
| func (s server) receive(res response) error { | ||
| line, err := s.stdout.ReadBytes('\n') | ||
| if err != nil { | ||
| if err == io.EOF { | ||
| return fmt.Errorf("EOF after reading %s", string(line)) | ||
| } | ||
| return err | ||
| } | ||
| fmt.Fprintf(s.log, "received from %s: %s\n", s.m, string(line)) | ||
| return res.unmarshal(line) | ||
| } | ||
| type jsonRPRCRequest[params any] struct { | ||
| JSONRPC string `json:"jsonrpc"` | ||
| ID int `json:"id"` | ||
| Method string `json:"method"` | ||
| Params params `json:"params"` | ||
| } | ||
| type jsonRPRCResponse[result any] struct { | ||
| JSONRPC string `json:"jsonrpc"` | ||
| ID int `json:"id"` | ||
| Method string `json:"method"` | ||
| Result result `json:"result"` | ||
| } | ||
| type request interface { | ||
| marshal() ([]byte, error) | ||
| } | ||
| type response interface { | ||
| unmarshal([]byte) error | ||
| } | ||
| func newInitializeRequest(params initializeRequestParams) initializeRequest { | ||
| return initializeRequest{ | ||
| jsonRPRCRequest: jsonRPRCRequest[initializeRequestParams]{ | ||
| JSONRPC: "2.0", | ||
| ID: 1, | ||
| Method: "initialize", | ||
| Params: params, | ||
| }, | ||
| } | ||
| } | ||
| type initializeRequest struct { | ||
| jsonRPRCRequest[initializeRequestParams] | ||
| } | ||
| func (r initializeRequest) marshal() ([]byte, error) { | ||
| return json.Marshal(r) | ||
| } | ||
| type initializeRequestParams struct { | ||
| ProtocolVersion string `json:"protocolVersion"` | ||
| Capabilities clientCapabilities `json:"capabilities"` | ||
| ClientInfo clientInfo `json:"clientInfo"` | ||
| } | ||
| type clientCapabilities struct{} // don't actually care about any of these right now | ||
| type clientInfo struct { | ||
| Name string `json:"name"` | ||
| Version string `json:"version"` | ||
| } | ||
| type initializeResponse struct { | ||
| jsonRPRCResponse[initializeResult] | ||
| } | ||
| func (r *initializeResponse) unmarshal(b []byte) error { | ||
| return json.Unmarshal(b, r) | ||
| } | ||
| type initializeResult struct { | ||
| ProtocolVersion string `json:"protocolVersion"` | ||
| Capabilities serverCapabilities `json:"capabilities"` | ||
| ServerInfo serverInfo `json:"serverInfo"` | ||
| } | ||
| type serverCapabilities struct { | ||
| Logging *struct{} `json:"logging,omitempty"` | ||
| Prompts *struct { | ||
| ListChanged bool `json:"listChanged,omitempty"` | ||
| } `json:"prompts,omitempty"` | ||
| Resources *struct { | ||
| Subscribe bool `json:"subscribe,omitempty"` | ||
| ListChanged bool `json:"listChanged,omitempty"` | ||
| } `json:"resources,omitempty"` | ||
| Tools *struct { | ||
| ListChanged bool `json:"listChanged,omitempty"` | ||
| } `json:"tools,omitempty"` | ||
| } | ||
| type serverInfo struct { | ||
| Name string `json:"name"` | ||
| Version string `json:"version"` | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.