Skip to content

replace uses of os/ioutil, and use test.TempDir() in tests #20

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
crazy-max merged 1 commit into from
Feb 23, 2022
Merged

replace uses of os/ioutil, and use test.TempDir() in tests #20

Show file tree
Hide file tree
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
7 changes: 3 additions & 4 deletions clidocstool_md.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ package clidocstool
import (
"bytes"
"fmt"
"io/ioutil"
"log"
"os"
"path/filepath"
Expand Down Expand Up @@ -82,14 +81,14 @@ func (c *Client) GenMarkdownTree(cmd *cobra.Command) error {
}); err != nil {
return err
}
if err = ioutil.WriteFile(targetPath, icBuf.Bytes(), 0644); err != nil {
if err = os.WriteFile(targetPath, icBuf.Bytes(), 0644); err != nil {
return err
}
} else if err := copyFile(sourcePath, targetPath); err != nil {
return err
}

content, err := ioutil.ReadFile(targetPath)
content, err := os.ReadFile(targetPath)
if err != nil {
return err
}
Expand All @@ -116,7 +115,7 @@ func (c *Client) GenMarkdownTree(cmd *cobra.Command) error {
if err != nil {
return err
}
if err = ioutil.WriteFile(targetPath, []byte(cont), fi.Mode()); err != nil {
if err = os.WriteFile(targetPath, []byte(cont), fi.Mode()); err != nil {
return fmt.Errorf("failed to write %s: %w", targetPath, err)
}

Expand Down
13 changes: 4 additions & 9 deletions clidocstool_md_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
package clidocstool

import (
"io/ioutil"
"os"
"path"
"path/filepath"
Expand All @@ -27,11 +26,9 @@ import (

//nolint:errcheck
func TestGenMarkdownTree(t *testing.T) {
tmpdir, err := ioutil.TempDir("", "test-gen-markdown-tree")
require.NoError(t, err)
defer os.RemoveAll(tmpdir)
tmpdir := t.TempDir()

err = copyFile(path.Join("fixtures", "buildx_stop.pre.md"), path.Join(tmpdir, "buildx_stop.md"))
err := copyFile(path.Join("fixtures", "buildx_stop.pre.md"), path.Join(tmpdir, "buildx_stop.md"))
require.NoError(t, err)

c, err := New(Options{
Expand All @@ -45,12 +42,10 @@ func TestGenMarkdownTree(t *testing.T) {
for _, tt := range []string{"buildx.md", "buildx_build.md", "buildx_stop.md"} {
tt := tt
t.Run(tt, func(t *testing.T) {
fres := filepath.Join(tmpdir, tt)
require.FileExists(t, fres)
bres, err := ioutil.ReadFile(fres)
bres, err := os.ReadFile(filepath.Join(tmpdir, tt))
require.NoError(t, err)

bexc, err := ioutil.ReadFile(path.Join("fixtures", tt))
bexc, err := os.ReadFile(path.Join("fixtures", tt))
require.NoError(t, err)
assert.Equal(t, string(bexc), string(bres))
})
Expand Down
13 changes: 4 additions & 9 deletions clidocstool_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
package clidocstool

import (
"io/ioutil"
"os"
"path"
"path/filepath"
Expand Down Expand Up @@ -175,11 +174,9 @@ func init() {

//nolint:errcheck
func TestGenAllTree(t *testing.T) {
tmpdir, err := ioutil.TempDir("", "test-gen-all-tree")
require.NoError(t, err)
defer os.RemoveAll(tmpdir)
tmpdir := t.TempDir()

err = copyFile(path.Join("fixtures", "buildx_stop.pre.md"), path.Join(tmpdir, "buildx_stop.md"))
err := copyFile(path.Join("fixtures", "buildx_stop.pre.md"), path.Join(tmpdir, "buildx_stop.md"))
require.NoError(t, err)

c, err := New(Options{
Expand All @@ -193,12 +190,10 @@ func TestGenAllTree(t *testing.T) {
for _, tt := range []string{"buildx.md", "buildx_build.md", "buildx_stop.md", "docker_buildx.yaml", "docker_buildx_build.yaml", "docker_buildx_stop.yaml"} {
tt := tt
t.Run(tt, func(t *testing.T) {
fres := filepath.Join(tmpdir, tt)
require.FileExists(t, fres)
bres, err := ioutil.ReadFile(fres)
bres, err := os.ReadFile(filepath.Join(tmpdir, tt))
require.NoError(t, err)

bexc, err := ioutil.ReadFile(path.Join("fixtures", tt))
bexc, err := os.ReadFile(path.Join("fixtures", tt))
require.NoError(t, err)
assert.Equal(t, string(bexc), string(bres))
})
Expand Down
3 changes: 1 addition & 2 deletions clidocstool_yaml.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ package clidocstool
import (
"fmt"
"io"
"io/ioutil"
"log"
"os"
"path/filepath"
Expand Down Expand Up @@ -376,7 +375,7 @@ func (c *Client) loadLongDescription(parentCmd *cobra.Command) error {
}
mdFile := strings.ReplaceAll(name, " ", "_") + ".md"
sourcePath := filepath.Join(c.source, mdFile)
content, err := ioutil.ReadFile(sourcePath)
content, err := os.ReadFile(sourcePath)
if os.IsNotExist(err) {
log.Printf("WARN: %s does not exist, skipping Markdown examples for YAML doc\n", mdFile)
continue
Expand Down
11 changes: 3 additions & 8 deletions clidocstool_yaml_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
package clidocstool

import (
"io/ioutil"
"os"
"path"
"path/filepath"
Expand All @@ -27,9 +26,7 @@ import (

//nolint:errcheck
func TestGenYamlTree(t *testing.T) {
tmpdir, err := ioutil.TempDir("", "test-gen-yaml-tree")
require.NoError(t, err)
defer os.RemoveAll(tmpdir)
tmpdir := t.TempDir()

c, err := New(Options{
Root: buildxCmd,
Expand All @@ -42,12 +39,10 @@ func TestGenYamlTree(t *testing.T) {
for _, tt := range []string{"docker_buildx.yaml", "docker_buildx_build.yaml", "docker_buildx_stop.yaml"} {
tt := tt
t.Run(tt, func(t *testing.T) {
fres := filepath.Join(tmpdir, tt)
require.FileExists(t, fres)
bres, err := ioutil.ReadFile(fres)
bres, err := os.ReadFile(filepath.Join(tmpdir, tt))
Comment on lines -45 to +42
Copy link
Member Author

@thaJeztah thaJeztah Feb 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The require.FileExists() check felt a bit redundant here, as os.ReadFile() will already return an error if the file doesn't exist (which would also include the name of the missing file.

Copy link
Member

@crazy-max crazy-max Feb 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes indeed

require.NoError(t, err)

bexc, err := ioutil.ReadFile(path.Join("fixtures", tt))
bexc, err := os.ReadFile(path.Join("fixtures", tt))
require.NoError(t, err)
assert.Equal(t, string(bexc), string(bres))
})
Expand Down