GODRIVER-2876 Automatically clean up mtest resources. #1347
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
matthewdale
force-pushed
the
godriver2876-clean-up-mtest
branch
from
931e97d
to
107b807
Compare
matthewdale
requested review from
qingyang-hu and
blink1073
and removed request for
a team
qingyang-hu
reviewed
Aug 9, 2023
mongo/integration/mtest/mongotest.go
Outdated
Comment on lines
190
to
193
| // Deprecated: Close is now called automatically by [testing.T.Cleanup] at the | ||
| // end of a test, so it does not need to be called explicitly. It is safe to | ||
| // call multiple times. | ||
| func (t *T) Close() { |
There was a problem hiding this comment.
Do we still need to expose the Close()?
There was a problem hiding this comment.
No, there is now no use case for calling it. I waffled on un-exporting vs deprecating Close because we know there are external users of mtest who would probably be impacted by us un-exporting it. However, mtest is documented as unstable so we should be able to change it.
I will un-export it.
Clement-Jean
added a commit
to Clement-Jean/grpc-go-course
that referenced
this pull request
Nov 14, 2023
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.
GODRIVER-2876
Summary
Automatically clean up
mtestresources by using T.Cleanup.Background & Motivation
Currently all tests must run
defer mt.Closeafter callingmtest.Newto make suremtestcleans up all of the server-side resources it created to run the test. That pattern is error-prone, possibly leading to tests that don't clean up server-side resources.Instead, we should make the cleanup process automatic by using T.Cleanup and deprecate
mt.Close.