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

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

@@ -1,12 +1,13 @@
 Metadata-Version: 2.1
 Name: robotframework-browser-tray
-Version: 1.2.1
+Version: 1.3.0
 Summary: Tray icon to start the Chromium installed by Browser Library
 Author-email: Marduk Bolaños <marduk.bolanos@imbus.de>
 Requires-Python: >=3.8.2
 Description-Content-Type: text/markdown
 Requires-Dist: pystray>=0.19.5
 Requires-Dist: robotframework-browser>=18.0.0
+Requires-Dist: robotframework-debug>=4.5.0
 Project-URL: homepage, https://github.com/mardukbp/robotframework-browser-tray
 
 # robotframework-browser-tray
@@ -42,23 +43,34 @@ pip install robotframework-browser-tray
 python -m BrowserTray
 ```
 
-3a. Click on the tray icon with the Chromium logo and select `Open Chromium`
+3. Click on the tray icon with the Chromium logo
 
-3b. If Microsoft Edge is installed on your machine:
+4. Open a Terminal and execute `ibrowser`
 
-    1. Close all instances of Microsoft Edge
+**Hint**: In case your environment does not allow executing ibrowser, call the Python module directly:
 
-    ```
-    taskkill /F /IM msedge.exe
-    ```
+```bash
+python -m BrowserTray.BrowserRepl
+```
+
+### 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.
+
+The role of an element can be easily obtained from the Accessibility Tree. To open the tree follow these steps:
 
-    2. Start Microsoft Edge with `Windows + R`
+1. Press F12 to open the DevTools
+2. Select the Elements tab
+3. In the right panel click on the Accessibility tab
+4. In the section "Accessibility Tree" check "Enable full-page accessibility tree"
+5. Click the button "Reload DevTools"
+6. In the left panel click on the person icon to toggle the Accessibility Tree view
 
-    ```powershell
-    msedge.exe --remote-debugging-port=1234
-    ```
 
-4. Add these lines to the top of the .robot file with your tests:
+### Usage in a Robot Framework Test Suite
+
+Add these lines to the top of the .robot file:
 
 ```robotframework
 Library       Browser               playwright_process_port=55555
@@ -71,6 +83,24 @@ In order to use other ports execute:
 browser-tray --pw-port=XXXX --cdp-port=XXXX
 ``` 
 
+
+### Using Microsoft Edge
+
+If Microsoft Edge is installed on your machine:
+
+1. Close all instances of Microsoft Edge
+
+```powershell
+taskkill /F /IM msedge.exe
+```
+
+2. Start Microsoft Edge with `Windows + R`
+
+```powershell
+msedge.exe --remote-debugging-port=1234
+```
+
+
 ## How it works
 
 On start up it checks whether `rfbrowser init chromium` has been executed in the current environment.
@@ -79,3 +109,5 @@ If this requirement is met the Playwright wrapper is started with `node site-pac
 
 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.
+

robotframework_browser_tray-1.3.0/README.md

@@ -0,0 +1,100 @@
+# robotframework-browser-tray
+
+A tray icon for starting the Chromium installed by [Browser Library](https://robotframework-browser.org/)
+
+**Requirements**
+
+- NodeJS >= 18
+- Windows
+
+
+## Use Cases
+
+- 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/)
+
+
+## How to use it
+
+1. Install the package
+
+```bash
+pip install robotframework-browser-tray
+```
+
+2. Execute `browser-tray`
+
+**Hint**: In case your environment does not allow executing browser-tray, call the Python module directly:
+
+```bash
+python -m BrowserTray
+```
+
+3. Click on the tray icon with the Chromium logo
+
+4. Open a Terminal and execute `ibrowser`
+
+**Hint**: In case your environment does not allow executing ibrowser, call the Python module directly:
+
+```bash
+python -m BrowserTray.BrowserRepl
+```
+
+### 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.
+
+The role of an element can be easily obtained from the Accessibility Tree. To open the tree follow these steps:
+
+1. Press F12 to open the DevTools
+2. Select the Elements tab
+3. In the right panel click on the Accessibility tab
+4. In the section "Accessibility Tree" check "Enable full-page accessibility tree"
+5. Click the button "Reload DevTools"
+6. In the left panel click on the person icon to toggle the Accessibility Tree view
+
+
+### Usage in a Robot Framework Test Suite
+
+Add these lines to the top of the .robot file:
+
+```robotframework
+Library       Browser               playwright_process_port=55555
+Test Setup    Connect To Browser    http://localhost:1234            chromium    use_cdp=True
+```
+
+In order to use other ports execute:
+
+```bash
+browser-tray --pw-port=XXXX --cdp-port=XXXX
+``` 
+
+
+### Using Microsoft Edge
+
+If Microsoft Edge is installed on your machine:
+
+1. Close all instances of Microsoft Edge
+
+```powershell
+taskkill /F /IM msedge.exe
+```
+
+2. Start Microsoft Edge with `Windows + R`
+
+```powershell
+msedge.exe --remote-debugging-port=1234
+```
+
+
+## How it works
+
+On start up it checks whether `rfbrowser init chromium` has been executed in the current environment.
+
+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.

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

@@ -1,6 +1,6 @@
 [project]
 name = "robotframework-browser-tray"
-version = "1.2.1"
+version = "1.3.0"
 description = "Tray icon to start the Chromium installed by Browser Library"
 authors = [
     {name = "Marduk Bolaños", email = "marduk.bolanos@imbus.de"},
@@ -10,6 +10,7 @@ urls = { homepage = "https://github.com/mardukbp/robotframework-browser-tray" }
 dependencies = [
     "pystray>=0.19.5",
     "robotframework-browser>=18.0.0",
+    "robotframework-debug>=4.5.0",
 ]
 requires-python = ">=3.8.2"
 readme = "README.md"
@@ -20,6 +21,7 @@ name = "BrowserTray"
 
 [project.scripts]
 browser-tray = "BrowserTray.tray:run"
+ibrowser = "BrowserTray.BrowserRepl.repl:run"
 
 [build-system]
 requires = ["flit_core>=3.2,<4"]

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

@@ -0,0 +1,12 @@
+from RobotDebug.RobotDebug import RobotDebug
+from robot.libraries.BuiltIn import BuiltIn
+import pathlib
+
+
+class BrowserRepl(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}") #  
+        BuiltIn().run_keyword("Connect To Browser", "http://localhost:1234", "chromium", "use_cdp=True")

robotframework_browser_tray-1.3.0/src/BrowserTray/BrowserRepl/__main__.py

@@ -0,0 +1,3 @@
+from .repl import run
+
+run()

robotframework_browser_tray-1.3.0/src/BrowserTray/BrowserRepl/jsextension.js

@@ -0,0 +1,18 @@
+async function registerMySelector(playwright) {
+    playwright.selectors.register("role", () => ({
+        // Returns the first element matching given selector in the root's subtree.
+        query(root, selector) {
+            return root.querySelector([role="${selector}"]);
+        },
+
+        // Returns all elements matching given selector in the root's subtree.
+        queryAll(root, selector) {
+            return Array.from(root.querySelectorAll([role="${selector}"]));
+        }
+    }));
+
+    return 1;
+}
+
+exports.__esModule = true;
+exports.registerMySelector = registerMySelector;

robotframework_browser_tray-1.3.0/src/BrowserTray/BrowserRepl/repl.py

@@ -0,0 +1,63 @@
+import http
+import sys
+import tempfile
+from pathlib import Path
+
+from robot import run_cli
+
+
+TEST_SUITE = b"""
+*** Settings ***
+Library    BrowserTray.BrowserRepl   jsextension=jsextension.js   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():
+    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")

robotframework_browser_tray-1.2.1/README.md

@@ -1,69 +0,0 @@
-# robotframework-browser-tray
-
-A tray icon for starting the Chromium installed by [Browser Library](https://robotframework-browser.org/)
-
-**Requirements**
-
-- NodeJS >= 18
-- Windows
-
-
-## Use Cases
-
-- 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/)
-
-
-## How to use it
-
-1. Install the package
-
-```bash
-pip install robotframework-browser-tray
-```
-
-2. Execute `browser-tray`
-
-**Hint**: In case your environment does not allow executing browser-tray, call the Python module directly:
-
-```bash
-python -m BrowserTray
-```
-
-3a. Click on the tray icon with the Chromium logo and select `Open Chromium`
-
-3b. If Microsoft Edge is installed on your machine:
-
-    1. Close all instances of Microsoft Edge
-
-    ```
-    taskkill /F /IM msedge.exe
-    ```
-
-    2. Start Microsoft Edge with `Windows + R`
-
-    ```powershell
-    msedge.exe --remote-debugging-port=1234
-    ```
-
-4. Add these lines to the top of the .robot file with your tests:
-
-```robotframework
-Library       Browser               playwright_process_port=55555
-Test Setup    Connect To Browser    http://localhost:1234            chromium    use_cdp=True
-```
-
-In order to use other ports execute:
-
-```bash
-browser-tray --pw-port=XXXX --cdp-port=XXXX
-``` 
-
-## How it works
-
-On start up it checks whether `rfbrowser init chromium` has been executed in the current environment.
-
-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`.