POC subtestWrapper

[prestonvasquez]

GODRIVER-2310

Create a subtest wrapper for the documentation example tests, specifically for use in the TestDocumentationExamples test function. This will help in testing individual functions within the TestDocumentationExamples test without decoupling the underlying functionality. For example, using the proposed refactor the following command runs only the InsertExamples subtest

go test -run TestDocumentationExamples/InsertExamples

This will also help with debugging in text editors, such as VS Code, where you can use configurations that launches only on specific documentation example subtests

// example vs code test configuration
{
    "name": "Launch Example Subtest",
    "type": "go",
    "request": "launch",
    "mode": "test",
    "program": "${fileDirname}",
    "args": ["-test.run", "TestDocumentationExamples/InsertExamples"]
}

In VS Code, there is no existing inline subtest selection.

[benjirewis]

I see you've included GODRIVER-2310 in the PR description, but just want to note that this PR does not include the snapshot examples. I like the refactor to make sure each example is an explicit subtest, but I wonder about the necessity of the subtestWrapper struct and associated methods.

[benjirewis]

While I do enjoy the abstraction here, is the usage of subtestWrapper strictly necessary? What would you think about just making each of these an explicit subtest? As in:

t.Run("InsertExamples", func(t *testing.T) {
   documentation_examples.InsertExamples(t, db)
}
t.Run("QueryToplevelFieldsExamples", func(t *testing.T) {
   documentation_examples.QueryToplevelFieldsExamples(t, db)
}
...

That might be more readable?

[prestonvasquez]

The only real value of the wrapper is to avoid multi-line subtests but that's just cosmetic. I'm more than happy to do it this way.

[benjirewis]

You could also use an mtest.Testing instance for the StableAPIStrictCountExample like mtest.Options().MinServerVersion("5.0").MaxServerVersion("6.0").Auth(true) instead of the odd testutil and os.Getenv logic I wrote below.