fix: stop using the deprecated io/ioutil package

ipfs · Aug 22, 2023 · c20ed1a · c20ed1a
1 parent 9086077
commit c20ed1a
Show file tree

Hide file tree

Showing 16 changed files with 47 additions and 54 deletions.
diff --git a/cli_test.go b/cli_test.go
@@ -4,8 +4,9 @@ import (
 	"path"
 	"testing"
 
-	"github.com/ipfs/ipfs-ds-convert/testutil"
 	"os"
+
+	"github.com/ipfs/ipfs-ds-convert/testutil"
 )
 
 func TestBasicConvert(t *testing.T) {

diff --git a/config/util.go b/config/util.go
@@ -2,11 +2,11 @@ package config
 
 import (
 	"encoding/json"
-	"io/ioutil"
+	"os"
 )
 
 func Load(path string, out *map[string]interface{}) error {
-	cfgbytes, err := ioutil.ReadFile(path)
+	cfgbytes, err := os.ReadFile(path)
 	if err != nil {
 		return err
 	}

diff --git a/convert/checks_test.go b/convert/checks_test.go
@@ -2,7 +2,6 @@ package convert_test
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path"
 	"runtime"
@@ -22,7 +21,7 @@ func TestInvalidRepoVersion(t *testing.T) {
 	dir, _close, _, _ := testutil.PrepareTest(t, 10, 10)
 	defer _close(t)
 
-	err := ioutil.WriteFile(path.Join(dir, "version"), []byte("147258369"), 0664)
+	err := os.WriteFile(path.Join(dir, "version"), []byte("147258369"), 0664)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -107,7 +106,7 @@ func TestInvalidVersion(t *testing.T) {
 	dir, _close, _, _ := testutil.PrepareTest(t, 10, 10)
 	defer _close(t)
 
-	err := ioutil.WriteFile(path.Join(dir, "version"), []byte("a"), 0600)
+	err := os.WriteFile(path.Join(dir, "version"), []byte("a"), 0600)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -128,7 +127,7 @@ func TestInvalidSpecJson(t *testing.T) {
 	dir, _close, _, _ := testutil.PrepareTest(t, 10, 10)
 	defer _close(t)
 
-	err := ioutil.WriteFile(path.Join(dir, repo.SpecsFile), []byte("}"), 0600)
+	err := os.WriteFile(path.Join(dir, repo.SpecsFile), []byte("}"), 0600)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -149,7 +148,7 @@ func TestInvalidSpecFile(t *testing.T) {
 	dir, _close, _, _ := testutil.PrepareTest(t, 10, 10)
 	defer _close(t)
 
-	err := ioutil.WriteFile(path.Join(dir, repo.SpecsFile), []byte("{}"), 0600)
+	err := os.WriteFile(path.Join(dir, repo.SpecsFile), []byte("{}"), 0600)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -191,7 +190,7 @@ func TestInvalidConfigJson(t *testing.T) {
 	dir, _close, _, _ := testutil.PrepareTest(t, 10, 10)
 	defer _close(t)
 
-	err := ioutil.WriteFile(path.Join(dir, repo.ConfigFile), []byte("}"), 0600)
+	err := os.WriteFile(path.Join(dir, repo.ConfigFile), []byte("}"), 0600)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -212,7 +211,7 @@ func TestInvalidConfigFile(t *testing.T) {
 	dir, _close, _, _ := testutil.PrepareTest(t, 10, 10)
 	defer _close(t)
 
-	err := ioutil.WriteFile(path.Join(dir, repo.ConfigFile), []byte("{}"), 0600)
+	err := os.WriteFile(path.Join(dir, repo.ConfigFile), []byte("{}"), 0600)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -231,7 +230,7 @@ func TestInvalidConfigFile(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	err = ioutil.WriteFile(path.Join(dir, repo.ConfigFile), []byte(`{"Datastore":{}}`), 0600)
+	err = os.WriteFile(path.Join(dir, repo.ConfigFile), []byte(`{"Datastore":{}}`), 0600)
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/convert/convert.go b/convert/convert.go
@@ -2,7 +2,6 @@ package convert
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 
@@ -135,7 +134,7 @@ func (c *Conversion) saveNewSpec(backup bool) (err error) {
 		return err
 	}
 
-	err = ioutil.WriteFile(filepath.Join(c.path, repo.SpecsFile), []byte(toDiskId), 0660)
+	err = os.WriteFile(filepath.Join(c.path, repo.SpecsFile), []byte(toDiskId), 0660)
 	if err != nil {
 		return err
 	}
@@ -151,12 +150,12 @@ func (c *Conversion) saveNewSpec(backup bool) (err error) {
 }
 
 func (c *Conversion) backupSpec() error {
-	backupFile, err := ioutil.TempFile(c.path, "datastore_spec_backup")
+	backupFile, err := os.CreateTemp(c.path, "datastore_spec_backup")
 	if err != nil {
 		return err
 	}
 
-	specData, err := ioutil.ReadFile(filepath.Join(c.path, repo.SpecsFile))
+	specData, err := os.ReadFile(filepath.Join(c.path, repo.SpecsFile))
 	if err != nil {
 		return err
 	}

diff --git a/convert/convert_test.go b/convert/convert_test.go
@@ -47,7 +47,7 @@ func TestLossyConvert(t *testing.T) {
 	t.Errorf("expected error 'adding missing to src spec: couldn't find best match for specA /'")
 }
 
-//should cover noop case in convert.go
+// should cover noop case in convert.go
 func TestNoopConvert(t *testing.T) {
 	//Prepare repo
 	dir, _close, s1, s2 := testutil.PrepareTest(t, 3000, 3000)

diff --git a/convert/copy.go b/convert/copy.go
@@ -3,7 +3,6 @@ package convert
 import (
 	"fmt"
 	"io"
-	"io/ioutil"
 	"os"
 	"path"
 	"path/filepath"
@@ -131,7 +130,7 @@ func (c *Copy) openDatastores() (err error) {
 	}
 	c.logStep("open datastore at %s", c.path)
 
-	c.newDsDir, err = ioutil.TempDir(c.path, "ds-convert")
+	c.newDsDir, err = os.MkdirTemp(c.path, "ds-convert")
 	if err != nil {
 		return errors.Wrapf(err, "error creating temp datastore at %s", c.path)
 	}
@@ -231,7 +230,7 @@ func CopyKeys(fromDs repo.Datastore, toDs repo.Datastore) error {
 }
 
 func (c *Copy) swapDatastores() (err error) {
-	c.oldDsDir, err = ioutil.TempDir(c.path, "ds-convert-old")
+	c.oldDsDir, err = os.MkdirTemp(c.path, "ds-convert-old")
 	if err != nil {
 		return errors.Wrapf(err, "error creating temp datastore at %s", c.path)
 	}

diff --git a/convert/copy_test.go b/convert/copy_test.go
@@ -2,7 +2,6 @@ package convert
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
@@ -57,7 +56,7 @@ var (
 )
 
 func TestInvalidSpecLeft(t *testing.T) {
-	d, err := ioutil.TempDir(os.TempDir(), "ds-convert-test-")
+	d, err := os.MkdirTemp(os.TempDir(), "ds-convert-test-")
 	if err != nil {
 		t.Fatalf(err.Error())
 	}
@@ -76,7 +75,7 @@ func TestInvalidSpecLeft(t *testing.T) {
 }
 
 func TestInvalidSpecRight(t *testing.T) {
-	d, err := ioutil.TempDir(os.TempDir(), "ds-convert-test-")
+	d, err := os.MkdirTemp(os.TempDir(), "ds-convert-test-")
 	if err != nil {
 		t.Fatalf(err.Error())
 	}
@@ -94,7 +93,7 @@ func TestInvalidSpecRight(t *testing.T) {
 }
 
 func TestOpenNonexist(t *testing.T) {
-	d, err := ioutil.TempDir(os.TempDir(), "ds-convert-test-")
+	d, err := os.MkdirTemp(os.TempDir(), "ds-convert-test-")
 	if err != nil {
 		t.Fatalf(err.Error())
 	}

diff --git a/convert/prepare.go b/convert/prepare.go
@@ -2,7 +2,6 @@ package convert
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strconv"
@@ -15,7 +14,7 @@ import (
 )
 
 func (c *Conversion) checkRepoVersion() error {
-	vstr, err := ioutil.ReadFile(filepath.Join(c.path, "version"))
+	vstr, err := os.ReadFile(filepath.Join(c.path, "version"))
 	if err != nil {
 		return err
 	}

diff --git a/revert/log.go b/revert/log.go
@@ -29,8 +29,8 @@ type ActionLogger struct {
 	file *os.File
 }
 
-//NewActionLogger creates revert action logger which logs actions needed to
-//revert conversion steps
+// NewActionLogger creates revert action logger which logs actions needed to
+// revert conversion steps
 func NewActionLogger(repoPath string) (*ActionLogger, error) {
 	if _, err := os.Stat(path.Join(repoPath, ConvertLog)); !os.IsNotExist(err) {
 		return nil, fmt.Errorf("Log file %s already exists, you may want to run revert", path.Join(repoPath, ConvertLog))

diff --git a/revert/log_test.go b/revert/log_test.go
@@ -1,7 +1,6 @@
 package revert_test
 
 import (
-	"io/ioutil"
 	"os"
 	"path"
 	"strings"
@@ -11,12 +10,12 @@ import (
 )
 
 func TestNewActionLogger(t *testing.T) {
-	d, err := ioutil.TempDir(os.TempDir(), "ds-convert-test-")
+	d, err := os.MkdirTemp(os.TempDir(), "ds-convert-test-")
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	err = ioutil.WriteFile(path.Join(d, revert.ConvertLog), []byte{}, 0664)
+	err = os.WriteFile(path.Join(d, revert.ConvertLog), []byte{}, 0664)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -38,7 +37,7 @@ func TestNewActionLogger(t *testing.T) {
 }
 
 func TestLog(t *testing.T) {
-	d, err := ioutil.TempDir(os.TempDir(), "ds-convert-test-")
+	d, err := os.MkdirTemp(os.TempDir(), "ds-convert-test-")
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -54,7 +53,7 @@ func TestLog(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	b, err := ioutil.ReadFile(path.Join(d, revert.ConvertLog))
+	b, err := os.ReadFile(path.Join(d, revert.ConvertLog))
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/revert/revert.go b/revert/revert.go
@@ -10,10 +10,10 @@ import (
 	"github.com/ipfs/ipfs-ds-convert/repo"
 
 	"encoding/json"
+
 	lock "github.com/ipfs/go-fs-lock"
 	"github.com/ipfs/ipfs-ds-convert/config"
 	"github.com/pkg/errors"
-	"io/ioutil"
 )
 
 var Log = logging.New(os.Stderr, "revert ", logging.LstdFlags)
@@ -222,7 +222,7 @@ func fixConfig(repoPath string) error {
 		return err
 	}
 
-	err = ioutil.WriteFile(filepath.Join(repoPath, repo.ConfigFile), []byte(confBytes), 0660)
+	err = os.WriteFile(filepath.Join(repoPath, repo.ConfigFile), []byte(confBytes), 0660)
 	if err != nil {
 		return err
 	}

diff --git a/revert/revert_test.go b/revert/revert_test.go
@@ -1,7 +1,7 @@
 package revert_test
 
 import (
-	"io/ioutil"
+	"os"
 	"path"
 	"strings"
 	"testing"
@@ -136,7 +136,7 @@ func TestBasicConvertRevertUnknownStep(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	ioutil.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"unknownactiontype","arg":[]}`), 0600)
+	os.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"unknownactiontype","arg":[]}`), 0600)
 
 	err = revert.Revert(dir, true, false, false)
 	if !strings.Contains(err.Error(), "unknown revert step 'unknownactiontype'") {
@@ -176,35 +176,35 @@ func TestBasicConvertRevertInvalidArgs(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	ioutil.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"`+revert.ActionRemove+`","arg":[]}`), 0600)
+	os.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"`+revert.ActionRemove+`","arg":[]}`), 0600)
 
 	err = revert.Revert(dir, true, false, false)
 	if !strings.Contains(err.Error(), "revert remove: arg count 0 != 1") {
 		t.Fatal(err)
 	}
 
-	ioutil.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"`+revert.ActionMove+`","arg":[]}`), 0600)
+	os.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"`+revert.ActionMove+`","arg":[]}`), 0600)
 
 	err = revert.Revert(dir, true, false, false)
 	if !strings.Contains(err.Error(), "revert move: arg count 0 != 2") {
 		t.Fatal(err)
 	}
 
-	ioutil.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"`+revert.ActionMkdir+`","arg":[]}`), 0600)
+	os.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"`+revert.ActionMkdir+`","arg":[]}`), 0600)
 
 	err = revert.Revert(dir, true, false, false)
 	if !strings.Contains(err.Error(), "revert mkdir: arg count 0 != 1") {
 		t.Fatal(err)
 	}
 
-	ioutil.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"`+revert.ActionCleanup+`","arg":["a"]}`), 0600)
+	os.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"`+revert.ActionCleanup+`","arg":["a"]}`), 0600)
 
 	err = revert.Revert(dir, true, false, true)
 	if !strings.Contains(err.Error(), "cannot cleanup after failed conversion") {
 		t.Fatal(err)
 	}
 
-	ioutil.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"`+revert.ActionCleanup+`","arg":[]}`+"\n"+`{"action":"`+revert.ActionDone+`","arg":[]}`), 0600)
+	os.WriteFile(path.Join(dir, revert.ConvertLog), []byte(`{"action":"`+revert.ActionCleanup+`","arg":[]}`+"\n"+`{"action":"`+revert.ActionDone+`","arg":[]}`), 0600)
 
 	err = revert.Revert(dir, true, false, true)
 	if !strings.Contains(err.Error(), "cleanup arg count 0 != 1") {
@@ -222,7 +222,7 @@ func TestRevertMkdirChecks(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	err = ioutil.WriteFile(path.Join(dir, revert.ConvertLog), []byte(l), 0600)
+	err = os.WriteFile(path.Join(dir, revert.ConvertLog), []byte(l), 0600)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -243,7 +243,7 @@ func TestRevertMoveChecks(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	err = ioutil.WriteFile(path.Join(dir, revert.ConvertLog), []byte(l), 0600)
+	err = os.WriteFile(path.Join(dir, revert.ConvertLog), []byte(l), 0600)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -258,7 +258,7 @@ func TestRevertMoveChecks(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	err = ioutil.WriteFile(path.Join(dir, revert.ConvertLog), []byte(l), 0600)
+	err = os.WriteFile(path.Join(dir, revert.ConvertLog), []byte(l), 0600)
 	if err != nil {
 		t.Fatal(err)
 	}