test: use T.TempDir to create temporary test directory
#703
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
This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The
directory created by `t.TempDir` is automatically removed when the test
and all its subtests complete.
Prior to this commit, temporary directory created using `ioutil.TempDir`
needs to be removed manually by calling `os.RemoveAll`, which is omitted
in some tests. The error handling boilerplate e.g.
defer func() {
if err := os.RemoveAll(dir); err != nil {
t.Fatal(err)
}
}
is also tedious, but `t.TempDir` handles this for us nicely.
Reference: https://pkg.go.dev/testing#T.TempDir
Signed-off-by: Eng Zer Jun <[email protected]>
sio4
approved these changes
Apr 10, 2022
fasmat
approved these changes
Apr 11, 2022
|
Thanks for your contribution! Looks good to me, I'm always happy to get rid of *util packages from our imports. |
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.
A testing cleanup.
This pull request replaces
ioutil.TempDirwitht.TempDir. We can use theT.TempDirfunction from thetestingpackage to create temporary directory. The directory created byT.TempDiris automatically removed when the test and all its subtests complete.Reference: https://pkg.go.dev/testing#T.TempDir
This PR also introduces a minor change to the
sqlitedialect. The file descriptor is now properly closed inCreateDB().func (m *sqlite) CreateDB() error { if err != nil { return fmt.Errorf("could not create SQLite database '%s': %w", m.ConnectionDetails.Database, err) } - _, err = os.Create(m.ConnectionDetails.Database) + f, err := os.Create(m.ConnectionDetails.Database) if err != nil { return fmt.Errorf("could not create SQLite database '%s': %w", m.ConnectionDetails.Database, err) } + _ = f.Close()This is required after we use
t.TempDirto create the temporary directory in the testTestSqlite_CreateDB. Otherwise the test will fail on Windows.