Replace deprecated io/ioutil functions (#1452)

The io/ioutil package has been deprecated as of Go 1.16 [1]. This commit replaces the existing io/ioutil functions with their new definitions in io and os packages. [1]: https://golang.org/doc/go1.16#ioutil Signed-off-by: Eng Zer Jun <[email protected]>
johnkerl · Dec 20, 2023 · f4cf166 · f4cf166
1 parent c6b7455
commit f4cf166
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 52 deletions.
diff --git a/pkg/climain/mlrcli_shebang.go b/pkg/climain/mlrcli_shebang.go
@@ -2,7 +2,7 @@ package climain
 
 import (
 	"fmt"
-	"io/ioutil"
+	"os"
 	"regexp"
 	"strings"
 
@@ -49,7 +49,7 @@ func maybeInterpolateDashS(args []string) ([]string, error) {
 	remainingArgs := args[3:]
 
 	// Read the bytes in the filename given after -s.
-	byteContents, rerr := ioutil.ReadFile(filename)
+	byteContents, rerr := os.ReadFile(filename)
 	if rerr != nil {
 		return nil, fmt.Errorf("mlr: cannot read %s: %v", filename, rerr)
 	}
@@ -68,7 +68,7 @@ func maybeInterpolateDashS(args []string) ([]string, error) {
 
 	if stripComments {
 		re := regexp.MustCompile(`#.*`)
-		for i, _ := range lines {
+		for i := range lines {
 			lines[i] = re.ReplaceAllString(lines[i], "")
 		}
 	}

diff --git a/pkg/entrypoint/entrypoint.go b/pkg/entrypoint/entrypoint.go
@@ -7,7 +7,6 @@ package entrypoint
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path"
 
@@ -135,7 +134,7 @@ func processInPlace(
 		containingDirectory := path.Dir(fileName)
 		// Names like ./mlr-in-place-2148227797 and ./mlr-in-place-1792078347,
 		// as revealed by printing handle.Name().
-		handle, err := ioutil.TempFile(containingDirectory, "mlr-in-place-")
+		handle, err := os.CreateTemp(containingDirectory, "mlr-in-place-")
 		if err != nil {
 			return err
 		}

diff --git a/pkg/lib/readfiles.go b/pkg/lib/readfiles.go
@@ -6,7 +6,6 @@
 package lib
 
 import (
-	"io/ioutil"
 	"os"
 	"strings"
 
@@ -34,10 +33,10 @@ func LoadStringsFromFileOrDir(path string, extension string) ([]string, error) {
 	}
 }
 
-// LoadStringFromFile is just a wrapper around ioutil.ReadFile,
+// LoadStringFromFile is just a wrapper around os.ReadFile,
 // with a cast from []byte to string.
 func LoadStringFromFile(filename string) (string, error) {
-	data, err := ioutil.ReadFile(filename)
+	data, err := os.ReadFile(filename)
 	if err != nil {
 		return "", err
 	}
@@ -51,14 +50,18 @@ func LoadStringFromFile(filename string) (string, error) {
 func LoadStringsFromDir(dirname string, extension string) ([]string, error) {
 	dslStrings := make([]string, 0)
 
-	entries, err := ioutil.ReadDir(dirname)
+	f, err := os.Open(dirname)
 	if err != nil {
 		return nil, err
 	}
+	defer f.Close()
 
-	for i := range entries {
-		entry := &entries[i]
-		name := (*entry).Name()
+	names, err := f.Readdirnames(-1)
+	if err != nil {
+		return nil, err
+	}
+
+	for _, name := range names {
 		if !strings.HasSuffix(name, extension) {
 			continue
 		}

diff --git a/pkg/lib/util.go b/pkg/lib/util.go
@@ -2,7 +2,6 @@ package lib
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"sort"
 	"strconv"
@@ -186,9 +185,9 @@ func GetArrayKeysSorted(input map[string]string) []string {
 // WriteTempFile places the contents string into a temp file, which the caller
 // must remove.
 func WriteTempFileOrDie(contents string) string {
-	// Use "" as first argument to ioutil.TempFile to use default directory.
+	// Use "" as first argument to os.CreateTemp to use default directory.
 	// Nominally "/tmp" or somesuch on all unix-like systems, but not for Windows.
-	handle, err := ioutil.TempFile("", "mlr-temp")
+	handle, err := os.CreateTemp("", "mlr-temp")
 	if err != nil {
 		fmt.Printf("mlr: could not create temp file.\n")
 		os.Exit(1)

diff --git a/pkg/terminals/regtest/regtester.go b/pkg/terminals/regtest/regtester.go
@@ -58,7 +58,6 @@ package regtest
 import (
 	"container/list"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"runtime"
@@ -153,7 +152,6 @@ func (regtester *RegTester) resetCounts() {
 func (regtester *RegTester) Execute(
 	casePaths []string,
 ) bool {
-
 	// Don't let the current user's settings affect expected results
 	for _, name := range envVarsToUnset {
 		os.Unsetenv(name)
@@ -279,42 +277,34 @@ func (regtester *RegTester) executeSingleDirectory(
 ) (bool, bool) {
 	passed := true
 	// TODO: comment
-	hasCaseSubdirectories := regtester.hasCaseSubdirectories(dirName)
+	fileNames, hasCaseSubdirectories := regtester.hasCaseSubdirectories(dirName)
 
 	if !regtester.plainMode {
 		if hasCaseSubdirectories && regtester.verbosityLevel >= 2 {
 			fmt.Printf("%s BEGIN %s/\n", MajorSeparator, dirName)
 		}
 	}
 
-	entries, err := ioutil.ReadDir(dirName)
-	if err != nil {
-		fmt.Printf("%s: %v\n", dirName, err)
-		passed = false
-	} else {
-
-		for i := range entries {
-			entry := &entries[i]
-			path := dirName + "/" + (*entry).Name()
+	for _, name := range fileNames {
+		path := dirName + "/" + name
 
-			ok := regtester.executeSinglePath(path)
-			if !ok {
-				passed = false
-			}
+		ok := regtester.executeSinglePath(path)
+		if !ok {
+			passed = false
 		}
+	}
 
-		// Only print if there are .cmd files directly in this directory.
-		// Otherwise it's just a directory-of-directories and we don't need to
-		// multiply announce.
-		if hasCaseSubdirectories {
-			if passed {
-				if !regtester.plainMode {
-					fmt.Printf("%s %s\n", colorizer.MaybeColorizePass("PASS", true), dirName)
-				}
-			} else {
-				if !regtester.plainMode {
-					fmt.Printf("%s %s\n", colorizer.MaybeColorizeFail("FAIL", true), dirName)
-				}
+	// Only print if there are .cmd files directly in this directory.
+	// Otherwise it's just a directory-of-directories and we don't need to
+	// multiply announce.
+	if hasCaseSubdirectories {
+		if passed {
+			if !regtester.plainMode {
+				fmt.Printf("%s %s\n", colorizer.MaybeColorizePass("PASS", true), dirName)
+			}
+		} else {
+			if !regtester.plainMode {
+				fmt.Printf("%s %s\n", colorizer.MaybeColorizeFail("FAIL", true), dirName)
 			}
 		}
 	}
@@ -340,22 +330,27 @@ func (regtester *RegTester) executeSingleDirectory(
 
 func (regtester *RegTester) hasCaseSubdirectories(
 	dirName string,
-) bool {
+) ([]string, bool) {
+	f, err := os.Open(dirName)
+	if err != nil {
+		fmt.Printf("%s: %v\n", dirName, err)
+		os.Exit(1)
+	}
+	defer f.Close()
 
-	entries, err := ioutil.ReadDir(dirName)
+	names, err := f.Readdirnames(-1)
 	if err != nil {
 		fmt.Printf("%s: %v\n", dirName, err)
 		os.Exit(1)
 	}
 
-	for i := range entries {
-		entry := &entries[i]
-		path := dirName + string(filepath.Separator) + (*entry).Name()
+	for _, name := range names {
+		path := dirName + string(filepath.Separator) + name
 		if regtester.isCaseDirectory(path) {
-			return true
+			return names, true
 		}
 	}
-	return false
+	return names, false
 }
 
 func (regtester *RegTester) isCaseDirectory(
@@ -774,7 +769,7 @@ func (regtester *RegTester) loadFile(
 	fileName string,
 	caseDir string,
 ) (string, error) {
-	byteContents, err := ioutil.ReadFile(fileName)
+	byteContents, err := os.ReadFile(fileName)
 	if err != nil {
 		return "", err
 	}
@@ -789,7 +784,7 @@ func (regtester *RegTester) storeFile(
 	fileName string,
 	contents string,
 ) error {
-	err := ioutil.WriteFile(fileName, []byte(contents), 0666)
+	err := os.WriteFile(fileName, []byte(contents), 0o666)
 	if err != nil {
 		return err
 	}