Remove uses of deprecated io/ioutil, and use new t.TempDir() and t.Cleanup() in tests by thaJeztah · Pull Request #3443 · docker/cli

thaJeztah · 2022-02-25T15:09:59Z

I had a "WIP" branch for this locally, and decided to finish the work; there's quite some uses of this package, so I split this up into commits per-package for easier reviewing.

Current versions of Go also added t.TempDIr() and t.Cleanup() for tests, so while at it, I updated tests to use those (which simplified the tests).

Finally, I updated the golangci-lint configuration to prevent the package from accidentally being added again.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

The package has been deprecated since Go 1.16: https://go.dev/doc/go1.16#ioutil Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

codecov-commenter · 2022-02-25T15:12:10Z

Codecov Report

Merging #3443 (8c3ae38) into master (df7adf4) will not change coverage.
The diff coverage is 70.21%.

@@ Coverage Diff @@## master #3443 +/- ##
=======================================
Coverage 58.24% 58.24% =======================================
Files 287 287 Lines 24155 24155 =======================================
Hits 14070 14070 Misses 9225 9225 Partials 860 860

thaJeztah · 2022-02-25T15:12:10Z

When reviewing, I recommend doing so per commit (as github doesn't like showing the whole diff 😅) most of them should be easy to review, but perhaps some may need closer looking (where I refactored or removed some test-utils for t.TempDir() etc.

thaJeztah · 2022-02-25T15:31:09Z

@silvin-lubecki @ndeloof @crazy-max ptal 🤗

crazy-max · 2022-02-25T15:35:08Z

+ depguard:
+ list-type: blacklist
+ include-go-root: true
+ packages:
+ # The io/ioutil package has been deprecated.
+ # https://go.dev/doc/go1.16#ioutil
+ - io/ioutil


we should have that in buildkit too (cc @tonistiigi)

crazy-max

LGTM

ndeloof

LGTM
I like use of t.TempDir() that don't force us to manage a cleanup function 👍

thaJeztah · 2022-02-25T15:55:24Z

Yes! t.TempDir() is really nice!!

I also want to have a look at uses of defer altogether in tests (not really a priority though), and perhaps change them to use t.Cleanup() instead. Probably doesn't make a lot of difference, but t.Cleanup() was designed for that, so perhaps there's advantages (e.g. perhaps it takes time taken by those into account when reporting test-durations etc)

thaJeztah · 2022-02-25T15:57:34Z

ok, let me get this one in; thanks for reviewing!

thaJeztah added 30 commits February 25, 2022 15:35

cli/command/checkpoint: remove deprecated io/ioutil
8dc5334
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/config: remove deprecated io/ioutil
bc1790c
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/container: remove deprecated io/ioutil
e946bf0
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/context: remove deprecated io/ioutil and use t.TempDir()
76b4735
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/image: remove deprecated io/ioutil and use t.TempDir()
d14b5bf
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/manifest: remove deprecated io/ioutil and use t.TempDir()
43795ec
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/context: remove deprecated io/ioutil
f28c063
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/node: remove deprecated io/ioutil
9bdeb09
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/plugin: remove deprecated io/ioutil
f61aab5
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/registry: remove deprecated io/ioutil
3b3a0b8
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/secret: remove deprecated io/ioutil
c558df7
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/service: remove deprecated io/ioutil
d1f26de
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/stack: remove deprecated io/ioutil
d59330f
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/swarm: remove deprecated io/ioutil and use t.TempDir()
78cb61c
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/system: remove deprecated io/ioutil
e0299ff
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/trust: remove deprecated io/ioutil and use t.TempDir()
b5dce3c
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command/volume: remove deprecated io/ioutil
cca73bf
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/command: remove deprecated io/ioutil and use t.TempDir()
3f7e7bf
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/compose: remove deprecated io/ioutil
b9f0340
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/config: remove deprecated io/ioutil and use t.TempDir()
71575ab
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/context: remove deprecated io/ioutil and use t.TempDir()
cca80cd
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/manifest: remove deprecated io/ioutil and use t.TempDir()
58cf16d
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli/trust: remove deprecated io/ioutil and use t.TempDir()
1e54bca
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cli: remove deprecated io/ioutil
86db51e
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

cmd/docker: remove deprecated io/ioutil
0e3197e
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

docs/yaml: remove deprecated io/ioutil and use t.TempDir()
39ace68
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

e2e: remove deprecated io/ioutil and use t.TempDir()
e89af84
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

internal/test: remove deprecated io/ioutil
7491c5a
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

man: remove deprecated io/ioutil and use t.TempDir()
85754c9
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

opts: remove deprecated io/ioutil and use t.Cleanup()
38e6257
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah added 2 commits February 25, 2022 16:01

cli-plugins/manager: remove uses of deprecated io/ioutil
6c06950
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

golangci-lint: prevent io/ioutil from being used
8c3ae38
The package has been deprecated since Go 1.16: https://go.dev/doc/go1.16#ioutil Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah added status/2-code-review kind/refactor PR's that refactor, or clean-up code labels Feb 25, 2022

thaJeztah added this to the 21.xx milestone Feb 25, 2022

thaJeztah requested a review from silvin-lubecki as a code owner February 25, 2022 15:09

crazy-max reviewed Feb 25, 2022
View reviewed changes

crazy-max approved these changes Feb 25, 2022
View reviewed changes

ndeloof approved these changes Feb 25, 2022
View reviewed changes

thaJeztah merged commit ae3b0b3 into docker:masterFeb 25, 2022

thaJeztah deleted the remove_ioutil branch February 25, 2022 15:57

thaJeztah mentioned this pull request Mar 10, 2022
Remove uses of deprecated io/ioutil docker/buildx#995
Merged

corhere mentioned this pull request Feb 27, 2023
[20.10 backport] Prepare for Go 1.19 upgrade #4055
Merged

Navigation Menu

Uh oh!

Remove uses of deprecated io/ioutil, and use new t.TempDir() and t.Cleanup() in tests - #3443

Remove uses of deprecated io/ioutil, and use new t.TempDir() and t.Cleanup() in tests#3443
thaJeztah merged 32 commits into
docker:masterfrom
thaJeztah:remove_ioutil

thaJeztah commented Feb 25, 2022

Uh oh!

codecov-commenter commented Feb 25, 2022•
edited
Loading

Uh oh!

thaJeztah commented Feb 25, 2022

Uh oh!

thaJeztah commented Feb 25, 2022

Uh oh!

crazy-maxFeb 25, 2022

Uh oh!

crazy-max left a comment

Uh oh!

ndeloof left a comment

Uh oh!

thaJeztah commented Feb 25, 2022

Uh oh!

thaJeztah commented Feb 25, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

thaJeztah commented Feb 25, 2022

Uh oh!

codecov-commenter commented Feb 25, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

thaJeztah commented Feb 25, 2022

Uh oh!

thaJeztah commented Feb 25, 2022

Uh oh!

crazy-maxFeb 25, 2022

Choose a reason for hiding this comment

Uh oh!

crazy-max left a comment

Choose a reason for hiding this comment

Uh oh!

ndeloof left a comment

Choose a reason for hiding this comment

Uh oh!

thaJeztah commented Feb 25, 2022

Uh oh!

thaJeztah commented Feb 25, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Feb 25, 2022•
edited
Loading