use %w to wrap error

Ericwww · Ericwww · commit e36eb9868869 · 2024-03-06T22:18:50.000+01:00
diff --git a/checksum.go b/checksum.go
@@ -53,13 +53,13 @@ func (cerr *ChecksumError) Error() string {
 func (c *FileChecksum) checksum(source string) error {
 	f, err := os.Open(source)
 	if err != nil {
-		return fmt.Errorf("Failed to open file for checksum: %s", err)
+		return fmt.Errorf("Failed to open file for checksum: %w", err)
 	}
 	defer f.Close()
 
 	c.Hash.Reset()
 	if _, err := io.Copy(c.Hash, f); err != nil {
-		return fmt.Errorf("Failed to hash: %s", err)
+		return fmt.Errorf("Failed to hash: %w", err)
 	}
 
 	if actual := c.Hash.Sum(nil); !bytes.Equal(actual, c.Value) {
@@ -128,7 +128,7 @@ func newChecksum(checksumValue, filename string) (*FileChecksum, error) {
 	var err error
 	c.Value, err = hex.DecodeString(checksumValue)
 	if err != nil {
-		return nil, fmt.Errorf("invalid checksum: %s", err)
+		return nil, fmt.Errorf("invalid checksum: %w", err)
 	}
 	return c, nil
 }
@@ -215,7 +215,7 @@ func (c *Client) ChecksumFromFile(checksumFile string, src *url.URL) (*FileCheck
 	}
 	if err = c2.Get(); err != nil {
 		return nil, fmt.Errorf(
-			"Error downloading checksum file: %s", err)
+			"Error downloading checksum file: %w", err)
 	}
 
 	filename := filepath.Base(src.Path)
diff --git a/client.go b/client.go
@@ -10,8 +10,9 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/hashicorp/go-safetemp"
+
 	urlhelper "github.com/hashicorp/go-getter/helper/url"
-	safetemp "github.com/hashicorp/go-safetemp"
 )
 
 // ErrSymlinkCopy means that a copy of a symlink was encountered on a request with DisableSymlinks enabled.
@@ -205,7 +206,7 @@ func (c *Client) Get() error {
 		td, err := ioutil.TempDir("", "getter")
 		if err != nil {
 			return fmt.Errorf(
-				"Error creating temporary directory for archive: %s", err)
+				"Error creating temporary directory for archive: %w", err)
 		}
 		defer os.RemoveAll(td)
 
@@ -220,7 +221,7 @@ func (c *Client) Get() error {
 	// Determine checksum if we have one
 	checksum, err := c.extractChecksum(u)
 	if err != nil {
-		return fmt.Errorf("invalid checksum: %s", err)
+		return fmt.Errorf("invalid checksum: %w", err)
 	}
 
 	// Delete the query parameter if we have it.
@@ -320,7 +321,7 @@ func (c *Client) Get() error {
 		// if we're specifying a subdir.
 		err := g.Get(dst, u)
 		if err != nil {
-			err = fmt.Errorf("error downloading '%s': %s", RedactURL(u), err)
+			err = fmt.Errorf("error downloading '%s': %w", RedactURL(u), err)
 			return err
 		}
 	}
diff --git a/decompress_tgz.go b/decompress_tgz.go
@@ -43,7 +43,7 @@ func (d *TarGzipDecompressor) Decompress(dst, src string, dir bool, umask os.Fil
 	// Gzip compression is second
 	gzipR, err := gzip.NewReader(f)
 	if err != nil {
-		return fmt.Errorf("Error opening a gzip reader for %s: %s", src, err)
+		return fmt.Errorf("Error opening a gzip reader for %s: %w", src, err)
 	}
 	defer gzipR.Close()
 
diff --git a/decompress_txz.go b/decompress_txz.go
@@ -44,7 +44,7 @@ func (d *TarXzDecompressor) Decompress(dst, src string, dir bool, umask os.FileM
 	// xz compression is second
 	txzR, err := xz.NewReader(f)
 	if err != nil {
-		return fmt.Errorf("Error opening an xz reader for %s: %s", src, err)
+		return fmt.Errorf("Error opening an xz reader for %s: %w", src, err)
 	}
 
 	return untar(txzR, dst, src, dir, umask, d.FileSizeLimit, d.FilesLimit)
diff --git a/decompress_tzst.go b/decompress_tzst.go
@@ -44,7 +44,7 @@ func (d *TarZstdDecompressor) Decompress(dst, src string, dir bool, umask os.Fil
 	// Zstd compression is second
 	zstdR, err := zstd.NewReader(f)
 	if err != nil {
-		return fmt.Errorf("Error opening a zstd reader for %s: %s", src, err)
+		return fmt.Errorf("Error opening a zstd reader for %s: %w", src, err)
 	}
 	defer zstdR.Close()
 
diff --git a/detect.go b/detect.go
@@ -79,7 +79,7 @@ func Detect(src string, pwd string, ds []Detector) (string, error) {
 		if subDir != "" {
 			u, err := url.Parse(result)
 			if err != nil {
-				return "", fmt.Errorf("Error parsing URL: %s", err)
+				return "", fmt.Errorf("Error parsing URL: %w", err)
 			}
 			u.Path += "//" + subDir
 
diff --git a/detect_bitbucket.go b/detect_bitbucket.go
@@ -27,7 +27,7 @@ func (d *BitBucketDetector) Detect(src, _ string) (string, bool, error) {
 func (d *BitBucketDetector) detectHTTP(src string) (string, bool, error) {
 	u, err := url.Parse("https://" + src)
 	if err != nil {
-		return "", true, fmt.Errorf("error parsing BitBucket URL: %s", err)
+		return "", true, fmt.Errorf("error parsing BitBucket URL: %w", err)
 	}
 
 	// We need to get info on this BitBucket repository to determine whether
@@ -38,7 +38,7 @@ func (d *BitBucketDetector) detectHTTP(src string) (string, bool, error) {
 	infoUrl := "https://api.bitbucket.org/2.0/repositories" + u.Path
 	resp, err := http.Get(infoUrl)
 	if err != nil {
-		return "", true, fmt.Errorf("error looking up BitBucket URL: %s", err)
+		return "", true, fmt.Errorf("error looking up BitBucket URL: %w", err)
 	}
 	if resp.StatusCode == 403 {
 		// A private repo
@@ -48,7 +48,7 @@ func (d *BitBucketDetector) detectHTTP(src string) (string, bool, error) {
 	}
 	dec := json.NewDecoder(resp.Body)
 	if err := dec.Decode(&info); err != nil {
-		return "", true, fmt.Errorf("error looking up BitBucket URL: %s", err)
+		return "", true, fmt.Errorf("error looking up BitBucket URL: %w", err)
 	}
 
 	switch info.SCM {
diff --git a/detect_gcs.go b/detect_gcs.go
@@ -36,7 +36,7 @@ func (d *GCSDetector) detectHTTP(src string) (string, bool, error) {
 	url, err := url.Parse(fmt.Sprintf("https://www.googleapis.com/storage/%s/%s/%s",
 		version, bucket, object))
 	if err != nil {
-		return "", false, fmt.Errorf("error parsing GCS URL: %s", err)
+		return "", false, fmt.Errorf("error parsing GCS URL: %w", err)
 	}
 
 	return "gcs::" + url.String(), true, nil
diff --git a/detect_github.go b/detect_github.go
@@ -32,7 +32,7 @@ func (d *GitHubDetector) detectHTTP(src string) (string, bool, error) {
 	urlStr := fmt.Sprintf("https://%s", strings.Join(parts[:3], "/"))
 	url, err := url.Parse(urlStr)
 	if err != nil {
-		return "", true, fmt.Errorf("error parsing GitHub URL: %s", err)
+		return "", true, fmt.Errorf("error parsing GitHub URL: %w", err)
 	}
 
 	if !strings.HasSuffix(url.Path, ".git") {
diff --git a/detect_gitlab.go b/detect_gitlab.go
@@ -32,7 +32,7 @@ func (d *GitLabDetector) detectHTTP(src string) (string, bool, error) {
 	urlStr := fmt.Sprintf("https://%s", strings.Join(parts[:3], "/"))
 	repoUrl, err := url.Parse(urlStr)
 	if err != nil {
-		return "", true, fmt.Errorf("error parsing GitLab URL: %s", err)
+		return "", true, fmt.Errorf("error parsing GitLab URL: %w", err)
 	}
 
 	if !strings.HasSuffix(repoUrl.Path, ".git") {
diff --git a/detect_s3.go b/detect_s3.go
@@ -46,7 +46,7 @@ func (d *S3Detector) detectPathStyle(region string, parts []string) (string, boo
 	urlStr := fmt.Sprintf("https://%s.amazonaws.com/%s", region, strings.Join(parts, "/"))
 	url, err := url.Parse(urlStr)
 	if err != nil {
-		return "", false, fmt.Errorf("error parsing S3 URL: %s", err)
+		return "", false, fmt.Errorf("error parsing S3 URL: %w", err)
 	}
 
 	return "s3::" + url.String(), true, nil
@@ -56,7 +56,7 @@ func (d *S3Detector) detectVhostStyle(region, bucket string, parts []string) (st
 	urlStr := fmt.Sprintf("https://%s.amazonaws.com/%s/%s", region, bucket, strings.Join(parts, "/"))
 	url, err := url.Parse(urlStr)
 	if err != nil {
-		return "", false, fmt.Errorf("error parsing S3 URL: %s", err)
+		return "", false, fmt.Errorf("error parsing S3 URL: %w", err)
 	}
 
 	return "s3::" + url.String(), true, nil
@@ -66,7 +66,7 @@ func (d *S3Detector) detectNewVhostStyle(region, bucket string, parts []string)
 	urlStr := fmt.Sprintf("https://s3.%s.amazonaws.com/%s/%s", region, bucket, strings.Join(parts, "/"))
 	url, err := url.Parse(urlStr)
 	if err != nil {
-		return "", false, fmt.Errorf("error parsing S3 URL: %s", err)
+		return "", false, fmt.Errorf("error parsing S3 URL: %w", err)
 	}
 
 	return "s3::" + url.String(), true, nil
diff --git a/detect_ssh.go b/detect_ssh.go
@@ -40,7 +40,7 @@ func detectSSH(src string) (*url.URL, error) {
 	if qidx < len(path) {
 		q, err := url.ParseQuery(path[qidx+1:])
 		if err != nil {
-			return nil, fmt.Errorf("error parsing GitHub SSH URL: %s", err)
+			return nil, fmt.Errorf("error parsing GitHub SSH URL: %w", err)
 		}
 		u.RawQuery = q.Encode()
 	}
diff --git a/folder_storage.go b/folder_storage.go
@@ -49,7 +49,7 @@ func (s *FolderStorage) Get(key string, source string, update bool) error {
 		} else if !os.IsNotExist(err) {
 			// If the error we got wasn't a file-not-exist error, then
 			// something went wrong and we should report it.
-			return fmt.Errorf("Error reading module directory: %s", err)
+			return fmt.Errorf("Error reading module directory: %w", err)
 		}
 	}
 
diff --git a/get_file_unix.go b/get_file_unix.go
@@ -1,3 +1,4 @@
+//go:build !windows
 // +build !windows
 
 package getter
@@ -17,7 +18,7 @@ func (g *FileGetter) Get(dst string, u *url.URL) error {
 
 	// The source path must exist and be a directory to be usable.
 	if fi, err := os.Stat(path); err != nil {
-		return fmt.Errorf("source path error: %s", err)
+		return fmt.Errorf("source path error: %w", err)
 	} else if !fi.IsDir() {
 		return fmt.Errorf("source path must be a directory")
 	}
@@ -59,7 +60,7 @@ func (g *FileGetter) GetFile(dst string, u *url.URL) error {
 	var fi os.FileInfo
 	var err error
 	if fi, err = os.Stat(path); err != nil {
-		return fmt.Errorf("source path error: %s", err)
+		return fmt.Errorf("source path error: %w", err)
 	} else if fi.IsDir() {
 		return fmt.Errorf("source path must be a file")
 	}
diff --git a/get_file_windows.go b/get_file_windows.go
@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 package getter
@@ -21,7 +22,7 @@ func (g *FileGetter) Get(dst string, u *url.URL) error {
 
 	// The source path must exist and be a directory to be usable.
 	if fi, err := os.Stat(path); err != nil {
-		return fmt.Errorf("source path error: %s", err)
+		return fmt.Errorf("source path error: %w", err)
 	} else if !fi.IsDir() {
 		return fmt.Errorf("source path must be a directory")
 	}
@@ -69,7 +70,7 @@ func (g *FileGetter) GetFile(dst string, u *url.URL) error {
 
 	// The source path must exist and be a directory to be usable.
 	if fi, err := os.Stat(path); err != nil {
-		return fmt.Errorf("source path error: %s", err)
+		return fmt.Errorf("source path error: %w", err)
 	} else if fi.IsDir() {
 		return fmt.Errorf("source path must be a file")
 	}
diff --git a/netrc.go b/netrc.go
@@ -53,7 +53,7 @@ func addAuthFromNetrc(u *url.URL) error {
 	// Load up the netrc file
 	net, err := netrc.ParseFile(path)
 	if err != nil {
-		return fmt.Errorf("Error parsing netrc file at %q: %s", path, err)
+		return fmt.Errorf("Error parsing netrc file at %q: %w", path, err)
 	}
 
 	machine := net.FindMachine(u.Host)

Original file line number	Diff line number	Diff line change
`@@ -53,13 +53,13 @@ func (cerr *ChecksumError) Error() string {`
`53`	`53`	`func (c *FileChecksum) checksum(source string) error {`
`54`	`54`	`f, err := os.Open(source)`
`55`	`55`	`if err != nil {`
`56`		`- return fmt.Errorf("Failed to open file for checksum: %s", err)`
	`56`	`+ return fmt.Errorf("Failed to open file for checksum: %w", err)`
`57`	`57`	`}`
`58`	`58`	`defer f.Close()`
`59`	`59`
`60`	`60`	`c.Hash.Reset()`
`61`	`61`	`if _, err := io.Copy(c.Hash, f); err != nil {`
`62`		`- return fmt.Errorf("Failed to hash: %s", err)`
	`62`	`+ return fmt.Errorf("Failed to hash: %w", err)`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`if actual := c.Hash.Sum(nil); !bytes.Equal(actual, c.Value) {`
`@@ -128,7 +128,7 @@ func newChecksum(checksumValue, filename string) (*FileChecksum, error) {`
`128`	`128`	`var err error`
`129`	`129`	`c.Value, err = hex.DecodeString(checksumValue)`
`130`	`130`	`if err != nil {`
`131`		`- return nil, fmt.Errorf("invalid checksum: %s", err)`
	`131`	`+ return nil, fmt.Errorf("invalid checksum: %w", err)`
`132`	`132`	`}`
`133`	`133`	`return c, nil`
`134`	`134`	`}`
`@@ -215,7 +215,7 @@ func (c Client) ChecksumFromFile(checksumFile string, src url.URL) (*FileCheck`
`215`	`215`	`}`
`216`	`216`	`if err = c2.Get(); err != nil {`
`217`	`217`	`return nil, fmt.Errorf(`
`218`		`- "Error downloading checksum file: %s", err)`
	`218`	`+ "Error downloading checksum file: %w", err)`
`219`	`219`	`}`
`220`	`220`
`221`	`221`	`filename := filepath.Base(src.Path)`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ func (d *TarGzipDecompressor) Decompress(dst, src string, dir bool, umask os.Fil`
`43`	`43`	`// Gzip compression is second`
`44`	`44`	`gzipR, err := gzip.NewReader(f)`
`45`	`45`	`if err != nil {`
`46`		`- return fmt.Errorf("Error opening a gzip reader for %s: %s", src, err)`
	`46`	`+ return fmt.Errorf("Error opening a gzip reader for %s: %w", src, err)`
`47`	`47`	`}`
`48`	`48`	`defer gzipR.Close()`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ func (d *TarXzDecompressor) Decompress(dst, src string, dir bool, umask os.FileM`
`44`	`44`	`// xz compression is second`
`45`	`45`	`txzR, err := xz.NewReader(f)`
`46`	`46`	`if err != nil {`
`47`		`- return fmt.Errorf("Error opening an xz reader for %s: %s", src, err)`
	`47`	`+ return fmt.Errorf("Error opening an xz reader for %s: %w", src, err)`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`return untar(txzR, dst, src, dir, umask, d.FileSizeLimit, d.FilesLimit)`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ func (d *TarZstdDecompressor) Decompress(dst, src string, dir bool, umask os.Fil`
`44`	`44`	`// Zstd compression is second`
`45`	`45`	`zstdR, err := zstd.NewReader(f)`
`46`	`46`	`if err != nil {`
`47`		`- return fmt.Errorf("Error opening a zstd reader for %s: %s", src, err)`
	`47`	`+ return fmt.Errorf("Error opening a zstd reader for %s: %w", src, err)`
`48`	`48`	`}`
`49`	`49`	`defer zstdR.Close()`
`50`	`50`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ func Detect(src string, pwd string, ds []Detector) (string, error) {`
`79`	`79`	`if subDir != "" {`
`80`	`80`	`u, err := url.Parse(result)`
`81`	`81`	`if err != nil {`
`82`		`- return "", fmt.Errorf("Error parsing URL: %s", err)`
	`82`	`+ return "", fmt.Errorf("Error parsing URL: %w", err)`
`83`	`83`	`}`
`84`	`84`	`u.Path += "//" + subDir`
`85`	`85`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func (d *BitBucketDetector) Detect(src, _ string) (string, bool, error) {`
`27`	`27`	`func (d *BitBucketDetector) detectHTTP(src string) (string, bool, error) {`
`28`	`28`	`u, err := url.Parse("https://" + src)`
`29`	`29`	`if err != nil {`
`30`		`- return "", true, fmt.Errorf("error parsing BitBucket URL: %s", err)`
	`30`	`+ return "", true, fmt.Errorf("error parsing BitBucket URL: %w", err)`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`// We need to get info on this BitBucket repository to determine whether`
`@@ -38,7 +38,7 @@ func (d *BitBucketDetector) detectHTTP(src string) (string, bool, error) {`
`38`	`38`	`infoUrl := "https://api.bitbucket.org/2.0/repositories" + u.Path`
`39`	`39`	`resp, err := http.Get(infoUrl)`
`40`	`40`	`if err != nil {`
`41`		`- return "", true, fmt.Errorf("error looking up BitBucket URL: %s", err)`
	`41`	`+ return "", true, fmt.Errorf("error looking up BitBucket URL: %w", err)`
`42`	`42`	`}`
`43`	`43`	`if resp.StatusCode == 403 {`
`44`	`44`	`// A private repo`
`@@ -48,7 +48,7 @@ func (d *BitBucketDetector) detectHTTP(src string) (string, bool, error) {`
`48`	`48`	`}`
`49`	`49`	`dec := json.NewDecoder(resp.Body)`
`50`	`50`	`if err := dec.Decode(&info); err != nil {`
`51`		`- return "", true, fmt.Errorf("error looking up BitBucket URL: %s", err)`
	`51`	`+ return "", true, fmt.Errorf("error looking up BitBucket URL: %w", err)`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`switch info.SCM {`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func (d *GCSDetector) detectHTTP(src string) (string, bool, error) {`
`36`	`36`	`url, err := url.Parse(fmt.Sprintf("https://www.googleapis.com/storage/%s/%s/%s",`
`37`	`37`	`version, bucket, object))`
`38`	`38`	`if err != nil {`
`39`		`- return "", false, fmt.Errorf("error parsing GCS URL: %s", err)`
	`39`	`+ return "", false, fmt.Errorf("error parsing GCS URL: %w", err)`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`return "gcs::" + url.String(), true, nil`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func (d *GitHubDetector) detectHTTP(src string) (string, bool, error) {`
`32`	`32`	`urlStr := fmt.Sprintf("https://%s", strings.Join(parts[:3], "/"))`
`33`	`33`	`url, err := url.Parse(urlStr)`
`34`	`34`	`if err != nil {`
`35`		`- return "", true, fmt.Errorf("error parsing GitHub URL: %s", err)`
	`35`	`+ return "", true, fmt.Errorf("error parsing GitHub URL: %w", err)`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`if !strings.HasSuffix(url.Path, ".git") {`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func (d *GitLabDetector) detectHTTP(src string) (string, bool, error) {`
`32`	`32`	`urlStr := fmt.Sprintf("https://%s", strings.Join(parts[:3], "/"))`
`33`	`33`	`repoUrl, err := url.Parse(urlStr)`
`34`	`34`	`if err != nil {`
`35`		`- return "", true, fmt.Errorf("error parsing GitLab URL: %s", err)`
	`35`	`+ return "", true, fmt.Errorf("error parsing GitLab URL: %w", err)`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`if !strings.HasSuffix(repoUrl.Path, ".git") {`