fix: address edge-case with using <me> with GPTSCRIPT_BIN

Before this change, the following command would not allow running of
gptscripts: GPTSCRIPT_BIN="<me>/gptscript" ./click-chats

This change address this edge-case.

Signed-off-by: Donnie Adams <[email protected]>

Author: thedadams

README.md

@@ -14,7 +14,7 @@ go get github.com/gptscript-ai/go-gptscript
 
 To use the module, you need to first set the OPENAI_API_KEY environment variable to your OpenAI API key.
 
-Additionally, you need the `gptscript` binary. You can install it on your system using the [installation instructions](https://github.com/gptscript-ai/gptscript?tab=readme-ov-file#1-install-the-latest-release).
+Additionally, you need the `gptscript` binary. You can install it on your system using the [installation instructions](https://github.com/gptscript-ai/gptscript?tab=readme-ov-file#1-install-the-latest-release). The binary can be on the PATH, or the `GPTSCRIPT_BIN` environment variable can be used to specify its location.
 
 ## Options
 

exec.go

@@ -6,6 +6,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"log/slog"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -315,16 +316,30 @@ func concatTools(tools []fmt.Stringer) string {
 
 func getCommand() string {
 	if gptScriptBin := os.Getenv("GPTSCRIPT_BIN"); gptScriptBin != "" {
-		if !strings.HasPrefix(gptScriptBin, relativeToBinaryPath) || len(os.Args) == 0 {
+		if len(os.Args) == 0 {
 			return gptScriptBin
 		}
-
-		return filepath.Join(filepath.Dir(os.Args[0]), strings.TrimPrefix(gptScriptBin, relativeToBinaryPath))
+		return determineProperCommand(filepath.Dir(os.Args[0]), gptScriptBin)
 	}
 
 	return "gptscript"
 }
 
+// determineProperCommand is for testing purposes. Users should use getCommand instead.
+func determineProperCommand(dir, bin string) string {
+	if !strings.HasPrefix(bin, relativeToBinaryPath) {
+		return bin
+	}
+
+	bin = filepath.Join(dir, strings.TrimPrefix(bin, relativeToBinaryPath))
+	if !filepath.IsAbs(bin) {
+		bin = "." + string(os.PathSeparator) + bin
+	}
+
+	slog.Debug("Using gptscript binary: " + bin)
+	return bin
+}
+
 func setupForkCommand(ctx context.Context, input string, args []string) (*exec.Cmd, io.Reader, io.Reader, error) {
 	if input != "" {
 		args = append(args, input)

exec_test.go

@@ -518,42 +518,58 @@ func TestExecWithWorkspace(t *testing.T) {
 	}
 }
 
-func TestGetCommand(t *testing.T) {
-	currentEnvVar := os.Getenv("GPTSCRIPT_BIN")
-	t.Cleanup(func() {
-		_ = os.Setenv("GPTSCRIPT_BIN", currentEnvVar)
-	})
-
+func TestDetermineProperCommand(t *testing.T) {
 	tests := []struct {
-		name   string
-		envVar string
-		want   string
+		name     string
+		dir, bin string
+		want     string
 	}{
 		{
-			name: "no env var set",
+			name: "no dir",
+			bin:  "gptscript",
 			want: "gptscript",
 		},
 		{
-			name:   "env var set to absolute path",
-			envVar: "/usr/local/bin/gptscript",
-			want:   "/usr/local/bin/gptscript",
+			name: "bin set to absolute path",
+			bin:  "/usr/local/bin/gptscript",
+			dir:  "/usr/local",
+			want: "/usr/local/bin/gptscript",
+		},
+		{
+			name: "bin set to relative path",
+			bin:  "../bin/gptscript",
+			dir:  "/usr/local",
+			want: "../bin/gptscript",
+		},
+		{
+			name: "bin set to relative 'to me' path with os.Args[0]",
+			bin:  "<me>/../bin/gptscript",
+			dir:  filepath.Dir(os.Args[0]),
+			want: filepath.Join(filepath.Dir(os.Args[0]), "../bin/gptscript"),
+		},
+		{
+			name: "env var set to relative 'to me' path with extra and dir is current",
+			bin:  "<me>/../bin/gptscript",
+			dir:  "./",
+			want: "./../bin/gptscript",
 		},
 		{
-			name:   "env var set to relative path",
-			envVar: "../bin/gptscript",
-			want:   "../bin/gptscript",
+			name: "env var set to relative 'to me' path and dir is current",
+			bin:  "<me>/gptscript",
+			dir:  "./",
+			want: "./gptscript",
 		},
 		{
-			name:   "env var set to relative 'to me' path",
-			envVar: "<me>/../bin/gptscript",
-			want:   filepath.Join(filepath.Dir(os.Args[0]), "../bin/gptscript"),
+			name: "env var set to relative 'to me' path with extra and dir is current",
+			bin:  "<me>/../bin/gptscript",
+			dir:  "./",
+			want: "./../bin/gptscript",
 		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			_ = os.Setenv("GPTSCRIPT_BIN", tt.envVar)
-			if got := getCommand(); got != tt.want {
-				t.Errorf("getCommand() = %v, want %v", got, tt.want)
+			if got := determineProperCommand(tt.dir, tt.bin); got != tt.want {
+				t.Errorf("determineProperCommand() = %v, want %v", got, tt.want)
 			}
 		})
 	}