diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | Makefile | 117 | ||||
| -rw-r--r-- | deps.mk | 0 | ||||
| -rw-r--r-- | go.mod | 8 | ||||
| -rw-r--r-- | go.sum | 4 | ||||
| -rwxr-xr-x | mkdeps.sh | 10 | ||||
| -rw-r--r-- | src/cmd/main.go | 7 | ||||
| -rw-r--r-- | src/lib.go | 118 | ||||
| -rwxr-xr-x | tests/cli-opts.sh | 47 | ||||
| -rwxr-xr-x | tests/integration.sh | 0 | ||||
| -rw-r--r-- | tests/lib.sh | 119 | ||||
| -rw-r--r-- | tests/lib_test.go | 24 |
12 files changed, 456 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..85a298a --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/*.bin +/tests/*.bin diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..2fa1777 --- /dev/null +++ b/Makefile @@ -0,0 +1,117 @@ +.POSIX: +DATE = 1970-01-01 +VERSION = 0.1.0 +NAME = wscat +NAME_UC = $(NAME) +LANGUAGES = en +## Installation prefix. Defaults to "/usr". +PREFIX = /usr +BINDIR = $(PREFIX)/bin +LIBDIR = $(PREFIX)/lib +INCLUDEDIR = $(PREFIX)/include +SRCDIR = $(PREFIX)/src/$(NAME) +SHAREDIR = $(PREFIX)/share +LOCALEDIR = $(SHAREDIR)/locale +MANDIR = $(SHAREDIR)/man +EXEC = ./ +## Where to store the installation. Empty by default. +DESTDIR = +LDLIBS = +GOFLAGS = + + + +.SUFFIXES: +.SUFFIXES: .go .bin + + + +all: +include deps.mk + + +sources = \ + src/lib.go \ + src/cmd/main.go \ + + +derived-assets = \ + $(NAME).bin \ + tests/lib_test.bin \ + +side-assets = \ + wscat.socket \ + + + +## Default target. Builds all artifacts required for testing +## and installation. +all: $(derived-assets) + + +$(NAME).bin: src/lib.go src/cmd/main.go Makefile + go build $(GOFLAGS) -v -o $@ src/cmd/main.go + +tests/lib_test.bin: src/lib.go tests/lib_test.go Makefile + go test $(GOFLAGS) -v -o $@ -c $*.go + + + +check-unit: tests/lib_test.bin + ./tests/lib_test.bin + + +integration-tests = \ + tests/cli-opts.sh \ + tests/integration.sh \ + +$(integration-tests): $(NAME).bin +$(integration-tests): ALWAYS + sh $@ + +check-integration: $(integration-tests) + + +## Run all tests. Each test suite is isolated, so that a parallel +## build can run tests at the same time. The required artifacts +## are created if missing. +check: check-unit check-integration + + + +## Remove *all* derived artifacts produced during the build. +## A dedicated test asserts that this is always true. +clean: + rm -rf $(derived-assets) $(side-assets) + + +## Installs into $(DESTDIR)$(PREFIX). Its dependency target +## ensures that all installable artifacts are crafted beforehand. +install: all + mkdir -p \ + '$(DESTDIR)$(BINDIR)' \ + + cp $(NAME).bin '$(DESTDIR)$(BINDIR)'/$(NAME) + for f in $(sources); do \ + dir='$(DESTDIR)$(SRCDIR)'/"`dirname "$${f#src/}"`"; \ + mkdir -p "$$dir"; \ + cp -P "$$f" "$$dir"; \ + done + +## Uninstalls from $(DESTDIR)$(PREFIX). This is a perfect mirror +## of the "install" target, and removes *all* that was installed. +## A dedicated test asserts that this is always true. +uninstall: + rm -rf \ + '$(DESTDIR)$(BINDIR)'/$(NAME) \ + '$(DESTDIR)$(SRCDIR)' \ + + + +## Run it locally. +run: all + rm -f wscat.socket + ./$(NAME).bin wscat.socket retcp.socket + + +ALWAYS: @@ -0,0 +1,8 @@ +module euandre.org/wscat + +go 1.21.5 + +require github.com/gorilla/websocket v1.5.1 +require golang.org/x/net v0.17.0 // indirect +require euandre.org/gobang v0.1.0 +replace euandre.org/gobang => ../gobang @@ -0,0 +1,4 @@ +github.com/gorilla/websocket v1.5.1 h1:gmztn0JnHVt9JZquRuzLw3g4wouNVzKL15iLr/zn/QY= +github.com/gorilla/websocket v1.5.1/go.mod h1:x3kM2JMyaluk02fnUJpQuwD2dCS5NDG2ZHL0uE0tcaY= +golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM= +golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= diff --git a/mkdeps.sh b/mkdeps.sh new file mode 100755 index 0000000..a6b23d5 --- /dev/null +++ b/mkdeps.sh @@ -0,0 +1,10 @@ +#!/bin/sh +set -eu + +export LANG=POSIX.UTF-8 + +varlist() { + printf '%s = \\\n' "$1" + sed 's|^\(.*\)$|\t\1 \\|' + printf '\n' +} diff --git a/src/cmd/main.go b/src/cmd/main.go new file mode 100644 index 0000000..e6ae309 --- /dev/null +++ b/src/cmd/main.go @@ -0,0 +1,7 @@ +package main + +import "euandre.org/wscat/src" + +func main() { + wscat.Main() +} diff --git a/src/lib.go b/src/lib.go new file mode 100644 index 0000000..3733475 --- /dev/null +++ b/src/lib.go @@ -0,0 +1,118 @@ +package wscat + +import ( + "fmt" + "net" + "net/http" + "os" + + g "euandre.org/gobang/src" + + "github.com/gorilla/websocket" +) + + + +type CLIArgs struct { + FromAddr string + ToAddr string +} + + + +const X = 1 + +var EmitActiveConnection = g.MakeGauge("active-connections") + + + +func ParseArgs(args []string) CLIArgs { + if len(args) != 3 { + fmt.Fprintf( + os.Stderr, + "Usage: %s FROM.socket TO.socket\n", + args[0], + ) + os.Exit(2) + } + return CLIArgs { + FromAddr: args[1], + ToAddr: args[2], + } +} + +func Listen(fromAddr string) net.Listener { + listener, err := net.Listen("unix", fromAddr) + g.FatalIf(err) + g.Info("Started listening", "listen-start", "from-address", fromAddr) + return listener +} + +func Start(toAddr string, listener net.Listener) { + upgrader := websocket.Upgrader {} + http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { + connFrom, err := upgrader.Upgrade(w, r, nil) + if err != nil { + g.Warning( + "Error upgrading connection", + "upgrade-connection-error", + "err", err, + ) + return + } + defer connFrom.Close() + EmitActiveConnection.Inc() + + connTo, err := net.Dial("unix", toAddr) + if err != nil { + g.Error( + "Error dialing connection", + "dial-connection", + "err", err, + ) + os.Exit(1) + } + defer connTo.Close() + + messageType, reader, err := connFrom.NextReader() + if err != nil { + g.Warning( + "Failed to get next reader from connection", + "connection-next-reader-error", + "err", err, + ) + return + } + + writer, err := connFrom.NextWriter(messageType) + if err != nil { + g.Warning( + "Failed to get next reader from connection", + "connection-next-reader-error", + "err", err, + ) + return + } + + + c := make(chan g.CopyResult) + go g.CopyData(c, "c2s", connTo, writer) + go g.CopyData(c, "s2c", reader, connTo) + go func() { + <- c + EmitActiveConnection.Dec() + }() + }); + + server := http.Server{} + err := server.Serve(listener) + g.FatalIf(err) +} + + +func Main() { + g.Init() + args := ParseArgs(os.Args) + listener := Listen(args.FromAddr) + Start(args.ToAddr, listener) +} diff --git a/tests/cli-opts.sh b/tests/cli-opts.sh new file mode 100755 index 0000000..82199ca --- /dev/null +++ b/tests/cli-opts.sh @@ -0,0 +1,47 @@ +#!/bin/sh +set -eu + +. tests/lib.sh + + +test_needs_2_arguments() { + testing 'needs 2 arguments' + + N="$LINENO" + OUT="$(mkstemp)" + ERR="$(mkstemp)" + trap 'rm -f "$OUT" "$ERR"' EXIT + STATUS=0 + ./wscat.bin 1>"$OUT" 2>"$ERR" || STATUS=$? + assert_status 2 + assert_empty_stdout + assert_usage "$ERR" + rm -f "$OUT" "$ERR" + + N="$LINENO" + OUT="$(mkstemp)" + ERR="$(mkstemp)" + trap 'rm -f "$OUT" "$ERR"' EXIT + STATUS=0 + ./wscat.bin FROM.socket 1>"$OUT" 2>"$ERR" || STATUS=$? + assert_status 2 + assert_empty_stdout + assert_usage "$ERR" + rm -f "$OUT" "$ERR" + + N="$LINENO" + OUT="$(mkstemp)" + ERR="$(mkstemp)" + trap 'rm -f "$OUT" "$ERR"' EXIT + STATUS=0 + ./wscat.bin TO.socket 1>"$OUT" 2>"$ERR" || STATUS=$? + assert_status 2 + assert_empty_stdout + assert_usage "$ERR" + rm -f "$OUT" "$ERR" + + test_ok +} + + +test_needs_2_arguments diff --git a/tests/integration.sh b/tests/integration.sh new file mode 100755 index 0000000..e69de29 --- /dev/null +++ b/tests/integration.sh diff --git a/tests/lib.sh b/tests/lib.sh new file mode 100644 index 0000000..07ecbef --- /dev/null +++ b/tests/lib.sh @@ -0,0 +1,119 @@ +#!/bin/sh + +end="\033[0m" +red="\033[0;31m" +green="\033[0;32m" +yellow="\033[0;33m" + +N= +OUT= +ERR= +STATUS= + +ERROR() { + # shellcheck disable=2059 + printf "${red}ERROR${end}" +} + +print_debug_info() { + # shellcheck disable=2016 + printf 'LINENO: %s\n$OUT: %s\n$ERR: %s\n' \ + "$N" "$OUT" "$ERR" >&2 +} + +assert_status() { + if [ "$STATUS" != "$1" ]; then + printf '\n%s: Bad status.\n\nexpected: %s\ngot: %s\n' \ + "$(ERROR)" "$1" "$STATUS" >&2 + print_debug_info + exit 1 + fi +} + +assert_usage() { + if ! grep -Fq 'Usage' "$1"; then + echo 'Expected to find "Usage" text, it was missing:' >&2 + cat "$1" >&2 + print_debug_info + exit 1 + fi +} + +assert_empty_stream() { + if [ -s "$2" ]; then + FMT='\n%s: Expected %s (%s) to be empty, but has content:\n%s\n' + # shellcheck disable=2059 + printf "$FMT" \ + "$(ERROR)" "$1" "$2" "$(cat "$2")" >&2 + print_debug_info + exit 1 + fi +} + +assert_empty_stdout() { + assert_empty_stream STDOUT "$OUT" +} + +assert_empty_stderr() { + assert_empty_stream STDERR "$ERR" +} + +assert_stream() { + if [ "$(cat "$2")" != "$3" ]; then + printf '\n%s: Bad %s (%s)\n\nexpected: %s\ngot: %s\n' \ + "$(ERROR)" "$1" "$2" "$3" "$(cat "$2")" >&2 + print_debug_info + exit 1 + fi +} + +assert_stdout() { + assert_stream STDOUT "$OUT" "$1" +} + +assert_stderr() { + assert_stream STDERR "$ERR" "$1" +} + +assert_grep_stream() { + if ! grep -qE "$3" "$2"; then + printf '\n%s: Bad %s (%s)\n\ngrepping: %s\nin:\n%s\n' \ + "$(ERROR)" "$1" "$2" "$3" "$(cat "$2")" >&2 + print_debug_info + exit 1 + fi +} + +assert_grep_stdout() { + assert_grep_stream STDOUT "$OUT" "$1" +} + +assert_grep_stderr() { + assert_grep_stream STDERR "$ERR" "$1" +} + +assert_fgrep_stream() { + if ! grep -Fq -- "$3" "$2"; then + printf '\n%s: Bad %s (%s)\n\ngrepping: %s\nin:\n%s\n' \ + "$(ERROR)" "$1" "$2" "$3" "$(cat "$2")" >&2 + print_debug_info + exit 1 + fi +} + +assert_fgrep_stdout() { + assert_fgrep_stream STDOUT "$OUT" "$1" +} + +assert_fgrep_stderr() { + assert_fgrep_stream STDERR "$ERR" "$1" +} + +testing() { + printf "${yellow}testing${end}: %s..." "$1" >&2 +} + +test_ok() { + # shellcheck disable=2059 + printf " ${green}OK${end}.\n" >&2 +} diff --git a/tests/lib_test.go b/tests/lib_test.go new file mode 100644 index 0000000..1007609 --- /dev/null +++ b/tests/lib_test.go @@ -0,0 +1,24 @@ +package wscat_test + +import ( + "testing" + + g "euandre.org/gobang/src" + + "euandre.org/wscat/src" +) + + +func TestPlaceholder(t *testing.T) { + g.AssertEqual(t, wscat.X, 1) +} + +func TestParseArgs(t *testing.T) { + given := wscat.ParseArgs([]string { "x", "y", "z" }) + expected := wscat.CLIArgs { + FromAddr: "y", + ToAddr: "z", + } + + g.AssertEqual(t, given, expected) +} |