refactor: reduce context.Background()

Signed-off-by: nerdylucifer <[email protected]>

Author: ashwat287

cmd/limactl/clone.go

@@ -72,7 +72,7 @@ func cloneAction(cmd *cobra.Command, args []string) error {
 		if err != nil {
 			return err
 		}
-		yBytes, err := yqutil.EvaluateExpression(yq, yContent)
+		yBytes, err := yqutil.EvaluateExpression(ctx, yq, yContent)
 		if err != nil {
 			return err
 		}

cmd/limactl/delete.go

@@ -47,7 +47,7 @@ func deleteAction(cmd *cobra.Command, args []string) error {
 			}
 			return err
 		}
-		if err := instance.Delete(cmd.Context(), inst, force); err != nil {
+		if err := instance.Delete(ctx, inst, force); err != nil {
 			return fmt.Errorf("failed to delete instance %q: %w", instName, err)
 		}
 		if runtime.GOOS == "darwin" || runtime.GOOS == "linux" {
@@ -60,7 +60,7 @@ func deleteAction(cmd *cobra.Command, args []string) error {
 		}
 		logrus.Infof("Deleted %q (%q)", instName, inst.Dir)
 	}
-	return networks.Reconcile(cmd.Context(), "")
+	return networks.Reconcile(ctx, "")
 }
 
 func deleteBashComplete(cmd *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {

cmd/limactl/edit.go

@@ -90,7 +90,7 @@ func editAction(cmd *cobra.Command, args []string) error {
 	var yBytes []byte
 	if len(yqExprs) > 0 {
 		yq := yqutil.Join(yqExprs)
-		yBytes, err = yqutil.EvaluateExpression(yq, yContent)
+		yBytes, err = yqutil.EvaluateExpression(ctx, yq, yContent)
 		if err != nil {
 			return err
 		}

cmd/limactl/hostagent.go

@@ -130,7 +130,7 @@ func hostagentAction(cmd *cobra.Command, args []string) error {
 		}
 	}()
 	defer srv.Close()
-	return ha.Run(cmd.Context())
+	return ha.Run(ctx)
 }
 
 // syncer is implemented by *os.File.

cmd/limactl/list.go

@@ -287,7 +287,7 @@ func listAction(cmd *cobra.Command, args []string) error {
 		}
 	} else {
 		var res []byte
-		if res, err = yqutil.EvaluateExpression(yqExpr, buf.Bytes()); err != nil {
+		if res, err = yqutil.EvaluateExpression(ctx, yqExpr, buf.Bytes()); err != nil {
 			return err
 		}
 		str = string(res)

cmd/limactl/network.go

@@ -4,6 +4,7 @@
 package main
 
 import (
+	"context"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -174,6 +175,8 @@ func networkCreateAction(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	ctx := cmd.Context()
+
 	switch mode {
 	case networks.ModeBridged:
 		if gateway != "" {
@@ -183,7 +186,7 @@ func networkCreateAction(cmd *cobra.Command, args []string) error {
 			return fmt.Errorf("network mode %q requires specifying interface", mode)
 		}
 		yq := fmt.Sprintf(`.networks.%q = {"mode":%q,"interface":%q}`, name, mode, intf)
-		return networkApplyYQ(yq)
+		return networkApplyYQ(ctx, yq)
 	default:
 		if gateway == "" {
 			return fmt.Errorf("network mode %q requires specifying gateway", mode)
@@ -208,11 +211,11 @@ func networkCreateAction(cmd *cobra.Command, args []string) error {
 		// TODO: check IP range collision
 
 		yq := fmt.Sprintf(`.networks.%q = {"mode":%q,"gateway":%q,"netmask":%q,"interface":%q}`, name, mode, gwIP.String(), gwMaskStr, intf)
-		return networkApplyYQ(yq)
+		return networkApplyYQ(ctx, yq)
 	}
 }
 
-func networkApplyYQ(yq string) error {
+func networkApplyYQ(ctx context.Context, yq string) error {
 	filePath, err := networks.ConfigFile()
 	if err != nil {
 		return err
@@ -221,7 +224,7 @@ func networkApplyYQ(yq string) error {
 	if err != nil {
 		return err
 	}
-	yBytes, err := yqutil.EvaluateExpression(yq, yContent)
+	yBytes, err := yqutil.EvaluateExpression(ctx, yq, yContent)
 	if err != nil {
 		return err
 	}
@@ -263,7 +266,7 @@ func networkDeleteAction(cmd *cobra.Command, args []string) error {
 			yq += " | "
 		}
 	}
-	return networkApplyYQ(yq)
+	return networkApplyYQ(cmd.Context(), yq)
 }
 
 func networkBashComplete(cmd *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {

cmd/limactl/start.go

@@ -307,7 +307,7 @@ func loadOrCreateInstance(cmd *cobra.Command, args []string, createOnly bool) (*
 			return nil, err
 		}
 	} else {
-		tmpl, err = limatmpl.Read(cmd.Context(), name, arg)
+		tmpl, err = limatmpl.Read(ctx, name, arg)
 		if err != nil {
 			return nil, err
 		}
@@ -321,7 +321,7 @@ func loadOrCreateInstance(cmd *cobra.Command, args []string, createOnly bool) (*
 		}
 	}
 
-	if err := tmpl.Embed(cmd.Context(), true, true); err != nil {
+	if err := tmpl.Embed(ctx, true, true); err != nil {
 		return nil, err
 	}
 	yqExprs, err := editflags.YQExpressions(flags, true)
@@ -331,18 +331,18 @@ func loadOrCreateInstance(cmd *cobra.Command, args []string, createOnly bool) (*
 	yq := yqutil.Join(yqExprs)
 	if tty {
 		var err error
-		tmpl, err = chooseNextCreatorState(cmd.Context(), tmpl, yq)
+		tmpl, err = chooseNextCreatorState(ctx, tmpl, yq)
 		if err != nil {
 			return nil, err
 		}
 	} else {
 		logrus.Info("Terminal is not available, proceeding without opening an editor")
-		if err := modifyInPlace(tmpl, yq); err != nil {
+		if err := modifyInPlace(ctx, tmpl, yq); err != nil {
 			return nil, err
 		}
 	}
 	saveBrokenYAML := tty
-	return instance.Create(cmd.Context(), tmpl.Name, tmpl.Bytes, saveBrokenYAML)
+	return instance.Create(ctx, tmpl.Name, tmpl.Bytes, saveBrokenYAML)
 }
 
 func applyYQExpressionToExistingInstance(ctx context.Context, inst *limatype.Instance, yq string) (*limatype.Instance, error) {
@@ -355,7 +355,7 @@ func applyYQExpressionToExistingInstance(ctx context.Context, inst *limatype.Ins
 		return nil, err
 	}
 	logrus.Debugf("Applying yq expression %q to an existing instance %q", yq, inst.Name)
-	yBytes, err := yqutil.EvaluateExpression(yq, yContent)
+	yBytes, err := yqutil.EvaluateExpression(ctx, yq, yContent)
 	if err != nil {
 		return nil, err
 	}
@@ -381,8 +381,8 @@ func applyYQExpressionToExistingInstance(ctx context.Context, inst *limatype.Ins
 	return store.Inspect(ctx, inst.Name)
 }
 
-func modifyInPlace(st *limatmpl.Template, yq string) error {
-	out, err := yqutil.EvaluateExpression(yq, st.Bytes)
+func modifyInPlace(ctx context.Context, st *limatmpl.Template, yq string) error {
+	out, err := yqutil.EvaluateExpression(ctx, yq, st.Bytes)
 	if err != nil {
 		return err
 	}
@@ -407,7 +407,7 @@ func (exitSuccessError) ExitCode() int {
 
 func chooseNextCreatorState(ctx context.Context, tmpl *limatmpl.Template, yq string) (*limatmpl.Template, error) {
 	for {
-		if err := modifyInPlace(tmpl, yq); err != nil {
+		if err := modifyInPlace(ctx, tmpl, yq); err != nil {
 			logrus.WithError(err).Warn("Failed to evaluate yq expression")
 			return tmpl, err
 		}

cmd/limactl/template.go

@@ -125,7 +125,7 @@ func templateCopyAction(cmd *cobra.Command, args []string) error {
 	if embed && verbatim {
 		return errors.New("--verbatim cannot be used with any of --embed, --embed-all, or --fill")
 	}
-	tmpl, err := limatmpl.Read(cmd.Context(), "", source)
+	tmpl, err := limatmpl.Read(ctx, "", source)
 	if err != nil {
 		return err
 	}
@@ -135,11 +135,11 @@ func templateCopyAction(cmd *cobra.Command, args []string) error {
 	if !verbatim {
 		if embed {
 			// Embed default base.yaml only when fill is true.
-			if err := tmpl.Embed(cmd.Context(), embedAll, fill); err != nil {
+			if err := tmpl.Embed(ctx, embedAll, fill); err != nil {
 				return err
 			}
 		} else {
-			if err := tmpl.UseAbsLocators(); err != nil {
+			if err := tmpl.UseAbsLocators(ctx); err != nil {
 				return err
 			}
 		}
@@ -197,14 +197,14 @@ func templateYQAction(cmd *cobra.Command, args []string) error {
 	ctx := cmd.Context()
 	locator := args[0]
 	expr := args[1]
-	tmpl, err := limatmpl.Read(cmd.Context(), "", locator)
+	tmpl, err := limatmpl.Read(ctx, "", locator)
 	if err != nil {
 		return err
 	}
 	if len(tmpl.Bytes) == 0 {
 		return fmt.Errorf("don't know how to interpret %q as a template locator", locator)
 	}
-	if err := tmpl.Embed(cmd.Context(), true, true); err != nil {
+	if err := tmpl.Embed(ctx, true, true); err != nil {
 		return err
 	}
 	if err := fillDefaults(ctx, tmpl); err != nil {
@@ -241,7 +241,7 @@ func templateValidateAction(cmd *cobra.Command, args []string) error {
 	}
 
 	for _, arg := range args {
-		tmpl, err := limatmpl.Read(cmd.Context(), "", arg)
+		tmpl, err := limatmpl.Read(ctx, "", arg)
 		if err != nil {
 			return err
 		}
@@ -252,7 +252,7 @@ func templateValidateAction(cmd *cobra.Command, args []string) error {
 			return fmt.Errorf("can't determine instance name from template locator %q", arg)
 		}
 		// Embed default base.yaml only when fill is true.
-		if err := tmpl.Embed(cmd.Context(), true, fill); err != nil {
+		if err := tmpl.Embed(ctx, true, fill); err != nil {
 			return err
 		}
 		// Load() will merge the template with override.yaml and default.yaml via FillDefaults().

pkg/driver/driver.go

@@ -46,7 +46,7 @@ type Lifecycle interface {
 type GUI interface {
 	// RunGUI is for starting GUI synchronously by hostagent. This method should be wait and return only after vm terminates
 	// It returns error if there are any failures
-	RunGUI() error
+	RunGUI(context.Context) error
 
 	ChangeDisplayPassword(ctx context.Context, password string) error
 	DisplayConnection(ctx context.Context) (string, error)
@@ -63,7 +63,7 @@ type SnapshotManager interface {
 // GuestAgent defines operations for the guest agent.
 type GuestAgent interface {
 	// ForwardGuestAgent returns if the guest agent sock needs forwarding by host agent.
-	ForwardGuestAgent() bool
+	ForwardGuestAgent(context.Context) bool
 
 	// GuestAgentConn returns the guest agent connection, or nil (if forwarded by ssh).
 	GuestAgentConn(_ context.Context) (net.Conn, string, error)
@@ -76,12 +76,12 @@ type Driver interface {
 	SnapshotManager
 	GuestAgent
 
-	Info() Info
+	Info(context.Context) Info
 
 	// Configure sets the configuration for the instance.
 	// TODO: merge Configure and FillConfig?
 	// Or come up with a better name to clarify the difference.
-	Configure(inst *limatype.Instance) *ConfiguredDriver
+	Configure(_ context.Context, inst *limatype.Instance) *ConfiguredDriver
 
 	// FillConfig fills and validates the configuration for the instance.
 	// The config is not set to the instance.

pkg/driver/external/client/methods.go

@@ -119,10 +119,10 @@ func (d *DriverClient) FillConfig(_ context.Context, _ *limatype.LimaYAML, _ str
 	return errors.New("pre-configured driver action not implemented in client driver")
 }
 
-func (d *DriverClient) RunGUI() error {
+func (d *DriverClient) RunGUI(ctx context.Context) error {
 	d.logger.Debug("Running GUI for the driver instance")
 
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(ctx, 10*time.Second)
 	defer cancel()
 
 	_, err := d.DriverSvc.RunGUI(ctx, &emptypb.Empty{})
@@ -221,10 +221,10 @@ func (d *DriverClient) ListSnapshots(ctx context.Context) (string, error) {
 	return resp.Snapshots, nil
 }
 
-func (d *DriverClient) ForwardGuestAgent() bool {
+func (d *DriverClient) ForwardGuestAgent(ctx context.Context) bool {
 	d.logger.Debug("Checking if guest agent needs to be forwarded")
 
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(ctx, 10*time.Second)
 	defer cancel()
 
 	resp, err := d.DriverSvc.ForwardGuestAgent(ctx, &emptypb.Empty{})
@@ -247,10 +247,10 @@ func (d *DriverClient) GuestAgentConn(ctx context.Context) (net.Conn, string, er
 	return nil, "", nil
 }
 
-func (d *DriverClient) Info() driver.Info {
+func (d *DriverClient) Info(ctx context.Context) driver.Info {
 	d.logger.Debug("Getting driver info")
 
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(ctx, 10*time.Second)
 	defer cancel()
 
 	resp, err := d.DriverSvc.Info(ctx, &emptypb.Empty{})
@@ -269,7 +269,7 @@ func (d *DriverClient) Info() driver.Info {
 	return info
 }
 
-func (d *DriverClient) Configure(inst *limatype.Instance) *driver.ConfiguredDriver {
+func (d *DriverClient) Configure(ctx context.Context, inst *limatype.Instance) *driver.ConfiguredDriver {
 	d.logger.Debugf("Setting config for instance %s with SSH local port %d", inst.Name, inst.SSHLocalPort)
 
 	instJSON, err := inst.MarshalJSON()
@@ -278,7 +278,7 @@ func (d *DriverClient) Configure(inst *limatype.Instance) *driver.ConfiguredDriv
 		return nil
 	}
 
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ctx, cancel := context.WithTimeout(ctx, 10*time.Second)
 	defer cancel()
 
 	_, err = d.DriverSvc.Configure(ctx, &pb.SetConfigRequest{