Skip to content

Commit 423f3ab

Browse files
authored
Remove readFile() and reverseSlice() in favour of stdlib (#671)
* Update updater.go remove readFile() as it appears to essentially be a re-implementation of stdlib's os.ReadFile Signed-off-by: udf2457 <udf2457@users.noreply.github.com> * Remove ReadFile from cli/tuf-client/cmd/root.go Another instance of re-implementing os.ReadFile. This one does not even appear to be used by the cli code. Signed-off-by: udf2457 <udf2457@users.noreply.github.com> * Update init.go Reference os.Readfile instead of the re-implementation Signed-off-by: udf2457 <udf2457@users.noreply.github.com> * Update root.go Remove ReadFile re-implementation Signed-off-by: udf2457 <udf2457@users.noreply.github.com> * Update metadata.go to use os.ReadFile Don't reinvent the wheel, use stdlib os.ReadFile 😉 Signed-off-by: udf2457 <udf2457@users.noreply.github.com> * Update updater.go - remove reimplementation of slices.Reverse() Remive the reimplementation of stdlib slices.Reverse() Signed-off-by: udf2457 <udf2457@users.noreply.github.com> * Update root.go remove un-necessary io import Signed-off-by: udf2457 <udf2457@users.noreply.github.com> * Update root.go Remove io import Signed-off-by: udf2457 <udf2457@users.noreply.github.com> --------- Signed-off-by: udf2457 <udf2457@users.noreply.github.com>
1 parent 110bec9 commit 423f3ab

File tree

5 files changed

+7
-69
lines changed

5 files changed

+7
-69
lines changed

examples/cli/tuf-client/cmd/init.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ func InitializeCmd() error {
8181
}
8282

8383
// read the content of root.json
84-
rootBytes, err := ReadFile(rootPath)
84+
rootBytes, err := os.ReadFile(rootPath)
8585
if err != nil {
8686
return err
8787
}

examples/cli/tuf-client/cmd/root.go

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
package cmd
1919

2020
import (
21-
"io"
2221
"os"
2322

2423
"github.com/spf13/cobra"
@@ -57,17 +56,3 @@ func Execute() {
5756
os.Exit(1)
5857
}
5958
}
60-
61-
// ReadFile reads the content of a file and return its bytes
62-
func ReadFile(name string) ([]byte, error) {
63-
in, err := os.Open(name)
64-
if err != nil {
65-
return nil, err
66-
}
67-
defer in.Close()
68-
data, err := io.ReadAll(in)
69-
if err != nil {
70-
return nil, err
71-
}
72-
return data, nil
73-
}

examples/cli/tuf/cmd/root.go

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
package cmd
1919

2020
import (
21-
"io"
2221
"os"
2322

2423
"github.com/spf13/cobra"
@@ -42,17 +41,3 @@ func Execute() {
4241
os.Exit(1)
4342
}
4443
}
45-
46-
// ReadFile reads the content of a file and return its bytes
47-
func ReadFile(name string) ([]byte, error) {
48-
in, err := os.Open(name)
49-
if err != nil {
50-
return nil, err
51-
}
52-
defer in.Close()
53-
data, err := io.ReadAll(in)
54-
if err != nil {
55-
return nil, err
56-
}
57-
return data, nil
58-
}

metadata/metadata.go

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,7 @@ func MetaFile(version int64) *MetaFiles {
161161

162162
// FromFile load metadata from file
163163
func (meta *Metadata[T]) FromFile(name string) (*Metadata[T], error) {
164-
in, err := os.Open(name)
165-
if err != nil {
166-
return nil, err
167-
}
168-
defer in.Close()
169-
data, err := io.ReadAll(in)
164+
data, err := os.ReadFile(name)
170165
if err != nil {
171166
return nil, err
172167
}
@@ -474,14 +469,8 @@ func (source *TargetFiles) Equal(expected TargetFiles) bool {
474469
// FromFile generate TargetFiles from file
475470
func (t *TargetFiles) FromFile(localPath string, hashes ...string) (*TargetFiles, error) {
476471
log.Info("Generating target file from file", "path", localPath)
477-
// open file
478-
in, err := os.Open(localPath)
479-
if err != nil {
480-
return nil, err
481-
}
482-
defer in.Close()
483472
// read file
484-
data, err := io.ReadAll(in)
473+
data, err := os.ReadFile(localPath)
485474
if err != nil {
486475
return nil, err
487476
}

metadata/updater/updater.go

Lines changed: 4 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ import (
2121
"encoding/hex"
2222
"errors"
2323
"fmt"
24-
"io"
2524
"net/http"
2625
"net/url"
2726
"os"
2827
"path/filepath"
2928
"regexp"
29+
"slices"
3030
"strconv"
3131
"strings"
3232
"time"
@@ -283,7 +283,7 @@ func (update *Updater) FindCachedTarget(targetFile *metadata.TargetFiles, filePa
283283
targetFilePath = filePath
284284
}
285285
// get file content
286-
data, err := readFile(targetFilePath)
286+
data, err := os.ReadFile(targetFilePath)
287287
if err != nil {
288288
// do not want to return err, instead we say that there's no cached target available
289289
return "", nil, nil
@@ -569,7 +569,7 @@ func (update *Updater) preOrderDepthFirstWalk(targetFilePath string) (*metadata.
569569
// push childRolesToVisit in reverse order of appearance
570570
// onto delegationsToVisit. Roles are popped from the end of
571571
// the list
572-
reverseSlice(childRolesToVisit)
572+
slices.Reverse(childRolesToVisit)
573573
delegationsToVisit = append(delegationsToVisit, childRolesToVisit...)
574574
}
575575
}
@@ -663,7 +663,7 @@ func (update *Updater) generateTargetFilePath(tf *metadata.TargetFiles) (string,
663663

664664
// loadLocalMetadata reads a local <roleName>.json file and returns its bytes
665665
func (update *Updater) loadLocalMetadata(roleName string) ([]byte, error) {
666-
return readFile(fmt.Sprintf("%s.json", roleName))
666+
return os.ReadFile(fmt.Sprintf("%s.json", roleName))
667667
}
668668

669669
// GetTopLevelTargets returns the top-level target files
@@ -702,24 +702,3 @@ func ensureTrailingSlash(url string) string {
702702
}
703703
return url + "/"
704704
}
705-
706-
// reverseSlice reverses the elements in a generic type of slice
707-
func reverseSlice[S ~[]E, E any](s S) {
708-
for i, j := 0, len(s)-1; i < j; i, j = i+1, j-1 {
709-
s[i], s[j] = s[j], s[i]
710-
}
711-
}
712-
713-
// readFile reads the content of a file and return its bytes
714-
func readFile(name string) ([]byte, error) {
715-
in, err := os.Open(name)
716-
if err != nil {
717-
return nil, err
718-
}
719-
defer in.Close()
720-
data, err := io.ReadAll(in)
721-
if err != nil {
722-
return nil, err
723-
}
724-
return data, nil
725-
}

0 commit comments

Comments
 (0)