robotframework-browser-tray 1.3.0__tar.gz → 1.4.0__tar.gz

{robotframework_browser_tray-1.3.0 → robotframework_browser_tray-1.4.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: robotframework-browser-tray
-Version: 1.3.0
-Summary: Tray icon to start the Chromium installed by Browser Library
+Version: 1.4.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
 Description-Content-Type: text/markdown
@@ -12,7 +12,8 @@ Project-URL: homepage, https://github.com/mardukbp/robotframework-browser-tray
 
 # robotframework-browser-tray
 
-A tray icon for starting the Chromium installed by [Browser Library](https://robotframework-browser.org/)
+Tray icon and REPL for trying out [Browser Library](https://robotframework-browser.org/) keywords using Chromium or Edge
+
 
 **Requirements**
 
@@ -24,7 +25,7 @@ A tray icon for starting the Chromium installed by [Browser Library](https://rob
 
 - Execute tests incrementally using e.g. [RobotCode](https://github.com/d-biehl/robotcode)
 
-- Test selectors in an open web page interactively using [irobot](https://pypi.org/project/robotframework-debug/)
+- Test selectors in an open web page interactively
 
 
 ## How to use it
@@ -50,13 +51,22 @@ python -m BrowserTray
 **Hint**: In case your environment does not allow executing ibrowser, call the Python module directly:
 
 ```bash
-python -m BrowserTray.BrowserRepl
+python -m BrowserTray.Repl
 ```
 
 ### ibrowser
 
-ibrowser allows testing selectors in an open web page interactively. In addition to the selectors supported by Browser library,
-it adds the selector `role` for selecting elements using their ARIA role.
+ibrowser allows testing selectors in an open web page interactively. 
+
+To start it execute:
+
+```bash
+ibrowser
+```
+
+On start up it checks whether the Chromium installed by `rfbrowser init chromium` is present. It can also be used with Microsoft Edge. See the section below for instructions. 
+
+In addition to the selectors supported by Browser Library, `ibrowser` adds the selector `role` for selecting elements using their ARIA role.
 
 The role of an element can be easily obtained from the Accessibility Tree. To open the tree follow these steps:
 
@@ -70,7 +80,7 @@ The role of an element can be easily obtained from the Accessibility Tree. To op
 
 ### Usage in a Robot Framework Test Suite
 
-Add these lines to the top of the .robot file:
+Add these lines to the Settings section of the .robot file:
 
 ```robotframework
 Library       Browser               playwright_process_port=55555
@@ -88,26 +98,24 @@ browser-tray --pw-port=XXXX --cdp-port=XXXX
 
 If Microsoft Edge is installed on your machine:
 
-1. Close all instances of Microsoft Edge
+1. Create a Shortcut to msedge.exe with the target:
 
 ```powershell
-taskkill /F /IM msedge.exe
+"C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe" --remote-debugging-port=1234 --user-data-dir=C:\Users\YOUR_USER\RFEdgeProfile
 ```
 
-2. Start Microsoft Edge with `Windows + R`
+2. Start Edge using this shortcut
 
-```powershell
-msedge.exe --remote-debugging-port=1234
-```
+3. Execute `ibrowser`
 
 
 ## How it works
 
-On start up it checks whether `rfbrowser init chromium` has been executed in the current environment.
+On start up `browser-tray` 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 55555`.
 
 Selecting "Open Chromium" in the tray icon executes `site-packages/Browser/wrapper/node_modules/playwright-core/.local-browsers/chromium-XX/chrome-win/chrome.exe --remote-debugging-port=1234 --test-type`.
 
-`ibrowser` is a batteries-included irobot that imports Browser library, connects to Chromium (if it is running) and adds some convenient selectors.
+`ibrowser` is a batteries-included [irobot](https://pypi.org/project/robotframework-debug/) that saves time by importing Browser Library and connecting to a running Chromium or Edge.
 

{robotframework_browser_tray-1.3.0 → robotframework_browser_tray-1.4.0}/README.md

@@ -1,6 +1,7 @@
 # robotframework-browser-tray
 
-A tray icon for starting the Chromium installed by [Browser Library](https://robotframework-browser.org/)
+Tray icon and REPL for trying out [Browser Library](https://robotframework-browser.org/) keywords using Chromium or Edge
+
 
 **Requirements**
 
@@ -12,7 +13,7 @@ A tray icon for starting the Chromium installed by [Browser Library](https://rob
 
 - Execute tests incrementally using e.g. [RobotCode](https://github.com/d-biehl/robotcode)
 
-- Test selectors in an open web page interactively using [irobot](https://pypi.org/project/robotframework-debug/)
+- Test selectors in an open web page interactively
 
 
 ## How to use it
@@ -38,13 +39,22 @@ python -m BrowserTray
 **Hint**: In case your environment does not allow executing ibrowser, call the Python module directly:
 
 ```bash
-python -m BrowserTray.BrowserRepl
+python -m BrowserTray.Repl
 ```
 
 ### ibrowser
 
-ibrowser allows testing selectors in an open web page interactively. In addition to the selectors supported by Browser library,
-it adds the selector `role` for selecting elements using their ARIA role.
+ibrowser allows testing selectors in an open web page interactively. 
+
+To start it execute:
+
+```bash
+ibrowser
+```
+
+On start up it checks whether the Chromium installed by `rfbrowser init chromium` is present. It can also be used with Microsoft Edge. See the section below for instructions. 
+
+In addition to the selectors supported by Browser Library, `ibrowser` adds the selector `role` for selecting elements using their ARIA role.
 
 The role of an element can be easily obtained from the Accessibility Tree. To open the tree follow these steps:
 
@@ -58,7 +68,7 @@ The role of an element can be easily obtained from the Accessibility Tree. To op
 
 ### Usage in a Robot Framework Test Suite
 
-Add these lines to the top of the .robot file:
+Add these lines to the Settings section of the .robot file:
 
 ```robotframework
 Library       Browser               playwright_process_port=55555
@@ -76,25 +86,23 @@ browser-tray --pw-port=XXXX --cdp-port=XXXX
 
 If Microsoft Edge is installed on your machine:
 
-1. Close all instances of Microsoft Edge
+1. Create a Shortcut to msedge.exe with the target:
 
 ```powershell
-taskkill /F /IM msedge.exe
+"C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe" --remote-debugging-port=1234 --user-data-dir=C:\Users\YOUR_USER\RFEdgeProfile
 ```
 
-2. Start Microsoft Edge with `Windows + R`
+2. Start Edge using this shortcut
 
-```powershell
-msedge.exe --remote-debugging-port=1234
-```
+3. Execute `ibrowser`
 
 
 ## How it works
 
-On start up it checks whether `rfbrowser init chromium` has been executed in the current environment.
+On start up `browser-tray` 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 55555`.
 
 Selecting "Open Chromium" in the tray icon executes `site-packages/Browser/wrapper/node_modules/playwright-core/.local-browsers/chromium-XX/chrome-win/chrome.exe --remote-debugging-port=1234 --test-type`.
 
-`ibrowser` is a batteries-included irobot that imports Browser library, connects to Chromium (if it is running) and adds some convenient selectors.
+`ibrowser` is a batteries-included [irobot](https://pypi.org/project/robotframework-debug/) that saves time by importing Browser Library and connecting to a running Chromium or Edge.

{robotframework_browser_tray-1.3.0 → robotframework_browser_tray-1.4.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "robotframework-browser-tray"
-version = "1.3.0"
-description = "Tray icon to start the Chromium installed by Browser Library"
+version = "1.4.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"},
 ]
@@ -21,7 +21,7 @@ name = "BrowserTray"
 
 [project.scripts]
 browser-tray = "BrowserTray.tray:run"
-ibrowser = "BrowserTray.BrowserRepl.repl:run"
+ibrowser = "BrowserTray.Repl.repl:run"
 
 [build-system]
 requires = ["flit_core>=3.2,<4"]

{robotframework_browser_tray-1.3.0/src/BrowserTray/BrowserRepl → robotframework_browser_tray-1.4.0/src/BrowserTray/Repl}/__init__.py

@@ -1,12 +1,13 @@
+import pathlib
+
 from RobotDebug.RobotDebug import RobotDebug
 from robot.libraries.BuiltIn import BuiltIn
-import pathlib
 
 
-class BrowserRepl(RobotDebug):
+class Repl(RobotDebug):
     def __init__(self, jsextension=None, **kwargs):
         super().__init__(**kwargs)
 
         jsextension = str(pathlib.Path(__file__).parent.resolve() / jsextension).replace('\\', '\\\\')
-        self.Library("Browser", "playwright_process_port=55555", f"jsextension={jsextension}") #  
+        self.Library("Browser", "enable_presenter_mode=True", "playwright_process_port=55555", f"jsextension={jsextension}") #  
         BuiltIn().run_keyword("Connect To Browser", "http://localhost:1234", "chromium", "use_cdp=True")

{robotframework_browser_tray-1.3.0/src/BrowserTray/BrowserRepl → robotframework_browser_tray-1.4.0/src/BrowserTray/Repl}/repl.py

@@ -8,7 +8,7 @@ from robot import run_cli
 
 TEST_SUITE = b"""
 *** Settings ***
-Library    BrowserTray.BrowserRepl   jsextension=jsextension.js   repl=${True}
+Library    BrowserTray.Repl   jsextension=jsextension.js   repl=${True}
 
 *** Test Cases ***
 Robot Framework Debug REPL
@@ -55,9 +55,13 @@ def shell():
             if file_path.exists():
                 file_path.unlink()
 
+
 def run():
     try:
         http.client.HTTPConnection('127.0.0.1', 1234, timeout=1).connect()
         shell()
     except TimeoutError:
-        print("ibrowser needs a running Chromium, started using the tray icon")
+        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/"
+        )

{robotframework_browser_tray-1.3.0 → robotframework_browser_tray-1.4.0}/src/BrowserTray/tray.py

@@ -6,6 +6,8 @@ import sys
 from os.path import realpath
 from pathlib import Path
 from subprocess import Popen
+from tkinter import messagebox
+
 from PIL import Image
 from pystray import Icon, Menu, MenuItem
 
@@ -14,6 +16,7 @@ _, 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]:
@@ -24,8 +27,12 @@ def find_chromium(path: Path) -> list[Path]:
     ]
 
 
+def playwright_is_initialized():
+    return node_modules.is_dir() and playwright_core.is_dir()
+
+
 def get_chromium_dir(node_modules: Path):
-    local_browsers = node_modules / "playwright-core" / ".local-browsers"
+    local_browsers = playwright_core / ".local-browsers"
 
     if not (node_modules.is_dir() and local_browsers.is_dir() and find_chromium(local_browsers)):
        return None
@@ -37,16 +44,10 @@ def start_playwright(index_js: Path, playwright_process_port: int) -> Popen:
     return Popen(['node', index_js, str(playwright_process_port)])
 
 
-def start_chromium(chromium_dir: Path, remote_debugging_port: int, incognito: bool) -> Popen:
-    incognito_flag = ["-incognito"] if incognito else []
-    chrome_exe = chromium_dir / "chrome-win" / "chrome.exe"
-    return Popen([chrome_exe, f"--remote-debugging-port={remote_debugging_port}", "--test-type"] + incognito_flag)
-
 
 class TrayIcon:
-    def __init__(self, processes: list[Popen], chromium_dir: Path, remote_debugging_port: int):
+    def __init__(self, processes: list[Popen], remote_debugging_port: int):
         chromium_icon = Image.open(Path(realpath(__file__)).parent / "chromium.png")
-        self.chromium_dir = chromium_dir
         self.processes = processes
         self.remote_debugging_port = remote_debugging_port
         self.icon = Icon(
@@ -76,16 +77,25 @@ class TrayIcon:
         self.icon.stop()
 
     def open_chromium(self):
-        chromium = start_chromium(self.chromium_dir, self.remote_debugging_port, False)
-        self.processes.append(chromium)
+        self.start_chromium(self.remote_debugging_port, False)
 
     def open_chromium_incognito(self):
-        chromium = start_chromium(self.chromium_dir, self.remote_debugging_port, True)
-        self.processes.append(chromium)
+        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:
+            messagebox.showerror("Error", "Chromium is not installed. Execute 'rfbrowser init chromium'.")
+        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)
+            self.processes.append(chromium)
+
 
 def is_running(cmd: str) -> bool:
     process_list = subprocess.check_output(
@@ -125,12 +135,16 @@ def run():
         sys.exit(1)
 
     playwright_process_port, remote_debugging_port = get_ports()
-    chromium_dir = get_chromium_dir(node_modules)
 
-    if not chromium_dir:
-        raise Exception("Playwright has not been initialized. Execute 'rfbrowser init chromium'.")
+    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)
 
     playwright_process = start_playwright(index_js, playwright_process_port)
     processes = [playwright_process]
-    tray_icon = TrayIcon(processes, chromium_dir, remote_debugging_port)
+    tray_icon = TrayIcon(processes, remote_debugging_port)
     tray_icon.run()