Add simple e2e test #330
Merged
Add simple e2e test #330
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a basic end-to-end (e2e) test to simplify validation of the MCP server Docker image and its GitHub API integration. Key changes include:
- A new e2e test written in Go to verify server initialization and the "get_me" tool.
- A helper function to build the Docker image before running tests.
- Documentation updates in the README on how to run the e2e tests.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| e2e/e2e_test.go | Added e2e tests that build the Docker image, initialize the client, and validate GitHub API responses. |
| e2e/README.md | Added documentation on the purpose and usage of the e2e tests. |
Comments suppressed due to low confidence (1)
e2e/e2e_test.go:84
- Consider renaming this new GitHub API client variable (for example, to ghClient) to avoid shadowing the existing 'client' variable, improving code clarity.
client := github.NewClient(nil).WithAuthToken(e2eServerToken)
williammartin
force-pushed
the
wm/add-e2e-test
branch
from
a8f75e9 to
0010c8e
Compare
toby
previously approved these changes
Apr 22, 2025
williammartin
force-pushed
the
wm/add-e2e-test
branch
from
0010c8e to
e74569e
Compare
|
Bypassing codeowner review rule because the only change I made after review from @toby was to expand e2e to End to End in the README. |
|
Impressed 😁 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Whilst reviewing dependabot updates, I really wanted a fast way to build a Docker image, start the server, call a tool and validate the result, as opposed to doing it manually.
The primary audience for the current e2e test is myself, and any other maintainer, and in future possibly other contributors. See the readme for some limitations on the approach, which is why I don't necessarily want to make all contributors first class audience, though there's no reason that it couldn't be used.
The implementation is pretty MVP, and that's also intentional, until we see if and where it provides value.