Add dev helpers and docs

Author: cmoog

README.md

@@ -56,6 +56,21 @@ func (s Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 }
 ```
 
+### Development / Testing
+
+Start a local executor:
+
+```
+go run ./dev/server
+```
+
+Start a client:
+
+```
+go run ./dev/client tty bash
+go run ./dev/client notty ls
+```
+
 ### Performance Goals
 
 Test command

dev/client/main.go

@@ -0,0 +1,113 @@
+package main
+
+import (
+	"context"
+	"io"
+	"os"
+
+	"cdr.dev/wsep"
+	"cdr.dev/wsep/internal/proto"
+	"github.com/spf13/pflag"
+	"go.coder.com/cli"
+	"go.coder.com/flog"
+	"nhooyr.io/websocket"
+)
+
+type notty struct {
+}
+
+func (c *notty) Run(fl *pflag.FlagSet) {
+	do(fl, false)
+}
+
+func (c *notty) Spec() cli.CommandSpec {
+	return cli.CommandSpec{
+		Name:    "notty",
+		Usage:   "[flags]",
+		Desc:    `Run a command without tty enabled.`,
+		RawArgs: true,
+	}
+}
+
+type tty struct {
+}
+
+func (c *tty) Run(fl *pflag.FlagSet) {
+	do(fl, true)
+}
+
+func (c *tty) Spec() cli.CommandSpec {
+	return cli.CommandSpec{
+		Name:    "tty",
+		Usage:   "[flags]",
+		Desc:    `Run a command with tty enabled.`,
+		RawArgs: true,
+	}
+}
+
+func do(fl *pflag.FlagSet, tty bool) {
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	conn, _, err := websocket.Dial(ctx, "ws://localhost:8080", nil)
+	if err != nil {
+		flog.Fatal("failed to dial remote executor: %v", err)
+	}
+	defer conn.Close(websocket.StatusAbnormalClosure, "terminate process")
+
+	executor := wsep.RemoteExecer(conn)
+
+	var args []string
+	if len(fl.Args()) < 1 {
+		flog.Fatal("a command argument is required")
+	}
+	if len(fl.Args()) > 1 {
+		args = fl.Args()[1:]
+	}
+	process, err := executor.Start(ctx, proto.Command{
+		Command: fl.Arg(0),
+		Args:    args,
+		TTY:     tty,
+	})
+	if err != nil {
+		flog.Fatal("failed to start remote command: %v", err)
+	}
+	go io.Copy(os.Stdout, process.Stdout())
+	go io.Copy(os.Stderr, process.Stderr())
+	go io.Copy(process.Stdin(), os.Stdin)
+
+	err = process.Wait()
+	if err != nil {
+		flog.Error("process failed: %v", err)
+	} else {
+		flog.Info("process finished successfully")
+	}
+	conn.Close(websocket.StatusNormalClosure, "normal closure")
+}
+
+type cmd struct {
+}
+
+func (c *cmd) Spec() cli.CommandSpec {
+	return cli.CommandSpec{
+		Name:    "wsep-client",
+		Usage:   "[flags]",
+		Desc:    `Run a simple wsep client for testing.`,
+		RawArgs: true,
+	}
+}
+
+func (c *cmd) Run(fl *pflag.FlagSet) {
+	fl.Usage()
+	os.Exit(1)
+}
+func (c *cmd) Subcommands() []cli.Command {
+	return []cli.Command{
+		&notty{},
+		&tty{},
+	}
+}
+
+func main() {
+	cli.RunRoot(&cmd{})
+}

dev/server/main.go

@@ -0,0 +1,32 @@
+package main
+
+import (
+	"net/http"
+
+	"cdr.dev/wsep"
+	"go.coder.com/flog"
+	"nhooyr.io/websocket"
+)
+
+func main() {
+	server := http.Server{
+		Addr:    ":8080",
+		Handler: server{},
+	}
+	err := server.ListenAndServe()
+	flog.Fatal("failed to listen: %v", err)
+}
+
+type server struct{}
+
+func (s server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	ws, err := websocket.Accept(w, r, &websocket.AcceptOptions{InsecureSkipVerify: true})
+	if err != nil {
+		w.WriteHeader(http.StatusInternalServerError)
+		return
+	}
+	err = wsep.Serve(r.Context(), ws, wsep.LocalExecer{})
+	if err != nil {
+		flog.Fatal("failed to serve local execer: %v", err)
+	}
+}

go.mod

@@ -4,6 +4,8 @@ go 1.14
 
 require (
 	github.com/creack/pty v1.1.11
+	github.com/spf13/pflag v1.0.5
+	go.coder.com/cli v0.4.0
 	go.coder.com/flog v0.0.0-20190906214207-47dd47ea0512
 	golang.org/x/sync v0.0.0-20200317015054-43a5402ce75a
 	golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543

go.sum

@@ -30,11 +30,17 @@ github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Ky
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
 github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg=
+github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
+github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
+github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw=
 github.com/ugorji/go/codec v1.1.7/go.mod h1:Ax+UKWsSmolVDwsd+7N3ZtXu+yMGCf907BLYF3GoBXY=
+go.coder.com/cli v0.4.0 h1:PruDGwm/CPFndyK/eMowZG3vzg5CgohRWeXWCTr3zi8=
+go.coder.com/cli v0.4.0/go.mod h1:hRTOURCR3LJF1FRW9arecgrzX+AHG7mfYMwThPIgq+w=
 go.coder.com/flog v0.0.0-20190906214207-47dd47ea0512 h1:DjCS6dRQh+1PlfiBmnabxfdrzenb0tAwJqFxDEH/s9g=
 go.coder.com/flog v0.0.0-20190906214207-47dd47ea0512/go.mod h1:83JsYgXYv0EOaXjIMnaZ1Fl6ddNB3fJnDZ/8845mUJ8=
 golang.org/x/sync v0.0.0-20200317015054-43a5402ce75a h1:WXEvlFVvvGxCJLG6REjsT03iWnKLEWinaScsxF2Vm2o=