Merge pull request #126 from nhooyr/test

Simplify tests

Author: nhooyr

ci/test.sh

@@ -10,18 +10,16 @@ argv=(
   "--junitfile=ci/out/websocket/testReport.xml"
   "--format=short-verbose"
   --
-  -race
   "-vet=off"
-  "-bench=."
 )
-# Interactive usage probably does not want to enable benchmarks, race detection
-# turn off vet or use gotestsum by default.
+# Interactive usage does not want to turn off vet or use gotestsum by default.
 if [[ $# -gt 0 ]]; then
   argv=(go test "$@")
 fi
 
-# We always want coverage.
+# We always want coverage and race detection.
 argv+=(
+  -race
   "-coverprofile=ci/out/coverage.prof"
   "-coverpkg=./..."
 )

cmp_test.go

@@ -0,0 +1,53 @@
+package websocket_test
+
+import (
+	"reflect"
+
+	"github.com/google/go-cmp/cmp"
+)
+
+// https://github.com/google/go-cmp/issues/40#issuecomment-328615283
+func cmpDiff(exp, act interface{}) string {
+	return cmp.Diff(exp, act, deepAllowUnexported(exp, act))
+}
+
+func deepAllowUnexported(vs ...interface{}) cmp.Option {
+	m := make(map[reflect.Type]struct{})
+	for _, v := range vs {
+		structTypes(reflect.ValueOf(v), m)
+	}
+	var typs []interface{}
+	for t := range m {
+		typs = append(typs, reflect.New(t).Elem().Interface())
+	}
+	return cmp.AllowUnexported(typs...)
+}
+
+func structTypes(v reflect.Value, m map[reflect.Type]struct{}) {
+	if !v.IsValid() {
+		return
+	}
+	switch v.Kind() {
+	case reflect.Ptr:
+		if !v.IsNil() {
+			structTypes(v.Elem(), m)
+		}
+	case reflect.Interface:
+		if !v.IsNil() {
+			structTypes(v.Elem(), m)
+		}
+	case reflect.Slice, reflect.Array:
+		for i := 0; i < v.Len(); i++ {
+			structTypes(v.Index(i), m)
+		}
+	case reflect.Map:
+		for _, k := range v.MapKeys() {
+			structTypes(v.MapIndex(k), m)
+		}
+	case reflect.Struct:
+		m[v.Type()] = struct{}{}
+		for i := 0; i < v.NumField(); i++ {
+			structTypes(v.Field(i), m)
+		}
+	}
+}

docs/CONTRIBUTING.md

@@ -43,12 +43,10 @@ For coverage details locally, please see `ci/out/coverage.html` after running `c
 
 See [ci/image/Dockerfile](ci/image/Dockerfile) for the installation of the CI dependencies on Ubuntu.
 
-You can also run tests normally with `go test`.
-`ci/test.sh` just passes a default set of flags to `go test` to collect coverage,
-enable the race detector, run benchmarks and also prettifies the output.
+You can also run tests normally with `go test`. `ci/test.sh` just passes a default set of flags to
+`go test` to collect coverage, enable the race detector and also prettifies the output.
 
-If you pass flags to `ci/test.sh`, it will pass those flags directly to `go test` but will also
-collect coverage for you. This is nice for when you don't want to wait for benchmarks
-or the race detector but want to have coverage.
+You can pass flags to `ci/test.sh` if you want to run a specific test or otherwise
+control the behaviour of `go test`.
 
 Coverage percentage from codecov and the CI scripts will be different because they are calculated differently.

go.mod

@@ -7,6 +7,8 @@ require (
 	github.com/google/go-cmp v0.2.0
 	github.com/kr/pretty v0.1.0 // indirect
 	go.coder.com/go-tools v0.0.0-20190317003359-0c6a35b74a16
+	go.uber.org/atomic v1.4.0 // indirect
+	go.uber.org/multierr v1.1.0
 	golang.org/x/lint v0.0.0-20190409202823-959b441ac422
 	golang.org/x/net v0.0.0-20190424112056-4829fb13d2c6
 	golang.org/x/text v0.3.2 // indirect

go.sum

@@ -40,6 +40,10 @@ github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 go.coder.com/go-tools v0.0.0-20190317003359-0c6a35b74a16 h1:3gGa1bM0nG7Ruhu5b7wKnoOOwAD/fJ8iyyAcpOzDG3A=
 go.coder.com/go-tools v0.0.0-20190317003359-0c6a35b74a16/go.mod h1:iKV5yK9t+J5nG9O3uF6KYdPEz3dyfMyB15MN1rbQ8Qw=
+go.uber.org/atomic v1.4.0 h1:cxzIVoETapQEqDhQu3QfnvXAV4AlzcvUCxkVUFw3+EU=
+go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE=
+go.uber.org/multierr v1.1.0 h1:HoEmRHQPVSqub6w2z2d2EOVs2fjyFRGyofhKuyDq0QI=
+go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
 golang.org/x/crypto v0.0.0-20180426230345-b49d69b5da94/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2 h1:VklqNMn3ovrHsnt90PveolxSbWFaJdECFbxSq0Mqo2M=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=

websocket.go

@@ -166,9 +166,9 @@ func (c *Conn) timeoutLoop() {
 		case readCtx = <-c.setReadTimeout:
 
 		case <-readCtx.Done():
-			c.close(xerrors.Errorf("data read timed out: %w", readCtx.Err()))
+			c.close(xerrors.Errorf("read timed out: %w", readCtx.Err()))
 		case <-writeCtx.Done():
-			c.close(xerrors.Errorf("data write timed out: %w", writeCtx.Err()))
+			c.close(xerrors.Errorf("write timed out: %w", writeCtx.Err()))
 		}
 	}
 }