Convert python jerry-debugger support python3 on win32 and OSX

Convert run-debugger-test.sh to run-debugger-test.py

After this change, run-debugger-test.py could running on Win32 and OSX

JerryScript-DCO-1.0-Signed-off-by: Yonggang Luo [email protected]

Author: lygstate

.github/workflows/gh-actions.yml

@@ -85,6 +85,13 @@ jobs:
       - run: python $env:RUNNER -q --unittests --build-debug
       - run: python $env:RUNNER -q --buildoption-test --build-debug
 
+  Win_x86-64_Debugger:
+      runs-on: windows-latest
+      steps:
+        - uses: actions/checkout@v2
+        - run: python $env:RUNNER -q --jerry-debugger --run-check-timeout=60
+        - run: python $env:RUNNER -q --jerry-debugger --build-debug --run-check-timeout=60
+
   OSX_x86-64_Build_Correctness_Unit_Tests:
     runs-on: macos-13
     steps:
@@ -94,6 +101,7 @@ jobs:
           python-version: '>=3.6'
       - run: $RUNNER -q --jerry-tests
       - run: $RUNNER -q --unittests
+      - run: $RUNNER -q --jerry-debugger --run-check-timeout=60
 
   OSX_x86-64_Build_Correctness_Unit_Tests_Debug:
     runs-on: macos-13
@@ -104,6 +112,7 @@ jobs:
           python-version: '>=3.6'
       - run: $RUNNER -q --jerry-tests --build-debug
       - run: $RUNNER -q --unittests --build-debug
+      - run: $RUNNER -q --jerry-debugger --build-debug --run-check-timeout=60
 
   Linux_x86-64_Build_Option_Tests:
     runs-on: ubuntu-latest

jerry-debugger/jerry_client.py

@@ -16,6 +16,7 @@
 
 from cmd import Cmd
 from pprint import pprint
+import codecs
 import math
 import socket
 import sys
@@ -25,6 +26,7 @@
 
 from jerry_client_websocket import WebSocket
 from jerry_client_rawpacket import RawPacket
+from jerry_client_serial import Serial
 from jerry_client_tcp import Socket
 
 def write(string):
@@ -261,8 +263,19 @@ def src_check_args(args):
         print(f"Error: Non-negative integer number expected: {val_errno}")
         return -1
 
-# pylint: disable=too-many-branches,too-many-locals,too-many-statements,import-outside-toplevel
+# This is for not lost data on 'win32' with python 'print'.
+# When use python subprocess call another script on win32, output with
+# 'utf-8' encoding, that's the same like linux platform; but when
+# call the python script in 'cmd.exe' shell, we have to output in 'native' encoding.
+def setup_stdio():
+    # For tty using native encoding, otherwise (pipe) use 'utf-8'
+    encoding = sys.stdout.encoding if sys.stdout.isatty() else 'utf-8'
+    # Always override it to avoid encode error
+    sys.stdout = codecs.getwriter(encoding)(sys.stdout.buffer, 'xmlcharrefreplace')
+    sys.stderr = codecs.getwriter(encoding)(sys.stderr.buffer, 'xmlcharrefreplace')
+
 def main():
+    setup_stdio()
     args = jerry_client_main.arguments_parse()
 
     channel = None
@@ -278,7 +291,6 @@ def main():
 
         protocol = Socket(address)
     elif args.protocol == "serial":
-        from jerry_client_serial import Serial
         protocol = Serial(args.serial_config)
     else:
         print("Unsupported transmission protocol")
@@ -326,6 +338,8 @@ def main():
             break
         if res_type == result.PROMPT:
             prompt.cmdloop()
+            sys.stdout.flush()
+            sys.stderr.flush()
         elif res_type == result.TEXT:
             write(result.get_text())
         continue

jerry-debugger/jerry_client_serial.py

@@ -13,7 +13,11 @@
 # limitations under the License.
 
 import select
-import serial
+try:
+    import serial
+except ImportError:
+    # OSX do not have serial
+    pass
 
 class Serial:
     """ Create a new socket using the given address family, socket type and protocol number. """

tools/run-tests.py

@@ -332,7 +332,7 @@ def run_jerry_debugger_tests():
                 if test_file.endswith(".cmd"):
                     test_case, _ = os.path.splitext(test_file)
                     test_case_path = os.path.join(settings.DEBUGGER_TESTS_DIR, test_case)
-                    test_cmd = [
+                    test_cmd = util.get_python_cmd_prefix() + [
                         settings.DEBUGGER_TEST_RUNNER_SCRIPT,
                         get_binary_path(build_dir_path),
                         channel,

tools/runners/run-debugger-test.py

@@ -0,0 +1,99 @@
+#!/usr/bin/env python
+
+# Copyright JS Foundation and other contributors, http://js.foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import subprocess
+import sys
+import time
+
+import util
+TempFile = __import__("test262-harness").TempFile # pylint: disable=invalid-name
+
+class DebuggerArgs:
+    def __init__(self):
+        self.jerry = sys.argv[1]
+        self.channel = sys.argv[2]
+        self.debugger_client = sys.argv[3]
+        self.test_case = sys.argv[4]
+
+
+def check_output(command_args, stdin=None, encoding=None):
+    try:
+        out = subprocess.check_output(command_args, stdin=stdin, shell=False, stderr=subprocess.STDOUT)
+    except subprocess.CalledProcessError as check_error:
+        out = check_error.output
+    return out.decode(encoding or 'utf-8', 'ignore')
+
+
+def execute_debug_client(out_tmp, cmd_file_name, debug_client_args):
+    print(f'input debug cmd: {cmd_file_name}')
+    with open(cmd_file_name, 'rb') as cmd_file:
+        out = check_output(debug_client_args, cmd_file)
+        out_tmp.write(out)
+
+
+def main(args):
+    util.setup_stdio()
+    jerry_debug_server_cmd = [args.jerry]
+    client_args = []
+    if 'client_source' in args.test_case:
+        jerry_debug_server_cmd += ['--start-debug-server', '--debug-channel',
+                                   args.channel, '--debugger-wait-source']
+        client_args += ['--client-source']
+        if 'client_source_multiple' in args.test_case:
+            client_args += [args.test_case + '_2.js', args.test_case + '_1.js']
+        else:
+            client_args += [args.test_case + '.js']
+    else:
+        jerry_debug_server_cmd += [args.test_case + '.js', '--start-debug-server', '--debug-channel', args.channel]
+    print(f'run debug server: {jerry_debug_server_cmd}')
+    with subprocess.Popen(jerry_debug_server_cmd, stdin=subprocess.PIPE,
+                            stdout=subprocess.PIPE, stderr=subprocess.STDOUT) as proc:
+        time.sleep(1)
+
+        out_tmp = TempFile(prefix=os.path.basename(args.test_case), suffix='out')
+        git_failed = False
+        try:
+            debug_client_args = util.get_python_cmd_prefix()
+            debug_client_args += [args.debugger_client, '--channel', args.channel, '--non-interactive']
+            debug_client_args += client_args
+            print(f"run debug client: {' '.join(debug_client_args)}")
+            execute_debug_client(out_tmp, args.test_case + '.cmd', debug_client_args)
+            if 'restart' in args.test_case:
+                continue_case = args.test_case.replace('restart', 'continue')
+                execute_debug_client(out_tmp, continue_case + '.cmd', debug_client_args)
+            out_tmp.close()
+            git_diff_cmd = ['git', '--no-pager', 'diff', '--ignore-space-at-eol',
+                            '--no-index', args.test_case + '.expected', out_tmp.name]
+            git_out = check_output(git_diff_cmd)
+            if '@@' in git_out:
+                git_failed = True
+        finally:
+            proc.wait()
+            if git_failed:
+                print(f"jerry out:\n{proc.stdout.read().decode('utf-8')}\nEOF")
+                print(f"git diff cmd: {' '.join(git_diff_cmd)}")
+                print(f'git diff result:\n{git_out}\nEOF')
+                print(f'{util.TERM_RED}FAIL: {args.test_case}{util.TERM_NORMAL}')
+                sys.exit(1)
+            else:
+                out_tmp.dispose()
+                print(f'{util.TERM_GREEN}PASS: {args.test_case}{util.TERM_NORMAL}')
+                sys.exit(0)
+
+
+if __name__ == "__main__":
+    sys.exit(main(DebuggerArgs()))

tools/runners/run-debugger-test.sh

@@ -24,7 +24,7 @@
 BUILD_SCRIPT = path.join(TOOLS_DIR, 'build.py')
 CPPCHECK_SCRIPT = path.join(TOOLS_DIR, 'check-cppcheck.sh')
 DEBUGGER_CLIENT_SCRIPT = path.join(PROJECT_DIR, 'jerry-debugger/jerry_client.py')
-DEBUGGER_TEST_RUNNER_SCRIPT = path.join(TOOLS_DIR, 'runners/run-debugger-test.sh')
+DEBUGGER_TEST_RUNNER_SCRIPT = path.join(TOOLS_DIR, 'runners/run-debugger-test.py')
 DOXYGEN_SCRIPT = path.join(TOOLS_DIR, 'check-doxygen.sh')
 LICENSE_SCRIPT = path.join(TOOLS_DIR, 'check-license.py')
 STRINGS_SCRIPT = path.join(TOOLS_DIR, 'check-strings.sh')