Make several protocol test helpers official

Author: st0012

CONTRIBUTING.md

@@ -320,6 +320,22 @@ Execute debugging `program` with `&scenario`. If you want to test it only for DA
 
 `run_protocol_scenario program, cdp: false ...`
 
+- attach_to_dap_server(terminate_debuggee:)
+
+Attach to the running DAP server through UNIX Domain Socket.
+
+- attach_to_cdp_server
+
+Attach to the running CDP server through TCP/IP.
+
+- req_dap_disconnect
+
+Disconnect from the currently connected DAP server.
+
+- req_cdp_disconnect
+
+Disconnect from the currently connected CDP server.
+
 - req_add_breakpoint(lineno, path: temp_file_path, cond: nil)
 
 Sends request to rdbg to add a breakpoint.

test/protocol/disconnect_cdp_test.rb

@@ -21,7 +21,7 @@ class DisconnectCDPTest < ProtocolTestCase
 
     def test_closing_cdp_connection_doesnt_kill_the_debuggee
       run_protocol_scenario PROGRAM, dap: false do
-        req_disconnect
+        req_cdp_disconnect
         attach_to_cdp_server
         req_terminate_debuggee
       end

test/protocol/disconnect_dap_test.rb

@@ -39,11 +39,6 @@ def test_disconnect_with_terminateDebuggee_kills_debuggee
 
     private
 
-    def req_dap_disconnect(terminate_debuggee:)
-      send_dap_request 'disconnect', terminateDebuggee: terminate_debuggee
-      close_reader
-    end
-
     def suspend_debugee
       send_dap_request "pause", threadId: 1
     end

test/support/protocol_test_case.rb

@@ -50,6 +50,51 @@ def run_protocol_scenario program, dap: true, cdp: true, &scenario
       end
     end
 
+    def attach_to_dap_server
+      @sock = Socket.unix @remote_info.sock_path
+      @seq = 1
+      @reader_thread = Thread.new do
+        while res = recv_response
+          @queue.push res
+        end
+      rescue Detach
+      end
+      sleep 0.001 while @reader_thread.status != 'sleep'
+      @reader_thread.run
+      INITIALIZE_DAP_MSGS.each{|msg| send(**msg)}
+    end
+
+    def attach_to_cdp_server
+      sock = Socket.tcp HOST, @remote_info.port
+
+      Timeout.timeout(TIMEOUT_SEC) do
+        sleep 0.001 until @remote_info.debuggee_backlog.join.include? 'Connected'
+      end
+
+      @web_sock = WebSocketClient.new sock
+      @web_sock.handshake @remote_info.port, '/'
+      @id = 1
+      @reader_thread = Thread.new do
+        while res = @web_sock.extract_data
+          @queue.push res
+        end
+      rescue Detach
+      end
+      sleep 0.001 while @reader_thread.status != 'sleep'
+      @reader_thread.run
+      INITIALIZE_CDP_MSGS.each{|msg| send(**msg)}
+    end
+
+    def req_dap_disconnect(terminate_debuggee:)
+      send_dap_request 'disconnect', restart: false, terminateDebuggee: terminate_debuggee
+      close_reader
+    end
+
+    def req_cdp_disconnect
+      @web_sock.send_close_connection
+      close_reader
+    end
+
     def req_add_breakpoint lineno, path: temp_file_path, cond: nil
       case get_target_ui
       when 'vscode'
@@ -304,7 +349,8 @@ def execute_cdp_scenario scenario
       @backlog = []
 
       attach_to_cdp_server
-      assert_cdp_connected
+      res = find_response :method, 'Debugger.paused', 'C<D'
+      @crt_frames = res.dig(:params, :callFrames)
       scenario.call
 
       flunk create_protocol_message "Expected the debuggee program to finish" unless wait_pid @remote_info.pid, TIMEOUT_SEC
@@ -316,19 +362,6 @@ def execute_cdp_scenario scenario
       @remote_info&.w&.close
     end
 
-    def req_disconnect
-      case get_target_ui
-      when 'vscode'
-        send_dap_request 'disconnect',
-                      restart: false,
-                      terminateDebuggee: false
-      when 'chrome'
-        @web_sock.send_close_connection
-      end
-
-      close_reader
-    end
-
     def req_set_breakpoints_on_dap
       bps_map = {temp_file_path => []}
       @bps.each{|tar_path, tar_lineno, condition|
@@ -364,48 +397,8 @@ def close_reader
       end
     end
 
-    def attach_to_dap_server
-      @sock = Socket.unix @remote_info.sock_path
-      @seq = 1
-      @reader_thread = Thread.new do
-        while res = recv_response
-          @queue.push res
-        end
-      rescue Detach
-      end
-      sleep 0.001 while @reader_thread.status != 'sleep'
-      @reader_thread.run
-      INITIALIZE_DAP_MSGS.each{|msg| send(**msg)}
-    end
-
     HOST = '127.0.0.1'
 
-    def attach_to_cdp_server
-      sock = Socket.tcp HOST, @remote_info.port
-
-      Timeout.timeout(TIMEOUT_SEC) do
-        sleep 0.001 until @remote_info.debuggee_backlog.join.include? 'Connected'
-      end
-
-      @web_sock = WebSocketClient.new sock
-      @web_sock.handshake @remote_info.port, '/'
-      @id = 1
-      @reader_thread = Thread.new do
-        while res = @web_sock.extract_data
-          @queue.push res
-        end
-      rescue Detach
-      end
-      sleep 0.001 while @reader_thread.status != 'sleep'
-      @reader_thread.run
-      INITIALIZE_CDP_MSGS.each{|msg| send(**msg)}
-    end
-
-    def assert_cdp_connected
-      res = find_response :method, 'Debugger.paused', 'C<D'
-      @crt_frames = res.dig(:params, :callFrames)
-    end
-
     JAVASCRIPT_TYPE_TO_CLASS_MAPS = {
       'string' => String,
       'number' => Integer,