Assert against result object instead of recorder #609
Merged
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.
I noticed that there is a subtle issue in the test setup, which could potentially lead to false positive test results.
According to the documentation of
httptest.ResponseRecorder
(see their example), you are supposed to run the test assertions against the result object returned byrecorder.Result()
, rather than against the recorder object itself.The recorder object basically tracks all interactions of the request handlers with the response. However, this may be different from what the HTTP server actually sends out to the client.
One such edge-case scenario is when you try to set response headers after having flushed out the response headers. In this case, any attempt to modify the headers via
res.Headers().Set()
will silently result in a no-op. The response object issued byrec.Result()
correctly reflects that, whereas the recorder object itself incorrectly yields the seemingly set header.Content-Type
header was set