robotframework-plugins 2026.11.0.dev1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- robotframework_plugins/__init__.py +14 -0
- robotframework_plugins/_assets/catalog.json +143 -0
- robotframework_plugins/_assets/plugins/rf-agentskills/.claude-plugin/plugin.json +25 -0
- robotframework_plugins/_assets/plugins/rf-agentskills/CHANGELOG.md +198 -0
- robotframework_plugins/_assets/plugins/rf-agentskills/README.md +27 -0
- robotframework_plugins/_assets/plugins/rf-agentskills/catalog.yaml +25 -0
- robotframework_plugins/_assets/plugins/rf-api/.claude-plugin/plugin.json +25 -0
- robotframework_plugins/_assets/plugins/rf-api/CHANGELOG.md +9 -0
- robotframework_plugins/_assets/plugins/rf-api/README.md +27 -0
- robotframework_plugins/_assets/plugins/rf-api/catalog.yaml +27 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/SKILL.md +110 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/assets/examples/authentication-patterns.robot +39 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/assets/examples/basic-crud.robot +46 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/assets/examples/file-upload.robot +28 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/assets/examples/session-handling.robot +48 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/references/authentication.md +58 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/references/install.md +10 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/references/request-options.md +90 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/references/response-validation.md +64 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/references/troubleshooting.md +64 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/SKILL.md +119 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/assets/examples/basic-rest.robot +51 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/assets/examples/schema-validation.robot +38 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/assets/examples/schemas/user.json +10 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/authentication.md +61 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/install.md +11 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/json-handling.md +89 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/migrate-from-requests.md +15 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/schema-validation.md +85 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/troubleshooting.md +68 -0
- robotframework_plugins/_assets/plugins/rf-core/.claude-plugin/plugin.json +19 -0
- robotframework_plugins/_assets/plugins/rf-core/CHANGELOG.md +11 -0
- robotframework_plugins/_assets/plugins/rf-core/README.md +38 -0
- robotframework_plugins/_assets/plugins/rf-core/agents/rf-debug-expert.md +104 -0
- robotframework_plugins/_assets/plugins/rf-core/agents/rf-migration-guide.md +73 -0
- robotframework_plugins/_assets/plugins/rf-core/agents/rf-test-architect.md +98 -0
- robotframework_plugins/_assets/plugins/rf-core/catalog.yaml +19 -0
- robotframework_plugins/_assets/plugins/rf-core/hooks/README.md +435 -0
- robotframework_plugins/_assets/plugins/rf-core/hooks/hooks.json +70 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/_hook_input.mjs +101 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/_pending_errors.mjs +65 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/_python_env.mjs +181 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/check_rf_environment.mjs +181 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/maybe_inject_rf_context.mjs +74 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/maybe_remind_robot_tests.mjs +108 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/report_pending_errors.mjs +72 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/rf_error_hints.mjs +126 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/validate_robot.mjs +509 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/validate_robot_project.mjs +103 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/SKILL.md +313 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/resources/api.resource +30 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/resources/calc.resource +23 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/resources/embedded.resource +20 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/resources/keywords.resource +26 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/resources/login.resource +10 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/01__keyword_driven.robot +15 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/02__data_driven.robot +10 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/03__templates.robot +17 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/04__bdd.robot +10 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/05__embedded.robot +13 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/__init__.robot +6 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/api/__init__.robot +7 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/api/users.robot +18 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/env.robot +15 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/variables/common.py +11 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/variables/dev.yaml +3 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/variables/staging.yaml +3 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/arguments.md +139 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/control-structures.md +175 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/embedded-arguments.md +135 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/migration.md +90 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/resources-and-variable-files.md +127 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/styles.md +92 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/suites-and-init.md +96 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/tags-and-selection.md +104 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/templates.md +124 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/variables-and-scopes.md +129 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/scripts/rf_conventions.py +883 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/SKILL.md +216 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/ExampleLibrary.py +61 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/ResultListener.py +60 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/converters.py +48 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/converters.robot +20 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/example_library.robot +31 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/listener.robot +12 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/references/api-variants.md +291 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/references/communication.md +248 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/references/conversion.md +347 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/references/listeners.md +150 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/references/packaging-and-docs.md +155 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/scripts/check_library.py +842 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/SKILL.md +159 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/github-actions-robot.yml +32 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/gitignore.txt +22 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/pyproject.poetry.toml +28 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/pyproject.uv.toml +20 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/requirements.txt +9 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/robot.toml +16 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/smoke.robot +22 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/ci.md +61 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/cli-tools.md +33 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/libraries.md +47 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/poetry.md +77 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/project-layout.md +86 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/troubleshooting.md +73 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/uv.md +108 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/venv-pip.md +71 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/codex/agents/rf-debug-expert.toml +103 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/codex/agents/rf-migration-guide.toml +72 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/codex/agents/rf-test-architect.toml +97 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/opencode/agents/rf-debug-expert.md +107 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/opencode/agents/rf-migration-guide.md +76 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/opencode/agents/rf-test-architect.md +101 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/opencode/plugins/rf-core.js +93 -0
- robotframework_plugins/_assets/plugins/rf-desktop/.claude-plugin/plugin.json +24 -0
- robotframework_plugins/_assets/plugins/rf-desktop/CHANGELOG.md +9 -0
- robotframework_plugins/_assets/plugins/rf-desktop/README.md +26 -0
- robotframework_plugins/_assets/plugins/rf-desktop/catalog.yaml +23 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/SKILL.md +266 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/assets/examples/calculator.robot +45 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/assets/examples/mock-deterministic.robot +33 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/cli-and-inspector.md +82 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/install.md +14 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/keywords-reference.md +102 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/locators-and-queries.md +95 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/platform-setup.md +65 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/status-and-migration.md +41 -0
- robotframework_plugins/_assets/plugins/rf-mobile/.claude-plugin/plugin.json +24 -0
- robotframework_plugins/_assets/plugins/rf-mobile/CHANGELOG.md +9 -0
- robotframework_plugins/_assets/plugins/rf-mobile/README.md +26 -0
- robotframework_plugins/_assets/plugins/rf-mobile/catalog.yaml +23 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/SKILL.md +134 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/assets/examples/android-basic.robot +60 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/assets/examples/gestures-example.robot +59 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/assets/examples/hybrid-app.robot +54 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/assets/examples/ios-basic.robot +48 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/capabilities.md +117 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/gestures-touch.md +84 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/install.md +21 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/locators-mobile.md +74 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/platform-specific.md +105 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/troubleshooting.md +70 -0
- robotframework_plugins/_assets/plugins/rf-web/.claude-plugin/plugin.json +25 -0
- robotframework_plugins/_assets/plugins/rf-web/CHANGELOG.md +9 -0
- robotframework_plugins/_assets/plugins/rf-web/README.md +27 -0
- robotframework_plugins/_assets/plugins/rf-web/catalog.yaml +27 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/SKILL.md +132 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/assets/examples/authentication-flow.robot +34 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/assets/examples/basic-web-test.robot +29 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/assets/examples/form-handling.robot +49 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/assets/examples/iframe-shadow-dom.robot +31 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/assertion-engine.md +79 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/authentication-storage.md +86 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/browser-context-page.md +110 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/downloads-uploads.md +51 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/iframes-shadow-dom.md +67 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/install.md +67 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/locators.md +83 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/migrate-from-selenium.md +22 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/troubleshooting.md +100 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/SKILL.md +123 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/assets/examples/basic-web-test.robot +64 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/assets/examples/multi-window.robot +55 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/assets/examples/wait-patterns.robot +53 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/browser-setup.md +103 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/frames-windows.md +84 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/install.md +12 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/javascript-execution.md +65 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/locators.md +86 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/troubleshooting.md +122 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/waiting-strategies.md +84 -0
- robotframework_plugins/_assets.py +120 -0
- robotframework_plugins/_catalog.py +123 -0
- robotframework_plugins/_snapshot.py +230 -0
- robotframework_plugins/adapters/__init__.py +53 -0
- robotframework_plugins/adapters/_base.py +400 -0
- robotframework_plugins/adapters/claude_code.py +312 -0
- robotframework_plugins/adapters/claude_desktop.py +129 -0
- robotframework_plugins/adapters/codex.py +276 -0
- robotframework_plugins/adapters/copilot.py +87 -0
- robotframework_plugins/adapters/cursor.py +295 -0
- robotframework_plugins/adapters/goose.py +240 -0
- robotframework_plugins/adapters/opencode.py +170 -0
- robotframework_plugins/bundle.py +85 -0
- robotframework_plugins/cli.py +1311 -0
- robotframework_plugins/detect.py +121 -0
- robotframework_plugins/manifest.py +338 -0
- robotframework_plugins/py.typed +0 -0
- robotframework_plugins/skillzip.py +39 -0
- robotframework_plugins/transforms.py +725 -0
- robotframework_plugins-2026.11.0.dev1.dist-info/METADATA +178 -0
- robotframework_plugins-2026.11.0.dev1.dist-info/RECORD +195 -0
- robotframework_plugins-2026.11.0.dev1.dist-info/WHEEL +4 -0
- robotframework_plugins-2026.11.0.dev1.dist-info/entry_points.txt +2 -0
- robotframework_plugins-2026.11.0.dev1.dist-info/licenses/LICENSE +201 -0
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
*** Settings ***
|
|
2
|
+
# Live desktop example — drives the OS Calculator with PlatynUI.BareMetal.
|
|
3
|
+
#
|
|
4
|
+
# REQUIRES A REAL DESKTOP:
|
|
5
|
+
# - robotframework-PlatynUI new_core: uv add --prerelease allow robotframework-PlatynUI
|
|
6
|
+
# - Windows, or Linux with a running AT-SPI2 bus on an X11 (or XWayland) session
|
|
7
|
+
# (see references/platform-setup.md). Wayland is degraded for pointer/coords.
|
|
8
|
+
#
|
|
9
|
+
# Pattern shown: launch via Process, Set Root on the app window, locate digit
|
|
10
|
+
# buttons by stable @Id with relative queries, then assert the result.
|
|
11
|
+
Library PlatynUI.BareMetal
|
|
12
|
+
Library Process
|
|
13
|
+
Library Collections
|
|
14
|
+
|
|
15
|
+
Suite Setup Launch Calculator
|
|
16
|
+
Suite Teardown Terminate All Processes
|
|
17
|
+
|
|
18
|
+
*** Variables ***
|
|
19
|
+
# ApplicationFrameHost hosts the UWP Calculator on Windows; localized window
|
|
20
|
+
# names handled with `or`. Adjust the anchor for your platform/app.
|
|
21
|
+
${CALC_WINDOW} app:Application[@Name="ApplicationFrameHost"]/control:Window[@Name="Calculator" or @Name="Rechner"]
|
|
22
|
+
|
|
23
|
+
*** Test Cases ***
|
|
24
|
+
Add Two Numbers
|
|
25
|
+
[Documentation] Click 2, +, 3, = and verify the display shows 5.
|
|
26
|
+
Scope To Calculator
|
|
27
|
+
Press Digit 2
|
|
28
|
+
Pointer Click .//control:Button[@Name="Plus" or @Name="Add"]
|
|
29
|
+
Press Digit 3
|
|
30
|
+
Pointer Click .//control:Button[@Name="Equals" or @Name="Gleich"]
|
|
31
|
+
# The results text exposes its value via the Name/Value attribute:
|
|
32
|
+
Get Attribute .//control:Text[@Id="CalculatorResults"] Name contains 5
|
|
33
|
+
|
|
34
|
+
*** Keywords ***
|
|
35
|
+
Launch Calculator
|
|
36
|
+
Start Process calc.exe
|
|
37
|
+
# No Sleep needed: the first query below retries (~30s) until the window appears.
|
|
38
|
+
|
|
39
|
+
Scope To Calculator
|
|
40
|
+
Set Root ${CALC_WINDOW}
|
|
41
|
+
|
|
42
|
+
Press Digit
|
|
43
|
+
[Arguments] ${digit}
|
|
44
|
+
# @Id is language-independent and stable — prefer it over @Name.
|
|
45
|
+
Pointer Click .//control:Button[@Id="num${digit}Button"]
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
*** Settings ***
|
|
2
|
+
# TEACHING EXAMPLE ONLY — does NOT run against the published pip wheel.
|
|
3
|
+
#
|
|
4
|
+
# `use_mock=${True}` exercises the Rust mock provider (a simulated desktop, no
|
|
5
|
+
# display, fully deterministic). It is the ideal shape for reproducible tests,
|
|
6
|
+
# BUT the published `robotframework-PlatynUI` / `platynui-native` wheels are
|
|
7
|
+
# built WITHOUT the mock feature and raise:
|
|
8
|
+
# ProviderError: Runtime.new_with_mock() requires building with feature 'mock-provider'
|
|
9
|
+
#
|
|
10
|
+
# To actually run this you need a source build of the native package:
|
|
11
|
+
# uv run maturin develop -m packages/native/Cargo.toml --features mock-provider
|
|
12
|
+
#
|
|
13
|
+
# This file shows the query/keyword shape against the mock tree
|
|
14
|
+
# (Mock Application -> "Operations Console" window -> List / Tree / Text /
|
|
15
|
+
# Button "OK" / Button "Cancel"). For an automated, display-free CI check of
|
|
16
|
+
# this skill, rely on the libdoc keyword-fidelity test instead (the runtime is
|
|
17
|
+
# lazy, so libdoc needs no desktop).
|
|
18
|
+
Library PlatynUI.BareMetal use_mock=${True}
|
|
19
|
+
|
|
20
|
+
*** Test Cases ***
|
|
21
|
+
Inspect The Mock Desktop
|
|
22
|
+
[Documentation] Query the deterministic mock tree and assert structure.
|
|
23
|
+
${windows}= Query //control:Window
|
|
24
|
+
Should Not Be Empty ${windows}
|
|
25
|
+
|
|
26
|
+
# Scope to the mock window, then read an attribute and act on a button.
|
|
27
|
+
Set Root //control:Window[@Name="Operations Console"]
|
|
28
|
+
${title}= Get Attribute . Name
|
|
29
|
+
Should Be Equal ${title} Operations Console
|
|
30
|
+
|
|
31
|
+
Get Attribute .//control:Button[@Name="OK"] Name == OK
|
|
32
|
+
Highlight .//control:Button[@Name="OK"] duration=${1}
|
|
33
|
+
Pointer Click .//control:Button[@Name="OK"]
|
robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/cli-and-inspector.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# PlatynUI CLI & Inspector
|
|
2
|
+
|
|
3
|
+
Two diagnostic tools drive the **locator-development loop**: develop and verify an XPath selector *before* baking it into a test. They are separate packages from the RF library.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
uv tool install --prerelease allow platynui-cli
|
|
7
|
+
uv tool install --prerelease allow platynui-inspector
|
|
8
|
+
# pip alternative (inside the project venv): pip install --pre platynui-cli platynui-inspector
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Prebuilt wheels (no Rust). They talk to the **live desktop** — Linux needs AT-SPI2 running (see `platform-setup.md`).
|
|
12
|
+
|
|
13
|
+
## platynui-cli
|
|
14
|
+
|
|
15
|
+
Global: `--log-level error|warn|info|debug|trace` (logs → stderr; output → stdout, pipe-safe). Override with `RUST_LOG`.
|
|
16
|
+
|
|
17
|
+
### Inspect / develop locators (the core loop)
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
platynui-cli list-providers # confirm a provider is active (atspi/uia)
|
|
21
|
+
platynui-cli list-providers --format json
|
|
22
|
+
platynui-cli info # desktop/platform metadata, monitors
|
|
23
|
+
|
|
24
|
+
# Test a selector against the live tree — the main "does my XPath match?" command:
|
|
25
|
+
platynui-cli query "//control:Window"
|
|
26
|
+
platynui-cli query "//control:Button[@Name='OK']"
|
|
27
|
+
platynui-cli query "//control:Button[@Name='OK']/@Bounds" # an attribute
|
|
28
|
+
platynui-cli query "count(//control:Button)" --format json # a value
|
|
29
|
+
|
|
30
|
+
# Dump a subtree to read structure / discover roles & attributes:
|
|
31
|
+
platynui-cli snapshot "//control:Window" --pretty
|
|
32
|
+
platynui-cli snapshot "//control:Window" --format xml --output windows.xml
|
|
33
|
+
platynui-cli snapshot "//control:Window" --max-depth 3 --attrs default
|
|
34
|
+
platynui-cli snapshot "//control:Window" --include "control:Bounds*" "app:*" --no-color
|
|
35
|
+
|
|
36
|
+
# Visually confirm a selector on screen:
|
|
37
|
+
platynui-cli highlight "//control:Button[@Name='OK']" --duration-ms 1200
|
|
38
|
+
platynui-cli highlight --rect "100,100,400,300"
|
|
39
|
+
platynui-cli highlight --clear
|
|
40
|
+
|
|
41
|
+
# Watch live tree events (dynamic UIs), optionally re-running an XPath:
|
|
42
|
+
platynui-cli watch --expression "//control:Window" --limit 5
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Act (mirror the RF keywords)
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
platynui-cli focus "//control:Button[@Name='New File']"
|
|
49
|
+
platynui-cli screenshot screen.png
|
|
50
|
+
platynui-cli screenshot --rect "0,0,800,600"
|
|
51
|
+
|
|
52
|
+
platynui-cli window --list
|
|
53
|
+
platynui-cli window "//control:Window[@Name='Calculator']" --bring-to-front --wait-ms 500
|
|
54
|
+
platynui-cli window "…" --minimize | --maximize | --restore | --close | --move X Y | --resize W H
|
|
55
|
+
|
|
56
|
+
platynui-cli pointer move "//control:Button[@Name='OK']"
|
|
57
|
+
platynui-cli pointer move --point "10,20"
|
|
58
|
+
platynui-cli pointer click "//control:Button[@Name='OK']" --button left
|
|
59
|
+
platynui-cli pointer multi-click --point "100,200" --count 2
|
|
60
|
+
platynui-cli pointer scroll "0,-3" --expr "//control:List"
|
|
61
|
+
platynui-cli pointer drag --from-expr "//item:ListItem[1]" --to-expr "//item:ListItem[5]"
|
|
62
|
+
platynui-cli pointer position
|
|
63
|
+
|
|
64
|
+
platynui-cli keyboard list # discover valid key names
|
|
65
|
+
platynui-cli keyboard type "Hello <Ctrl+A>" --delay-ms 50
|
|
66
|
+
platynui-cli keyboard press "<Ctrl+S>"
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
> The **published CLI wheel has no `--mock`** — it always talks to the live desktop. Mock requires a source build with `--features mock-provider`.
|
|
70
|
+
|
|
71
|
+
## platynui-inspector
|
|
72
|
+
|
|
73
|
+
An egui GUI to explore and debug the live UI tree interactively:
|
|
74
|
+
|
|
75
|
+
- **Left:** hierarchical UI tree (lazy expand, role icons, invalid nodes struck through).
|
|
76
|
+
- **Right:** sortable Properties table (`namespace:name`, value, type) with copy-via-context-menu.
|
|
77
|
+
- **Search bar:** streaming, cancellable XPath evaluation; click a result to reveal it in the tree.
|
|
78
|
+
- Selected elements are **highlighted on screen** (~1.5 s). "Always On Top" toggle.
|
|
79
|
+
|
|
80
|
+
Use it to eyeball the real tree, find the right Role/`@Id`/`@Name`, and test XPath visually; then translate to a keyword call. The CLI `query`/`snapshot`/`highlight` commands are the scriptable equivalent.
|
|
81
|
+
|
|
82
|
+
Run: `platynui-inspector` (needs a display; AT-SPI on Linux). Under WSL2/WSLg, if it crashes with a broken-pipe/winit error, run with `WINIT_UNIX_BACKEND=x11 WAYLAND_DISPLAY= platynui-inspector`.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Installing PlatynUI (preview)
|
|
2
|
+
|
|
3
|
+
Commands are in uv form. For a new environment, Poetry and venv + pip forms, and the general troubleshooting (wrong interpreter, PEP 668, old Python), see `rf-setup` (plugin `rf-core`): `uv add <pkg>` is `poetry add <pkg>` (pip alternative: `.venv/bin/python -m pip install <pkg>`), and `uv run <cmd>` is `poetry run <cmd>` or `.venv/bin/<cmd>`. Versions and floors checked on PyPI 2026-09-26.
|
|
4
|
+
|
|
5
|
+
Package `robotframework-PlatynUI`. The documented `PlatynUI.BareMetal` library exists only as a **pre-release** (Python ≥ 3.12). A plain install resolves the old 0.9.2, which is a different library.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
uv add robotframework-PlatynUI==0.12.0.dev330 # verified pin # pip: pip install robotframework-PlatynUI==0.12.0.dev330
|
|
9
|
+
uv add --prerelease allow robotframework-PlatynUI # latest pre-release # pip: pip install --pre robotframework-PlatynUI
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
- The wheel is prebuilt: it bundles the compiled `platynui-native` runtime. No Rust toolchain or git checkout is needed.
|
|
13
|
+
- Linux also needs a running AT-SPI2 accessibility bus and, recommended, an X11 session: see `platform-setup.md`.
|
|
14
|
+
- The optional CLI and inspector are standalone tools: `uv tool install --prerelease allow platynui-cli` and `uv tool install --prerelease allow platynui-inspector` (see `cli-and-inspector.md`).
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# PlatynUI.BareMetal — Keyword Reference
|
|
2
|
+
|
|
3
|
+
Complete keyword surface of `Library PlatynUI.BareMetal` (verified against `robotframework-PlatynUI==0.12.0.dev330`, library version `0.12.0-dev.330`, scope `SUITE`, doc format `ROBOT`). **24 keywords, all documented.**
|
|
4
|
+
|
|
5
|
+
> The high-level `PlatynUI` library is a placeholder (`Dummy Keyword` only). Use `BareMetal`.
|
|
6
|
+
|
|
7
|
+
## Import
|
|
8
|
+
|
|
9
|
+
```robotframework
|
|
10
|
+
Library PlatynUI.BareMetal
|
|
11
|
+
... keyboard_profile=${None} # KeyboardProfileLike | dict | None
|
|
12
|
+
... pointer_settings=${None} # PointerSettingsLike | dict | None
|
|
13
|
+
... pointer_profile=${None} # PointerProfileLike | dict | None
|
|
14
|
+
... use_mock=${False} # mock provider (needs --features mock-provider build)
|
|
15
|
+
... auto_activate=${True} # foreground target window before pointer/keyboard
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
All import args are keyword-only and optional.
|
|
19
|
+
|
|
20
|
+
## Element references
|
|
21
|
+
|
|
22
|
+
Most keywords take a `descriptor: UiNodeDescriptor` — pass either:
|
|
23
|
+
- a **PlatynUI XPath string** (e.g. `//control:Button[@Name="OK"]`) — auto-converted, lazily resolved with retry (~30 s) until the node appears or `ElementNotFoundError` is raised, or
|
|
24
|
+
- a **`UiNode`** captured from `Query ... only_first=${True}`.
|
|
25
|
+
|
|
26
|
+
Where the signature shows `descriptor: ... | None`, passing `${None}` means "no element" (act on raw coordinates, or type into whatever currently has focus).
|
|
27
|
+
|
|
28
|
+
## Query & scope
|
|
29
|
+
|
|
30
|
+
| Keyword | Arguments | Returns | Notes |
|
|
31
|
+
|---------|-----------|---------|-------|
|
|
32
|
+
| `Query` | `expression: str`, `root: UiNode \| None = None`, `only_first: bool = False` | node / list / value | Evaluate an XPath expression. `only_first=${True}` → first `UiNode` or `${None}`. Value expressions (`count(...)`) return the computed value. Read-only. |
|
|
33
|
+
| `Set Root` | `descriptor: UiNodeDescriptor \| None` | previous root | Scope subsequent queries to a subtree. `${None}` resets to the desktop. |
|
|
34
|
+
|
|
35
|
+
## Pointer / mouse
|
|
36
|
+
|
|
37
|
+
Shared optional args (keyword-only `*`): `button: PointerButtonLike = LEFT` (`LEFT`/`MIDDLE`/`RIGHT` or `1`/`2`/`3`), `x`/`y: float | None`, `overrides: PointerOverridesLike | None`, `activate: bool | None` (defaults to library `auto_activate`). See coordinate rules in SKILL.md.
|
|
38
|
+
|
|
39
|
+
| Keyword | Arguments | Short doc |
|
|
40
|
+
|---------|-----------|-----------|
|
|
41
|
+
| `Pointer Click` | `descriptor=None`, `*`, `button=LEFT`, `x=None`, `y=None`, `overrides=None`, `activate=None` | Click at absolute or element-relative screen coordinates. |
|
|
42
|
+
| `Pointer Multi Click` | …above… `+ clicks: int = 2` | Multiple clicks (double=`${2}`, triple=`${3}`). |
|
|
43
|
+
| `Pointer Press` | same as Pointer Click | Press (and hold) a mouse button. |
|
|
44
|
+
| `Pointer Release` | same as Pointer Click | Release a mouse button at current or specified coordinates. |
|
|
45
|
+
| `Pointer Move To` | `descriptor=None`, `*`, `x=None`, `y=None`, `overrides=None`, `activate=None` | Move the pointer (no `button`). |
|
|
46
|
+
| `Get Pointer Position` | `assertion_operator=None`, `assertion_expected=None`, `assertion_message=None` | Current pointer position (assertable). |
|
|
47
|
+
|
|
48
|
+
## Keyboard
|
|
49
|
+
|
|
50
|
+
| Keyword | Arguments | Short doc |
|
|
51
|
+
|---------|-----------|-----------|
|
|
52
|
+
| `Keyboard Type` | `descriptor: UiNodeDescriptor \| None`, `text: str`, `*`, `overrides: KeyboardOverridesLike \| None = None` | Type a sequence of characters and/or keys (full press→release). |
|
|
53
|
+
| `Keyboard Press` | `descriptor \| None`, `text: str`, `*`, `overrides=None` | Press (and hold) keys. |
|
|
54
|
+
| `Keyboard Release` | `descriptor \| None`, `text: str`, `*`, `overrides=None` | Release keys. |
|
|
55
|
+
|
|
56
|
+
`descriptor` is positional but may be `${None}` (skip focusing). Key syntax: `<Ctrl+A>`, `<Return>`, `<ESC>`, `<Shift+Tab>`, plain text, `${\n}`. List valid key names: `platynui-cli keyboard list`.
|
|
57
|
+
|
|
58
|
+
## Focus & attributes
|
|
59
|
+
|
|
60
|
+
| Keyword | Arguments | Short doc |
|
|
61
|
+
|---------|-----------|-----------|
|
|
62
|
+
| `Focus` | `descriptor: UiNodeDescriptor` | Set input focus to the element (brings to front + focuses). |
|
|
63
|
+
| `Bring To Front` | `descriptor: UiNodeDescriptor` | Bring the node to the front (no focus). |
|
|
64
|
+
| `Get Attribute` | `descriptor`, `attribute_name: str`, `assertion_operator=None`, `assertion_expected=None`, `assertion_message=None` | Read an attribute (assertable). `ns:Name` selects a namespace. |
|
|
65
|
+
|
|
66
|
+
`Get Attribute` is **assertable** — `Get Attribute //control:Button[@Name="OK"] Name == OK`. Typed/structured attributes expose component aliases (`Bounds.X`, `Bounds.Width`, `ActivationPoint.Y`).
|
|
67
|
+
|
|
68
|
+
## Window surface
|
|
69
|
+
|
|
70
|
+
All take `descriptor: UiNodeDescriptor` and require a window node (else `PatternError`).
|
|
71
|
+
|
|
72
|
+
| Keyword | Extra args | Short doc |
|
|
73
|
+
|---------|-----------|-----------|
|
|
74
|
+
| `Activate Window` | — | Activate (bring to front and focus) a window. |
|
|
75
|
+
| `Bring To Front` | — | (listed above — front without focus) |
|
|
76
|
+
| `Minimize Window` | — | Minimize a window. |
|
|
77
|
+
| `Maximize Window` | — | Maximize a window. |
|
|
78
|
+
| `Restore Window` | — | Restore from minimized/maximized. |
|
|
79
|
+
| `Close Window` | — | Close a window. |
|
|
80
|
+
| `Move Window` | `x: float`, `y: float` | Move top-left to screen coordinates. |
|
|
81
|
+
| `Resize Window` | `width: float`, `height: float` | Resize. |
|
|
82
|
+
| `Move And Resize Window` | `x`, `y`, `width`, `height` (float) | Move + resize in one operation. |
|
|
83
|
+
|
|
84
|
+
## Diagnostics
|
|
85
|
+
|
|
86
|
+
| Keyword | Arguments | Short doc |
|
|
87
|
+
|---------|-----------|-----------|
|
|
88
|
+
| `Take Screenshot` | `descriptor=None`, `filename='platynui-screenshot-{index}.png'`, `rect: RectLike \| None = None` | Full screen, an element (its bounds), or a rect. `filename=EMBED` embeds base64 PNG in the log; files go to `${OUTPUT DIR}`; `{index}` auto-increments. |
|
|
89
|
+
| `Highlight` | `descriptor: ... \| list \| None = None`, `*`, `rect: RectLike \| list \| None = None`, `duration: float = 1.0` | Draw an overlay around one/many elements or rect(s) for `duration` seconds. Needs at least one of descriptor/rect. |
|
|
90
|
+
|
|
91
|
+
## Not present (know the gaps)
|
|
92
|
+
|
|
93
|
+
- **No application launch/attach keyword** — launch with `Library Process` (`Start Process calc.exe`) and locate via `app:Application[...]`.
|
|
94
|
+
- **No explicit wait/retry keyword** — resolution waits automatically (~30 s). There is no runtime keyword to change that timeout.
|
|
95
|
+
- **No semantic action keywords** (`Activate`, `Select`, `Set Value`, `Check`) — these are the *intended direction* of the high-level library, not shipped. Compose `Pointer Click` / `Keyboard Type` / `Query` instead. See `status-and-migration.md`.
|
|
96
|
+
|
|
97
|
+
## Types referenced
|
|
98
|
+
|
|
99
|
+
- `PointerButtonLike` = `PointerButton` enum (`LEFT=1`, `MIDDLE=2`, `RIGHT=3`) or `int`.
|
|
100
|
+
- `RectLike` = `Rect` | `(x, y, width, height)` tuple | `{x, y, width, height}` dict.
|
|
101
|
+
- `*OverridesLike` / `*ProfileLike` / `*SettingsLike` = native object or a `&{dict}` (keys like `press_delay_ms`, `between_keys_delay_ms`, `acceleration_profile`, `motion`, `jitter_amplitude`, `multi_click_delay_ms`).
|
|
102
|
+
- Exceptions: `BareMetalError` → `ElementNotFoundError`, `ResultTypeError`, `NoQueryError`; native `PlatynUiError` → `PatternError`, `PointerError`, `KeyboardError`, `ProviderError`, …
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# PlatynUI Locators & Queries
|
|
2
|
+
|
|
3
|
+
PlatynUI's analog of Browser Library's "locators" is an **XPath-2.0 query engine over a normalized desktop UI tree**. Selectors are XPath strings; node names are roles; namespaces scope the query.
|
|
4
|
+
|
|
5
|
+
## The UI model
|
|
6
|
+
|
|
7
|
+
Every application's accessibility tree is normalized into one model rooted at the **Desktop** document node. Each node exposes:
|
|
8
|
+
|
|
9
|
+
- `role()` — normalized PascalCase role (`Window`, `Button`, `Edit`, `ListItem`…). The original native role is preserved under `native:Role`.
|
|
10
|
+
- `Name` — display name (`@Name`).
|
|
11
|
+
- `Id` — developer-set stable id (`@Id`): UIA AutomationId / AT-SPI accessible_id / macOS AXIdentifier.
|
|
12
|
+
- typed attributes — `Bounds`, `IsVisible`, `IsEnabled`, `IsFocused`, `IsSelected`, `Value`, `Text`, `ActivationPoint`, `ToggleState`, … Structured values auto-expose component aliases: `Bounds.X`, `Bounds.Width`, `ActivationPoint.Y`.
|
|
13
|
+
|
|
14
|
+
Top-level controls appear both directly under the desktop (flat) and under `app:Application` nodes (grouped) — so `app:Application[@Name='Studio']//control:Window` works.
|
|
15
|
+
|
|
16
|
+
## Namespaces (scope selector)
|
|
17
|
+
|
|
18
|
+
| Prefix | Scope | Examples | Default? |
|
|
19
|
+
|--------|-------|----------|----------|
|
|
20
|
+
| `control` | UI controls | `Window`, `Button`, `Edit`, `Menu`, `Tree`, `Table` | **Yes** |
|
|
21
|
+
| `item` | container children | `ListItem`, `TreeItem`, `TabItem`, `Cell`, `Row` | No |
|
|
22
|
+
| `app` | application/process | `Application` | No |
|
|
23
|
+
| `native` | raw platform attrs | `native:HWND`, `native:Role`, `native:Accessible.*` | No |
|
|
24
|
+
|
|
25
|
+
**The single most important rule:** an unprefixed query matches `control:` only. `//Button` ≡ `//control:Button`. To match container items you MUST write `//item:ListItem` — `//ListItem` finds nothing. Always prefix `app:` and `item:`.
|
|
26
|
+
|
|
27
|
+
## Supported XPath syntax
|
|
28
|
+
|
|
29
|
+
The engine implements XPath 2.0 over live UI trees (not XML files).
|
|
30
|
+
|
|
31
|
+
**Axes:** `child` (default), `descendant` (`//`), `descendant-or-self`, `self` (`.`), `parent` (`..`), `ancestor`, `ancestor-or-self`, `following`, `following-sibling`, `preceding`, `preceding-sibling`, `attribute` (`@`), `namespace`.
|
|
32
|
+
|
|
33
|
+
**Node tests:** name tests, `*` wildcard, `node()`, `text()`, `comment()`.
|
|
34
|
+
|
|
35
|
+
**Predicates `[...]`:**
|
|
36
|
+
- equality: `[@Name='OK']`, `[@Id="num5Button"]`
|
|
37
|
+
- boolean: `[@Name='Calculator' or @Name='Rechner']`, `and`
|
|
38
|
+
- positional: `[1]`, `[position()=2]`, `last()`
|
|
39
|
+
- functions: `contains()`, `matches()` (regex), `starts-with()`, `count()`, `normalize-space()`, `string()`
|
|
40
|
+
- all-attribute wildcard: `[contains(@*, 'Close')]`
|
|
41
|
+
|
|
42
|
+
**Value expressions** (returned by `Query` as computed values, not nodes): `count(//control:Button)`.
|
|
43
|
+
|
|
44
|
+
Not supported: schema awareness, `fn:unparsed-text*`, static typing.
|
|
45
|
+
|
|
46
|
+
## Example selectors (from real PlatynUI tests)
|
|
47
|
+
|
|
48
|
+
| Selector | Matches | Notes |
|
|
49
|
+
|----------|---------|-------|
|
|
50
|
+
| `//control:Button[@Name="OK"]` | a button named OK | `control:` optional |
|
|
51
|
+
| `//Button[@Name="New File"]` | same as above unprefixed | default namespace = control |
|
|
52
|
+
| `app:Application[@Name="Notepad"]//Document` | a Document anywhere under Notepad | grouped `app:` view |
|
|
53
|
+
| `app:Application[@Name="ApplicationFrameHost"]/control:Window[@Name="Calculator" or @Name="Rechner"]` | the Calc/Rechner window | direct child `/`, locale-tolerant |
|
|
54
|
+
| `.//control:Button[@Id="num5Button"]` | digit button relative to root | use after `Set Root`; `@Id` stable |
|
|
55
|
+
| `app:Application[@Name='kalk']/Frame//item:TabItem` | a tab item | **`item:` required** |
|
|
56
|
+
| `…/Label[@Name='5']/parent::Button` | the button owning a label | reverse axis |
|
|
57
|
+
| `//*[contains(@Name,'Checked')]` | any node with "Checked" in name | `*` widens past control |
|
|
58
|
+
| `app:Application[@Name='…']//*[contains(@*, 'Close')]` | any node whose any attribute has "Close" | `@*` all-attribute search |
|
|
59
|
+
| `count(//control:Button)` | number of buttons | value expression |
|
|
60
|
+
| `.` | the current root node | with `Query .` |
|
|
61
|
+
|
|
62
|
+
## Role vocabulary
|
|
63
|
+
|
|
64
|
+
Common normalized roles usable as node names in queries:
|
|
65
|
+
|
|
66
|
+
- **control:** `Window`, `Frame`, `Dialog`, `Button`, `CheckBox`, `ComboBox`, `Edit`, `Text`, `List`, `Tree`, `Table`, `Menu`, `MenuBar`, `MenuItem`, `TabList`, `Document`, `Label`, `Control`.
|
|
67
|
+
- **item:** `ListItem`, `TreeItem`, `TabItem`, `Cell`, `EditableCell`, `Row`.
|
|
68
|
+
- **app:** `Application`.
|
|
69
|
+
- **special:** `Desktop` (root).
|
|
70
|
+
|
|
71
|
+
Cross-platform normalization (originals under `native:Role`):
|
|
72
|
+
|
|
73
|
+
| PlatynUI | UIA | AT-SPI2 | macOS AX |
|
|
74
|
+
|----------|-----|---------|----------|
|
|
75
|
+
| Button | Button | PUSH_BUTTON | AXButton |
|
|
76
|
+
| Edit | Edit | ENTRY/TEXT | AXTextField |
|
|
77
|
+
| List / ListItem | List / ListItem | LIST / LIST_ITEM | AXList / AXStaticText |
|
|
78
|
+
| Tree / TreeItem | Tree / TreeItem | TREE / TABLE_ROW | AXOutline / AXRow |
|
|
79
|
+
| Menu / MenuItem | Menu / MenuItem | MENU / MENU_ITEM | AXMenu / AXMenuItem |
|
|
80
|
+
| TabList / TabItem | Tab / TabItem | PAGE_TAB_LIST / PAGE_TAB | AXTabGroup / AXRadioButton |
|
|
81
|
+
| Window | Window | FRAME / WINDOW | AXWindow |
|
|
82
|
+
|
|
83
|
+
## Locator strategy (best practices)
|
|
84
|
+
|
|
85
|
+
1. **`control` is default** — only add `control:` for clarity.
|
|
86
|
+
2. **Always prefix `app:` and `item:`** — the #1 "element not found" cause.
|
|
87
|
+
3. **Prefer `@Id` over `@Name`** — language-independent and stable; `@Name` only when no Id.
|
|
88
|
+
4. **Anchor on the app, then descend** — `app:Application[@Name='…']//control:Window//control:Button[@Id='…']`, or `Set Root` once and use `.//…`.
|
|
89
|
+
5. **`/` vs `//` deliberately** — `/` direct child (precise/fast), `//` any descendant (broad/slower).
|
|
90
|
+
6. **Localization → `or`** — `[@Name='Calculator' or @Name='Rechner']`.
|
|
91
|
+
7. **Fuzzy → functions** — `contains(@Name,'…')`, `matches(@X,'regex')`, `[contains(@*,'…')]`.
|
|
92
|
+
8. **Structure → axes** — `…/Label[@Name='5']/parent::Button`.
|
|
93
|
+
9. **Positional `[1]` is a last resort** — brittle; prefer attribute predicates.
|
|
94
|
+
10. **Don't `Sleep`** — descriptor resolution retries ~30 s; write the right selector and let it wait.
|
|
95
|
+
11. **Develop selectors with the CLI/inspector** — `platynui-cli query "…"`, `platynui-cli highlight "…"`, or the inspector GUI (see `cli-and-inspector.md`).
|
robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/platform-setup.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# PlatynUI Platform Setup
|
|
2
|
+
|
|
3
|
+
## Install matrix
|
|
4
|
+
|
|
5
|
+
| What | Command | Build | Requirements |
|
|
6
|
+
|------|---------|-------|--------------|
|
|
7
|
+
| **RF library (new_core)** | `uv add robotframework-PlatynUI==0.12.0.dev330` **or** `uv add --prerelease allow robotframework-PlatynUI` (into the project env; see rf-setup (plugin rf-core)) | Prebuilt wheel (bundles `platynui-native` `_native.abi3.so`) | **Python 3.12+**. No Rust, no git. |
|
|
8
|
+
| CLI | `uv tool install --prerelease allow platynui-cli` | Prebuilt wheel | Python 3.12+ |
|
|
9
|
+
| Inspector | `uv tool install --prerelease allow platynui-inspector` | Prebuilt wheel | Python 3.12+, a display |
|
|
10
|
+
| Mock-enabled native build | `uv run maturin develop -m packages/native/Cargo.toml --features mock-provider` | **Source build** | **Rust 1.95+** (2024 edition), Cargo, system libs |
|
|
11
|
+
|
|
12
|
+
### The version footgun (read this)
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
uv add robotframework-PlatynUI # → 0.9.2 (OLD: different lib, NO BareMetal)
|
|
16
|
+
uv add --prerelease allow robotframework-PlatynUI # → 0.12.0.dev* (new_core) # pip: pip install --pre robotframework-PlatynUI
|
|
17
|
+
uv add robotframework-PlatynUI==0.12.0.dev330 # exact pin (no opt-in needed) # pip: pip install robotframework-PlatynUI==0.12.0.dev330
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
`new_core` is published **only as a pre-release**. An unpinned install without the pre-release opt-in silently resolves the old stable `0.9.2`, whose `PlatynUI` library is a different, near-undocumented surface with **no `BareMetal`**. Always opt into pre-releases (`--prerelease allow`; pip `--pre`) or pin.
|
|
21
|
+
|
|
22
|
+
## Linux runtime requirements
|
|
23
|
+
|
|
24
|
+
Two things must be true for PlatynUI to actually drive a Linux desktop:
|
|
25
|
+
|
|
26
|
+
1. **A running AT-SPI2 accessibility bus.** The Linux UI provider reads the tree over AT-SPI2/D-Bus. If it isn't up, the tree is empty.
|
|
27
|
+
- Install `at-spi2-core`; ensure the bus runs in your session.
|
|
28
|
+
- Some toolkits (egui/AccessKit apps) only expose their tree when a screen reader is considered active — set `org.a11y.Status.ScreenReaderEnabled=true` (the PlatynUI repo ships `scripts/linux-a11y-enable.sh`).
|
|
29
|
+
- Verify: `platynui-cli list-providers` should show the `atspi` provider `Active = yes`.
|
|
30
|
+
2. **A session/display.** X11 needs `$DISPLAY`; Wayland needs `$WAYLAND_DISPLAY`. There is no headless tree mode for the real providers.
|
|
31
|
+
|
|
32
|
+
### X11 vs Wayland — prefer X11
|
|
33
|
+
|
|
34
|
+
X11 is the complete path; Wayland is experimental/degraded:
|
|
35
|
+
|
|
36
|
+
- **Input injection:** X11 uses XTest (simple, complete). Wayland forbids client input injection — needs libei/EIS (GNOME 45+/KDE 6.1+), wlroots virtual input, or a portal with a consent dialog. Fragmented per compositor.
|
|
37
|
+
- **Screen coordinates:** under Wayland, AT-SPI `GetExtents(SCREEN)` returns `(0,0)` — pointer targeting by absolute screen coords is unreliable.
|
|
38
|
+
- **Screenshots / highlight / window management:** X11 complete; Wayland screenshot not implemented, highlight/window control limited.
|
|
39
|
+
|
|
40
|
+
**Recommendation:** run on **X11 (or an XWayland-backed session) with AT-SPI2**. A pure Wayland session works for tree traversal but is degraded for clicks, screenshots, and window control.
|
|
41
|
+
|
|
42
|
+
## Docker / headless (CI)
|
|
43
|
+
|
|
44
|
+
The real providers need a session + AT-SPI, so for containers stand up a nested/headless display and the a11y bus:
|
|
45
|
+
|
|
46
|
+
- Install `at-spi2-core`, dbus, and a display server (Xvfb/Xephyr for X11, or Weston `headless`).
|
|
47
|
+
- Start AT-SPI in an isolated `dbus-run-session` (`at-spi-bus-launcher --launch-immediately --a11y=1` + `at-spi2-registryd`), then enable accessibility.
|
|
48
|
+
- Run the tools against that display.
|
|
49
|
+
|
|
50
|
+
The PlatynUI repo's own `scripts/` (`setup-atspi.sh`, `startxsession.sh`, `startwaylandsession.sh`, `linux-a11y-enable.sh`) are a working reference recipe.
|
|
51
|
+
|
|
52
|
+
## Mock provider (deterministic, no desktop)
|
|
53
|
+
|
|
54
|
+
`use_mock=${True}` / `Runtime.new_with_mock()` runs a simulated desktop with no native APIs — ideal for deterministic tests. **But the published wheels are built without it** and raise `ProviderError: Runtime.new_with_mock() requires building with feature 'mock-provider'`. To use mock you must build the native package from source with `--features mock-provider`. For most CI needs, the display-free check is **libdoc** (keyword introspection works without a desktop because the runtime is lazy), not a live mock run.
|
|
55
|
+
|
|
56
|
+
## Troubleshooting
|
|
57
|
+
|
|
58
|
+
| Symptom | Fix |
|
|
59
|
+
|---------|-----|
|
|
60
|
+
| Installed library has no `BareMetal` | You got `0.9.2` (unpinned install without pre-release opt-in). Reinstall with `uv add --prerelease allow robotframework-PlatynUI` or pin `==0.12.0.dev330`. |
|
|
61
|
+
| Linux tree empty / no nodes | AT-SPI not running / a11y disabled. Install `at-spi2-core`, enable a11y, check `platynui-cli list-providers`. |
|
|
62
|
+
| Wayland: clicks land wrong, screenshots fail | Use an X11/XWayland session. |
|
|
63
|
+
| `ProviderError: ... feature 'mock-provider'` | `use_mock` needs a source build with `--features mock-provider`. |
|
|
64
|
+
| `ElementNotFoundError` after ~30 s | Wrong namespace (`item:`/`app:`?), prefer `@Id`; verify with `platynui-cli query`. |
|
|
65
|
+
| Inspector crashes under WSL2 | `WINIT_UNIX_BACKEND=x11 WAYLAND_DISPLAY= platynui-inspector`. |
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# PlatynUI Status & Migration
|
|
2
|
+
|
|
3
|
+
## Verified against
|
|
4
|
+
|
|
5
|
+
This skill was authored and verified against **`robotframework-PlatynUI==0.12.0.dev330`** (library version `0.12.0-dev.330`, the `new_core` rewrite). PlatynUI is **preview/pre-release** — keyword names, CLI output, and platform behavior may change before a stable release. Re-verify with the keyword-fidelity test when bumping versions.
|
|
6
|
+
|
|
7
|
+
## Which library to use
|
|
8
|
+
|
|
9
|
+
| Library | Status | Use it? |
|
|
10
|
+
|---------|--------|---------|
|
|
11
|
+
| `PlatynUI.BareMetal` | **Functional, permanent.** Low-level keyword surface mapping the Rust runtime ~1:1. 24 documented keywords. | ✅ Yes — this is the surface this skill documents. |
|
|
12
|
+
| `PlatynUI` (high-level) | **Placeholder.** A single `Dummy Keyword`; importing it warns `"The PlatynUI library is not implemented yet. This is a placeholder."` | ❌ No — not implemented. |
|
|
13
|
+
|
|
14
|
+
`Library PlatynUI.BareMetal` is the only usable RF entry point today. The high-level object model (typed widget classes — `Button`, `Edit`, `List`, `Tree`, …) exists in Python and is largely built, but its **Robot Framework keyword layer (migration Phase 5) is pending**, so none of it is exposed as keywords yet.
|
|
15
|
+
|
|
16
|
+
## Two different PyPI surfaces (don't mix them up)
|
|
17
|
+
|
|
18
|
+
| Install | Version | `PlatynUI` lib | `PlatynUI.BareMetal` |
|
|
19
|
+
|---------|---------|----------------|----------------------|
|
|
20
|
+
| Unpinned, no pre-release opt-in | `0.9.2` (old stable) | 19 keywords, **1 documented** | **absent** |
|
|
21
|
+
| Pre-release opt-in (`--prerelease allow` / pip `--pre`) or `==0.12.0.dev330` | `0.12.0.dev330` (new_core) | placeholder (1 `Dummy Keyword`) | **24 keywords, all documented** |
|
|
22
|
+
|
|
23
|
+
The old `0.9.2` is a genuinely different library — different keywords, almost no docs. If an agent or user reports keywords that don't match this skill (or "no BareMetal"), they almost certainly installed `0.9.2`. Fix: opt into pre-releases (`--prerelease allow` / pip `--pre`) or pin.
|
|
24
|
+
|
|
25
|
+
## Semantic actions are direction, not API
|
|
26
|
+
|
|
27
|
+
PlatynUI's design narrative (and RoboCon talk) describes high-level **semantic verbs** — `Activate`, `Select`, `Set Value`, `Check`, condition-based `Wait` — driven by typed page objects. **These are not shipped keywords.** With `BareMetal` you express the same intent by composing primitives:
|
|
28
|
+
|
|
29
|
+
| Intended semantic verb | BareMetal equivalent today |
|
|
30
|
+
|------------------------|----------------------------|
|
|
31
|
+
| `Activate` / `Click` a control | `Pointer Click //control:Button[@Id='…']` |
|
|
32
|
+
| `Set Value` of a field | `Keyboard Type //control:Edit[…] <Ctrl+A>new value` |
|
|
33
|
+
| `Select` a list item | `Pointer Click //item:ListItem[@Name='…']` |
|
|
34
|
+
| `Wait Until` visible | (implicit — descriptor resolution retries ~30 s) |
|
|
35
|
+
| assert state | `Get Attribute … Value == expected` |
|
|
36
|
+
|
|
37
|
+
When the high-level keyword library ships, prefer it for readability — but until then, document and write BareMetal.
|
|
38
|
+
|
|
39
|
+
## Transitional internals (don't hard-code)
|
|
40
|
+
|
|
41
|
+
The design notes mark the in-library `UiNodeDescriptor` and the `${PLATYNUI_ROOT_DESCRIPTOR}` variable (set by `Set Root`) as transitional — a future shared mechanism may rename the root variable (e.g. `${PLATYNUI_ROOT_ELEMENT}`). Use the `Set Root` keyword rather than touching the variable directly.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "rf-mobile",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "AppiumLibrary skill for Robot Framework mobile tests on Android and iOS.",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "manykarim",
|
|
7
|
+
"email": "manykarim@users.noreply.github.com"
|
|
8
|
+
},
|
|
9
|
+
"homepage": "https://github.com/MarketSquare/robotframework-plugins",
|
|
10
|
+
"repository": "https://github.com/MarketSquare/robotframework-plugins",
|
|
11
|
+
"license": "Apache-2.0",
|
|
12
|
+
"keywords": [
|
|
13
|
+
"robotframework",
|
|
14
|
+
"testing",
|
|
15
|
+
"mobile-testing",
|
|
16
|
+
"appium"
|
|
17
|
+
],
|
|
18
|
+
"dependencies": [
|
|
19
|
+
{
|
|
20
|
+
"name": "rf-core",
|
|
21
|
+
"version": "^1.0"
|
|
22
|
+
}
|
|
23
|
+
]
|
|
24
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
The `rf-mobile` plugin, versioned on its own (`rf-mobile--v<version>` tags); see `RELEASING.md` at the repository root.
|
|
4
|
+
|
|
5
|
+
## 1.0.0 (unreleased)
|
|
6
|
+
|
|
7
|
+
First release, split out of `rf-agentskills` 3.0.0: `rf-appium`. It depends on `rf-core` `^1.0`. Skill names are unchanged; their plugin prefix is now `rf-mobile:` instead of `rf-agentskills:`, for example `/rf-mobile:rf-appium`.
|
|
8
|
+
|
|
9
|
+
- **Install steps moved here** from `rf-setup`: `rf-appium` has `references/install.md`, with the Appium server and driver steps.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# rf-mobile plugin
|
|
2
|
+
|
|
3
|
+
Robot Framework skills for mobile tests. Install instructions for every agent are in the [repository README](https://github.com/MarketSquare/robotframework-plugins#install).
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
/plugin install rf-mobile --marketplace MarketSquare/robotframework-plugins
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
That one step works on Claude Code 2.1.275 or later. The commands for other agents and older versions are in the repository README.
|
|
12
|
+
|
|
13
|
+
| Skill | Library and package |
|
|
14
|
+
|---|---|
|
|
15
|
+
| `rf-appium` | AppiumLibrary: `robotframework-appiumlibrary` |
|
|
16
|
+
|
|
17
|
+
## Needs rf-core
|
|
18
|
+
|
|
19
|
+
This plugin depends on `rf-core`, which holds Robot Framework syntax, environment setup, the subagents and the validation hooks. Claude Code installs `rf-core` with it. Copilot CLI and Codex don't install plugin dependencies, so install `rf-core` there too:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
copilot plugin install rf-core@robotframework-plugins
|
|
23
|
+
codex plugin add rf-core@robotframework-plugins
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
The `robotframework-plugins` installer adds `rf-core` for you. Don't install this plugin next to the `rf-agentskills` bundle: the bundle carries its own copy of every skill, and you would see each skill twice.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Programme manifest: see schemas/catalog.schema.json and CONTRIBUTING.md.
|
|
2
|
+
name: rf-mobile
|
|
3
|
+
summary: AppiumLibrary skill for Android and iOS tests.
|
|
4
|
+
tier: verified
|
|
5
|
+
status: active
|
|
6
|
+
maintainers:
|
|
7
|
+
- github: manykarim
|
|
8
|
+
name: Many Kasiriha
|
|
9
|
+
libraries:
|
|
10
|
+
- name: AppiumLibrary
|
|
11
|
+
package: robotframework-appiumlibrary
|
|
12
|
+
versions: ">=3,<4"
|
|
13
|
+
skills: [rf-appium]
|
|
14
|
+
robotframework: ">=7.0"
|
|
15
|
+
agents:
|
|
16
|
+
- claude-code
|
|
17
|
+
- copilot-cli
|
|
18
|
+
- vscode-copilot
|
|
19
|
+
- codex
|
|
20
|
+
- cursor
|
|
21
|
+
- opencode
|
|
22
|
+
- goose
|
|
23
|
+
- claude-desktop
|