wstest

go websocket client for unit testing of a websocket handler

Programming language: Go

License: Apache License 2.0

Tags: Testing     Testing Frameworks    

Latest version: v1.2.0

README

wstest

A websocket client for unit-testing a websocket server

The gorilla organization provides full featured websocket implementation that the standard library lacks.

The standard library provides a httptest.ResponseRecorder struct that test an http.Handler without ListenAndServe, but is helpless when the connection is being hijacked by an http upgrader. As for testing websockets, it has the httptest.NewServer that actually listens on a socket on an arbitrary port.

This package provides a NewDialer function to test just the http.Handler that upgrades the connection to a websocket session. It runs the handler function in a goroutine without listening on any port. The returned websocket.Dialer then can be used to dial and communicate with the given handler.

Get

go get -u github.com/posener/wstest

Examples

See the [example test](./example_test.go).

An example how to modify a test function from using httptest.Server to use wstest.NewDialer function.

func TestHandler(t *testing.T) {
    var err error

    h := &myHandler{}
-   s := httptest.NewServer(h)
-   defer s.Close()
-   d := websocket.Dialer{}
+   d := wstest.NewDialer(h)

-   c, resp, err := d.Dial("ws://" + s.Listener.Addr().String() + "/ws", nil)
+   c, resp, err := d.Dial("ws://" + "whatever" + "/ws", nil)
    if err != nil {
        t.Fatal(err)
    }

    if got, want := resp.StatusCode, http.StatusSwitchingProtocols; got != want {
        t.Errorf("resp.StatusCode = %q, want %q", got, want)
    }

    err = c.WriteJSON("test")
    if err != nil {
        t.Fatal(err)
    }
}