Update deps and embed a standard Contxt in cmd.Context

Author: wallyworld

cmd.go

@@ -5,6 +5,7 @@ package cmd
 
 import (
 	"bytes"
+	"context"
 	"errors"
 	"fmt"
 	"io"
@@ -108,6 +109,7 @@ func (c *CommandBase) AllowInterspersedFlags() bool {
 // should interpret file names relative to Dir (see AbsPath below), and print
 // output and errors to Stdout and Stderr respectively.
 type Context struct {
+	context.Context
 	Dir              string
 	Env              map[string]string
 	Stdin            io.Reader
@@ -119,6 +121,13 @@ type Context struct {
 	serialisable     bool
 }
 
+// With returns a command context with the specified context.Context.
+func (ctx *Context) With(c context.Context) *Context {
+	newCtx := *ctx
+	newCtx.Context = c
+	return &newCtx
+}
+
 // Quiet reports whether the command is in "quiet" mode. When
 // this is true, informational output should be suppressed (logger
 // messages can be used instead).
@@ -407,12 +416,14 @@ func DefaultContext() (*Context, error) {
 	if err != nil {
 		return nil, err
 	}
-	return &Context{
+	ctx := &Context{
 		Dir:    abs,
 		Stdin:  os.Stdin,
 		Stdout: os.Stdout,
 		Stderr: os.Stderr,
-	}, nil
+	}
+	ctx.Context = context.Background()
+	return ctx, nil
 }
 
 // CheckEmpty is a utility function that returns an error if args is not empty.

cmd_test.go

@@ -5,17 +5,20 @@ package cmd_test
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"os"
 	"path/filepath"
 	"strings"
 
+	jc "github.com/juju/testing/checkers"
 	gc "gopkg.in/check.v1"
 
-	"github.com/juju/cmd/v3"
-	"github.com/juju/cmd/v3/cmdtesting"
 	"github.com/juju/gnuflag"
 	"github.com/juju/testing"
+
+	"github.com/juju/cmd/v3"
+	"github.com/juju/cmd/v3/cmdtesting"
 )
 
 var _ = gc.Suite(&CmdSuite{})
@@ -27,13 +30,22 @@ type CmdSuite struct {
 
 func (s *CmdSuite) TestContext(c *gc.C) {
 	ctx := cmdtesting.Context(c)
+	c.Check(ctx.Context, jc.DeepEquals, context.Background())
 	c.Check(ctx.AbsPath("/foo/bar"), gc.Equals, "/foo/bar")
 	c.Check(ctx.AbsPath("/foo/../bar"), gc.Equals, "/bar")
 	c.Check(ctx.AbsPath("foo/bar"), gc.Equals, filepath.Join(ctx.Dir, "foo/bar"))
 	homeDir := os.Getenv("HOME")
 	c.Check(ctx.AbsPath("~/foo/bar"), gc.Equals, filepath.Join(homeDir, "foo/bar"))
 }
 
+func (s *CmdSuite) TestWith(c *gc.C) {
+	ctx := cmdtesting.Context(c)
+	cancelCtx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+	ctx = ctx.With(cancelCtx)
+	c.Assert(ctx.Context, jc.DeepEquals, cancelCtx)
+}
+
 func (s *CmdSuite) TestContextGetenv(c *gc.C) {
 	ctx := cmdtesting.Context(c)
 	ctx.Env = make(map[string]string)

cmdtesting/cmd.go

@@ -5,6 +5,7 @@ package cmdtesting
 
 import (
 	"bytes"
+	"context"
 	"io/ioutil"
 
 	"github.com/juju/gnuflag"
@@ -36,23 +37,27 @@ func InitCommand(c cmd.Command, args []string) error {
 // Context creates a simple command execution context with the current
 // dir set to a newly created directory within the test directory.
 func Context(c *gc.C) *cmd.Context {
-	return &cmd.Context{
+	ctx := &cmd.Context{
 		Dir:    c.MkDir(),
 		Stdin:  &bytes.Buffer{},
 		Stdout: &bytes.Buffer{},
 		Stderr: &bytes.Buffer{},
 	}
+	ctx.Context = context.TODO()
+	return ctx
 }
 
 // ContextForDir creates a simple command execution context with the current
 // dir set to the specified directory.
 func ContextForDir(c *gc.C, dir string) *cmd.Context {
-	return &cmd.Context{
+	ctx := &cmd.Context{
 		Dir:    dir,
 		Stdin:  &bytes.Buffer{},
 		Stdout: &bytes.Buffer{},
 		Stderr: &bytes.Buffer{},
 	}
+	ctx.Context = context.TODO()
+	return ctx
 }
 
 // Stdout takes a command Context that we assume has been created in this

go.mod

@@ -4,28 +4,27 @@ go 1.17
 
 require (
 	github.com/juju/ansiterm v0.0.0-20210706145210-9283cdf370b5
-	github.com/juju/errors v0.0.0-20200330140219-3fe23663418f
+	github.com/juju/errors v0.0.0-20220203013757-bd733f3c86b9
 	github.com/juju/gnuflag v0.0.0-20171113085948-2ce1bb71843d
 	github.com/juju/loggo v0.0.0-20210728185423-eebad3a902c4
-	github.com/juju/testing v0.0.0-20220202055744-1ad0816210a6
-	github.com/juju/utils/v3 v3.0.0-20220130232349-cd7ecef0e94a
+	github.com/juju/testing v0.0.0-20220203020004-a0ff61f03494
+	github.com/juju/utils/v3 v3.0.0-20220203023959-c3fbc78a33b0
 	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c
 	gopkg.in/yaml.v2 v2.4.0
 )
 
 require (
-	github.com/juju/clock v0.0.0-20190205081909-9c5c9712527c // indirect
-	github.com/juju/collections v0.0.0-20200605021417-0d0ec82b7271 // indirect
+	github.com/juju/clock v0.0.0-20220203021603-d9deb868a28a // indirect
+	github.com/juju/collections v0.0.0-20220203020748-febd7cad8a7a // indirect
 	github.com/juju/mgo/v2 v2.0.0-20210302023703-70d5d206e208 // indirect
 	github.com/juju/retry v0.0.0-20180821225755-9058e192b216 // indirect
-	github.com/juju/version v0.0.0-20191219164919-81c1be00b9a6 // indirect
+	github.com/juju/version/v2 v2.0.0-20211007103408-2e8da085dc23 // indirect
 	github.com/kr/pretty v0.2.1 // indirect
 	github.com/kr/text v0.2.0 // indirect
 	github.com/lunixbochs/vtclean v1.0.0 // indirect
 	github.com/mattn/go-colorable v0.1.8 // indirect
 	github.com/mattn/go-isatty v0.0.13 // indirect
-	golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 // indirect
-	golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d // indirect
+	golang.org/x/crypto v0.0.0-20211215153901-e495a2d5b3d3 // indirect
+	golang.org/x/net v0.0.0-20211216030914-fe4d6282115f // indirect
 	golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069 // indirect
-	gopkg.in/mgo.v2 v2.0.0-20190816093944-a6b53ec6cb22 // indirect
 )