Merge pull request #4745 from kersten/chore/wrap-plugin-utils-errors

🌱 (chore): wrap plugin and util error returns for better context

Author: k8s-ci-robot

pkg/plugin/util/exec.go

@@ -17,6 +17,7 @@ limitations under the License.
 package util
 
 import (
+	"fmt"
 	"os"
 	"os/exec"
 	"strings"
@@ -30,5 +31,10 @@ func RunCmd(msg, cmd string, args ...string) error {
 	c.Stdout = os.Stdout
 	c.Stderr = os.Stderr
 	log.Println(msg + ":\n$ " + strings.Join(c.Args, " "))
-	return c.Run()
+
+	if err := c.Run(); err != nil {
+		return fmt.Errorf("error running %q: %w", cmd, err)
+	}
+
+	return nil
 }

pkg/plugin/util/util.go

@@ -41,7 +41,7 @@ func RandomSuffix() (string, error) {
 		bi := new(big.Int)
 		r, err := rand.Int(rand.Reader, bi.SetInt64(int64(len(source))))
 		if err != nil {
-			return "", err
+			return "", fmt.Errorf("failed to generate random number: %w", err)
 		}
 		res[i] = source[r.Int64()]
 	}
@@ -67,23 +67,27 @@ func InsertCode(filename, target, code string) error {
 	//nolint:gosec // false positive
 	contents, err := os.ReadFile(filename)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to read file %q: %w", filename, err)
 	}
 	idx := strings.Index(string(contents), target)
 	if idx == -1 {
 		return fmt.Errorf("string %s not found in %s", target, string(contents))
 	}
 	out := string(contents[:idx+len(target)]) + code + string(contents[idx+len(target):])
 	//nolint:gosec // false positive
-	return os.WriteFile(filename, []byte(out), 0o644)
+	if errWriteFile := os.WriteFile(filename, []byte(out), 0o644); errWriteFile != nil {
+		return fmt.Errorf("failed to write file %q: %w", filename, errWriteFile)
+	}
+
+	return nil
 }
 
-// InsertCodeIfNotExist insert code if it does not already exists
+// InsertCodeIfNotExist insert code if it does not already exist
 func InsertCodeIfNotExist(filename, target, code string) error {
 	//nolint:gosec // false positive
 	contents, err := os.ReadFile(filename)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to read file %q: %w", filename, err)
 	}
 
 	idx := strings.Index(string(contents), code)
@@ -98,7 +102,7 @@ func InsertCodeIfNotExist(filename, target, code string) error {
 func AppendCodeIfNotExist(filename, code string) error {
 	contents, err := os.ReadFile(filename)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to read file %q: %w", filename, err)
 	}
 
 	if strings.Contains(string(contents), code) {
@@ -112,16 +116,19 @@ func AppendCodeIfNotExist(filename, code string) error {
 func AppendCodeAtTheEnd(filename, code string) error {
 	f, err := os.OpenFile(filename, os.O_APPEND|os.O_WRONLY, 0o644)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to open file %q: %w", filename, err)
 	}
 	defer func() {
 		if err = f.Close(); err != nil {
 			return
 		}
 	}()
 
-	_, err = f.WriteString(code)
-	return err
+	if _, errWriteString := f.WriteString(code); errWriteString != nil {
+		return fmt.Errorf("failed to write to file %q: %w", filename, errWriteString)
+	}
+
+	return nil
 }
 
 // UncommentCode searches for target in the file and remove the comment prefix
@@ -130,19 +137,19 @@ func UncommentCode(filename, target, prefix string) error {
 	//nolint:gosec // false positive
 	content, err := os.ReadFile(filename)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to read file %q: %w", filename, err)
 	}
 	strContent := string(content)
 
 	idx := strings.Index(strContent, target)
 	if idx < 0 {
-		return fmt.Errorf("unable to find the code %s to be uncomment", target)
+		return fmt.Errorf("unable to find the code %q to be uncomment", target)
 	}
 
 	out := new(bytes.Buffer)
 	_, err = out.Write(content[:idx])
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to write to file %q: %w", filename, err)
 	}
 
 	scanner := bufio.NewScanner(bytes.NewBufferString(target))
@@ -151,23 +158,26 @@ func UncommentCode(filename, target, prefix string) error {
 	}
 	for {
 		if _, err = out.WriteString(strings.TrimPrefix(scanner.Text(), prefix)); err != nil {
-			return err
+			return fmt.Errorf("failed to write to file %q: %w", filename, err)
 		}
 		// Avoid writing a newline in case the previous line was the last in target.
 		if !scanner.Scan() {
 			break
 		}
 		if _, err = out.WriteString("\n"); err != nil {
-			return err
+			return fmt.Errorf("failed to write to file %q: %w", filename, err)
 		}
 	}
 
-	_, err = out.Write(content[idx+len(target):])
-	if err != nil {
-		return err
+	if _, err = out.Write(content[idx+len(target):]); err != nil {
+		return fmt.Errorf("failed to write to file %q: %w", filename, err)
 	}
 	//nolint:gosec // false positive
-	return os.WriteFile(filename, out.Bytes(), 0o644)
+	if err = os.WriteFile(filename, out.Bytes(), 0o644); err != nil {
+		return fmt.Errorf("failed to write file %q: %w", filename, err)
+	}
+
+	return nil
 }
 
 // CommentCode searches for target in the file and adds the comment prefix
@@ -176,42 +186,44 @@ func CommentCode(filename, target, prefix string) error {
 	// Read the file content
 	content, err := os.ReadFile(filename)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to read file %q: %w", filename, err)
 	}
 	strContent := string(content)
 
 	// Find the target code to be commented
 	idx := strings.Index(strContent, target)
 	if idx < 0 {
-		return fmt.Errorf("unable to find the code %s to be commented", target)
+		return fmt.Errorf("unable to find the code %q to be commented", target)
 	}
 
 	// Create a buffer to hold the modified content
 	out := new(bytes.Buffer)
-	_, err = out.Write(content[:idx])
-	if err != nil {
-		return err
+	if _, err = out.Write(content[:idx]); err != nil {
+		return fmt.Errorf("failed to write to file %q: %w", filename, err)
 	}
 
 	// Add the comment prefix to each line of the target code
 	scanner := bufio.NewScanner(bytes.NewBufferString(target))
 	for scanner.Scan() {
 		if _, err = out.WriteString(prefix + scanner.Text() + "\n"); err != nil {
-			return err
+			return fmt.Errorf("failed to write to file %q: %w", filename, err)
 		}
 	}
 
 	// Write the rest of the file content
-	_, err = out.Write(content[idx+len(target):])
-	if err != nil {
-		return err
+	if _, err = out.Write(content[idx+len(target):]); err != nil {
+		return fmt.Errorf("failed to write to file %q: %w", filename, err)
 	}
 
 	// Write the modified content back to the file
-	return os.WriteFile(filename, out.Bytes(), 0o644)
+	if err = os.WriteFile(filename, out.Bytes(), 0o644); err != nil {
+		return fmt.Errorf("failed to write file %q: %w", filename, err)
+	}
+
+	return nil
 }
 
-// EnsureExistAndReplace check if the content exists and then do the replace
+// EnsureExistAndReplace check if the content exists and then do the replacement
 func EnsureExistAndReplace(input, match, replace string) (string, error) {
 	if !strings.Contains(input, match) {
 		return "", fmt.Errorf("can't find %q", match)
@@ -223,20 +235,19 @@ func EnsureExistAndReplace(input, match, replace string) (string, error) {
 func ReplaceInFile(path, oldValue, newValue string) error {
 	info, err := os.Stat(path)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to stat file %q: %w", path, err)
 	}
 	//nolint:gosec // false positive
 	b, err := os.ReadFile(path)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to read file %q: %w", path, err)
 	}
 	if !strings.Contains(string(b), oldValue) {
 		return errors.New("unable to find the content to be replaced")
 	}
 	s := strings.Replace(string(b), oldValue, newValue, -1)
-	err = os.WriteFile(path, []byte(s), info.Mode())
-	if err != nil {
-		return err
+	if err = os.WriteFile(path, []byte(s), info.Mode()); err != nil {
+		return fmt.Errorf("failed to write file %q: %w", path, err)
 	}
 	return nil
 }
@@ -249,25 +260,26 @@ func ReplaceInFile(path, oldValue, newValue string) error {
 func ReplaceRegexInFile(path, match, replace string) error {
 	matcher, err := regexp.Compile(match)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to compile regular expression %q: %w", match, err)
 	}
 	info, err := os.Stat(path)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to stat file %q: %w", path, err)
 	}
 	//nolint:gosec // false positive
 	b, err := os.ReadFile(path)
 	if err != nil {
-		return err
+		return fmt.Errorf("failed to read file %q: %w", path, err)
 	}
 	s := matcher.ReplaceAllString(string(b), replace)
 	if s == string(b) {
 		return errors.New("unable to find the content to be replaced")
 	}
-	err = os.WriteFile(path, []byte(s), info.Mode())
-	if err != nil {
-		return err
+
+	if err = os.WriteFile(path, []byte(s), info.Mode()); err != nil {
+		return fmt.Errorf("failed to write file %q: %w", path, err)
 	}
+
 	return nil
 }
 
@@ -276,7 +288,7 @@ func HasFileContentWith(path, text string) (bool, error) {
 	//nolint:gosec
 	contents, err := os.ReadFile(path)
 	if err != nil {
-		return false, err
+		return false, fmt.Errorf("failed to read file %q: %w", path, err)
 	}
 
 	return strings.Contains(string(contents), text), nil

pkg/plugin/version.go

@@ -54,12 +54,12 @@ func (v *Version) Parse(version string) error {
 		if n, errParse := strconv.Atoi(version); errParse == nil && n < 0 {
 			return errNegative
 		}
-		return err
+		return fmt.Errorf("error converting version number %q: %w", substrings[0], err)
 	}
 
 	if len(substrings) > 1 {
 		if err = v.Stage.Parse(substrings[1]); err != nil {
-			return err
+			return fmt.Errorf("error parsing stage %q: %w", substrings[1], err)
 		}
 	}
 
@@ -81,7 +81,11 @@ func (v Version) Validate() error {
 		return errNegative
 	}
 
-	return v.Stage.Validate()
+	if err := v.Stage.Validate(); err != nil {
+		return fmt.Errorf("error validating stage %q: %w", v.Stage, err)
+	}
+
+	return nil
 }
 
 // Compare returns -1 if v < other, 0 if v == other, and 1 if v > other.