robotframework-browser-tray 1.5.2__tar.gz → 1.6.1__tar.gz

{robotframework_browser_tray-1.5.2 → robotframework_browser_tray-1.6.1}/PKG-INFO

@@ -1,10 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: robotframework-browser-tray
-Version: 1.5.2
+Version: 1.6.1
 Summary: Tray icon and REPL for trying out Browser Library keywords using Chromium or Edge
 Author-email: Marduk Bolaños <marduk.bolanos@imbus.de>
-Requires-Python: >=3.8.2
+Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
+Requires-Dist: psutil>=6.1.1
 Requires-Dist: pystray>=0.19.5
 Requires-Dist: robotframework-browser>=18.0.0
 Requires-Dist: robotframework-debug>=4.5.0

{robotframework_browser_tray-1.5.2 → robotframework_browser_tray-1.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "robotframework-browser-tray"
-version = "1.5.2"
+version = "1.6.1"
 description = "Tray icon and REPL for trying out Browser Library keywords using Chromium or Edge"
 authors = [
     {name = "Marduk Bolaños", email = "marduk.bolanos@imbus.de"},
@@ -8,11 +8,12 @@ authors = [
 urls = { homepage = "https://github.com/mardukbp/robotframework-browser-tray" }
 
 dependencies = [
+    "psutil>=6.1.1",
     "pystray>=0.19.5",
     "robotframework-browser>=18.0.0",
     "robotframework-debug>=4.5.0",
 ]
-requires-python = ">=3.8.2"
+requires-python = ">=3.9.0"
 readme = "README.md"
 license = {text = "Apache 2.0"}
 
@@ -31,7 +32,7 @@ dev = [
 ]
 
 [tool.pdm.scripts]
-test = "tox -p all"
+test = "tox"
 
 
 [project.scripts]

robotframework_browser_tray-1.6.1/src/BrowserTray/Repl/__init__.py

@@ -0,0 +1,14 @@
+from RobotDebug.RobotDebug import RobotDebug
+from robot.libraries.BuiltIn import BuiltIn
+
+
+class Repl(RobotDebug):
+    def __init__(self, playwright_process_port, remote_debugging_port, **kwargs):
+        super().__init__(**kwargs)
+        
+        self.Library("Browser", "enable_presenter_mode=True", f"playwright_process_port={playwright_process_port}")
+        self.connect(remote_debugging_port)
+
+    def connect(self, remote_debugging_port):
+        BuiltIn().run_keyword("Connect To Browser", f"http://localhost:{remote_debugging_port}", "chromium", "use_cdp=True")
+        BuiltIn().run_keyword("Set Browser Timeout", "2s")

robotframework_browser_tray-1.6.1/src/BrowserTray/Repl/repl.py

@@ -0,0 +1,144 @@
+import http.client
+import re
+import socket
+import sys
+import tempfile
+import time
+from functools import wraps
+from pathlib import Path
+from textwrap import dedent
+
+import psutil
+import RobotDebug.styles
+from Browser.base.librarycomponent import LibraryComponent
+from robot.run import run_cli
+from robot.api import logger
+
+from BrowserTray.tray import get_ports
+
+
+def escape_ansi(line):
+    ansi_escape = re.compile(r'(?:\x1B[@-_]|[\x80-\x9F])[0-?]*[ -/]*[@-~]')
+    return ansi_escape.sub('', line)
+
+
+print_output = RobotDebug.styles.print_output
+
+@wraps(print_output)
+def wrap_print_output(head, message, style=RobotDebug.styles.NORMAL_STYLE):
+    print_output(head, escape_ansi(message), style)
+
+RobotDebug.styles.print_output = wrap_print_output
+
+
+presenter_mode = LibraryComponent.presenter_mode
+
+@wraps(presenter_mode)
+def wrap_presenter_mode(self, selector, strict):
+    selector = self.resolve_selector(selector)
+    if self.library.presenter_mode:
+        mode = self.get_presenter_mode
+        try:
+            self.library.scroll_to_element(selector)
+            self.library.highlight_elements(
+                selector,
+                duration=mode["duration"],
+                width=mode["width"],
+                style=mode["style"],
+                color=mode["color"],
+            )
+        except Exception as error:
+            # selector = self.library.record_selector(f'"{selector}" failure')
+            logger.debug(f"On presenter more supress {error}")
+        else:
+            time.sleep(mode["duration"].seconds)
+    return selector
+
+LibraryComponent.presenter_mode = wrap_presenter_mode
+
+
+def test_suite(playwright_process_port, remote_debugging_port):
+    return bytes(dedent(
+        f"""
+        *** Settings ***
+        Library    BrowserTray.Repl    {playwright_process_port}    {remote_debugging_port}    repl=${True}
+
+        *** Test Cases ***
+        Robot Framework Debug REPL
+            Debug
+        """
+        ), 
+        encoding='utf-8'
+    )
+
+
+def shell(playwright_process_port, remote_debugging_port):
+    """A standalone robotframework shell."""
+
+    default_no_logs = [
+        "-l",
+        "None",
+        "-x",
+        "None",
+        "-o",
+        "None",
+        "-L",
+        "None",
+        "-r",
+        "None",
+        "--quiet",
+    ]
+
+    with tempfile.NamedTemporaryFile(
+        prefix="robot-debug-", suffix=".robot", delete=False
+    ) as test_file:
+        test_file.write(test_suite(playwright_process_port, remote_debugging_port))
+        test_file.flush()
+
+        if len(sys.argv) > 1:
+            args = sys.argv[1:] + [test_file.name]
+        else:
+            args = [*default_no_logs, test_file.name]
+
+        try:
+            sys.exit(run_cli(args))
+        finally:
+            test_file.close()
+            # pybot will raise PermissionError on Windows NT or later
+            # if NamedTemporaryFile called with `delete=True`,
+            # deleting test file seperated will be OK.
+            file_path = Path(test_file.name)
+            if file_path.exists():
+                file_path.unlink()
+
+
+def run(timeout=0, test=False):
+    ports = []
+
+    if not test:
+        cmdline = [
+            proc.cmdline()
+            for proc in psutil.process_iter()
+            if proc.name() == 'browser-tray.exe'
+        ]
+
+        if not cmdline:
+            print("browser-tray must be running prior to executing ibrowser")
+            sys.exit(1)
+
+        _, *ports = cmdline[0]
+
+    playwright_process_port, remote_debugging_port = get_ports(ports)
+
+    try:
+        http.client.HTTPConnection('127.0.0.1', remote_debugging_port, timeout=1).connect()
+        if timeout:
+            time.sleep(timeout)
+            sys.exit(0)
+        shell(playwright_process_port, remote_debugging_port)
+    except socket.timeout:
+        print("ibrowser needs either:\n" +
+              "  - a running Chromium, started using the tray icon or\n" + 
+              "  - a running Microsoft Edge started as explained in the documentation: https://pypi.org/project/robotframework-browser-tray/"
+        )
+        sys.exit(1)

{robotframework_browser_tray-1.5.2 → robotframework_browser_tray-1.6.1}/src/BrowserTray/tray.py

@@ -6,6 +6,7 @@ import socket
 import subprocess
 import sys
 import time
+import tkinter as tk
 from os.path import realpath
 from pathlib import Path
 from subprocess import Popen
@@ -109,7 +110,9 @@ class TrayIcon:
         chromium_dir = get_chromium_dir(node_modules)
 
         if not chromium_dir:
-            messagebox.showerror("Error", "Chromium is not installed. Execute 'rfbrowser init chromium'.")
+            window = tk.Tk()
+            window.withdraw()
+            messagebox.showerror("Error", "Chromium is not installed. Execute 'rfbrowser init chromium'.", master=window)
         else:
             incognito_flag = ["-incognito"] if incognito else []
             chrome_exe = chromium_dir / "chrome-win" / "chrome.exe"
@@ -131,13 +134,13 @@ def is_running(cmd: str) -> bool:
     return len(instances) > 1
 
 
-def get_ports() -> Tuple[int, int]:
+def get_ports(cmdline_args=None) -> Tuple[int, int]:
     MAX_PORT = 2**16
     
     arg_parser = argparse.ArgumentParser(add_help=True)
     arg_parser.add_argument("--pw-port", default=PLAYWRIGHT_PROCESS_PORT, type=int, help=f"Playwright process port (default: {PLAYWRIGHT_PROCESS_PORT})")
     arg_parser.add_argument("--cdp-port", default=REMOTE_DEBUGGING_PORT, type=int, help=f"Chromium debugging port (default: {REMOTE_DEBUGGING_PORT})")
-    args = arg_parser.parse_args()
+    args = arg_parser.parse_args(cmdline_args)
     playwright_process_port = args.pw_port
     remote_debugging_port = args.cdp_port
 
@@ -165,7 +168,7 @@ def run():
 
     try:
         http.client.HTTPConnection('127.0.0.1', playwright_process_port, timeout=1).connect()
-        print("The port 4711 is already in use. Either browser-tray is already running or another process is using the port.\n" + 
+        print(f"The port {playwright_process_port} is already in use. Either browser-tray is already running or another process is using the port.\n" + 
               "To start the Playwright wrapper on another port execute `browser-tray --pw-port PORT`")
         sys.exit(1)
     except socket.timeout:

robotframework_browser_tray-1.5.2/src/BrowserTray/Repl/__init__.py

@@ -1,13 +0,0 @@
-from RobotDebug.RobotDebug import RobotDebug
-from robot.libraries.BuiltIn import BuiltIn
-
-
-class Repl(RobotDebug):
-    def __init__(self, **kwargs):
-        super().__init__(**kwargs)
-
-        self.Library("Browser", "enable_presenter_mode=True", "playwright_process_port=4711")
-        self.connect()
-
-    def connect(self):
-        BuiltIn().run_keyword("Connect To Browser", "http://localhost:1234", "chromium", "use_cdp=True")

robotframework_browser_tray-1.5.2/src/BrowserTray/Repl/repl.py

@@ -1,73 +0,0 @@
-import http.client
-import socket
-import sys
-import tempfile
-from pathlib import Path
-import time
-
-from robot import run_cli
-
-
-TEST_SUITE = b"""
-*** Settings ***
-Library    BrowserTray.Repl   repl=${True}
-
-*** Test Cases ***
-Robot Framework Debug REPL
-    Debug
-"""
-
-
-def shell():
-    """A standalone robotframework shell."""
-
-    default_no_logs = [
-        "-l",
-        "None",
-        "-x",
-        "None",
-        "-o",
-        "None",
-        "-L",
-        "None",
-        "-r",
-        "None",
-        "--quiet",
-    ]
-
-    with tempfile.NamedTemporaryFile(
-        prefix="robot-debug-", suffix=".robot", delete=False
-    ) as test_file:
-        test_file.write(TEST_SUITE)
-        test_file.flush()
-
-        if len(sys.argv) > 1:
-            args = sys.argv[1:] + [test_file.name]
-        else:
-            args = [*default_no_logs, test_file.name]
-
-        try:
-            sys.exit(run_cli(args))
-        finally:
-            test_file.close()
-            # pybot will raise PermissionError on Windows NT or later
-            # if NamedTemporaryFile called with `delete=True`,
-            # deleting test file seperated will be OK.
-            file_path = Path(test_file.name)
-            if file_path.exists():
-                file_path.unlink()
-
-
-def run(timeout=0):
-    try:
-        http.client.HTTPConnection('127.0.0.1', 1234, timeout=1).connect()
-        if timeout:
-            time.sleep(timeout)
-            sys.exit(0)
-        shell()
-    except socket.timeout:
-        print("ibrowser needs either:\n" +
-              "  - a running Chromium, started using the tray icon or\n" + 
-              "  - a running Microsoft Edge started as explained in the documentation: https://pypi.org/project/robotframework-browser-tray/"
-        )
-        sys.exit(1)