[GODRIVER-2100] Audit and improve the existing test suite Created: 21/Jul/21  Updated: 21/Dec/22  Resolved: 01/Dec/22

Status: Closed
Project: Go Driver
Component/s: Testing
Affects Version/s: None
Fix Version/s: None

Type: Epic Priority: Minor - P4
Reporter: Benji Rewis (Inactive) Assignee: Benji Rewis (Inactive)
Resolution: Done Votes: 0
Labels: size-medium
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Quarter: FY23Q4
Documentation Changes: Not Needed
Start date:

 Description   

Summary

With the creation of a new testing policy, we should give some attention to our testing suite. This epic contains a number of testing QOL improvements and tasks.

The following is a subset of the tasks in the epic and their potential improvements to the driver. Improving the testing suite will make development on the Go driver both faster and of higher quality.

Improvement Impact
Refactor mtest.T mtest code would be easier to use and less bloated
Document testing practices Both Mongo developers and external contributors would have public resources to write good Go driver tests with consistent style
Enable data-race detector Data races would be (in some cases) immediately discovered instead of creating difficult-to-debug issues down the line
Improve how topologies are tested Opting out of topologies instead of in may provide significantly more test coverage with new tests
Use testing.Short to skip longer tests A meaningful subset of the testing suite would be far easier to run locally

Motivation

Who is the affected end user?

Developers contributing to the Go driver.

How does this affect the end user?

The testing suite has some inconsistencies and key areas for improvement. 

Is this issue urgent?

Evaluating the performance of our driver has come up recently and being more clear in/adherent to our testing policy is important.

Is this ticket required by a downstream team?

No.

Is this ticket only for tests?

Yes.

 



 Comments   
Comment by Rachelle Palmer [ 21/Dec/22 ]

Comment by PM Bot [ 27/Jan/22 ]

If you are not logged in, you can view the tickets in this epic by following this link.

Comment by PM Bot [ 19/Jan/22 ]

If you are not logged in, you can view the tickets in this epic by following this link.

Generated at Thu Feb 08 08:37:49 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.