robotframework-plugins 2026.11.0__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 +113 -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/async-jobs.md +42 -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/loose-assertions.md +20 -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 +120 -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/loose-assertions.md +18 -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 +13 -0
- robotframework_plugins/_assets/plugins/rf-core/README.md +38 -0
- robotframework_plugins/_assets/plugins/rf-core/agents/rf-debug-expert.md +120 -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 +445 -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 +128 -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 +517 -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 +119 -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 +123 -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 +10 -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 +268 -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 +134 -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/selector-drift.md +29 -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 +320 -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.dist-info/METADATA +198 -0
- robotframework_plugins-2026.11.0.dist-info/RECORD +199 -0
- robotframework_plugins-2026.11.0.dist-info/WHEEL +4 -0
- robotframework_plugins-2026.11.0.dist-info/entry_points.txt +2 -0
- robotframework_plugins-2026.11.0.dist-info/licenses/LICENSE +201 -0
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# Capabilities
|
|
2
|
+
|
|
3
|
+
Capability sets for `Open Application`. Every name that is not W3C-standard (`platformName`, `browserName`, …) is sent with the `appium:` prefix; the Appium Python client adds it when it is missing, but writing it keeps logs and vendor docs aligned. Vendor capabilities keep their own prefix (`bstack:`, `sauce:`).
|
|
4
|
+
|
|
5
|
+
- Android
|
|
6
|
+
- iOS
|
|
7
|
+
- Mobile browsers
|
|
8
|
+
- Cloud grids
|
|
9
|
+
- Reset and timeouts
|
|
10
|
+
- Configuring one suite for both platforms
|
|
11
|
+
|
|
12
|
+
## Android
|
|
13
|
+
|
|
14
|
+
| Capability | Value | When |
|
|
15
|
+
|---|---|---|
|
|
16
|
+
| `platformName` | `Android` | always |
|
|
17
|
+
| `appium:automationName` | `UiAutomator2` | always |
|
|
18
|
+
| `appium:deviceName` | `emulator-5554` | informational; `appium:udid` picks a device when several are attached |
|
|
19
|
+
| `appium:app` | path or URL to the `.apk` | install and launch |
|
|
20
|
+
| `appium:appPackage` + `appium:appActivity` | `com.example.app` / `.MainActivity` | launch an installed app instead of `app` |
|
|
21
|
+
| `appium:autoGrantPermissions` | `${True}` | skip runtime permission dialogs |
|
|
22
|
+
| `appium:avd` | `Pixel_7_API_34` | let the driver boot an emulator (`appium:avdLaunchTimeout` in ms) |
|
|
23
|
+
| `appium:chromedriverAutodownload` | `${True}` | WebView / Chrome contexts need a matching chromedriver; the server must allow the insecure feature `chromedriver_autodownload` (UiAutomator2 driver docs) |
|
|
24
|
+
|
|
25
|
+
```robotframework
|
|
26
|
+
Open Application ${APPIUM_URL}
|
|
27
|
+
... platformName=Android
|
|
28
|
+
... appium:automationName=UiAutomator2
|
|
29
|
+
... appium:appPackage=com.example.app
|
|
30
|
+
... appium:appActivity=.MainActivity
|
|
31
|
+
... appium:noReset=${True}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## iOS
|
|
35
|
+
|
|
36
|
+
| Capability | Value | When |
|
|
37
|
+
|---|---|---|
|
|
38
|
+
| `platformName` | `iOS` | always |
|
|
39
|
+
| `appium:automationName` | `XCUITest` | always |
|
|
40
|
+
| `appium:deviceName` | `iPhone 15` | simulator name (with `appium:platformVersion`) |
|
|
41
|
+
| `appium:platformVersion` | `17.5` | selects the simulator runtime |
|
|
42
|
+
| `appium:app` | path to `.app` (simulator) or `.ipa` (device) | install and launch |
|
|
43
|
+
| `appium:bundleId` | `com.example.app` | launch an installed app |
|
|
44
|
+
| `appium:udid` | device UDID | real devices |
|
|
45
|
+
| `appium:xcodeOrgId` + `appium:xcodeSigningId` | team id / `Apple Development` | real devices: signing WebDriverAgent |
|
|
46
|
+
| `appium:autoAcceptAlerts` | `${True}` | accept system alerts (permissions) automatically |
|
|
47
|
+
| `appium:wdaLaunchTimeout` | `120000` | slow first WebDriverAgent build |
|
|
48
|
+
|
|
49
|
+
```robotframework
|
|
50
|
+
Open Application ${APPIUM_URL}
|
|
51
|
+
... platformName=iOS
|
|
52
|
+
... appium:automationName=XCUITest
|
|
53
|
+
... appium:deviceName=iPhone 15
|
|
54
|
+
... appium:platformVersion=17.5
|
|
55
|
+
... appium:app=${CURDIR}/MyApp.app
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Mobile browsers
|
|
59
|
+
|
|
60
|
+
Set `browserName` (W3C, no prefix) instead of `app`; then use `Go To Url` and web locators (`css=`, `xpath=`).
|
|
61
|
+
|
|
62
|
+
```robotframework
|
|
63
|
+
Open Application ${APPIUM_URL}
|
|
64
|
+
... platformName=Android
|
|
65
|
+
... appium:automationName=UiAutomator2
|
|
66
|
+
... browserName=Chrome
|
|
67
|
+
Go To Url https://example.com
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
On iOS use `platformName=iOS`, `appium:automationName=XCUITest`, `browserName=Safari`.
|
|
71
|
+
|
|
72
|
+
## Cloud grids
|
|
73
|
+
|
|
74
|
+
Cloud providers take their credentials in a vendor capability; the hub URL comes from the provider.
|
|
75
|
+
|
|
76
|
+
```robotframework
|
|
77
|
+
Open Application https://hub-cloud.browserstack.com/wd/hub
|
|
78
|
+
... platformName=Android
|
|
79
|
+
... appium:deviceName=Google Pixel 7
|
|
80
|
+
... appium:platformVersion=13.0
|
|
81
|
+
... appium:app=bs://<app-hash>
|
|
82
|
+
... bstack:options=${BSTACK_OPTIONS}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
`${BSTACK_OPTIONS}` is a dictionary (`&{BSTACK_OPTIONS} userName=… accessKey=…` in `*** Variables ***`). Sauce Labs uses `sauce:options` the same way.
|
|
86
|
+
|
|
87
|
+
## Reset and timeouts
|
|
88
|
+
|
|
89
|
+
| Capability | Effect |
|
|
90
|
+
|---|---|
|
|
91
|
+
| `appium:noReset=${True}` | keep app data between sessions (faster, but state leaks) |
|
|
92
|
+
| `appium:fullReset=${True}` | uninstall and reinstall the app (clean, slow) |
|
|
93
|
+
| neither | the driver's default reset, which differs between UiAutomator2 and XCUITest (see the driver docs) |
|
|
94
|
+
| `appium:newCommandTimeout` | seconds the server waits for the next command before it ends the session (default 60); raise it for debugging pauses |
|
|
95
|
+
|
|
96
|
+
The library's own wait timeout is the import argument (`Library AppiumLibrary timeout=15s`) or `Set Appium Timeout`; it does not change any capability.
|
|
97
|
+
|
|
98
|
+
## Configuring one suite for both platforms
|
|
99
|
+
|
|
100
|
+
Keep the capabilities in variable files or dictionaries and select them on the command line:
|
|
101
|
+
|
|
102
|
+
```robotframework
|
|
103
|
+
*** Variables ***
|
|
104
|
+
${PLATFORM} android
|
|
105
|
+
&{ANDROID} platformName=Android appium:automationName=UiAutomator2 appium:app=${CURDIR}/app.apk
|
|
106
|
+
&{IOS} platformName=iOS appium:automationName=XCUITest appium:app=${CURDIR}/MyApp.app
|
|
107
|
+
|
|
108
|
+
*** Keywords ***
|
|
109
|
+
Open App For Platform
|
|
110
|
+
IF '${PLATFORM}' == 'ios'
|
|
111
|
+
Open Application ${APPIUM_URL} &{IOS}
|
|
112
|
+
ELSE
|
|
113
|
+
Open Application ${APPIUM_URL} &{ANDROID}
|
|
114
|
+
END
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Run with `robot --variable PLATFORM:ios tests/`.
|
robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/gestures-touch.md
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Gestures and Touch
|
|
2
|
+
|
|
3
|
+
Durations take units (`500ms`, `1s`). `Swipe`, `Swipe By Percent` and `Tap With Positions` read a bare number as milliseconds and log a warning; `Tap` reads a bare number as seconds.
|
|
4
|
+
|
|
5
|
+
- Tap and long press
|
|
6
|
+
- Scrolling to an element
|
|
7
|
+
- Swipes
|
|
8
|
+
- Pinch, zoom and driver gestures
|
|
9
|
+
- Drag and drop
|
|
10
|
+
- Removed gesture keywords
|
|
11
|
+
|
|
12
|
+
## Tap and long press
|
|
13
|
+
|
|
14
|
+
```robotframework
|
|
15
|
+
Tap accessibility_id=item_1 # single tap (duration defaults to 1s)
|
|
16
|
+
Tap accessibility_id=item_1 count=2 duration=200ms # double tap
|
|
17
|
+
Tap accessibility_id=item_1 duration=2s # long press, e.g. to open a context menu
|
|
18
|
+
Tap With Positions 300ms ${{ (540, 1200) }} # tap at coordinates; duration comes first
|
|
19
|
+
Tap With Positions 300ms ${{ (300, 800) }} ${{ (700, 800) }} # two fingers
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
`Tap` also accepts a coordinate list instead of a locator (`VAR @{point} 540 1200` then `Tap ${point}`).
|
|
23
|
+
|
|
24
|
+
## Scrolling to an element
|
|
25
|
+
|
|
26
|
+
| Need | Use |
|
|
27
|
+
|---|---|
|
|
28
|
+
| Android, element somewhere below | `Scroll Down <locator>` — swipes up to `timeout` (default 10s) until the locator matches |
|
|
29
|
+
| Android, long list, text known | `Click Element android=new UiScrollable(new UiSelector().scrollable(true)).scrollIntoView(new UiSelector().text("Item 50"))` |
|
|
30
|
+
| iOS | `Scroll Down <locator>` scrolls to an element that is already in the view hierarchy (XCUITest keeps off-screen cells in the tree) |
|
|
31
|
+
| Between two known elements | `Scroll <start_locator> <end_locator>` |
|
|
32
|
+
| Element present but off-screen | `Scroll Element Into View <locator>` |
|
|
33
|
+
|
|
34
|
+
On Android, `Scroll Down` / `Scroll Up` return without failing when the timeout ends and the element never appeared, so assert afterwards:
|
|
35
|
+
|
|
36
|
+
```robotframework
|
|
37
|
+
Scroll Down accessibility_id=terms_checkbox timeout=20s
|
|
38
|
+
Expect Element accessibility_id=terms_checkbox visible
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Swipes
|
|
42
|
+
|
|
43
|
+
`Swipe` takes keyword-only pixel coordinates; `Swipe By Percent` takes positional percentages of the screen (0–100), so it works across resolutions.
|
|
44
|
+
|
|
45
|
+
```robotframework
|
|
46
|
+
Swipe start_x=540 start_y=1600 end_x=540 end_y=400 duration=500ms # scroll content up
|
|
47
|
+
Swipe By Percent 90 50 10 50 duration=300ms # carousel: next page
|
|
48
|
+
Swipe By Percent 50 25 50 75 duration=500ms # pull to refresh
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Screen-relative pixels: read `Get Window Width` / `Get Window Height` and compute with `${{ }}` expressions.
|
|
52
|
+
|
|
53
|
+
## Pinch, zoom and driver gestures
|
|
54
|
+
|
|
55
|
+
AppiumLibrary has no pinch or zoom keyword. Call the driver's `mobile:` commands through `Execute Script`; named arguments become the command's parameter map.
|
|
56
|
+
|
|
57
|
+
```robotframework
|
|
58
|
+
${map}= Get Webelement accessibility_id=map_view
|
|
59
|
+
# Android (UiAutomator2): percent is 0..1
|
|
60
|
+
Execute Script mobile: pinchOpenGesture elementId=${map.id} percent=${0.75}
|
|
61
|
+
Execute Script mobile: pinchCloseGesture elementId=${map.id} percent=${0.5}
|
|
62
|
+
# iOS (XCUITest): scale > 1 zooms in, < 1 zooms out; velocity sign follows the scale
|
|
63
|
+
Execute Script mobile: pinch elementId=${map.id} scale=${2.0} velocity=${1.0}
|
|
64
|
+
Execute Script mobile: pinch elementId=${map.id} scale=${0.5} velocity=${-1.0}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Other gestures follow the same pattern (UiAutomator2: `mobile: longClickGesture`, `mobile: swipeGesture`, `mobile: scrollGesture`, `mobile: dragGesture`; XCUITest: `mobile: touchAndHold`, `mobile: swipe`, `mobile: scroll`). Their parameters are in the driver's execute-methods documentation; pass numbers as `${…}` so they are not sent as strings.
|
|
68
|
+
|
|
69
|
+
## Drag and drop
|
|
70
|
+
|
|
71
|
+
```robotframework
|
|
72
|
+
Drag And Drop accessibility_id=card_1 accessibility_id=done_column
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
When the app needs a slow drag, use `Swipe` from the element's centre (`Get Element Location` + `Get Element Size`) with `duration=2s`.
|
|
76
|
+
|
|
77
|
+
## Removed gesture keywords
|
|
78
|
+
|
|
79
|
+
| Removed | Use |
|
|
80
|
+
|---|---|
|
|
81
|
+
| `Long Press` | `Tap <locator> duration=2s` |
|
|
82
|
+
| `Click A Point` | `Tap With Positions 500ms ${{ (x, y) }}` |
|
|
83
|
+
| `Zoom` | `Execute Script mobile: pinchOpenGesture` (Android) / `mobile: pinch` with `scale` > 1 (iOS) |
|
|
84
|
+
| `Pinch` | `Execute Script mobile: pinchCloseGesture` (Android) / `mobile: pinch` with `scale` < 1 (iOS) |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Installing AppiumLibrary
|
|
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
|
+
```bash
|
|
6
|
+
uv add robotframework-appiumlibrary
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
- Package `robotframework-appiumlibrary` (3.2). Module `AppiumLibrary`. It pulls in `Appium-Python-Client`.
|
|
10
|
+
- After installing: the **Appium server** and platform drivers are Node tools, installed outside the Python environment:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install -g appium # Appium 3.x; Node ^20.19, ^22.12 or ≥ 24
|
|
14
|
+
appium driver install uiautomator2 # Android
|
|
15
|
+
appium driver install xcuitest # iOS (macOS + Xcode)
|
|
16
|
+
appium driver list
|
|
17
|
+
appium driver doctor uiautomator2 # checks ANDROID_HOME, JDK, adb …
|
|
18
|
+
appium # start the server (default http://127.0.0.1:4723)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
- Android also needs the Android SDK (`ANDROID_HOME`), a JDK and an emulator or device. iOS needs Xcode. See `platform-specific.md`.
|
robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/locators-mobile.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Mobile Locators
|
|
2
|
+
|
|
3
|
+
AppiumLibrary locators are `strategy=value`. Without a prefix the value is an `id` (or XPath when it starts with `//`); an unknown prefix fails with "Element locator with prefix '…' is not supported".
|
|
4
|
+
|
|
5
|
+
- Strategy order
|
|
6
|
+
- Android
|
|
7
|
+
- iOS
|
|
8
|
+
- XPath
|
|
9
|
+
- Finding locators
|
|
10
|
+
|
|
11
|
+
## Strategy order
|
|
12
|
+
|
|
13
|
+
| Strategy | Android | iOS | Notes |
|
|
14
|
+
|---|---|---|---|
|
|
15
|
+
| `accessibility_id=` | content-desc | accessibility identifier | same value on both platforms when the app sets it; the first choice |
|
|
16
|
+
| `id=` | resource-id | accessibility id / name | short form `id=login` works when the id belongs to the app package |
|
|
17
|
+
| `name=` | — | name / label | iOS only in practice |
|
|
18
|
+
| `android=` | UiAutomator selector | — | fast, can scroll (see Android) |
|
|
19
|
+
| `predicate=` | — | NSPredicate string | fast |
|
|
20
|
+
| `chain=` | — | class chain | fast, hierarchical |
|
|
21
|
+
| `xpath=` | yes | yes | slow on large trees; last resort |
|
|
22
|
+
| `class=` | widget class | XCUIElementType | usually matches many elements |
|
|
23
|
+
| `css=` | WebView / browser context only | same | web content after `Switch To Context` |
|
|
24
|
+
|
|
25
|
+
`ios=` is the retired UI Automation strategy; the current Appium Python client no longer supports it. Use `predicate=` or `chain=`.
|
|
26
|
+
|
|
27
|
+
## Android
|
|
28
|
+
|
|
29
|
+
```robotframework
|
|
30
|
+
Click Element accessibility_id=login_button
|
|
31
|
+
Click Element id=com.example.app:id/login_button
|
|
32
|
+
Click Element android=new UiSelector().text("Login")
|
|
33
|
+
Click Element android=new UiSelector().className("android.widget.Button").textContains("Sub")
|
|
34
|
+
Click Element android=new UiSelector().resourceId("com.example.app:id/item").instance(2)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Scroll a list until an element exists, in one call (UiAutomator scrolls on the device):
|
|
38
|
+
|
|
39
|
+
```robotframework
|
|
40
|
+
Click Element android=new UiScrollable(new UiSelector().scrollable(true)).scrollIntoView(new UiSelector().text("Item 50"))
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Common classes: `android.widget.Button`, `android.widget.EditText`, `android.widget.TextView`, `android.widget.CheckBox`, `android.widget.Switch`, `android.widget.ImageView`, `androidx.recyclerview.widget.RecyclerView`.
|
|
44
|
+
|
|
45
|
+
## iOS
|
|
46
|
+
|
|
47
|
+
```robotframework
|
|
48
|
+
Click Element accessibility_id=loginButton
|
|
49
|
+
Click Element predicate=type == 'XCUIElementTypeButton' AND name == 'Login'
|
|
50
|
+
Click Element predicate=type == 'XCUIElementTypeStaticText' AND value BEGINSWITH 'Hello'
|
|
51
|
+
Click Element chain=**/XCUIElementTypeButton[`name == 'Login'`]
|
|
52
|
+
Click Element chain=**/XCUIElementTypeTable/XCUIElementTypeCell[3]
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Predicate operators: `==`, `!=`, `CONTAINS`, `BEGINSWITH`, `ENDSWITH`, `MATCHES` (regex), combined with `AND` / `OR` / `NOT`; append `[c]` for case-insensitive (`name CONTAINS[c] 'log'`). Class chains accept a predicate in backticks inside `[…]` and an index `[n]` (1-based).
|
|
56
|
+
|
|
57
|
+
Common types: `XCUIElementTypeButton`, `XCUIElementTypeTextField`, `XCUIElementTypeSecureTextField`, `XCUIElementTypeStaticText`, `XCUIElementTypeCell`, `XCUIElementTypeSwitch`, `XCUIElementTypeAlert`.
|
|
58
|
+
|
|
59
|
+
## XPath
|
|
60
|
+
|
|
61
|
+
```robotframework
|
|
62
|
+
Click Element xpath=//android.widget.Button[@text='Login']
|
|
63
|
+
Click Element xpath=//*[@content-desc='Submit']
|
|
64
|
+
Click Element xpath=//XCUIElementTypeButton[@name='Login']
|
|
65
|
+
${n}= Get Matching Xpath Count //android.widget.CheckBox
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
XPath walks the whole view hierarchy, so it is slow on long lists; prefer an `android=` or `predicate=` query with the same condition. `Get Matching Xpath Count` and `Xpath Should Match X Times` take the XPath without the `xpath=` prefix; `Get Matching Xpath Count` returns a string, so compare with `Should Be Equal As Integers`.
|
|
69
|
+
|
|
70
|
+
## Finding locators
|
|
71
|
+
|
|
72
|
+
- `Log Source` writes the current view hierarchy (XML) to the log; read attribute names there (`content-desc`, `resource-id`, `text` on Android; `name`, `label`, `value`, `type` on iOS).
|
|
73
|
+
- Appium Inspector shows the same tree interactively and can try a locator before you write it.
|
|
74
|
+
- Ask the app developers for accessibility identifiers when elements have none; they stabilise tests on both platforms.
|
robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/platform-specific.md
ADDED
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# Platform-Specific Keywords
|
|
2
|
+
|
|
3
|
+
Keywords and driver commands that exist on only one platform, and hybrid-app context handling. Capabilities and locators per platform are in their own reference files.
|
|
4
|
+
|
|
5
|
+
- Android: keys and keyboard
|
|
6
|
+
- Android: activities and app state
|
|
7
|
+
- Android: permissions, notifications and shell
|
|
8
|
+
- iOS: alerts and permissions
|
|
9
|
+
- iOS: keyboard, pickers and biometrics
|
|
10
|
+
- Both: orientation, background and app lifecycle
|
|
11
|
+
- Hybrid apps and WebViews
|
|
12
|
+
|
|
13
|
+
## Android: keys and keyboard
|
|
14
|
+
|
|
15
|
+
`Press Keycode` and `Long Press Keycode` send Android key codes (`metastate=1` adds Shift).
|
|
16
|
+
|
|
17
|
+
| Key | Code | Key | Code |
|
|
18
|
+
|---|---|---|---|
|
|
19
|
+
| Back | `4` | Enter | `66` |
|
|
20
|
+
| Home | `3` | Delete (backspace) | `67` |
|
|
21
|
+
| Menu | `82` | Tab | `61` |
|
|
22
|
+
| Volume up / down | `24` / `25` | App switch | `187` |
|
|
23
|
+
|
|
24
|
+
```robotframework
|
|
25
|
+
Press Keycode 4 # back
|
|
26
|
+
Press Keycode 66 # enter, e.g. submit a search field
|
|
27
|
+
Hide Keyboard # Android ignores the key_name argument
|
|
28
|
+
${shown}= Is Keyboard Shown
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Android: activities and app state
|
|
32
|
+
|
|
33
|
+
```robotframework
|
|
34
|
+
${activity}= Get Activity
|
|
35
|
+
Start Activity com.example.app .SettingsActivity
|
|
36
|
+
Wait Activity .SettingsActivity 10
|
|
37
|
+
${state}= Execute Script mobile: queryAppState appId=com.example.app # 4 = running in foreground
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
`Start Activity` passes extra options (`stop=${True}`, `action=…`, `uri=…`) to the driver's `mobile: startActivity`. Deep links: `Start Activity` with `action=android.intent.action.VIEW` and `uri=myapp://path`.
|
|
41
|
+
|
|
42
|
+
## Android: permissions, notifications and shell
|
|
43
|
+
|
|
44
|
+
- Runtime permission dialogs: start the session with `appium:autoGrantPermissions=${True}`; otherwise tap the dialog's button (`id=com.android.permissioncontroller:id/permission_allow_button` on recent Android versions; read the exact id with `Log Source`).
|
|
45
|
+
- `Open Notifications` expands the notification drawer; locate notifications by text with `android=new UiSelector().textContains("…")`, then `Press Keycode 4` to close it.
|
|
46
|
+
- Shell commands: `Execute Adb Shell <command> <args>` or `Execute Script mobile: shell command=getprop args=${{ ["ro.build.version.release"] }}`. Both need the server started with the insecure feature `adb_shell` allowed.
|
|
47
|
+
|
|
48
|
+
## iOS: alerts and permissions
|
|
49
|
+
|
|
50
|
+
```robotframework
|
|
51
|
+
Wait Until Page Contains Element class=XCUIElementTypeAlert timeout=5s
|
|
52
|
+
Click Alert Button Allow
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
`Click Alert Button` is iOS-only and takes the button text. To accept every system alert, start the session with `appium:autoAcceptAlerts=${True}` (or `appium:autoDismissAlerts`). Checking for an optional alert:
|
|
56
|
+
|
|
57
|
+
```robotframework
|
|
58
|
+
*** Keywords ***
|
|
59
|
+
Accept Alert If Present
|
|
60
|
+
${present}= Run Keyword And Return Status
|
|
61
|
+
... Wait Until Page Contains Element class=XCUIElementTypeAlert timeout=3s
|
|
62
|
+
IF ${present} Click Alert Button Allow
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## iOS: keyboard, pickers and biometrics
|
|
66
|
+
|
|
67
|
+
```robotframework
|
|
68
|
+
Hide Keyboard Done # iOS presses the named key to dismiss the keyboard
|
|
69
|
+
@{wheels}= Get Webelements class=XCUIElementTypePickerWheel
|
|
70
|
+
Input Value ${wheels}[0] December
|
|
71
|
+
Input Value ${wheels}[1] 25
|
|
72
|
+
Touch Id match=${True} # simulator only; enrol first with Toggle Touch Id Enrollment
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
`Input Value` (iOS only) sets a value directly and suits picker wheels; `Input Text` types key by key. Face ID and Touch ID on simulators can also be driven with `Execute Script mobile: sendBiometricMatch type=faceId match=${True}`.
|
|
76
|
+
|
|
77
|
+
## Both: orientation, background and app lifecycle
|
|
78
|
+
|
|
79
|
+
```robotframework
|
|
80
|
+
Landscape
|
|
81
|
+
Portrait
|
|
82
|
+
Background Application 3 # seconds in the background, then back
|
|
83
|
+
Terminate Application com.example.app # bundleId on iOS
|
|
84
|
+
Activate Application com.example.app
|
|
85
|
+
Lock 2
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
`Close Application` ends the session; `Terminate Application` only stops the app and keeps the session, so the next step can `Activate Application` again.
|
|
89
|
+
|
|
90
|
+
## Hybrid apps and WebViews
|
|
91
|
+
|
|
92
|
+
```robotframework
|
|
93
|
+
Wait Until Page Contains Element class=android.webkit.WebView timeout=15s
|
|
94
|
+
@{contexts}= Get Contexts
|
|
95
|
+
Log ${contexts} # e.g. NATIVE_APP, WEBVIEW_com.example.app
|
|
96
|
+
Switch To Context WEBVIEW_com.example.app
|
|
97
|
+
Input Text css=input#email demo@example.com
|
|
98
|
+
Click Element css=button[type=submit]
|
|
99
|
+
Switch To Context NATIVE_APP
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
- The WebView context appears only after the WebView has loaded, and on Android only when the app enables WebView debugging (`setWebContentsDebuggingEnabled(true)` in debug builds).
|
|
103
|
+
- Android WebViews need a chromedriver that matches the WebView version (see the chromedriver capabilities in the capabilities reference).
|
|
104
|
+
- iOS WebView context names look like `WEBVIEW_12345.1`; read them from `Get Contexts` rather than hard-coding them.
|
|
105
|
+
- In the web context, native locators (`accessibility_id=`, `android=`) do not work; switch back to `NATIVE_APP` first.
|
robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/troubleshooting.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Troubleshooting
|
|
2
|
+
|
|
3
|
+
Organised by the message you see. Environment problems (Node.js, Appium server or driver install, Android SDK, Xcode) belong to rf-setup (plugin rf-core).
|
|
4
|
+
|
|
5
|
+
- Connection refused or "Max retries exceeded"
|
|
6
|
+
- "The requested resource could not be found" on session start
|
|
7
|
+
- "Could not find a connected Android device" / "Device … was not in the list"
|
|
8
|
+
- "SessionNotCreatedException" on iOS (WebDriverAgent)
|
|
9
|
+
- "Element locator '…' did not match any elements"
|
|
10
|
+
- "Element locator with prefix '…' is not supported"
|
|
11
|
+
- "No keyword with name '…' found"
|
|
12
|
+
- "No Chromedriver found that can automate Chrome"
|
|
13
|
+
- WebView context missing from Get Contexts
|
|
14
|
+
- Session ends between steps
|
|
15
|
+
- Reading the screen when a locator fails
|
|
16
|
+
|
|
17
|
+
## Connection refused or "Max retries exceeded"
|
|
18
|
+
|
|
19
|
+
The Appium server is not running at the URL of `Open Application`. Start it (`appium`, port 4723 by default) and check `curl http://127.0.0.1:4723/status`. Tests on another machine need its address and an open port.
|
|
20
|
+
|
|
21
|
+
## "The requested resource could not be found" on session start
|
|
22
|
+
|
|
23
|
+
The URL has the wrong base path. Appium 2 and later serve at `/` by default, so `http://127.0.0.1:4723/wd/hub` fails; drop `/wd/hub`, or start the server with `--base-path /wd/hub` when old suites cannot change. Cloud providers keep their own documented path.
|
|
24
|
+
|
|
25
|
+
## "Could not find a connected Android device" / "Device … was not in the list"
|
|
26
|
+
|
|
27
|
+
`adb devices` must list the emulator or device as `device` (not `unauthorized` or `offline`). With several devices, pick one with `appium:udid=<serial>`. Accept the USB debugging prompt on real devices.
|
|
28
|
+
|
|
29
|
+
## "SessionNotCreatedException" on iOS (WebDriverAgent)
|
|
30
|
+
|
|
31
|
+
WebDriverAgent could not be built or started. On simulators, check that `appium:deviceName` and `appium:platformVersion` name an installed simulator (`xcrun simctl list devices`). On real devices, set `appium:xcodeOrgId` and `appium:xcodeSigningId` and trust the developer certificate on the device. The first build can take minutes; raise `appium:wdaLaunchTimeout`.
|
|
32
|
+
|
|
33
|
+
## "Element locator '…' did not match any elements"
|
|
34
|
+
|
|
35
|
+
- The screen was not ready: action keywords do not wait. Add `Wait Until Page Contains Element` (or `Expect Element … visible`) before the first action on a new screen.
|
|
36
|
+
- The element is off-screen in a list: Android only creates visible rows. Scroll to it first (`Scroll Down <locator>` or a `UiScrollable` locator).
|
|
37
|
+
- The context is wrong: after `Switch To Context WEBVIEW_…`, native locators no longer match, and the other way round.
|
|
38
|
+
- The locator is wrong: run `Log Source` and compare attribute names and values.
|
|
39
|
+
|
|
40
|
+
## "Element locator with prefix '…' is not supported"
|
|
41
|
+
|
|
42
|
+
Everything before the first `=` is read as a strategy. Use one of `accessibility_id`, `id`, `name`, `xpath`, `class`, `android`, `predicate`, `chain`, `css` (web context), or write an XPath starting with `//`. A value that itself contains `=` needs an explicit prefix (`id=…`).
|
|
43
|
+
|
|
44
|
+
## "No keyword with name '…' found"
|
|
45
|
+
|
|
46
|
+
The keyword was removed in AppiumLibrary 3.x or never existed (`Long Press`, `Click A Point`, `Zoom`, `Pinch`, `Quit Application`, `Reset Application`, `Background App`, `Get Window Size`). Look the name up with libdoc; the replacements are in the skill's Gotchas.
|
|
47
|
+
|
|
48
|
+
## "No Chromedriver found that can automate Chrome"
|
|
49
|
+
|
|
50
|
+
The WebView or Chrome version on the device does not match any chromedriver the UiAutomator2 driver has. Set `appium:chromedriverAutodownload=${True}` and allow the server's insecure feature `chromedriver_autodownload`, or point `appium:chromedriverExecutable` at a matching binary.
|
|
51
|
+
|
|
52
|
+
## WebView context missing from Get Contexts
|
|
53
|
+
|
|
54
|
+
Wait for the WebView to load before calling `Get Contexts`. Android apps expose WebViews only when WebView debugging is enabled in the app build; iOS WebViews of release builds on real devices are not inspectable unless the app marks them inspectable.
|
|
55
|
+
|
|
56
|
+
## Session ends between steps
|
|
57
|
+
|
|
58
|
+
The server ends a session after `appium:newCommandTimeout` seconds without a command (default 60). Long `Sleep`s or debugger pauses trigger it; raise the capability instead of adding keep-alive steps. A session also ends when a previous test crashed the app: open it again in Test Setup or use per-test sessions.
|
|
59
|
+
|
|
60
|
+
## Reading the screen when a locator fails
|
|
61
|
+
|
|
62
|
+
`run_on_failure` captures a screenshot by default (`Capture Page Screenshot`). Add the view hierarchy while debugging:
|
|
63
|
+
|
|
64
|
+
```robotframework
|
|
65
|
+
Log Source loglevel=INFO
|
|
66
|
+
${source}= Get Source
|
|
67
|
+
Create File ${OUTPUT_DIR}/screen.xml ${source}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Keywords with a `loglevel` argument (`Expect Element`, `Page Should Contain Element`) already log the source when they fail; pass `loglevel=NONE` to turn that off.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "rf-web",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Browser Library (Playwright) and SeleniumLibrary skills for Robot Framework web tests.",
|
|
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
|
+
"web-testing",
|
|
16
|
+
"playwright",
|
|
17
|
+
"selenium"
|
|
18
|
+
],
|
|
19
|
+
"dependencies": [
|
|
20
|
+
{
|
|
21
|
+
"name": "rf-core",
|
|
22
|
+
"version": "^1.0"
|
|
23
|
+
}
|
|
24
|
+
]
|
|
25
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
The `rf-web` plugin, versioned on its own (`rf-web--v<version>` tags); see `RELEASING.md` at the repository root.
|
|
4
|
+
|
|
5
|
+
## 1.0.0 (2026-11-18)
|
|
6
|
+
|
|
7
|
+
First release, split out of `rf-agentskills` 3.0.0: `rf-browser` and `rf-selenium`. It depends on `rf-core` `^1.0`. Skill names are unchanged; their plugin prefix is now `rf-web:` instead of `rf-agentskills:`, for example `/rf-web:rf-browser`.
|
|
8
|
+
|
|
9
|
+
- **Install steps moved here** from `rf-setup`: `rf-browser` and `rf-selenium` each have `references/install.md`, with the full post-install steps, verification, troubleshooting and the CI step. `rf-browser` also has `references/migrate-from-selenium.md`, the SeleniumLibrary → Browser keyword map that `rf-migration-guide` used to carry.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# rf-web plugin
|
|
2
|
+
|
|
3
|
+
Robot Framework skills for web 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-web --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-browser` | Browser Library (Playwright): `robotframework-browser` |
|
|
16
|
+
| `rf-selenium` | SeleniumLibrary: `robotframework-seleniumlibrary` |
|
|
17
|
+
|
|
18
|
+
## Needs rf-core
|
|
19
|
+
|
|
20
|
+
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:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
copilot plugin install rf-core@robotframework-plugins
|
|
24
|
+
codex plugin add rf-core@robotframework-plugins
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
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,27 @@
|
|
|
1
|
+
# Programme manifest: see schemas/catalog.schema.json and CONTRIBUTING.md.
|
|
2
|
+
name: rf-web
|
|
3
|
+
summary: Browser Library and SeleniumLibrary skills for web tests.
|
|
4
|
+
tier: verified
|
|
5
|
+
status: active
|
|
6
|
+
maintainers:
|
|
7
|
+
- github: manykarim
|
|
8
|
+
name: Many Kasiriha
|
|
9
|
+
libraries:
|
|
10
|
+
- name: Browser
|
|
11
|
+
package: robotframework-browser
|
|
12
|
+
versions: ">=20,<21"
|
|
13
|
+
skills: [rf-browser]
|
|
14
|
+
- name: SeleniumLibrary
|
|
15
|
+
package: robotframework-seleniumlibrary
|
|
16
|
+
versions: ">=6.9,<7"
|
|
17
|
+
skills: [rf-selenium]
|
|
18
|
+
robotframework: ">=7.0"
|
|
19
|
+
agents:
|
|
20
|
+
- claude-code
|
|
21
|
+
- copilot-cli
|
|
22
|
+
- vscode-copilot
|
|
23
|
+
- codex
|
|
24
|
+
- cursor
|
|
25
|
+
- opencode
|
|
26
|
+
- goose
|
|
27
|
+
- claude-desktop
|