Refactor agent integration test API #2764
Merged
Conversation
This file contains 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
moskyb
force-pushed
the
refactor-agent-integration-test-api
branch
from
5e3cd05 to
67c7673
Compare
moskyb
changed the title
patrobinson
approved these changes
May 2, 2024
agent/integration/test_helpers.go
Outdated
| return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) { | ||
| b, _ := io.ReadAll(req.Body) | ||
| req.Body.Close() | ||
| req.Body = io.NopCloser(bytes.NewBuffer(b)) |
There was a problem hiding this comment.
What's the purpose of this?
There was a problem hiding this comment.
right... this function records the contents of the body of the request so that consumers can look through it later on. unfortunately, the body of an HTTP request is an io.ReadCloser, which is forward-read-only. this means that if we read the body, then tried to read it again, it wouldn't work (it would either return an EOF error, or it would return an empty read body, i can't remember which).
regardless, this little dance is basically:
- read the body into a
[]bytecaledb - close the body (we're done with it)
- replace the body with a copy of
bthat is also anio.ReadCloser
i'll add a comment explaining this, it's not super clear just from reading it
moskyb
force-pushed
the
refactor-agent-integration-test-api
branch
2 times, most recently
from
8db8a08 to
8d9360a
Compare
moskyb
force-pushed
the
refactor-agent-integration-test-api
branch
2 times, most recently
from
d381589 to
890da64
Compare
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
The agent integration tests use a mock server to pretend to be the Buildkite Agent API, but it's extremely brittle, and quite frankly, some of the worst code i've ever written. it's difficult to add new endpoints, and callers of the server can't modify its behaviour in any way, which is frustrating when you need to test against specific behaviour.
This PR refactors that server to use Go 1.22's new
http.HandleFunc("GET /some/path/{with}/path/params")gear, cleans up the handler code to not be godawful, and allows callers to add endpoints, and override the existing ones.It also adds an error return to the
runJobhelper that gets used in agent integration tests, as we might in future want to test failures of this codeTesting
go test ./...). Buildkite employees may check this if the pipeline has run automatically.go fmt ./...)