Rename websocket test server identifiers

Resolves #166 (comment)

Author: inancgumus

common/connection_test.go

@@ -38,7 +38,7 @@ import (
 )
 
 func TestConnection(t *testing.T) {
-	server := ws.NewWSServerWithEcho(t)
+	server := ws.NewServerWithEcho(t)
 	defer server.Cleanup()
 
 	t.Run("connect", func(t *testing.T) {
@@ -53,7 +53,7 @@ func TestConnection(t *testing.T) {
 }
 
 func TestConnectionClosureAbnormal(t *testing.T) {
-	server := ws.NewWSServerWithClosureAbnormal(t)
+	server := ws.NewServerWithClosureAbnormal(t)
 	defer server.Cleanup()
 
 	t.Run("closure abnormal", func(t *testing.T) {
@@ -71,7 +71,7 @@ func TestConnectionClosureAbnormal(t *testing.T) {
 }
 
 func TestConnectionSendRecv(t *testing.T) {
-	server := ws.NewWSServerWithCDPHandler(t, ws.CDPDefaultHandler, nil)
+	server := ws.NewServerWithCDPHandler(t, ws.CDPDefaultHandler, nil)
 	defer server.Cleanup()
 
 	t.Run("send command with empty reply", func(t *testing.T) {
@@ -135,7 +135,7 @@ func TestConnectionCreateSession(t *testing.T) {
 		}
 	}
 
-	server := ws.NewWSServerWithCDPHandler(t, handler, &cmdsReceived)
+	server := ws.NewServerWithCDPHandler(t, handler, &cmdsReceived)
 	defer server.Cleanup()
 
 	t.Run("create session for target", func(t *testing.T) {

common/session_test.go

@@ -61,18 +61,18 @@ func TestSessionCreateSession(t *testing.T) {
 			case cdproto.MethodType(cdproto.CommandTargetAttachToTarget):
 				writeCh <- cdproto.Message{
 					Method: cdproto.EventTargetAttachedToTarget,
-					Params: easyjson.RawMessage([]byte(ws.CDPTargetAttachedToTargetRequest)),
+					Params: easyjson.RawMessage([]byte(ws.TargetAttachedToTargetEvent)),
 				}
 				writeCh <- cdproto.Message{
 					ID:        msg.ID,
 					SessionID: msg.SessionID,
-					Result:    easyjson.RawMessage([]byte(ws.CDPTargetAttachedToTargetResponse)),
+					Result:    easyjson.RawMessage([]byte(ws.TargetAttachedToTargetResult)),
 				}
 			}
 		}
 	}
 
-	server := ws.NewWSServerWithCDPHandler(t, handler, &cmdsReceived)
+	server := ws.NewServerWithCDPHandler(t, handler, &cmdsReceived)
 	defer server.Cleanup()
 
 	t.Run("send and recv session commands", func(t *testing.T) {

tests/ws/server.go

@@ -53,7 +53,7 @@ const (
 )
 
 var (
-	CDPTargetAttachedToTargetRequest = fmt.Sprintf(`
+	TargetAttachedToTargetEvent = fmt.Sprintf(`
 	{
 		"sessionId": "%s",
 		"targetInfo": {
@@ -68,19 +68,19 @@ var (
 	}
 	`, DummyCDPSessionID, DummyCDPTargetID, DummyCDPBrowserContextID)
 
-	CDPTargetAttachedToTargetResponse = fmt.Sprintf(`{"sessionId":"%s"}`, DummyCDPSessionID)
+	TargetAttachedToTargetResult = fmt.Sprintf(`{"sessionId":"%s"}`, DummyCDPSessionID)
 )
 
-// NewWSServerWithCDPHandler creates a WS test server with a custom CDP handler function
-func NewWSServerWithCDPHandler(
+// NewServerWithCDPHandler creates a WS test server with a custom CDP handler function
+func NewServerWithCDPHandler(
 	t testing.TB,
 	fn func(conn *websocket.Conn, msg *cdproto.Message, writeCh chan cdproto.Message, done chan struct{}),
-	cmdsReceived *[]cdproto.MethodType) *WSTestServer {
-	return NewWSServer(t, "/cdp", getWebsocketHandlerCDP(fn, cmdsReceived))
+	cmdsReceived *[]cdproto.MethodType) *Server {
+	return NewServer(t, "/cdp", getWebsocketHandlerCDP(fn, cmdsReceived))
 }
 
-// WSTestServer can be used as a test alternative to a real CDP compatible browser.
-type WSTestServer struct {
+// Server can be used as a test alternative to a real CDP compatible browser.
+type Server struct {
 	Mux           *http.ServeMux
 	ServerHTTP    *httptest.Server
 	Dialer        *k6netext.Dialer
@@ -89,18 +89,18 @@ type WSTestServer struct {
 	Cleanup       func()
 }
 
-// NewWSServerWithClosureAbnormal creates a WS test server with abnormal closure behavior
-func NewWSServerWithClosureAbnormal(t testing.TB) *WSTestServer {
-	return NewWSServer(t, "/closure-abnormal", getWebsocketHandlerAbnormalClosure())
+// NewServerWithClosureAbnormal creates a WS test server with abnormal closure behavior
+func NewServerWithClosureAbnormal(t testing.TB) *Server {
+	return NewServer(t, "/closure-abnormal", getWebsocketHandlerAbnormalClosure())
 }
 
-// NewWSServerWithEcho creates a WS test server with an echo handler
-func NewWSServerWithEcho(t testing.TB) *WSTestServer {
-	return NewWSServer(t, "/echo", getWebsocketHandlerEcho())
+// NewServerWithEcho creates a WS test server with an echo handler
+func NewServerWithEcho(t testing.TB) *Server {
+	return NewServer(t, "/echo", getWebsocketHandlerEcho())
 }
 
-// NewWSServer returns a fully configured and running WS test server
-func NewWSServer(t testing.TB, path string, handler http.Handler) *WSTestServer {
+// NewServer returns a fully configured and running WS test server
+func NewServer(t testing.TB, path string, handler http.Handler) *Server {
 	t.Helper()
 
 	// Create a http.ServeMux and set the httpbin handler as the default
@@ -135,7 +135,7 @@ func NewWSServer(t testing.TB, path string, handler http.Handler) *WSTestServer
 	require.NoError(t, http2.ConfigureTransport(transport))
 
 	ctx, ctxCancel := context.WithCancel(context.Background())
-	return &WSTestServer{
+	return &Server{
 		Mux:           mux,
 		ServerHTTP:    httpSrv,
 		Dialer:        dialer,
@@ -148,6 +148,8 @@ func NewWSServer(t testing.TB, path string, handler http.Handler) *WSTestServer
 	}
 }
 
+// TODO: make a websocket.Conn wrapper for CDPxxx methods
+
 // CDPDefaultCDPHandler is a default handler for the CDP WS server
 func CDPDefaultHandler(conn *websocket.Conn, msg *cdproto.Message, writeCh chan cdproto.Message, done chan struct{}) {
 	if msg.SessionID != "" && msg.Method != "" {
@@ -163,12 +165,12 @@ func CDPDefaultHandler(conn *websocket.Conn, msg *cdproto.Message, writeCh chan
 		case cdproto.MethodType(cdproto.CommandTargetAttachToTarget):
 			writeCh <- cdproto.Message{
 				Method: cdproto.EventTargetAttachedToTarget,
-				Params: easyjson.RawMessage([]byte(CDPTargetAttachedToTargetRequest)),
+				Params: easyjson.RawMessage([]byte(TargetAttachedToTargetEvent)),
 			}
 			writeCh <- cdproto.Message{
 				ID:        msg.ID,
 				SessionID: msg.SessionID,
-				Result:    easyjson.RawMessage([]byte(CDPTargetAttachedToTargetResponse)),
+				Result:    easyjson.RawMessage([]byte(TargetAttachedToTargetResult)),
 			}
 		default:
 			writeCh <- cdproto.Message{