feat: add an interactive debugger to GnoVM

gnovm/cmd/gno/debug_test.go

@@ -0,0 +1,56 @@
+package main
+
+import (
+	"bytes"
+	"context"
+	"strings"
+	"testing"
+
+	"github.com/gnolang/gno/tm2/pkg/commands"
+)
+
+type dtest struct{ in, out string }
+
+const debugTarget = "../../tests/integ/debugger/sample.gno"
+
+func runDebugTest(t *testing.T, tests []dtest) {
+	args := []string{"run", "-debug", debugTarget}
+
+	for _, test := range tests {
+		test := test
+		t.Run("", func(t *testing.T) {
+			out := bytes.NewBufferString("")
+			err := bytes.NewBufferString("")
+			io := commands.NewTestIO()
+			io.SetIn(bytes.NewBufferString(test.in))
+			io.SetOut(commands.WriteNopCloser(out))
+			io.SetErr(commands.WriteNopCloser(err))
+			if err := newGnocliCmd(io).ParseAndRun(context.Background(), args); err != nil {
+				t.Fatal(err)
+			}
+			t.Log("in:", test.in, "out:", out)
+			if !strings.Contains(out.String(), test.out) {
+				t.Errorf("result does not contain \"%s\", got \"%s\"", test.out, out.String())
+			}
+		})
+	}
+}
+
+func TestDebug(t *testing.T) {
+	brk := "break " + debugTarget + ":7\n"
+	cont := brk + "continue\n"
+
+	runDebugTest(t, []dtest{
+		{in: "", out: "Welcome to the Gnovm debugger. Type 'help' for list of commands."},
+		{in: "help\n", out: "The following commands are available"},
+		{in: "h\n", out: "The following commands are available"},
+		{in: "help h\n", out: "Print the help message."},
+		{in: "list " + debugTarget + ":1\n", out: "1: // This is a sample target"},
+		{in: brk, out: "Breakpoint 0 at main "},
+		{in: cont, out: "=>    7: 	println(name, i)"},
+		{in: cont + "stack\n", out: "2	in main.main"},
+		{in: cont + "up\n", out: "=>   11: 	f(s, n)"},
+		{in: cont + "print name\n", out: `("hello" string)`},
+		{in: cont + "p i\n", out: `(3 int)`},
+	})
+}

gnovm/cmd/gno/run.go

@@ -16,9 +16,11 @@ import (
 )
 
 type runCfg struct {
-	verbose bool
-	rootDir string
-	expr    string
+	verbose   bool
+	rootDir   string
+	expr      string
+	debug     bool
+	debugAddr string
 }
 
 func newRunCmd(io commands.IO) *commands.Command {
@@ -58,6 +60,20 @@ func (c *runCfg) RegisterFlags(fs *flag.FlagSet) {
 		"main()",
 		"value of expression to evaluate. Defaults to executing function main() with no args",
 	)
+
+	fs.BoolVar(
+		&c.debug,
+		"debug",
+		false,
+		"enable interactive debugger using stdin and stdout",
+	)
+
+	fs.StringVar(
+		&c.debugAddr,
+		"debug-addr",
+		"",
+		"enable interactive debugger using tcp address in the form [host]:port",
+	)
 }
 
 func execRun(cfg *runCfg, args []string, io commands.IO) error {
@@ -96,10 +112,14 @@ func execRun(cfg *runCfg, args []string, io commands.IO) error {
 	}
 
 	m := gno.NewMachineWithOptions(gno.MachineOptions{
-		PkgPath: string(files[0].PkgName),
-		Output:  stdout,
-		Store:   testStore,
+		PkgPath:   string(files[0].PkgName),
+		Output:    stdout,
+		Store:     testStore,
+		Debug:     cfg.debug || cfg.debugAddr != "",
+		DebugAddr: cfg.debugAddr,
 	})
+	m.DebugIn = stdin
+	m.DebugOut = stdout
 
 	defer m.Release()