robotframework-browser-tray 1.6.0__tar.gz → 1.7.0__tar.gz

{robotframework_browser_tray-1.6.0 → robotframework_browser_tray-1.7.0}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: robotframework-browser-tray
-Version: 1.6.0
+Version: 1.7.0
 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: pystray>=0.19.5
 Requires-Dist: robotframework-browser>=18.0.0
@@ -51,7 +51,7 @@ python -m BrowserTray
 **Hint**: In case your environment does not allow executing ibrowser, call the Python module directly:
 
 ```bash
-python -m BrowserTray.Repl
+python -m BrowserTray.ibrowser
 ```
 
 ### ibrowser
@@ -103,7 +103,7 @@ If Microsoft Edge is installed on your machine:
 
 ## How it works
 
-On start up `browser-tray` checks whether `rfbrowser init` has been executed.
+On start up `ibrowser` checks whether `rfbrowser init` has been executed.
 
 If this requirement is met the Playwright wrapper is started with `node site-packages/Browser/wrapper/index.js 4711`.
 

{robotframework_browser_tray-1.6.0 → robotframework_browser_tray-1.7.0}/README.md

@@ -39,7 +39,7 @@ python -m BrowserTray
 **Hint**: In case your environment does not allow executing ibrowser, call the Python module directly:
 
 ```bash
-python -m BrowserTray.Repl
+python -m BrowserTray.ibrowser
 ```
 
 ### ibrowser
@@ -91,7 +91,7 @@ If Microsoft Edge is installed on your machine:
 
 ## How it works
 
-On start up `browser-tray` checks whether `rfbrowser init` has been executed.
+On start up `ibrowser` checks whether `rfbrowser init` has been executed.
 
 If this requirement is met the Playwright wrapper is started with `node site-packages/Browser/wrapper/index.js 4711`.
 

{robotframework_browser_tray-1.6.0 → robotframework_browser_tray-1.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "robotframework-browser-tray"
-version = "1.6.0"
+version = "1.7.0"
 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"},
@@ -12,7 +12,7 @@ dependencies = [
     "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"}
 
@@ -36,7 +36,7 @@ test = "tox"
 
 [project.scripts]
 browser-tray = "BrowserTray.tray:run"
-ibrowser = "BrowserTray.Repl.repl:run"
+ibrowser = "BrowserTray.ibrowser:run"
 
 [build-system]
 requires = ["flit_core>=3.2,<4"]

robotframework_browser_tray-1.7.0/src/BrowserTray/BrowserRepl/__init__.py

@@ -0,0 +1,14 @@
+from RobotDebug.RobotDebug import RobotDebug
+from robot.libraries.BuiltIn import BuiltIn
+
+
+class BrowserRepl(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.7.0/src/BrowserTray/cmdline_args.py

@@ -0,0 +1,22 @@
+import argparse
+from typing import Tuple
+
+
+REMOTE_DEBUGGING_PORT = 1234
+PLAYWRIGHT_PROCESS_PORT= 4711
+
+
+def get_ports() -> 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()
+    playwright_process_port = args.pw_port
+    remote_debugging_port = args.cdp_port
+
+    if playwright_process_port > MAX_PORT or remote_debugging_port > MAX_PORT:
+        raise ValueError(f"Port numbers cannot be larger than {MAX_PORT}")
+
+    return (playwright_process_port, remote_debugging_port)

robotframework_browser_tray-1.7.0/src/BrowserTray/ibrowser/__init__.py

@@ -0,0 +1 @@
+from .repl import run

{robotframework_browser_tray-1.6.0/src/BrowserTray/Repl → robotframework_browser_tray-1.7.0/src/BrowserTray/ibrowser}/repl.py

@@ -1,17 +1,22 @@
 import http.client
 import re
 import socket
+from subprocess import Popen
 import sys
 import tempfile
 import time
 from functools import wraps
 from pathlib import Path
+from textwrap import dedent
 
 import RobotDebug.styles
 from Browser.base.librarycomponent import LibraryComponent
 from robot.run import run_cli
 from robot.api import logger
 
+from BrowserTray import cmdline_args
+from BrowserTray import playwright
+
 
 def escape_ansi(line):
     ansi_escape = re.compile(r'(?:\x1B[@-_]|[\x80-\x9F])[0-?]*[ -/]*[@-~]')
@@ -53,17 +58,22 @@ def wrap_presenter_mode(self, selector, strict):
 LibraryComponent.presenter_mode = wrap_presenter_mode
 
 
-TEST_SUITE = b"""
-*** Settings ***
-Library    BrowserTray.Repl   repl=${True}
+def test_suite(playwright_process_port, remote_debugging_port):
+    return bytes(dedent(
+        f"""
+        *** Settings ***
+        Library    BrowserTray.BrowserRepl    {playwright_process_port}    {remote_debugging_port}    repl=${True}
 
-*** Test Cases ***
-Robot Framework Debug REPL
-    Debug
-"""
+        *** Test Cases ***
+        Robot Framework Debug REPL
+            Debug
+        """
+        ), 
+        encoding='utf-8'
+    )
 
 
-def shell():
+def irobot(testsuite: bytes, playwright_proc: Popen):
     """A standalone robotframework shell."""
 
     default_no_logs = [
@@ -83,15 +93,21 @@ def shell():
     with tempfile.NamedTemporaryFile(
         prefix="robot-debug-", suffix=".robot", delete=False
     ) as test_file:
-        test_file.write(TEST_SUITE)
+        test_file.write(testsuite)
         test_file.flush()
 
         if len(sys.argv) > 1:
-            args = sys.argv[1:] + [test_file.name]
+            sys.argv = [
+                arg 
+                for arg in sys.argv 
+                if not (arg.startswith('--pw-port') or arg.startswith('--cdp-port'))
+            ]
+            args = sys.argv[1:] + [*default_no_logs, test_file.name]
         else:
             args = [*default_no_logs, test_file.name]
 
         try:
+            
             sys.exit(run_cli(args))
         finally:
             test_file.close()
@@ -101,18 +117,22 @@ def shell():
             file_path = Path(test_file.name)
             if file_path.exists():
                 file_path.unlink()
+            
+            playwright_proc.terminate()
+
 
+def run():
+    playwright_process_port, remote_debugging_port = cmdline_args.get_ports()
 
-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()
+        http.client.HTTPConnection('127.0.0.1', remote_debugging_port, timeout=1).connect()
+
+        playwright_proc = playwright.run(playwright_process_port)
+        irobot(test_suite(playwright_process_port, remote_debugging_port), playwright_proc)
     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/"
+              "  - a running Microsoft Edge started as explained in the documentation: https://pypi.org/project/robotframework-browser-tray/\n" +
+              f"Default remote-debugging-port: {remote_debugging_port}"
         )
         sys.exit(1)

robotframework_browser_tray-1.7.0/src/BrowserTray/playwright.py

@@ -0,0 +1,44 @@
+import http.client
+import site
+import socket
+import subprocess
+import sys
+from pathlib import Path
+from subprocess import Popen
+
+
+_, site_packages = site.getsitepackages()
+browser_wrapper = Path(site_packages) / "Browser" / "wrapper"
+index_js = browser_wrapper / "index.js"
+node_modules = browser_wrapper / "node_modules"
+playwright_core = node_modules / "playwright-core"
+
+
+def playwright_is_initialized():
+    return node_modules.is_dir() and playwright_core.is_dir()
+
+
+def start_playwright(playwright_process_port: int) -> Popen:
+    return Popen(
+        ['node', index_js, str(playwright_process_port)],
+        stderr=subprocess.PIPE,
+        stdout=subprocess.PIPE
+    )
+
+
+def run(playwright_process_port: int) -> Popen:
+    if not playwright_is_initialized():
+        print(
+            "Playwright has not been initialized.\n" + 
+            "In order to use Chromium execute 'rfbrowser init chromium'.\n" + 
+            "If you want to use the Microsoft Edge installed on your system execute 'rfbrowser init --skip-browsers'"
+        )
+        sys.exit(1)
+
+    try:
+        http.client.HTTPConnection('127.0.0.1', playwright_process_port, timeout=1).connect()
+        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:
+        return start_playwright(playwright_process_port)

robotframework_browser_tray-1.7.0/src/BrowserTray/tray.py

@@ -0,0 +1,114 @@
+import os
+import site
+import subprocess
+import sys
+import tkinter as tk
+from os.path import realpath
+from pathlib import Path
+from subprocess import Popen
+from tkinter import messagebox
+from typing import List
+
+from PIL import Image
+from pystray import Icon, Menu, MenuItem
+
+from BrowserTray import cmdline_args
+
+
+_, site_packages = site.getsitepackages()
+browser_wrapper = Path(site_packages).resolve() / "Browser" / "wrapper"
+index_js = browser_wrapper / "index.js"
+node_modules = browser_wrapper / "node_modules"
+playwright_core = node_modules / "playwright-core"
+
+
+def find_chromium(path: Path) -> List[Path]:
+    return [
+        Path(file.path)
+        for file in os.scandir(path)
+        if file.is_dir() and file.name.startswith("chromium")
+    ]
+
+
+def get_chromium_dir(node_modules: Path):
+    local_browsers = playwright_core / ".local-browsers"
+
+    if not (node_modules.is_dir() and local_browsers.is_dir() and find_chromium(local_browsers)):
+       return None
+
+    return find_chromium(local_browsers)[0]
+
+
+def start_chromium(remote_debugging_port: int, incognito: bool):
+    chromium_dir = get_chromium_dir(node_modules)
+
+    if not chromium_dir:
+        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"
+        Popen([chrome_exe, f"--remote-debugging-port={remote_debugging_port}", "--test-type"] + incognito_flag)
+
+
+class TrayIcon:
+    def __init__(self, remote_debugging_port: int):
+        chromium_icon = Image.open(Path(realpath(__file__)).parent / "chromium.png")
+
+        self.remote_debugging_port = remote_debugging_port
+        self.icon = Icon(
+        name='Browser Tray',
+        icon=chromium_icon,
+        menu=Menu(
+            MenuItem(
+                'Open Chromium',
+                self.open_chromium,
+                default=True
+            ),
+            MenuItem(
+                'Open Chromium Incognito',
+                self.open_chromium_incognito,
+            ),
+            MenuItem(
+                'Exit',
+                self.exit
+            )
+        )
+    )
+
+    def exit(self):
+        self.icon.stop()
+
+    def open_chromium(self):
+        start_chromium(self.remote_debugging_port, False)
+
+    def open_chromium_incognito(self):
+        start_chromium(self.remote_debugging_port, True)
+
+    def run(self):
+        cmd = "browser-tray.exe"
+        if is_running(cmd):
+            print(f"{cmd} is already running")
+            sys.exit(1)
+            
+        self.icon.run()
+
+
+def is_running(cmd: str) -> bool:
+    process_list = subprocess.check_output(
+        # Set the character page to 65001 = UTF-8
+        f'chcp 65001 | TASKLIST /FI "IMAGENAME eq {cmd}"', shell=True
+    ).decode('utf-8').splitlines()
+    instances = [
+        process 
+        for process in process_list 
+        if process.startswith(cmd)
+    ]
+    return len(instances) > 1
+
+
+def run():
+    playwright_process_port, remote_debugging_port = cmdline_args.get_ports()
+    tray_icon = TrayIcon(remote_debugging_port)
+    tray_icon.run()

robotframework_browser_tray-1.6.0/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", "timeout=2s")
-        self.connect()
-
-    def connect(self):
-        BuiltIn().run_keyword("Connect To Browser", "http://localhost:1234", "chromium", "use_cdp=True")

robotframework_browser_tray-1.6.0/src/BrowserTray/tray.py

@@ -1,176 +0,0 @@
-import argparse
-import http.client
-import os
-import site
-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
-from tkinter import messagebox
-from typing import List, Tuple
-
-from PIL import Image
-from pystray import Icon, Menu, MenuItem
-
-
-REMOTE_DEBUGGING_PORT = 1234
-PLAYWRIGHT_PROCESS_PORT= 4711
-
-
-_, site_packages = site.getsitepackages()
-browser_wrapper = Path(site_packages) / "Browser" / "wrapper"
-index_js = browser_wrapper / "index.js"
-node_modules = browser_wrapper / "node_modules"
-playwright_core = node_modules / "playwright-core"
-
-
-def find_chromium(path: Path) -> List[Path]:
-    return [
-        Path(file.path)
-        for file in os.scandir(path)
-        if file.is_dir() and file.name.startswith("chromium")
-    ]
-
-
-def playwright_is_initialized():
-    return node_modules.is_dir() and playwright_core.is_dir()
-
-
-def get_chromium_dir(node_modules: Path):
-    local_browsers = playwright_core / ".local-browsers"
-
-    if not (node_modules.is_dir() and local_browsers.is_dir() and find_chromium(local_browsers)):
-       return None
-
-    return find_chromium(local_browsers)[0]
-
-
-def start_playwright(playwright_process_port: int) -> Popen:
-    return Popen(['node', index_js, str(playwright_process_port)])
-
-
-class TrayIcon:
-    def __init__(self, playwright_process_port: int, remote_debugging_port: int, timeout=0):
-        chromium_icon = Image.open(Path(realpath(__file__)).parent / "chromium.png")
-
-        playwright_process = start_playwright(playwright_process_port)
-        time.sleep(2)
-        return_code = playwright_process.poll()
-
-        if return_code:
-            sys.exit(return_code)
-
-        if timeout:
-            time.sleep(timeout)
-            playwright_process.kill()
-            sys.exit(0)
-
-        self.processes = [playwright_process]
-        self.remote_debugging_port = remote_debugging_port
-        self.icon = Icon(
-        name='Browser Tray',
-        icon=chromium_icon,
-        menu=Menu(
-            MenuItem(
-                'Open Chromium',
-                self.open_chromium,
-                default=True
-            ),
-            MenuItem(
-                'Open Chromium Incognito',
-                self.open_chromium_incognito,
-            ),
-            MenuItem(
-                'Exit',
-                self.exit
-            )
-        )
-    )
-
-    def exit(self):
-        for proc in self.processes:
-            proc.terminate()
-
-        self.icon.stop()
-
-    def open_chromium(self):
-        self.start_chromium(self.remote_debugging_port, False)
-
-    def open_chromium_incognito(self):
-        self.start_chromium(self.remote_debugging_port, True)
-
-    def run(self):
-        self.icon.run()
-
-    def start_chromium(self, remote_debugging_port: int, incognito: bool):
-        chromium_dir = get_chromium_dir(node_modules)
-
-        if not chromium_dir:
-            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"
-            chromium = Popen([chrome_exe, f"--remote-debugging-port={remote_debugging_port}", "--test-type"] + incognito_flag)
-            time.sleep(2)
-            self.processes.append(chromium)
-
-
-def is_running(cmd: str) -> bool:
-    process_list = subprocess.check_output(
-        # Set the character page to 65001 = UTF-8
-        f'chcp 65001 | TASKLIST /FI "IMAGENAME eq {cmd}"', shell=True
-    ).decode('utf-8').splitlines()
-    instances = [
-        process 
-        for process in process_list 
-        if process.startswith(cmd) and os.getlogin().lower() in process.lower()
-    ]
-    return len(instances) > 1
-
-
-def get_ports() -> 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()
-    playwright_process_port = args.pw_port
-    remote_debugging_port = args.cdp_port
-
-    if playwright_process_port > MAX_PORT or remote_debugging_port > MAX_PORT:
-        raise ValueError(f"Port numbers cannot be larger than {MAX_PORT}")
-
-    return (playwright_process_port, remote_debugging_port)
-
-
-def run():
-    cmd = "browser-tray.exe"
-    if is_running(cmd):
-        print(f"{cmd} is already running")
-        sys.exit(1)
-
-    playwright_process_port, remote_debugging_port = get_ports()
-
-    if not playwright_is_initialized():
-        print(
-            "Playwright has not been initialized.\n" + 
-            "In order to use Chromium execute 'rfbrowser init chromium'.\n" + 
-            "If you want to use the Microsoft Edge installed on your system execute 'rfbrowser init --skip-browsers'"
-        )
-        sys.exit(1)
-
-    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" + 
-              "To start the Playwright wrapper on another port execute `browser-tray --pw-port PORT`")
-        sys.exit(1)
-    except socket.timeout:
-        tray_icon = TrayIcon(playwright_process_port, remote_debugging_port)
-        tray_icon.run()