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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-browser-tray
-Version: 1.5.0
+Version: 1.5.2
 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
@@ -68,6 +68,8 @@ On start up it connects to a running Chromium (started using the tray icon) or M
 
 If you start a new browser while ibrowser is running, call the keyword "Connect" to connect ibrowser to it.
 
+To exit ibrowser press `Ctrl-D`.
+
 ### Usage in a Robot Framework Test Suite
 
 Add these lines to the Settings section of the .robot file:

{robotframework_browser_tray-1.5.0 → robotframework_browser_tray-1.5.2}/README.md

@@ -56,6 +56,8 @@ On start up it connects to a running Chromium (started using the tray icon) or M
 
 If you start a new browser while ibrowser is running, call the keyword "Connect" to connect ibrowser to it.
 
+To exit ibrowser press `Ctrl-D`.
+
 ### Usage in a Robot Framework Test Suite
 
 Add these lines to the Settings section of the .robot file:

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

@@ -1,6 +1,6 @@
 [project]
 name = "robotframework-browser-tray"
-version = "1.5.0"
+version = "1.5.2"
 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"},
@@ -19,6 +19,21 @@ license = {text = "Apache 2.0"}
 [tool.flit.module]
 name = "BrowserTray"
 
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.dev-dependencies]
+dev = [
+    "tox>=4.15.1",
+    "pytest>=8.2.2",
+    "mypy>=1.10.0",
+]
+
+[tool.pdm.scripts]
+test = "tox -p all"
+
+
 [project.scripts]
 browser-tray = "BrowserTray.tray:run"
 ibrowser = "BrowserTray.Repl.repl:run"
@@ -26,7 +41,3 @@ ibrowser = "BrowserTray.Repl.repl:run"
 [build-system]
 requires = ["flit_core>=3.2,<4"]
 build-backend = "flit_core.buildapi"
-
-
-[tool.pdm]
-distribution = true

{robotframework_browser_tray-1.5.0 → robotframework_browser_tray-1.5.2}/src/BrowserTray/Repl/repl.py

@@ -1,7 +1,9 @@
-import http
+import http.client
+import socket
 import sys
 import tempfile
 from pathlib import Path
+import time
 
 from robot import run_cli
 
@@ -56,12 +58,16 @@ def shell():
                 file_path.unlink()
 
 
-def run():
+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 TimeoutError:
+    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.0 → robotframework_browser_tray-1.5.2}/src/BrowserTray/tray.py

@@ -1,17 +1,25 @@
 import argparse
+import http.client
 import os
 import site
+import socket
 import subprocess
 import sys
+import time
 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"
@@ -19,7 +27,7 @@ node_modules = browser_wrapper / "node_modules"
 playwright_core = node_modules / "playwright-core"
 
 
-def find_chromium(path: Path) -> list[Path]:
+def find_chromium(path: Path) -> List[Path]:
     return [
         Path(file.path)
         for file in os.scandir(path)
@@ -40,15 +48,27 @@ def get_chromium_dir(node_modules: Path):
     return find_chromium(local_browsers)[0]
 
 
-def start_playwright(index_js: Path, playwright_process_port: int) -> Popen:
+def start_playwright(playwright_process_port: int) -> Popen:
     return Popen(['node', index_js, str(playwright_process_port)])
 
 
-
 class TrayIcon:
-    def __init__(self, processes: list[Popen], remote_debugging_port: int):
+    def __init__(self, playwright_process_port: int, remote_debugging_port: int, timeout=0):
         chromium_icon = Image.open(Path(realpath(__file__)).parent / "chromium.png")
-        self.processes = processes
+
+        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',
@@ -58,7 +78,7 @@ class TrayIcon:
                 'Open Chromium',
                 self.open_chromium,
                 default=True
-            ),        
+            ),
             MenuItem(
                 'Open Chromium Incognito',
                 self.open_chromium_incognito,
@@ -94,6 +114,7 @@ class TrayIcon:
             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)
 
 
@@ -110,10 +131,8 @@ def is_running(cmd: str) -> bool:
     return len(instances) > 1
 
 
-def get_ports() -> tuple[int, int]:
+def get_ports() -> Tuple[int, int]:
     MAX_PORT = 2**16
-    REMOTE_DEBUGGING_PORT = 1234
-    PLAYWRIGHT_PROCESS_PORT= 4711
     
     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})")
@@ -144,7 +163,11 @@ def run():
         )
         sys.exit(1)
 
-    playwright_process = start_playwright(index_js, playwright_process_port)
-    processes = [playwright_process]
-    tray_icon = TrayIcon(processes, remote_debugging_port)
-    tray_icon.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" + 
+              "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()