fix: Pass down context.Context for proper context management

Author: liamg

checksum.go

@@ -6,6 +6,7 @@ package getter
 import (
 	"bufio"
 	"bytes"
+	"context"
 	"crypto/md5"
 	"crypto/sha1"
 	"crypto/sha256"
@@ -80,23 +81,27 @@ func (c *FileChecksum) checksum(source string) error {
 // extractChecksum will return a FileChecksum based on the 'checksum'
 // parameter of u.
 // ex:
-//  http://hashicorp.com/terraform?checksum=<checksumValue>
-//  http://hashicorp.com/terraform?checksum=<checksumType>:<checksumValue>
-//  http://hashicorp.com/terraform?checksum=file:<checksum_url>
+//
+//	http://hashicorp.com/terraform?checksum=<checksumValue>
+//	http://hashicorp.com/terraform?checksum=<checksumType>:<checksumValue>
+//	http://hashicorp.com/terraform?checksum=file:<checksum_url>
+//
 // when checksumming from a file, extractChecksum will go get checksum_url
 // in a temporary directory, parse the content of the file then delete it.
 // Content of files are expected to be BSD style or GNU style.
 //
 // BSD-style checksum:
-//  MD5 (file1) = <checksum>
-//  MD5 (file2) = <checksum>
+//
+//	MD5 (file1) = <checksum>
+//	MD5 (file2) = <checksum>
 //
 // GNU-style:
-//  <checksum>  file1
-//  <checksum> *file2
+//
+//	<checksum>  file1
+//	<checksum> *file2
 //
 // see parseChecksumLine for more detail on checksum file parsing
-func (c *Client) extractChecksum(u *url.URL) (*FileChecksum, error) {
+func (c *Client) extractChecksum(ctx context.Context, u *url.URL) (*FileChecksum, error) {
 	q := u.Query()
 	v := q.Get("checksum")
 
@@ -118,7 +123,7 @@ func (c *Client) extractChecksum(u *url.URL) (*FileChecksum, error) {
 
 	switch checksumType {
 	case "file":
-		return c.ChecksumFromFile(checksumValue, u)
+		return c.ChecksumFromFile(ctx, checksumValue, u)
 	default:
 		return newChecksumFromType(checksumType, checksumValue, filepath.Base(u.EscapedPath()))
 	}
@@ -193,7 +198,7 @@ func newChecksumFromValue(checksumValue, filename string) (*FileChecksum, error)
 //
 // ChecksumFromFile will only return checksums for files that match file
 // behind src
-func (c *Client) ChecksumFromFile(checksumFile string, src *url.URL) (*FileChecksum, error) {
+func (c *Client) ChecksumFromFile(ctx context.Context, checksumFile string, src *url.URL) (*FileChecksum, error) {
 	checksumFileURL, err := urlhelper.Parse(checksumFile)
 	if err != nil {
 		return nil, err
@@ -206,7 +211,6 @@ func (c *Client) ChecksumFromFile(checksumFile string, src *url.URL) (*FileCheck
 	defer os.Remove(tempfile)
 
 	c2 := &Client{
-		Ctx:              c.Ctx,
 		Getters:          c.Getters,
 		Decompressors:    c.Decompressors,
 		Detectors:        c.Detectors,
@@ -216,7 +220,7 @@ func (c *Client) ChecksumFromFile(checksumFile string, src *url.URL) (*FileCheck
 		Dst:              tempfile,
 		ProgressListener: c.ProgressListener,
 	}
-	if err = c2.Get(); err != nil {
+	if err = c2.Get(ctx); err != nil {
 		return nil, fmt.Errorf(
 			"Error downloading checksum file: %s", err)
 	}

client.go

@@ -26,8 +26,6 @@ var ErrSymlinkCopy = errors.New("copying of symlinks has been disabled")
 // Using a client directly allows more fine-grained control over how downloading
 // is done, as well as customizing the protocols supported.
 type Client struct {
-	// Ctx for cancellation
-	Ctx context.Context
 
 	// Src is the source URL to get.
 	//
@@ -104,7 +102,7 @@ func (c *Client) mode(mode os.FileMode) os.FileMode {
 }
 
 // Get downloads the configured source to the destination.
-func (c *Client) Get() error {
+func (c *Client) Get(ctx context.Context) error {
 	if err := c.Configure(c.Options...); err != nil {
 		return err
 	}
@@ -221,7 +219,7 @@ func (c *Client) Get() error {
 	}
 
 	// Determine checksum if we have one
-	checksum, err := c.extractChecksum(u)
+	checksum, err := c.extractChecksum(ctx, u)
 	if err != nil {
 		return fmt.Errorf("invalid checksum: %s", err)
 	}
@@ -232,7 +230,7 @@ func (c *Client) Get() error {
 
 	if mode == ClientModeAny {
 		// Ask the getter which client mode to use
-		mode, err = g.ClientMode(u)
+		mode, err = g.ClientMode(ctx, u)
 		if err != nil {
 			return err
 		}
@@ -270,7 +268,7 @@ func (c *Client) Get() error {
 			}
 		}
 		if getFile {
-			err := g.GetFile(dst, u)
+			err := g.GetFile(ctx, dst, u)
 			if err != nil {
 				return err
 			}
@@ -321,7 +319,7 @@ func (c *Client) Get() error {
 
 		// We're downloading a directory, which might require a bit more work
 		// if we're specifying a subdir.
-		err := g.Get(dst, u)
+		err := g.Get(ctx, dst, u)
 		if err != nil {
 			err = fmt.Errorf("error downloading '%s': %s", RedactURL(u), err)
 			return err
@@ -343,7 +341,7 @@ func (c *Client) Get() error {
 			return err
 		}
 
-		return copyDir(c.Ctx, realDst, subDir, false, c.DisableSymlinks, c.umask())
+		return copyDir(ctx, realDst, subDir, false, c.DisableSymlinks, c.umask())
 	}
 
 	return nil

client_option.go

@@ -4,7 +4,6 @@
 package getter
 
 import (
-	"context"
 	"os"
 )
 
@@ -15,10 +14,6 @@ type ClientOption func(*Client) error
 // behavior including context, decompressors, detectors, and getters used by
 // the client.
 func (c *Client) Configure(opts ...ClientOption) error {
-	// If the context has not been configured use the background context.
-	if c.Ctx == nil {
-		c.Ctx = context.Background()
-	}
 
 	// Store the options used to configure this client.
 	c.Options = opts
@@ -52,15 +47,6 @@ func (c *Client) Configure(opts ...ClientOption) error {
 	return nil
 }
 
-// WithContext allows to pass a context to operation
-// in order to be able to cancel a download in progress.
-func WithContext(ctx context.Context) ClientOption {
-	return func(c *Client) error {
-		c.Ctx = ctx
-		return nil
-	}
-}
-
 // WithDecompressors specifies which Decompressor are available.
 func WithDecompressors(decompressors map[string]Decompressor) ClientOption {
 	return func(c *Client) error {

client_option_progress_test.go

@@ -4,6 +4,7 @@
 package getter
 
 import (
+	"context"
 	"io"
 	"net/http"
 	"net/http/httptest"
@@ -42,7 +43,7 @@ func TestGet_progress(t *testing.T) {
 	{ // dl without tracking
 		dst := tempTestFile(t)
 		defer os.RemoveAll(filepath.Dir(dst))
-		if err := GetFile(dst, s.URL+"/file?thig=this&that"); err != nil {
+		if err := GetFile(context.Background(), dst, s.URL+"/file?thig=this&that"); err != nil {
 			t.Fatalf("download failed: %v", err)
 		}
 	}
@@ -51,10 +52,10 @@ func TestGet_progress(t *testing.T) {
 		p := &MockProgressTracking{}
 		dst := tempTestFile(t)
 		defer os.RemoveAll(filepath.Dir(dst))
-		if err := GetFile(dst, s.URL+"/file?thig=this&that", WithProgress(p)); err != nil {
+		if err := GetFile(context.Background(), dst, s.URL+"/file?thig=this&that", WithProgress(p)); err != nil {
 			t.Fatalf("download failed: %v", err)
 		}
-		if err := GetFile(dst, s.URL+"/otherfile?thig=this&that", WithProgress(p)); err != nil {
+		if err := GetFile(context.Background(), dst, s.URL+"/otherfile?thig=this&that", WithProgress(p)); err != nil {
 			t.Fatalf("download failed: %v", err)
 		}
 

cmd/go-getter/main.go

@@ -58,7 +58,6 @@ func main() {
 	ctx, cancel := context.WithCancel(context.Background())
 	// Build the client
 	client := &getter.Client{
-		Ctx:     ctx,
 		Src:     args[0],
 		Dst:     args[1],
 		Pwd:     pwd,
@@ -72,7 +71,7 @@ func main() {
 	go func() {
 		defer wg.Done()
 		defer cancel()
-		if err := client.Get(); err != nil {
+		if err := client.Get(ctx); err != nil {
 			errChan <- err
 		}
 	}()

folder_storage.go

@@ -4,6 +4,7 @@
 package getter
 
 import (
+	"context"
 	"crypto/md5"
 	"encoding/hex"
 	"fmt"
@@ -42,7 +43,7 @@ func (s *FolderStorage) Dir(key string) (d string, e bool, err error) {
 }
 
 // Get implements Storage.Get
-func (s *FolderStorage) Get(key string, source string, update bool) error {
+func (s *FolderStorage) Get(ctx context.Context, key string, source string, update bool) error {
 	dir := s.dir(key)
 	if !update {
 		if _, err := os.Stat(dir); err == nil {
@@ -57,7 +58,7 @@ func (s *FolderStorage) Get(key string, source string, update bool) error {
 	}
 
 	// Get the source. This always forces an update.
-	return Get(dir, source)
+	return Get(ctx, dir, source)
 }
 
 // dir returns the directory name internally that we'll use to map to

folder_storage_test.go

@@ -4,6 +4,7 @@
 package getter
 
 import (
+	"context"
 	"os"
 	"path/filepath"
 	"testing"
@@ -30,7 +31,7 @@ func TestFolderStorage(t *testing.T) {
 	key := "foo"
 
 	// We can get it
-	err = s.Get(key, module, false)
+	err = s.Get(context.Background(), key, module, false)
 	if err != nil {
 		t.Fatalf("err: %s", err)
 	}

get.go

@@ -16,6 +16,7 @@ package getter
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"net/url"
 	"os/exec"
@@ -33,16 +34,16 @@ type Getter interface {
 	// The directory may already exist (if we're updating). If it is in a
 	// format that isn't understood, an error should be returned. Get shouldn't
 	// simply nuke the directory.
-	Get(string, *url.URL) error
+	Get(context.Context, string, *url.URL) error
 
 	// GetFile downloads the give URL into the given path. The URL must
 	// reference a single file. If possible, the Getter should check if
 	// the remote end contains the same file and no-op this operation.
-	GetFile(string, *url.URL) error
+	GetFile(context.Context, string, *url.URL) error
 
 	// ClientMode returns the mode based on the given URL. This is used to
 	// allow clients to let the getters decide which mode to use.
-	ClientMode(*url.URL) (ClientMode, error)
+	ClientMode(context.Context, *url.URL) (ClientMode, error)
 
 	// SetClient allows a getter to know it's client
 	// in order to access client's Get functions or
@@ -82,13 +83,13 @@ func init() {
 //
 // src is a URL, whereas dst is always just a file path to a folder. This
 // folder doesn't need to exist. It will be created if it doesn't exist.
-func Get(dst, src string, opts ...ClientOption) error {
+func Get(ctx context.Context, dst, src string, opts ...ClientOption) error {
 	return (&Client{
 		Src:     src,
 		Dst:     dst,
 		Dir:     true,
 		Options: opts,
-	}).Get()
+	}).Get(ctx)
 }
 
 // GetAny downloads a URL into the given destination. Unlike Get or
@@ -97,24 +98,24 @@ func Get(dst, src string, opts ...ClientOption) error {
 // dst must be a directory. If src is a file, it will be downloaded
 // into dst with the basename of the URL. If src is a directory or
 // archive, it will be unpacked directly into dst.
-func GetAny(dst, src string, opts ...ClientOption) error {
+func GetAny(ctx context.Context, dst, src string, opts ...ClientOption) error {
 	return (&Client{
 		Src:     src,
 		Dst:     dst,
 		Mode:    ClientModeAny,
 		Options: opts,
-	}).Get()
+	}).Get(ctx)
 }
 
 // GetFile downloads the file specified by src into the path specified by
 // dst.
-func GetFile(dst, src string, opts ...ClientOption) error {
+func GetFile(ctx context.Context, dst, src string, opts ...ClientOption) error {
 	return (&Client{
 		Src:     src,
 		Dst:     dst,
 		Dir:     false,
 		Options: opts,
-	}).Get()
+	}).Get(ctx)
 }
 
 // getRunCommand is a helper that will run a command and capture the output

get_base.go

@@ -3,21 +3,10 @@
 
 package getter
 
-import "context"
-
 // getter is our base getter; it regroups
 // fields all getters have in common.
 type getter struct {
 	client *Client
 }
 
 func (g *getter) SetClient(c *Client) { g.client = c }
-
-// Context tries to returns the Contex from the getter's
-// client. otherwise context.Background() is returned.
-func (g *getter) Context() context.Context {
-	if g == nil || g.client == nil {
-		return context.Background()
-	}
-	return g.client.Ctx
-}

get_file.go

@@ -4,6 +4,7 @@
 package getter
 
 import (
+	"context"
 	"net/url"
 	"os"
 )
@@ -19,7 +20,7 @@ type FileGetter struct {
 	Copy bool
 }
 
-func (g *FileGetter) ClientMode(u *url.URL) (ClientMode, error) {
+func (g *FileGetter) ClientMode(_ context.Context, u *url.URL) (ClientMode, error) {
 	path := u.Path
 	if u.RawPath != "" {
 		path = u.RawPath