feat(goenv,gomod): use context

Author: ldez

goenv/goenv.go

@@ -3,23 +3,16 @@ package goenv
 
 import (
 	"bytes"
+	"context"
 	"encoding/json"
 	"fmt"
 	"os/exec"
 	"strings"
 )
 
 // GetAll gets information from "go env".
-func GetAll() (map[string]string, error) {
-	cmd := exec.Command("go", "env", "-json")
-
-	out, err := cmd.Output()
-	if err != nil {
-		return nil, fmt.Errorf("command %q: %w: %s", strings.Join(cmd.Args, " "), err, string(out))
-	}
-
-	v := map[string]string{}
-	err = json.NewDecoder(bytes.NewBuffer(out)).Decode(&v)
+func GetAll(ctx context.Context) (map[string]string, error) {
+	v, err := Get(ctx)
 	if err != nil {
 		return nil, err
 	}
@@ -28,16 +21,8 @@ func GetAll() (map[string]string, error) {
 }
 
 // GetOne gets information from "go env" for one environment variable.
-func GetOne(name string) (string, error) {
-	cmd := exec.Command("go", "env", "-json", name)
-
-	out, err := cmd.Output()
-	if err != nil {
-		return "", fmt.Errorf("command %q: %w: %s", strings.Join(cmd.Args, " "), err, string(out))
-	}
-
-	v := map[string]string{}
-	err = json.NewDecoder(bytes.NewBuffer(out)).Decode(&v)
+func GetOne(ctx context.Context, name string) (string, error) {
+	v, err := Get(ctx, name)
 	if err != nil {
 		return "", err
 	}
@@ -46,9 +31,9 @@ func GetOne(name string) (string, error) {
 }
 
 // Get gets information from "go env" for one or several environment variables.
-func Get(name ...string) (map[string]string, error) {
+func Get(ctx context.Context, name ...string) (map[string]string, error) {
 	args := append([]string{"env", "-json"}, name...)
-	cmd := exec.Command("go", args...) //nolint:gosec // The env var names must be checked by the user.
+	cmd := exec.CommandContext(ctx, "go", args...) //nolint:gosec // The env var names must be checked by the user.
 
 	out, err := cmd.Output()
 	if err != nil {

goenv/goenv_test.go

@@ -1,6 +1,7 @@
 package goenv
 
 import (
+	"context"
 	"path/filepath"
 	"testing"
 
@@ -9,7 +10,7 @@ import (
 )
 
 func TestGetOne(t *testing.T) {
-	p, err := GetOne(GOMOD)
+	p, err := GetOne(context.Background(), GOMOD)
 	require.NoError(t, err)
 
 	abs, err := filepath.Abs("..")
@@ -19,7 +20,7 @@ func TestGetOne(t *testing.T) {
 }
 
 func TestGet(t *testing.T) {
-	values, err := Get(GOMOD, GOCACHE)
+	values, err := Get(context.Background(), GOMOD, GOCACHE)
 	require.NoError(t, err)
 
 	assert.NotEmpty(t, values[GOMOD])

gomod/gomod.go

@@ -3,6 +3,7 @@ package gomod
 
 import (
 	"bytes"
+	"context"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -27,9 +28,9 @@ type ModInfo struct {
 }
 
 // GetModuleInfo gets modules information from `go list`.
-func GetModuleInfo() ([]ModInfo, error) {
+func GetModuleInfo(ctx context.Context) ([]ModInfo, error) {
 	// https://github.com/golang/go/issues/44753#issuecomment-790089020
-	cmd := exec.Command("go", "list", "-m", "-json")
+	cmd := exec.CommandContext(ctx, "go", "list", "-m", "-json")
 
 	out, err := cmd.Output()
 	if err != nil {
@@ -62,15 +63,9 @@ func GetModuleInfo() ([]ModInfo, error) {
 	return infos, nil
 }
 
-// GetGoModPath extracts go.mod path from "go env".
-// Deprecated: use goenv.GetOne(goenv.GOMOD) instead.
-func GetGoModPath() (string, error) {
-	return goenv.GetOne(goenv.GOMOD)
-}
-
 // GetModulePath extracts module path from go.mod.
-func GetModulePath() (string, error) {
-	p, err := goenv.GetOne(goenv.GOMOD)
+func GetModulePath(ctx context.Context) (string, error) {
+	p, err := goenv.GetOne(ctx, goenv.GOMOD)
 	if err != nil {
 		return "", err
 	}
@@ -82,3 +77,9 @@ func GetModulePath() (string, error) {
 
 	return modfile.ModulePath(b), nil
 }
+
+// GetGoModPath extracts go.mod path from "go env".
+// Deprecated: use `goenv.GetOne(context.Background(), goenv.GOMOD)` instead.
+func GetGoModPath() (string, error) {
+	return goenv.GetOne(context.Background(), goenv.GOMOD)
+}

gomod/gomod_test.go

@@ -1,14 +1,15 @@
 package gomod
 
 import (
+	"context"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
 func TestGetModuleInfo(t *testing.T) {
-	info, err := GetModuleInfo()
+	info, err := GetModuleInfo(context.Background())
 	require.NoError(t, err)
 
 	require.Len(t, info, 1)
@@ -19,7 +20,7 @@ func TestGetModuleInfo(t *testing.T) {
 }
 
 func TestGetModulePath(t *testing.T) {
-	p, err := GetModulePath()
+	p, err := GetModulePath(context.Background())
 	require.NoError(t, err)
 
 	assert.Equal(t, "github.com/ldez/grignotin", p)