[Bug 18964] New: koha-plack should have a --debug switch
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Bug ID: 18964 Summary: koha-plack should have a --debug switch Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Command-line Utilities Assignee: koha-bugs@lists.koha-community.org Reporter: tomascohen@gmail.com QA Contact: testopia@bugs.koha-community.org CC: robin@catalyst.net.nz It should be great to enhance koha-plack so it provides the following option flags: --debug: enable debugging mode --debugger: the remote debugger IP:PORT combination --ide-key: a string containing the IDE key required by the remote debugging tool in use. --debugger-dir: the remote debugging library PATH, so it overloads Perl default (i.e. the path to Komodo tool, or Devel::DBGP or whatever is needed by the developer). -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |tomascohen@gmail.com |ity.org | -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 --- Comment #1 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 65190 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=65190&action=edit Bug 18964: Add --debugger option to koha-plack This patch is WIP for people to take a look! The explanation on how to use it assumes you are running kohadevbox. This patch adds the following option switches to koha-plack: --debugger ---------- Toggle debugging --debugger-key -------------- Some IDEs require a key, this needs to match because they are picky about it --debugger-location ------------------- This option switch is used to specify the host:port your IDE is listening at. Inside kohadevbox (using Vdebug with Vim) this would be localhost:9000. Outside kohadevbox it would be 192.168.50.1:9000 --debugger-path --------------- This is the path in which you installed the Komodo Remote Debugger libraryi [1]. In kohadevbox you could put the contents of the downloaded .tar.gz in /home/vagrant/dbgp/perllib. That perllib seems to be required for things to work [2]. You can test with a simple CLI script things work: PERL5LIB=/home/vagrant/dbgp/perllib:$PERL5LIB \ PERLDB="BEGIN { require q(/home/vagrant/dbgp/perllib/perl5db.pl) }" \ PERLDB_OPTS="RemotePort=192.168.50.1:9000" perl -d t/Prices.t If you see action on your IDE, you are on the right track. WARNING: The main difficulty I found was setting the right dir/file mappings. [1] http://code.activestate.com/komodo/remotedebugging/ [2] https://github.com/Komodo/KomodoEdit/issues/644#issuecomment-236268012 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |lari.taskula@jns.fi, | |olli-antti.kivilahti@jns.fi -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 --- Comment #2 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Hi, I put this together so you can actually help me making it work properly. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #65190|0 |1 is obsolete| | --- Comment #3 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 65196 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=65196&action=edit Bug 18964: Add --debugger option to koha-plack This patch is WIP for people to take a look! The explanation on how to use it assumes you are running kohadevbox. This patch adds the following option switches to koha-plack: --debugger ---------- Toggle debugging --debugger-key -------------- Some IDEs require a key, this needs to match because they are picky about it --debugger-location ------------------- This option switch is used to specify the host:port your IDE is listening at. Inside kohadevbox (using Vdebug with Vim) this would be localhost:9000. Outside kohadevbox it would be 192.168.50.1:9000 --debugger-path --------------- This is the path in which you installed the Komodo Remote Debugger libraryi [1]. In kohadevbox you could put the contents of the downloaded .tar.gz in /home/vagrant/dbgp/perllib. That perllib seems to be required for things to work [2]. You can test with a simple CLI script things work: PERL5LIB=/home/vagrant/dbgp/perllib:$PERL5LIB \ PERLDB="BEGIN { require q(/home/vagrant/dbgp/perllib/perl5db.pl) }" \ PERLDB_OPTS="RemotePort=192.168.50.1:9000" perl -d t/Prices.t If you see action on your IDE, you are on the right track. WARNING: The main difficulty I found was setting the right dir/file mappings. [1] http://code.activestate.com/komodo/remotedebugging/ [2] https://github.com/Komodo/KomodoEdit/issues/644#issuecomment-236268012 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #65196|0 |1 is obsolete| | --- Comment #4 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 65318 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=65318&action=edit Bug 18964: Add --debugger option to koha-plack CAVEAT: This patch is only about allowing koha-plack to start a debugging session on a remote target. Configuring all the needed pieces to make it work is out of the scope of the bug. Testing should be focused (mainly) on making sure this introduces NO REGRESSIONS on regular use (i.e. not debugging). This patch adds the following option switches to koha-plack: --debugger ---------- Toggle debugging --debugger-key -------------- Some IDEs require a key, this needs to match because they are picky about it --debugger-location ------------------- This option switch is used to specify the host:port your IDE is listening at. Inside kohadevbox (using Vdebug with Vim) this would be localhost:9000. Outside kohadevbox it would be 192.168.50.1:9000 --debugger-path --------------- This is the path in which you installed the Komodo Remote Debugger library [1]. In kohadevbox you could put the contents of the downloaded .tar.gz in /home/vagrant/dbgp/perllib. That perllib seems to be required for things to work [2]. You can test with a simple CLI script things work: PERL5LIB=/home/vagrant/dbgp/perllib:$PERL5LIB \ PERLDB="BEGIN { require q(/home/vagrant/dbgp/perllib/perl5db.pl) }" \ PERLDB_OPTS="RemotePort=192.168.50.1:9000" perl -d t/Prices.t If you see action on your IDE, you are on the right track on the IDE side. To test: - Apply this patch - Enable remote debugging on your IDE, on port 9000 (or adjust the command below to match your IDE's listening port). - Download the Komodo Remote Debugger package, and place the package's contents in /home/vagrant/dbgp/perllib (you should see perl5db.pl in there). - Run: $ sudo koha-plack --stop kohadev $ sudo kohaclone/debian/koha-plack --start \ --debugger \ --debugger-path /home/vagrant/dbgp/perllib \ --debugger-location 192.168.50.1:9000 \ kohadev => SUCCESS: You IDE/tool gets a connection from the Plack process. - Sign off :-D The explanation on how to use it assumes you are running kohadevbox. WARNING: The main difficulty I found was setting the right dir/file mappings. [1] http://code.activestate.com/komodo/remotedebugging/ [2] https://github.com/Komodo/KomodoEdit/issues/644#issuecomment-236268012 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|koha-plack should have a |koha-plack should have a |--debug switch |--debugger switch -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #65318|0 |1 is obsolete| | --- Comment #5 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Created attachment 70401 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=70401&action=edit Bug 18964: Add --debugger option to koha-plack CAVEAT: This patch is only about allowing koha-plack to start a debugging session on a remote target. Configuring all the needed pieces to make it work is out of the scope of the bug. Testing should be focused (mainly) on making sure this introduces NO REGRESSIONS on regular use (i.e. not debugging). This patch adds the following option switches to koha-plack: --debugger ---------- Toggle debugging --debugger-key -------------- Some IDEs require a key, this needs to match because they are picky about it --debugger-location ------------------- This option switch is used to specify the host:port your IDE is listening at. Inside kohadevbox (using Vdebug with Vim) this would be localhost:9000. Outside kohadevbox it would be 192.168.50.1:9000 --debugger-path --------------- This is the path in which you installed the Komodo Remote Debugger library [1]. In kohadevbox you could put the contents of the downloaded .tar.gz in /home/vagrant/dbgp/perllib. That perllib seems to be required for things to work [2]. You can test with a simple CLI script things work: PERL5LIB=/home/vagrant/dbgp/perllib:$PERL5LIB \ PERLDB="BEGIN { require q(/home/vagrant/dbgp/perllib/perl5db.pl) }" \ PERLDB_OPTS="RemotePort=192.168.50.1:9000" perl -d t/Prices.t If you see action on your IDE, you are on the right track on the IDE side. To test: - Apply this patch - Enable remote debugging on your IDE, on port 9000 (or adjust the command below to match your IDE's listening port). - Download the Komodo Remote Debugger package, and place the package's contents in /home/vagrant/dbgp/perllib (you should see perl5db.pl in there). - Run: $ sudo koha-plack --stop kohadev $ sudo kohaclone/debian/koha-plack --start \ --debugger \ --debugger-path /home/vagrant/dbgp/perllib \ --debugger-location 192.168.50.1:9000 \ kohadev => SUCCESS: You IDE/tool gets a connection from the Plack process. - Sign off :-D The explanation on how to use it assumes you are running kohadevbox. WARNING: The main difficulty I found was setting the right dir/file mappings. [1] http://code.activestate.com/komodo/remotedebugging/ [2] https://github.com/Komodo/KomodoEdit/issues/644#issuecomment-236268012 Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@bugs.koha-c | |ommunity.org --- Comment #6 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Note: You will need the python3 version of vdebug if you are running python3: https://github.com/markkimsal/vdebug/tree/python3 (which does not work really well) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|koha-plack should have a |Add a --debugger flag to |--debugger switch |koha-plack -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA --- Comment #7 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Waiting for too long, skipping QA. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |20079 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20079 [Bug 20079] Display stack trace for development installations -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Text to go in the| |Remote debugging release notes| |capabilities are added to | |the koha-plack script. This | |is very important for | |developers. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to Master --- Comment #8 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Pushed to master for 18.05 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18964 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to Master |RESOLVED Resolution|--- |FIXED CC| |nick@bywatersolutions.com --- Comment #9 from Nick Clemens <nick@bywatersolutions.com> --- Awesome work all, enhancement, not backported for 17.11.x -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org