devtool/devtool_test.go

package devtool

import (
	"bufio"
	"bytes"
	"context"
	"flag"
	"fmt"
	"io"
	"io/ioutil"
	"net/http"
	"net/http/httptest"
	"path/filepath"
	"strings"
	"testing"
)

var update = flag.Bool("update", false, "update .golden files")

type testHandler struct {
	t      *testing.T
	status int
	body   []byte
	buf    *bytes.Buffer

	// This is used to inform testHandler that a
	// hostname lookup will be performed next.
	hostnameLookup bool
}

func newTestHandler(t *testing.T) *testHandler {
	return &testHandler{t: t}
}

func (h *testHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	if !strings.HasPrefix(r.RequestURI, "/json") {
		w.WriteHeader(http.StatusBadRequest)
		_, err := w.Write([]byte("Only /json endpoint is supported!"))
		if err != nil {
			h.t.Error(err)
		}
		return
	}
	if h.hostnameLookup {
		h.hostnameLookup = false
		w.WriteHeader(200)
		w.Write([]byte("{}"))
		return
	}
	if h.buf != nil {
		fmt.Fprintln(h.buf, r.Method, r.RequestURI)
	}
	w.WriteHeader(h.status)
	_, err := w.Write(h.body)
	if err != nil {
		h.t.Error(err)
	}
}

func read(t *testing.T, name string) []byte {
	b, err := ioutil.ReadFile(name)
	if err != nil {
		t.Fatal(err)
	}
	return b
}

func TestDevTools_WithClient(t *testing.T) {
	c := &http.Client{}
	devt := New("", WithClient(c))
	if devt.client != c {
		t.Error("DevTools client was not set")
	}
}

func TestDevTools(t *testing.T) {
	th := newTestHandler(t)
	srv := httptest.NewServer(th)
	defer srv.Close()

	devt := New(srv.URL)
	th.hostnameLookup = true

	var buf bytes.Buffer
	th.buf = &buf

	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	tests := []struct {
		name   string
		status int
		body   []byte
		fn     func() (interface{}, error)
	}{
		{"CreateURL", http.StatusOK, read(t, filepath.Join("testdata", "new.json")), func() (interface{}, error) {
			target, err := devt.CreateURL(ctx, "https://www.google.com")
			return target, err
		}},
		{"Create", http.StatusOK, read(t, filepath.Join("testdata", "new.json")), func() (interface{}, error) {
			target, err := devt.Create(ctx)
			return target, err
		}},
		{"Get", http.StatusOK, read(t, filepath.Join("testdata", "list.json")), func() (interface{}, error) {
			target, err := devt.Get(ctx, Page)
			return target, err
		}},
		{"Close", http.StatusOK, []byte("Target is closing"), func() (interface{}, error) {
			return nil, devt.Close(ctx, &Target{ID: "ddd908ca-4d8c-4783-a089-c9456c463eef"})
		}},
		{"Activate", http.StatusOK, []byte("Target activated"), func() (interface{}, error) {
			return nil, devt.Activate(ctx, &Target{ID: "ddd908ca-4d8c-4783-a089-c9456c463eef"})
		}},
		{"Version", http.StatusOK, read(t, filepath.Join("testdata", "version.json")), func() (interface{}, error) {
			v, err := devt.Version(ctx)
			return v, err
		}},
	}

	for _, tt := range tests {
		th.status = tt.status
		th.body = tt.body
		v, err := tt.fn()
		fmt.Fprintf(&buf, "%s: %v %v\n", tt.name, v, err)
	}

	out := filepath.Join("testdata", "test.golden")
	want, err := ioutil.ReadFile(out)
	if err != nil {
		t.Fatal(err)
	}

	if got := buf.Bytes(); !bytes.Equal(got, want) {
		if *update {
			err := ioutil.WriteFile(out, got, 0666)
			if err != nil {
				t.Error(err)
			}
			return
		}
		t.Error("output does not match golden file")
		showDiff(t, got, want)
	}
}

func TestDevTools_Error(t *testing.T) {
	th := newTestHandler(t)
	srv := httptest.NewServer(th)
	defer srv.Close()

	devt := New(srv.URL)
	th.hostnameLookup = true

	var buf bytes.Buffer

	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	tests := []struct {
		name   string
		status int
		body   []byte
		fn     func() (interface{}, error)
	}{
		{"Create", http.StatusNotFound, []byte("Not found"), func() (interface{}, error) {
			target, err := devt.Create(ctx)
			return target, err
		}},
		{"Get", http.StatusNotFound, []byte("Not found"), func() (interface{}, error) {
			target, err := devt.Get(ctx, Page)
			return target, err
		}},
		{"Get ServiceWorker", http.StatusOK, read(t, filepath.Join("testdata", "list.json")), func() (interface{}, error) {
			target, err := devt.Get(ctx, ServiceWorker)
			return target, err
		}},
		{"Close", http.StatusNotFound, []byte("Could not close target id: ddd908ca-4d8c-4783-a089-c9456c463eef"), func() (interface{}, error) {
			return nil, devt.Close(ctx, &Target{ID: "ddd908ca-4d8c-4783-a089-c9456c463eef"})
		}},
		{"Activate", http.StatusNotFound, []byte("Could not close target id: ddd908ca-4d8c-4783-a089-c9456c463eef"), func() (interface{}, error) {
			return nil, devt.Activate(ctx, &Target{ID: "ddd908ca-4d8c-4783-a089-c9456c463eef"})
		}},
		{"Version", http.StatusNotFound, []byte("Not found"), func() (interface{}, error) {
			v, err := devt.Version(ctx)
			return v, err
		}},
	}

	for _, tt := range tests {
		th.status = tt.status
		th.body = tt.body
		v, err := tt.fn()
		fmt.Fprintf(&buf, "%s: %v %v\n", tt.name, v, err)
	}

	out := filepath.Join("testdata", "error.golden")
	want, err := ioutil.ReadFile(out)
	if err != nil {
		t.Fatal(err)
	}

	if got := buf.Bytes(); !bytes.Equal(got, want) {
		if *update {
			err := ioutil.WriteFile(out, got, 0666)
			if err != nil {
				t.Error(err)
			}
			return
		}
		t.Error("output does not match golden file")
		showDiff(t, got, want)
	}
}

func TestDevTools_InvalidURL(t *testing.T) {
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	tests := []struct {
		name string
		url  string
		fn   func(devt *DevTools) error
	}{
		{"Create", "", func(devt *DevTools) (err error) {
			_, err = devt.Create(ctx)
			return
		}},
		{"Get", "", func(devt *DevTools) (err error) {
			_, err = devt.Get(ctx, Page)
			return
		}},
		{"Close", "", func(devt *DevTools) (err error) {
			return devt.Close(ctx, &Target{ID: "ddd908ca-4d8c-4783-a089-c9456c463eef"})
		}},
		{"Activate", "", func(devt *DevTools) (err error) {
			return devt.Activate(ctx, &Target{ID: "ddd908ca-4d8c-4783-a089-c9456c463eef"})
		}},
		{"Version", "", func(devt *DevTools) (err error) {
			_, err = devt.Version(ctx)
			return
		}},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			devt := New(tt.url)
			err := tt.fn(devt)
			if err == nil {
				t.Errorf("want error, got nil")
			}
		})
	}
}

func showDiff(t testing.TB, got, want []byte) {
	gr := bufio.NewReader(bytes.NewReader(got))
	wr := bufio.NewReader(bytes.NewReader(want))
	var lineno int
	for {
		lineno++
		g, err1 := gr.ReadBytes('\n')
		w, err2 := wr.ReadBytes('\n')
		if err1 != nil || err2 != nil {
			if err1 != io.EOF || err2 != io.EOF {
				t.Error(err1, err2)
			}
			break
		}
		if !bytes.Equal(g, w) {
			t.Errorf("line %d: got %s; want %s", lineno, g[:len(g)-1], w[:len(w)-1])
		}
	}
}