Split TestCursor into separate test functions. #2179
+244
−232
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
API Change ReportNo changes found! |
🧪 Performance ResultsCommit SHA: 274e85dThe following benchmark tests for version 68af5c4a782d900007408db1 had statistically significant changes (i.e., |z-score| > 1.96):
For a comprehensive view of all microbenchmark results for this PR's commit, please check out the Evergreen perf task for this patch. |
matthewdale
added
enhancement
review-priority-low
There was a problem hiding this comment.
Pull Request Overview
This pull request refactors the TestCursor function by splitting its nested subtests into separate, independent test functions. This improves test maintainability and readability by reducing the complexity of deeply-nested test structures.
Key changes:
- Extracted four subtests from
TestCursorinto standalone test functions:TestCursor_TryNext,TestCursor_RemainingBatchLength,TestCursor_All, andTestCursor_Close - Moved the "set batchSize" subtest to remain within the original
TestCursorfunction - Relocated variable declarations to their appropriate scopes in the new test functions
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
prestonvasquez
requested changes
Aug 28, 2025
|
|
||
| var docs []bson.D | ||
| err = cursor.All(context.Background(), &docs) | ||
| assert.NotNil(mt, err, "expected change stream error, got nil") |
There was a problem hiding this comment.
Suggested change
| assert.NotNil(mt, err, "expected change stream error, got nil") | |
| require.Error(mt, err, "expected change stream error, got nil") |
| // Call All with the canceled context and expect context.Canceled. | ||
| var docs []bson.D | ||
| err = cur.All(canceledCtx, &docs) | ||
| assert.NotNil(mt, err, "expected error for All, got nil") |
There was a problem hiding this comment.
Suggested change
| assert.NotNil(mt, err, "expected error for All, got nil") | |
| require.Error(mt, err, "expected error for All, got nil") |
| // Find with batchSize 2 so All will run getMore for next 3 docs and error. | ||
| cur, err := mt.Coll.Find(context.Background(), bson.D{}, | ||
| options.Find().SetBatchSize(2)) | ||
| assert.Nil(mt, err, "Find error: %v", err) |
There was a problem hiding this comment.
Suggested change
| assert.Nil(mt, err, "Find error: %v", err) | |
| require.NoError(mt, err, "Find error: %v", err) |
| assert.Nil(mt, err, "Find error: %v", err) | ||
|
|
||
| err = cursor.Close(context.Background()) | ||
| assert.NotNil(mt, err, "expected change stream error, got nil") |
There was a problem hiding this comment.
Suggested change
| assert.NotNil(mt, err, "expected change stream error, got nil") | |
| require.Error(mt, err, "expected change stream error, got nil") |
| }) | ||
| initCollection(mt, mt.Coll) | ||
| cursor, err := mt.Coll.Find(context.Background(), bson.D{}, options.Find().SetBatchSize(2)) | ||
| assert.Nil(mt, err, "Find error: %v", err) |
There was a problem hiding this comment.
Suggested change
| assert.Nil(mt, err, "Find error: %v", err) | |
| require.NoError(mt, err, "Find error: %v", err) |
| findRes := mtest.CreateCursorResponse(50, "foo.bar", mtest.FirstBatch) | ||
| mt.AddMockResponses(findRes) | ||
| cursor, err := mt.Coll.Find(context.Background(), bson.D{}) | ||
| assert.Nil(mt, err, "Find error: %v", err) |
There was a problem hiding this comment.
Suggested change
| assert.Nil(mt, err, "Find error: %v", err) | |
| require.NoError(mt, err, "Find error: %v", err) |
| assert.Nil(mt, err, "InsertOne error: %v", err) | ||
|
|
||
| cursor, err := mt.Coll.Find(context.Background(), bson.D{}, options.Find().SetCursorType(options.Tailable)) | ||
| assert.Nil(mt, err, "Find error: %v", err) |
There was a problem hiding this comment.
Suggested change
| assert.Nil(mt, err, "Find error: %v", err) | |
| require.NoError(mt, err, "Find error: %v", err) |
| // insert a document because a tailable cursor will only have a non-zero ID if the initial Find matches | ||
| // at least one document | ||
| _, err := mt.Coll.InsertOne(context.Background(), bson.D{{"x", 1}}) | ||
| assert.Nil(mt, err, "InsertOne error: %v", err) |
There was a problem hiding this comment.
Suggested change
| assert.Nil(mt, err, "InsertOne error: %v", err) | |
| require.NoError(mt, err, "InsertOne error: %v", err) |
|
|
||
| initCollection(mt, mt.Coll) | ||
| cursor, err := mt.Coll.Find(context.Background(), bson.D{}) | ||
| assert.Nil(mt, err, "Find error: %v", err) |
There was a problem hiding this comment.
Suggested change
| assert.Nil(mt, err, "Find error: %v", err) | |
| require.NoError(mt, err, "Find error: %v", err) |
|
|
||
| // The initial batch length should be equal to the batchSize. Do batchSize Next calls to exhaust the current | ||
| // batch and assert that no getMore was done. | ||
| assertCursorBatchLength(mt, cursor, batchSize) |
There was a problem hiding this comment.
It's not part of the changes in this PR but assertCursorBatchLength should call mt.Helper().
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.
Summary
TestCursorthat test specificCursormethods into separate test functions.Background & Motivation
Very long test functions with deeply-nested subtests are difficult to read, maintain, and run. It's better to split up some subtests into separate test functions.