Skip to content

GODRIVER-2075 Update "mtest.T.Get*Event()" documentation #1407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 3, 2023
Merged

GODRIVER-2075 Update "mtest.T.Get*Event()" documentation #1407

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions mongo/integration/mtest/mongotest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,11 +278,9 @@ func (t *T) ClearMockResponses() {
t.mockDeployment.clearResponses()
}

// GetStartedEvent returns the most recent CommandStartedEvent, or nil if one is not present.
// GetStartedEvent returns the least recent CommandStartedEvent, or nil if one is not present.
// This can only be called once per event.
func (t *T) GetStartedEvent() *event.CommandStartedEvent {
// TODO(GODRIVER-2075): GetStartedEvent documents that it returns the most recent event, but actually returns the first
// TODO event. Update either the documentation or implementation.
if len(t.started) == 0 {
return nil
}
Expand All @@ -291,11 +289,9 @@ func (t *T) GetStartedEvent() *event.CommandStartedEvent {
return e
}

// GetSucceededEvent returns the most recent CommandSucceededEvent, or nil if one is not present.
// GetSucceededEvent returns the least recent CommandSucceededEvent, or nil if one is not present.
// This can only be called once per event.
func (t *T) GetSucceededEvent() *event.CommandSucceededEvent {
// TODO(GODRIVER-2075): GetSucceededEvent documents that it returns the most recent event, but actually returns the
// TODO first event. Update either the documentation or implementation.
if len(t.succeeded) == 0 {
return nil
}
Expand All @@ -304,11 +300,9 @@ func (t *T) GetSucceededEvent() *event.CommandSucceededEvent {
return e
}

// GetFailedEvent returns the most recent CommandFailedEvent, or nil if one is not present.
// GetFailedEvent returns the least recent CommandFailedEvent, or nil if one is not present.
// This can only be called once per event.
func (t *T) GetFailedEvent() *event.CommandFailedEvent {
// TODO(GODRIVER-2075): GetFailedEvent documents that it returns the most recent event, but actually returns the first
// TODO event. Update either the documentation or implementation.
if len(t.failed) == 0 {
return nil
}
Expand Down