Replace deprecated io/ioutil with io and os packages (grafana#7212

) The `io/ioutil` package has been deprecated in Go 1.16 (See https://pkg.go.dev/io/ioutil). This PR replaces the existing `io/ioutil` functions with their new definitions in `io` and `os` packages. Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
lxwzy · Nov 7, 2022 · 7b62146 · 7b62146
1 parent d85784b
commit 7b62146
Show file tree

Hide file tree

Showing 97 changed files with 302 additions and 338 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -32,6 +32,7 @@
 * [6415](https://github.com/grafana/loki/pull/6415) **salvacorts**: Evenly spread queriers across kubernetes nodes.
 * [6349](https://github.com/grafana/loki/pull/6349) **simonswine**: Update the default HTTP listen port from 80 to 3100. Make sure to configure the port explicitly if you are using port 80.
 * [6835](https://github.com/grafana/loki/pull/6835) **DylanGuedes**: Add new per-tenant query timeout configuration and remove engine query timeout.
+* [7212](https://github.com/grafana/loki/pull/7212) **Juneezee**: Replaces deprecated `io/ioutil` with `io` and `os`.
 
 #### Promtail
 

diff --git a/clients/cmd/docker-driver/config.go b/clients/cmd/docker-driver/config.go
@@ -3,7 +3,6 @@ package main
 import (
 	"bytes"
 	"fmt"
-	"io/ioutil"
 	"net/url"
 	"os"
 	"strconv"
@@ -385,7 +384,7 @@ func parseBoolean(key string, logCtx logger.Info, defaultValue bool) (bool, erro
 
 // loadConfig read YAML-formatted config from filename into cfg.
 func loadConfig(filename string, cfg interface{}) error {
-	buf, err := ioutil.ReadFile(filename)
+	buf, err := os.ReadFile(filename)
 	if err != nil {
 		return errors.Wrap(err, "Error reading config file")
 	}

diff --git a/clients/cmd/docker-driver/config_test.go b/clients/cmd/docker-driver/config_test.go
@@ -2,7 +2,6 @@ package main
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"reflect"
 	"testing"
@@ -82,7 +81,7 @@ var pipeline = PipelineConfig{
 }
 
 func Test_parsePipeline(t *testing.T) {
-	f, err := ioutil.TempFile("/tmp", "Test_parsePipeline")
+	f, err := os.CreateTemp("/tmp", "Test_parsePipeline")
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/clients/cmd/fluent-bit/config.go b/clients/cmd/fluent-bit/config.go
@@ -4,7 +4,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"io/ioutil"
+	"os"
 	"strconv"
 	"strings"
 	"time"
@@ -200,7 +200,7 @@ func parseConfig(cfg ConfigGetter) (*config, error) {
 
 	labelMapPath := cfg.Get("LabelMapPath")
 	if labelMapPath != "" {
-		content, err := ioutil.ReadFile(labelMapPath)
+		content, err := os.ReadFile(labelMapPath)
 		if err != nil {
 			return nil, fmt.Errorf("failed to open LabelMap file: %s", err)
 		}

diff --git a/clients/cmd/fluent-bit/config_test.go b/clients/cmd/fluent-bit/config_test.go
@@ -1,7 +1,6 @@
 package main
 
 import (
-	"io/ioutil"
 	"net/url"
 	"os"
 	"reflect"
@@ -229,7 +228,7 @@ func mustParseDuration(u string) time.Duration {
 }
 
 func createTempLabelMap(t *testing.T) string {
-	file, err := ioutil.TempFile("", "labelmap")
+	file, err := os.CreateTemp("", "labelmap")
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/clients/pkg/promtail/positions/positions.go b/clients/pkg/promtail/positions/positions.go
@@ -3,7 +3,6 @@ package positions
 import (
 	"flag"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strconv"
@@ -215,7 +214,7 @@ func (p *positions) cleanup() {
 
 func readPositionsFile(cfg Config, logger log.Logger) (map[string]string, error) {
 	cleanfn := filepath.Clean(cfg.PositionsFile)
-	buf, err := ioutil.ReadFile(cleanfn)
+	buf, err := os.ReadFile(cleanfn)
 	if err != nil {
 		if os.IsNotExist(err) {
 			return map[string]string{}, nil

diff --git a/clients/pkg/promtail/positions/positions_test.go b/clients/pkg/promtail/positions/positions_test.go
@@ -1,7 +1,6 @@
 package positions
 
 import (
-	"io/ioutil"
 	"os"
 	"strings"
 	"testing"
@@ -16,7 +15,7 @@ import (
 func tempFilename(t *testing.T) string {
 	t.Helper()
 
-	temp, err := ioutil.TempFile("", "positions")
+	temp, err := os.CreateTemp("", "positions")
 	if err != nil {
 		t.Fatal("tempFilename:", err)
 	}
@@ -43,7 +42,7 @@ func TestReadPositionsOK(t *testing.T) {
 	yaml := []byte(`positions:
   /tmp/random.log: "17623"
 `)
-	err := ioutil.WriteFile(temp, yaml, 0644)
+	err := os.WriteFile(temp, yaml, 0644)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -63,7 +62,7 @@ func TestReadPositionsEmptyFile(t *testing.T) {
 	}()
 
 	yaml := []byte(``)
-	err := ioutil.WriteFile(temp, yaml, 0644)
+	err := os.WriteFile(temp, yaml, 0644)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -104,7 +103,7 @@ func TestReadPositionsFromBadYaml(t *testing.T) {
 	badYaml := []byte(`positions:
   /tmp/random.log: "176
 `)
-	err := ioutil.WriteFile(temp, badYaml, 0644)
+	err := os.WriteFile(temp, badYaml, 0644)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -126,7 +125,7 @@ func TestReadPositionsFromBadYamlIgnoreCorruption(t *testing.T) {
 	badYaml := []byte(`positions:
   /tmp/random.log: "176
 `)
-	err := ioutil.WriteFile(temp, badYaml, 0644)
+	err := os.WriteFile(temp, badYaml, 0644)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -148,7 +147,7 @@ func Test_ReadOnly(t *testing.T) {
 	yaml := []byte(`positions:
   /tmp/random.log: "17623"
 `)
-	err := ioutil.WriteFile(temp, yaml, 0644)
+	err := os.WriteFile(temp, yaml, 0644)
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/clients/pkg/promtail/positions/write_positions_windows.go b/clients/pkg/promtail/positions/write_positions_windows.go
@@ -4,7 +4,6 @@
 package positions
 
 import (
-	"io/ioutil"
 	"os"
 	"path/filepath"
 
@@ -24,7 +23,7 @@ func writePositionFile(filename string, positions map[string]string) error {
 	target := filepath.Clean(filename)
 	temp := target + "-new"
 
-	err = ioutil.WriteFile(temp, buf, os.FileMode(positionFileMode))
+	err = os.WriteFile(temp, buf, os.FileMode(positionFileMode))
 	if err != nil {
 		return err
 	}

diff --git a/clients/pkg/promtail/promtail_test.go b/clients/pkg/promtail/promtail_test.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"math"
 	"math/rand"
 	"net"
@@ -510,7 +509,7 @@ func getPromMetrics(t *testing.T, httpListenAddr net.Addr) ([]byte, string) {
 		t.Fatal("Received a non 200 status code from /metrics endpoint", resp.StatusCode)
 	}
 
-	b, err := ioutil.ReadAll(resp.Body)
+	b, err := io.ReadAll(resp.Body)
 	if err != nil {
 		t.Fatal("Error reading response body from /metrics endpoint", err)
 	}
@@ -656,7 +655,7 @@ func randName() string {
 }
 
 func Test_DryRun(t *testing.T) {
-	f, err := ioutil.TempFile("/tmp", "Test_DryRun")
+	f, err := os.CreateTemp("/tmp", "Test_DryRun")
 	require.NoError(t, err)
 	defer os.Remove(f.Name())
 

diff --git a/clients/pkg/promtail/server/template.go b/clients/pkg/promtail/server/template.go
@@ -3,7 +3,6 @@ package server
 import (
 	"context"
 	"io"
-	"io/ioutil"
 	"net/http"
 	"net/url"
 	"path"
@@ -77,7 +76,7 @@ func getTemplate(name string) (string, error) {
 		defer func() {
 			_ = f.Close()
 		}()
-		b, err := ioutil.ReadAll(f)
+		b, err := io.ReadAll(f)
 		if err != nil {
 			return err
 		}

diff --git a/clients/pkg/promtail/targets/journal/journaltarget.go b/clients/pkg/promtail/targets/journal/journaltarget.go
@@ -6,7 +6,6 @@ package journal
 import (
 	"fmt"
 	"io"
-	"io/ioutil"
 	"strings"
 	"syscall"
 	"time"
@@ -201,7 +200,7 @@ func journalTargetWithReader(
 
 	go func() {
 		for {
-			err := t.r.Follow(until, ioutil.Discard)
+			err := t.r.Follow(until, io.Discard)
 			if err != nil {
 				level.Error(t.logger).Log("msg", "received error during sdjournal follow", "err", err.Error())
 

diff --git a/clients/pkg/promtail/targets/syslog/syslogtarget_test.go b/clients/pkg/promtail/targets/syslog/syslogtarget_test.go
@@ -5,7 +5,6 @@ import (
 	"crypto/x509"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"net"
 	"os"
 	"testing"
@@ -656,7 +655,7 @@ func testSyslogTargetWithTLS(t *testing.T, fmtFunc formatFunc) {
 }
 
 func createTempFile(data []byte) (*os.File, error) {
-	tmpFile, err := ioutil.TempFile("", "")
+	tmpFile, err := os.CreateTemp("", "")
 	if err != nil {
 		return nil, fmt.Errorf("failed to create temporary file: %s", err)
 	}

diff --git a/clients/pkg/promtail/targets/syslog/transport.go b/clients/pkg/promtail/targets/syslog/transport.go
@@ -6,8 +6,8 @@ import (
 	"crypto/x509"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"net"
+	"os"
 	"strings"
 	"sync"
 	"time"
@@ -207,7 +207,7 @@ func newTLSConfig(certFile string, keyFile string, caFile string) (*tls.Config,
 	}
 
 	if caFile != "" {
-		caCert, err := ioutil.ReadFile(caFile)
+		caCert, err := os.ReadFile(caFile)
 		if err != nil {
 			return nil, fmt.Errorf("unable to load client CA certificate: %w", err)
 		}

diff --git a/clients/pkg/promtail/targets/windows/bookmark.go b/clients/pkg/promtail/targets/windows/bookmark.go
@@ -4,7 +4,7 @@
 package windows
 
 import (
-	"io/ioutil"
+	"io"
 	"os"
 
 	"github.com/spf13/afero"
@@ -52,7 +52,7 @@ func newBookMark(path string) (*bookMark, error) {
 	if err != nil {
 		return nil, err
 	}
-	fileContent, err := ioutil.ReadAll(file)
+	fileContent, err := io.ReadAll(file)
 	if err != nil {
 		return nil, err
 	}

diff --git a/cmd/chunks-inspect/loki.go b/cmd/chunks-inspect/loki.go
@@ -7,7 +7,6 @@ import (
 	"fmt"
 	"hash/crc32"
 	"io"
-	"io/ioutil"
 
 	"github.com/golang/snappy"
 	"github.com/klauspost/compress/flate"
@@ -187,7 +186,7 @@ func parseLokiBlock(compression Encoding, data []byte) ([]byte, []LokiEntry, err
 		return nil, nil, err
 	}
 
-	decompressed, err := ioutil.ReadAll(r)
+	decompressed, err := io.ReadAll(r)
 	origDecompressed := decompressed
 	if err != nil {
 		return nil, nil, err

diff --git a/cmd/chunks-inspect/main.go b/cmd/chunks-inspect/main.go
@@ -4,7 +4,6 @@ import (
 	"crypto/sha256"
 	"flag"
 	"fmt"
-	"io/ioutil"
 	"log"
 	"os"
 	"strings"
@@ -122,7 +121,7 @@ func printFile(filename string, blockDetails, printLines, storeBlocks bool) {
 }
 
 func writeBlockToFile(data []byte, blockIndex int, filename string) {
-	err := ioutil.WriteFile(filename, data, 0644)
+	err := os.WriteFile(filename, data, 0644)
 	if err != nil {
 		log.Println("Failed to store block", blockIndex, "to file", filename, "due to error:", err)
 	} else {

diff --git a/operator/cmd/loki-broker/main.go b/operator/cmd/loki-broker/main.go
@@ -3,7 +3,6 @@ package main
 import (
 	"flag"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path"
 	"strings"
@@ -117,7 +116,7 @@ func main() {
 
 	cfg.validateFlags(logger)
 
-	b, err := ioutil.ReadFile(cfg.crFilepath)
+	b, err := os.ReadFile(cfg.crFilepath)
 	if err != nil {
 		logger.Info("failed to read custom resource file", "path", cfg.crFilepath)
 		os.Exit(1)
@@ -169,7 +168,7 @@ func main() {
 		if cfg.writeToDir != "" {
 			basename := fmt.Sprintf("%s-%s.yaml", o.GetObjectKind().GroupVersionKind().Kind, o.GetName())
 			fname := strings.ToLower(path.Join(cfg.writeToDir, basename))
-			if err := ioutil.WriteFile(fname, b, 0o644); err != nil {
+			if err := os.WriteFile(fname, b, 0o644); err != nil {
 				logger.Error(err, "failed to write file to directory", "path", fname)
 				os.Exit(1)
 			}

diff --git a/operator/controllers/loki/lokistack_controller_test.go b/operator/controllers/loki/lokistack_controller_test.go
@@ -2,7 +2,7 @@ package controllers
 
 import (
 	"flag"
-	"io/ioutil"
+	"io"
 	"os"
 	"testing"
 
@@ -38,7 +38,7 @@ func TestMain(m *testing.M) {
 	if testing.Verbose() {
 		logger = log.NewLogger("testing", log.WithVerbosity(5))
 	} else {
-		logger = log.NewLogger("testing", log.WithOutput(ioutil.Discard))
+		logger = log.NewLogger("testing", log.WithOutput(io.Discard))
 	}
 
 	// Register the clientgo and CRD schemes

diff --git a/operator/internal/handlers/lokistack_create_or_update_test.go b/operator/internal/handlers/lokistack_create_or_update_test.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"errors"
 	"flag"
-	"io/ioutil"
+	"io"
 	"os"
 	"testing"
 
@@ -94,7 +94,7 @@ func TestMain(m *testing.M) {
 	if testing.Verbose() {
 		logger = log.NewLogger("testing", log.WithVerbosity(5))
 	} else {
-		logger = log.NewLogger("testing", log.WithOutput(ioutil.Discard))
+		logger = log.NewLogger("testing", log.WithOutput(io.Discard))
 	}
 
 	// Register the clientgo and CRD schemes