chore(ioutil): move from io/ioutil to io and os packages (ChainSafe#2030

) * refactor: move from io/ioutil to io and os packages The io/ioutil package has been deprecated as of Go 1.16, see https://golang.org/doc/go1.16#ioutil. This commit replaces the existing io/ioutil functions with their new definitions in io and os packages. Signed-off-by: Eng Zer Jun <engzerjun@gmail.com> * ci: use Go 1.17 for check-description Signed-off-by: Eng Zer Jun <engzerjun@gmail.com> * refactor(test): use t.tempDir() for auto cleanup Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
timwu20 · Dec 6, 2021 · 73daafb · 73daafb
1 parent 57cb6b6
commit 73daafb
Show file tree

Hide file tree

Showing 45 changed files with 104 additions and 158 deletions.
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -34,6 +34,9 @@ jobs:
     if: ${{ github.actor != 'dependabot[bot]' }}
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/setup-go@v2
+        with:
+          go-version: "1.17.x"
       - uses: actions/checkout@v2
       - name: Checks PR has title and body description
         run: |

diff --git a/cmd/gossamer/import_runtime.go b/cmd/gossamer/import_runtime.go
@@ -6,7 +6,7 @@ package main
 import (
 	"encoding/json"
 	"fmt"
-	"io/ioutil"
+	"os"
 	"path/filepath"
 
 	"github.com/ChainSafe/gossamer/lib/genesis"
@@ -15,7 +15,7 @@ import (
 var defaultGenesisSpecPath = "./chain/gssmr/genesis-spec.json"
 
 func createGenesisWithRuntime(fp string) (string, error) {
-	runtime, err := ioutil.ReadFile(filepath.Clean(fp))
+	runtime, err := os.ReadFile(filepath.Clean(fp))
 	if err != nil {
 		return "", err
 	}

diff --git a/cmd/gossamer/import_runtime_test.go b/cmd/gossamer/import_runtime_test.go
@@ -5,7 +5,6 @@ package main
 
 import (
 	"encoding/json"
-	"io/ioutil"
 	"os"
 	"testing"
 
@@ -20,11 +19,11 @@ func TestCreateGenesisWithRuntime(t *testing.T) {
 
 	testCode := []byte("somecode")
 	testHex := common.BytesToHex(testCode)
-	testFile, err := ioutil.TempFile("", "testcode-*.wasm")
+	testFile, err := os.CreateTemp("", "testcode-*.wasm")
 	require.NoError(t, err)
 	defer os.Remove(testFile.Name())
 
-	err = ioutil.WriteFile(testFile.Name(), testCode, 0777)
+	err = os.WriteFile(testFile.Name(), testCode, 0777)
 	require.NoError(t, err)
 
 	out, err := createGenesisWithRuntime(testFile.Name())

diff --git a/cmd/gossamer/main_test.go b/cmd/gossamer/main_test.go
@@ -8,7 +8,6 @@ import (
 	"bytes"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"sync"
@@ -91,7 +90,7 @@ func (tt *TestExecCommand) Run(name string, args ...string) {
 func (tt *TestExecCommand) ExpectExit() {
 	var output []byte
 	tt.withKillTimeout(func() {
-		output, _ = ioutil.ReadAll(tt.stdout)
+		output, _ = io.ReadAll(tt.stdout)
 	})
 	tt.WaitExit()
 	if tt.Cleanup != nil {
@@ -104,7 +103,7 @@ func (tt *TestExecCommand) ExpectExit() {
 
 func (tt *TestExecCommand) GetOutput() (stdout []byte, stderr []byte) {
 	tt.withSigTimeout(func() {
-		stdout, _ = ioutil.ReadAll(tt.stdout)
+		stdout, _ = io.ReadAll(tt.stdout)
 		stderr = tt.stderr.buf.Bytes()
 	})
 	tt.WaitExit()
@@ -220,8 +219,7 @@ func TestInvalidCommand(t *testing.T) {
 func TestInitCommand_RenameNodeWhenCalled(t *testing.T) {
 	genesisPath := utils.GetGssmrGenesisRawPath()
 
-	tempDir, err := ioutil.TempDir("", "gossamer-maintest-")
-	require.Nil(t, err)
+	tempDir := t.TempDir()
 
 	nodeName := dot.RandomNodeName()
 	init := runTestGossamer(t,
@@ -234,7 +232,6 @@ func TestInitCommand_RenameNodeWhenCalled(t *testing.T) {
 	)
 
 	stdout, stderr := init.GetOutput()
-	require.Nil(t, err)
 
 	t.Log("init gossamer output, ", "stdout", string(stdout), "stderr", string(stderr))
 
@@ -250,7 +247,6 @@ func TestInitCommand_RenameNodeWhenCalled(t *testing.T) {
 	)
 
 	stdout, stderr = init.GetOutput()
-	require.Nil(t, err)
 
 	t.Log("init gossamer output, ", "stdout", string(stdout), "stderr", string(stderr))
 

diff --git a/cmd/gossamer/utils.go b/cmd/gossamer/utils.go
@@ -6,7 +6,6 @@ package main
 import (
 	"bufio"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"strconv"
 	"strings"
@@ -110,7 +109,7 @@ func newTestConfig(t *testing.T) *dot.Config {
 func newTestConfigWithFile(t *testing.T) (*dot.Config, *os.File) {
 	cfg := newTestConfig(t)
 
-	file, err := ioutil.TempFile(cfg.Global.BasePath, "config-")
+	file, err := os.CreateTemp(cfg.Global.BasePath, "config-")
 	require.NoError(t, err)
 
 	tomlCfg := dotConfigToToml(cfg)

diff --git a/dot/build_spec_test.go b/dot/build_spec_test.go
@@ -6,7 +6,7 @@ package dot
 import (
 	"encoding/json"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"os"
 	"testing"
 
@@ -62,7 +62,7 @@ func TestBuildFromGenesis_WhenGenesisDoesNotExists(t *testing.T) {
 }
 
 func TestWriteGenesisSpecFileWhenFileAlreadyExists(t *testing.T) {
-	f, err := ioutil.TempFile("", "existing file data")
+	f, err := os.CreateTemp("", "existing file data")
 	require.NoError(t, err)
 	defer os.Remove(f.Name())
 
@@ -105,7 +105,7 @@ func TestWriteGenesisSpecFile(t *testing.T) {
 		require.NoError(t, err)
 		defer file.Close()
 
-		genesisBytes, err := ioutil.ReadAll(file)
+		genesisBytes, err := io.ReadAll(file)
 		require.NoError(t, err)
 
 		gen := new(genesis.Genesis)

diff --git a/dot/core/service_test.go b/dot/core/service_test.go
@@ -6,7 +6,6 @@ package core
 import (
 	"errors"
 	"fmt"
-	"io/ioutil"
 	"math/big"
 	"os"
 	"sort"
@@ -549,7 +548,7 @@ func TestService_HandleRuntimeChanges(t *testing.T) {
 	err = s.blockState.HandleRuntimeChanges(ts, parentRt, bhash1)
 	require.NoError(t, err)
 
-	testRuntime, err := ioutil.ReadFile(updateNodeRuntimeWasmPath)
+	testRuntime, err := os.ReadFile(updateNodeRuntimeWasmPath)
 	require.NoError(t, err)
 
 	ts.Set(common.CodeKey, testRuntime)
@@ -578,7 +577,7 @@ func TestService_HandleRuntimeChanges(t *testing.T) {
 func TestService_HandleCodeSubstitutes(t *testing.T) {
 	s := NewTestService(t, nil)
 
-	testRuntime, err := ioutil.ReadFile(runtime.POLKADOT_RUNTIME_FP)
+	testRuntime, err := os.ReadFile(runtime.POLKADOT_RUNTIME_FP)
 	require.NoError(t, err)
 
 	blockHash := common.MustHexToHash("0x86aa36a140dfc449c30dbce16ce0fea33d5c3786766baa764e33f336841b9e29") // hash for known test code substitution
@@ -626,7 +625,7 @@ func TestService_HandleRuntimeChangesAfterCodeSubstitutes(t *testing.T) {
 	require.NoError(t, err)
 	require.Equal(t, codeHashBefore, parentRt.GetCodeHash()) // codeHash should remain unchanged after code substitute
 
-	testRuntime, err := ioutil.ReadFile(runtime.POLKADOT_RUNTIME_FP)
+	testRuntime, err := os.ReadFile(runtime.POLKADOT_RUNTIME_FP)
 	require.NoError(t, err)
 
 	ts, err = s.storageState.TrieState(nil)

diff --git a/dot/core/test_helpers.go b/dot/core/test_helpers.go
@@ -4,7 +4,6 @@
 package core
 
 import (
-	"io/ioutil"
 	"path/filepath"
 	"testing"
 
@@ -45,8 +44,7 @@ func NewTestService(t *testing.T, cfg *Config) *Service {
 	cfg.LogLvl = 3
 
 	var stateSrvc *state.Service
-	testDatadirPath, err := ioutil.TempDir("/tmp", "test-datadir-*")
-	require.NoError(t, err)
+	testDatadirPath := t.TempDir()
 
 	gen, genTrie, genHeader := genesis.NewTestGenesisWithTrieAndHeader(t)
 
@@ -58,7 +56,7 @@ func NewTestService(t *testing.T, cfg *Config) *Service {
 		stateSrvc = state.NewService(config)
 		stateSrvc.UseMemDB()
 
-		err = stateSrvc.Initialise(gen, genHeader, genTrie)
+		err := stateSrvc.Initialise(gen, genHeader, genTrie)
 		require.Nil(t, err)
 
 		err = stateSrvc.Start()
@@ -88,6 +86,7 @@ func NewTestService(t *testing.T, cfg *Config) *Service {
 	if cfg.Runtime == nil {
 		rtCfg := &wasmer.Config{}
 
+		var err error
 		rtCfg.Storage, err = rtstorage.NewTrieState(genTrie)
 		require.NoError(t, err)
 

diff --git a/dot/digest/digest_test.go b/dot/digest/digest_test.go
@@ -4,7 +4,6 @@
 package digest
 
 import (
-	"io/ioutil"
 	"math/big"
 	"testing"
 	"time"
@@ -23,8 +22,7 @@ import (
 )
 
 func newTestHandler(t *testing.T) *Handler {
-	testDatadirPath, err := ioutil.TempDir("/tmp", "test-datadir-*")
-	require.NoError(t, err)
+	testDatadirPath := t.TempDir()
 
 	config := state.Config{
 		Path:     testDatadirPath,
@@ -34,7 +32,7 @@ func newTestHandler(t *testing.T) *Handler {
 	stateSrvc.UseMemDB()
 
 	gen, genTrie, genHeader := genesis.NewTestGenesisWithTrieAndHeader(t)
-	err = stateSrvc.Initialise(gen, genHeader, genTrie)
+	err := stateSrvc.Initialise(gen, genHeader, genTrie)
 	require.NoError(t, err)
 
 	err = stateSrvc.Start()

diff --git a/dot/import.go b/dot/import.go
@@ -6,7 +6,7 @@ package dot
 import (
 	"encoding/json"
 	"errors"
-	"io/ioutil"
+	"os"
 	"path/filepath"
 
 	"github.com/ChainSafe/gossamer/dot/state"
@@ -41,7 +41,7 @@ func ImportState(basepath, stateFP, headerFP string, firstSlot uint64) error {
 }
 
 func newTrieFromPairs(filename string) (*trie.Trie, error) {
-	data, err := ioutil.ReadFile(filepath.Clean(filename))
+	data, err := os.ReadFile(filepath.Clean(filename))
 	if err != nil {
 		return nil, err
 	}
@@ -71,7 +71,7 @@ func newTrieFromPairs(filename string) (*trie.Trie, error) {
 }
 
 func newHeaderFromFile(filename string) (*types.Header, error) {
-	data, err := ioutil.ReadFile(filepath.Clean(filename))
+	data, err := os.ReadFile(filepath.Clean(filename))
 	if err != nil {
 		return nil, err
 	}

diff --git a/dot/import_test.go b/dot/import_test.go
@@ -5,8 +5,8 @@ package dot
 
 import (
 	"encoding/json"
-	"io/ioutil"
 	"math/big"
+	"os"
 	"testing"
 
 	"github.com/ChainSafe/gossamer/dot/types"
@@ -20,7 +20,7 @@ import (
 func setupStateFile(t *testing.T) string {
 	filename := "../lib/runtime/test_data/kusama/block1482002.out"
 
-	data, err := ioutil.ReadFile(filename)
+	data, err := os.ReadFile(filename)
 	require.NoError(t, err)
 
 	rpcPairs := make(map[string]interface{})
@@ -32,7 +32,7 @@ func setupStateFile(t *testing.T) string {
 	require.NoError(t, err)
 
 	fp := "./test_data/state.json"
-	err = ioutil.WriteFile(fp, bz, 0777)
+	err = os.WriteFile(fp, bz, 0777)
 	require.NoError(t, err)
 
 	return fp
@@ -41,7 +41,7 @@ func setupStateFile(t *testing.T) string {
 func setupHeaderFile(t *testing.T) string {
 	headerStr := "{\"digest\":{\"logs\":[\"0x0642414245b501013c0000009659bd0f0000000070edad1c9064fff78cb18435223d8adaf5ea04c24b1a8766e3dc01eb03cc6a0c11b79793d4e31cc0990838229c44fed1669a7c7c79e1e6d0a96374d6496728069d1ef739e290497a0e3b728fa88fcbdd3a5504e0efde0242e7a806dd4fa9260c\",\"0x054241424501019e7f28dddcf27c1e6b328d5694c368d5b2ec5dbe0e412ae1c98f88d53be4d8502fac571f3f19c9caaf281a673319241e0c5095a683ad34316204088a36a4bd86\"]},\"extrinsicsRoot\":\"0xda26dc8c1455f8f81cae12e4fc59e23ce961b2c837f6d3f664283af906d344e0\",\"number\":\"0x169d12\",\"parentHash\":\"0x3b45c9c22dcece75a30acc9c2968cb311e6b0557350f83b430f47559db786975\",\"stateRoot\":\"0x09f9ca28df0560c2291aa16b56e15e07d1e1927088f51356d522722aa90ca7cb\"}"
 	fp := "./test_data/header.json"
-	err := ioutil.WriteFile(fp, []byte(headerStr), 0777)
+	err := os.WriteFile(fp, []byte(headerStr), 0777)
 	require.NoError(t, err)
 	return fp
 }
@@ -78,8 +78,7 @@ func TestNewHeaderFromFile(t *testing.T) {
 }
 
 func TestImportState(t *testing.T) {
-	basepath, err := ioutil.TempDir("", "gossamer-test-*")
-	require.NoError(t, err)
+	basepath := t.TempDir()
 
 	cfg := NewTestConfig(t)
 	require.NotNil(t, cfg)
@@ -92,7 +91,7 @@ func TestImportState(t *testing.T) {
 	cfg.Init.Genesis = genFile.Name()
 
 	cfg.Global.BasePath = basepath
-	err = InitNode(cfg)
+	err := InitNode(cfg)
 	require.NoError(t, err)
 
 	stateFP := setupStateFile(t)

diff --git a/dot/network/utils.go b/dot/network/utils.go
@@ -9,7 +9,6 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"io/ioutil"
 	mrand "math/rand"
 	"os"
 	"path"
@@ -78,7 +77,7 @@ func loadKey(fp string) (crypto.PrivKey, error) {
 	if _, err := os.Stat(pth); os.IsNotExist(err) {
 		return nil, nil
 	}
-	keyData, err := ioutil.ReadFile(filepath.Clean(pth))
+	keyData, err := os.ReadFile(filepath.Clean(pth))
 	if err != nil {
 		return nil, err
 	}

diff --git a/dot/rpc/http_test.go b/dot/rpc/http_test.go
@@ -8,7 +8,6 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"net"
 	"net/http"
 	"testing"
@@ -279,7 +278,7 @@ func PostRequest(t *testing.T, url string, data io.Reader) (int, []byte) {
 
 	defer res.Body.Close()
 
-	resBody, err := ioutil.ReadAll(res.Body)
+	resBody, err := io.ReadAll(res.Body)
 	require.NoError(t, err)
 
 	responseData := new(bytes.Buffer)

diff --git a/dot/rpc/modules/chain_test.go b/dot/rpc/modules/chain_test.go
@@ -4,7 +4,6 @@
 package modules
 
 import (
-	"io/ioutil"
 	"math/big"
 	"path/filepath"
 	"testing"
@@ -338,8 +337,7 @@ func TestChainGetFinalizedHeadByRound(t *testing.T) {
 }
 
 func newTestStateService(t *testing.T) *state.Service {
-	testDatadirPath, err := ioutil.TempDir("/tmp", "test-datadir-*")
-	require.NoError(t, err)
+	testDatadirPath := t.TempDir()
 
 	config := state.Config{
 		Path:     testDatadirPath,
@@ -350,7 +348,7 @@ func newTestStateService(t *testing.T) *state.Service {
 
 	gen, genTrie, genesisHeader := genesis.NewTestGenesisWithTrieAndHeader(t)
 
-	err = stateSrvc.Initialise(gen, genesisHeader, genTrie)
+	err := stateSrvc.Initialise(gen, genesisHeader, genTrie)
 	require.NoError(t, err)
 
 	err = stateSrvc.Start()