Test for remote debugger #76

ono-max · 2021-06-09T05:05:51Z

I implement the test framework for remote debugger.

Assign the argument remote: false in debug_code method when using require "debug/run" or DEBUGGER__.console.
Test for remote and local are in each method by one. That's why if first test(local) failed, second test(remote) won't work.
- Test for local test will be executed first, and Test for remote(UNIX domain socket mode and TCP/IP mode) will be executed next.

test/support/utils.rb

st0012 · 2021-06-10T14:29:58Z

If we can further improve the current test framework and not relying on the internal info for testing (e.g. run tests by purely recording input/output), we can avoid patching either the server nor client for remote testing. This approach has some benefits:

We don't need to maintain any extra layers/patches for the testing mode so the lib codebase would be clean.
Remote debugging (TCP/IP) will be a lot easier to implement because the extra patches won't be not needed.
It'll be able to test irb integration without extra patches on it.

@ono-max @ko1 wdyt?

ono-max · 2021-06-10T23:41:06Z

@st0012
We'll discuss it today. Just a moment, please.
Thank you.

ko1 · 2021-06-11T01:54:18Z

test/support/utils.rb

+        r, w, server_pid = PTY.spawn("#{RUBY} #{boot_options} #{temp_file_path}")
+        r.close
+        sleep(0.1)
+        cmd = "exe/rdbg -A"


should not use this path.

https://github.com/ruby/debug/pull/76/files#diff-ee14bf65f14927f7778a246f90c5cec0c581be3e2658c2a8a3726c59db5be3f9R57

ono-max · 2021-06-13T01:39:17Z

@st0012
I'm sorry for the late reply.

What you're trying to say is that "we don't want to create extra patches", right?
I can output the internal info without extra patches such as #84, and I don't need to write codes for it.

ko1 · 2021-06-22T15:12:24Z

could you introduce local only mode for fast debug?

ko1 · 2021-06-22T15:13:03Z

Also, now UNIX domain socket mode is supported. Could you add an option to test on TCP/IP mode?

ko1 · 2021-06-22T15:14:43Z

test/support/utils.rb

      inject_lib_to_load_path
      ENV['RUBY_DEBUG_USE_COLORIZE'] = "false"
      ENV['RUBY_DEBUG_TEST_MODE'] = 'true'

      timeout_sec = (ENV['RUBY_DEBUG_TIMEOUT_SEC'] || 10).to_i

-      PTY.spawn("#{RUBY} #{boot_options} #{temp_file_path}") do |read, write, pid|
+      if boot_options == "-r debug/open"


It has bad smell.

I modified it.

ono-max · 2021-06-24T03:18:10Z

could you introduce local only mode for fast debug?

I did it by an environmental variable.
2beeb4f#diff-ee14bf65f14927f7778a246f90c5cec0c581be3e2658c2a8a3726c59db5be3f9R40

Also, now UNIX domain socket mode is supported. Could you add an option to test on TCP/IP mode?

I supported it.
2beeb4f#diff-ee14bf65f14927f7778a246f90c5cec0c581be3e2658c2a8a3726c59db5be3f9R51-R52

ono-max · 2021-06-24T03:27:16Z

@st0012
You haven't replied me. Can I resolve conversation with you?

st0012 · 2021-06-25T09:16:58Z

@ono-max sorry I missed the notifications. given the scope of this PR, I'll leave the rest of the review to @ko1, so you can resolve the comments now 🙂

ko1 · 2021-06-28T07:26:05Z

test/support/utils.rb

+        cmd = "#{__dir__}/../../exe/rdbg -A"
+        new_child_process("#{RUBY} #{boot_options} #{temp_file_path}")
+        create_pseudo_terminal(cmd, repl_prompt)
+        cmd = "#{__dir__}/../../exe/rdbg -A 12345"


PORT should be given by an option, maybe RUBY_DEBUG_TEST_PORT or something.

https://github.com/ruby/debug/pull/76/files#diff-ee14bf65f14927f7778a246f90c5cec0c581be3e2658c2a8a3726c59db5be3f9R38

ko1 · 2021-06-28T07:26:25Z

test/support/utils.rb

      inject_lib_to_load_path
+
+      if remote && ENV['RUBY_DEBUG_LOCAL_ONLY_MODE'] == 'false'


RUBY_DEBUG_TEST prefix is better to make clear the purpose.

https://github.com/ruby/debug/pull/76/files#diff-ee14bf65f14927f7778a246f90c5cec0c581be3e2658c2a8a3726c59db5be3f9R41

test/debug/session_test.rb

test/support/utils.rb

…DEBUGGER__.console`

ono-max · 2021-07-01T04:21:15Z

@st0012
I modified codes based on your comments. Are they ok for you?

st0012 · 2021-07-01T05:51:38Z

@ono-max yes. thanks for the quick update 👍

ono-max force-pushed the test-for-remote-debugger branch from 266c6ca to 162bf9b Compare June 9, 2021 05:14

st0012 reviewed Jun 9, 2021

View reviewed changes

test/support/utils.rb Outdated Show resolved Hide resolved

test/support/utils.rb Outdated Show resolved Hide resolved

ono-max force-pushed the test-for-remote-debugger branch 4 times, most recently from 2aaf758 to 8184d3a Compare June 10, 2021 13:35

ono-max force-pushed the test-for-remote-debugger branch 3 times, most recently from e695a6e to 5ad682f Compare June 11, 2021 01:02

ko1 reviewed Jun 11, 2021

View reviewed changes

ono-max force-pushed the test-for-remote-debugger branch 9 times, most recently from de725e0 to 62f4bce Compare June 19, 2021 04:26

ono-max marked this pull request as ready for review June 19, 2021 04:29

ono-max changed the title ~~[WIP]test for remote debugger~~ Test for remote debugger Jun 19, 2021

ko1 reviewed Jun 22, 2021

View reviewed changes

ono-max added 2 commits June 23, 2021 10:00

make ASK_CMD constant

a54368e

make sure to kill remote server process

0829da5

ono-max force-pushed the test-for-remote-debugger branch from 62f4bce to cd8f3bd Compare June 23, 2021 05:15

ono-max force-pushed the test-for-remote-debugger branch 2 times, most recently from 0bb8d2b to 70cf2a6 Compare June 24, 2021 02:16

ono-max requested a review from ko1 June 24, 2021 03:16

ko1 reviewed Jun 28, 2021

View reviewed changes

ono-max force-pushed the test-for-remote-debugger branch 3 times, most recently from 32432b2 to e91ef1e Compare June 28, 2021 22:15

ono-max requested a review from ko1 June 28, 2021 22:25

st0012 reviewed Jun 30, 2021

View reviewed changes

test/debug/session_test.rb Show resolved Hide resolved

st0012 reviewed Jul 1, 2021

View reviewed changes

test/support/utils.rb Show resolved Hide resolved

ono-max force-pushed the test-for-remote-debugger branch from e91ef1e to 7733fd7 Compare July 1, 2021 04:02

ono-max added 2 commits July 1, 2021 13:05

test for remote debugger

545a8b9

do not test for remote debugger when using require "debug/run" or `…

ea3f471

…DEBUGGER__.console`

ono-max force-pushed the test-for-remote-debugger branch from 7733fd7 to ea3f471 Compare July 1, 2021 04:05

ko1 merged commit 8dfe757 into ruby:master Jul 1, 2021

ono-max deleted the test-for-remote-debugger branch November 2, 2021 09:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Test for remote debugger #76

Test for remote debugger #76

ono-max commented Jun 9, 2021 •

edited

Loading

st0012 commented Jun 10, 2021

ono-max commented Jun 10, 2021 •

edited

Loading

ko1 Jun 11, 2021

ono-max Jun 19, 2021

ono-max commented Jun 13, 2021

ko1 commented Jun 22, 2021

ko1 commented Jun 22, 2021

ko1 Jun 22, 2021

ono-max Jun 24, 2021

ono-max commented Jun 24, 2021 •

edited

Loading

ono-max commented Jun 24, 2021

st0012 commented Jun 25, 2021

ko1 Jun 28, 2021

ono-max Jun 28, 2021

ko1 Jun 28, 2021

ono-max Jun 28, 2021

ono-max commented Jul 1, 2021 •

edited

Loading

st0012 commented Jul 1, 2021

		inject_lib_to_load_path

		if remote && ENV['RUBY_DEBUG_LOCAL_ONLY_MODE'] == 'false'

Test for remote debugger #76

Test for remote debugger #76

Conversation

ono-max commented Jun 9, 2021 • edited Loading

st0012 commented Jun 10, 2021

ono-max commented Jun 10, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ono-max commented Jun 13, 2021

ko1 commented Jun 22, 2021

ko1 commented Jun 22, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ono-max commented Jun 24, 2021 • edited Loading

ono-max commented Jun 24, 2021

st0012 commented Jun 25, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ono-max commented Jul 1, 2021 • edited Loading

st0012 commented Jul 1, 2021

ono-max commented Jun 9, 2021 •

edited

Loading

ono-max commented Jun 10, 2021 •

edited

Loading

ono-max commented Jun 24, 2021 •

edited

Loading

ono-max commented Jul 1, 2021 •

edited

Loading