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,51 @@
|
|
|
1
|
+
*** Settings ***
|
|
2
|
+
Documentation RESTinstance basics: requests, status and field assertions, JSONPath,
|
|
3
|
+
... chaining values between requests and negative tests.
|
|
4
|
+
... Run: robot --variable API_URL:http://localhost:8000 basic-rest.robot
|
|
5
|
+
Library REST ${API_URL}
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
*** Variables ***
|
|
9
|
+
${API_URL} http://localhost:8000
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
*** Test Cases ***
|
|
13
|
+
Get One User
|
|
14
|
+
GET /users/1
|
|
15
|
+
Integer response status 200
|
|
16
|
+
Integer response body id 1
|
|
17
|
+
String response body name pattern=^[A-Z]
|
|
18
|
+
Boolean response body active
|
|
19
|
+
User Should Look Valid
|
|
20
|
+
|
|
21
|
+
List Users
|
|
22
|
+
GET /users query={"limit": "10"}
|
|
23
|
+
Integer response status 200
|
|
24
|
+
Array response body minItems=1
|
|
25
|
+
Integer $[*].id minimum=1
|
|
26
|
+
String $[*].email format=email
|
|
27
|
+
|
|
28
|
+
Create And Read Back
|
|
29
|
+
VAR &{new_user} name=Carol email=carol@example.com active=${True}
|
|
30
|
+
POST /users ${new_user}
|
|
31
|
+
Integer response status 201
|
|
32
|
+
${id}= Output response body id also_console=false
|
|
33
|
+
GET /users/${id}
|
|
34
|
+
Integer response status 200
|
|
35
|
+
String response body name Carol
|
|
36
|
+
|
|
37
|
+
Unknown User Returns 404
|
|
38
|
+
GET /users/99999
|
|
39
|
+
Integer response status 404
|
|
40
|
+
Missing response body id
|
|
41
|
+
|
|
42
|
+
Status Is One Of
|
|
43
|
+
DELETE /users/2
|
|
44
|
+
Integer response status 200 204 404
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
*** Keywords ***
|
|
48
|
+
User Should Look Valid
|
|
49
|
+
[Documentation] Reusable field checks for the last response.
|
|
50
|
+
Object response body required=["id", "name", "email"]
|
|
51
|
+
String response body email format=email
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
*** Settings ***
|
|
2
|
+
Documentation RESTinstance schemas: a committed schema file as an expectation,
|
|
3
|
+
... inline expectations, learning a schema, and scoping with Clear Expectations.
|
|
4
|
+
... Run: robot --variable API_URL:http://localhost:8000 schema-validation.robot
|
|
5
|
+
Library REST ${API_URL}
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
*** Variables ***
|
|
9
|
+
${API_URL} http://localhost:8000
|
|
10
|
+
${USER_SCHEMA} ${CURDIR}/schemas/user.json
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
*** Test Cases ***
|
|
14
|
+
Users Match The Committed Schema
|
|
15
|
+
Expect Response Body ${USER_SCHEMA}
|
|
16
|
+
GET /users/1
|
|
17
|
+
Integer response status 200
|
|
18
|
+
GET /users/2
|
|
19
|
+
Integer response status 200
|
|
20
|
+
[Teardown] Clear Expectations
|
|
21
|
+
|
|
22
|
+
No Unexpected Properties
|
|
23
|
+
Expect Response Body {"additionalProperties": false, "properties": {"id": {}, "name": {}, "email": {}, "active": {}}}
|
|
24
|
+
GET /users/1
|
|
25
|
+
Integer response status 200
|
|
26
|
+
[Teardown] Clear Expectations
|
|
27
|
+
|
|
28
|
+
Negative Test Skips The Contract
|
|
29
|
+
Expect Response Body ${USER_SCHEMA}
|
|
30
|
+
GET /users/99999 validate=false
|
|
31
|
+
Integer response status 404
|
|
32
|
+
[Teardown] Clear Expectations
|
|
33
|
+
|
|
34
|
+
Learn The Schema Of A Response
|
|
35
|
+
[Documentation] Writes the inferred schema; review it before committing it as a contract.
|
|
36
|
+
GET /users/1
|
|
37
|
+
Integer response status 200
|
|
38
|
+
Output Schema response body file_path=${OUTPUT DIR}/learned-user.json also_console=false
|
robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/authentication.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Authentication in RESTinstance
|
|
2
|
+
|
|
3
|
+
Everything set with `Set Headers`, `Set Client Authentication` or `Set Client Cert` is stored in the library instance and sent with every later request in the suite. Per-request `headers=` apply to one request only.
|
|
4
|
+
|
|
5
|
+
## Bearer token from a login request
|
|
6
|
+
|
|
7
|
+
```robotframework
|
|
8
|
+
*** Keywords ***
|
|
9
|
+
Log In As
|
|
10
|
+
[Arguments] ${user} ${password}
|
|
11
|
+
POST /auth/login {"username": "${user}", "password": "${password}"}
|
|
12
|
+
Integer response status 200
|
|
13
|
+
${token}= Output response body access_token also_console=false
|
|
14
|
+
Set Headers {"Authorization": "Bearer ${token}"}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Call it in `Suite Setup` when every test uses the same user. For a test that must run unauthenticated, override the header on that request: `GET /me headers={"Authorization": ""}`, then assert `Integer response status 401`.
|
|
18
|
+
|
|
19
|
+
## API keys
|
|
20
|
+
|
|
21
|
+
```robotframework
|
|
22
|
+
*** Test Cases ***
|
|
23
|
+
Api Key In Header
|
|
24
|
+
Set Headers {"X-API-Key": "${API_KEY}"}
|
|
25
|
+
GET /reports
|
|
26
|
+
Integer response status 200
|
|
27
|
+
|
|
28
|
+
Api Key In Query
|
|
29
|
+
GET /reports query={"api_key": "${API_KEY}"}
|
|
30
|
+
Integer response status 200
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Keep keys and passwords out of the suite: pass them with `--variable API_KEY:…` or read them from the environment (`%{API_KEY}`).
|
|
34
|
+
|
|
35
|
+
## Basic, digest and proxy auth
|
|
36
|
+
|
|
37
|
+
```robotframework
|
|
38
|
+
*** Test Cases ***
|
|
39
|
+
Basic Auth
|
|
40
|
+
Set Client Authentication basic ${USER} ${PASSWORD}
|
|
41
|
+
GET /protected
|
|
42
|
+
Integer response status 200
|
|
43
|
+
[Teardown] Set Client Authentication ${NONE}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
`auth_type` is `basic`, `digest`, `proxy` or `${NONE}` (removes it). The credentials appear in the log in plain text.
|
|
47
|
+
|
|
48
|
+
## Client certificates and TLS
|
|
49
|
+
|
|
50
|
+
```robotframework
|
|
51
|
+
*** Settings ***
|
|
52
|
+
Library REST ${API_URL} ssl_verify=${CURDIR}/certs/ca.pem
|
|
53
|
+
|
|
54
|
+
*** Test Cases ***
|
|
55
|
+
Mutual TLS
|
|
56
|
+
Set Client Cert ["${CURDIR}/certs/client.crt", "${CURDIR}/certs/client.key"]
|
|
57
|
+
GET /secure
|
|
58
|
+
Integer response status 200
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
`Set Client Cert` takes a `.pem` path or a cert/key pair; `${None}` clears it. `ssl_verify` (import) and `Set SSL Verify` accept `true`, `false` or a CA bundle path.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Installing RESTinstance
|
|
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 RESTinstance
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
- Package `RESTinstance` (1.8.0, **Python ≥ 3.11**). Module `REST`.
|
|
10
|
+
- Importing it prints `SyntaxWarning: invalid escape sequence` lines from its `flex` dependency on Python 3.12+. They are harmless.
|
|
11
|
+
- Verify: `uv run python -c "import REST"`.
|
robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/json-handling.md
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# Paths, Assertions and Values in RESTinstance
|
|
2
|
+
|
|
3
|
+
- Field paths
|
|
4
|
+
- JSONPath
|
|
5
|
+
- Type keywords and validation arguments
|
|
6
|
+
- Reading values for later requests
|
|
7
|
+
- Request bodies and query parameters
|
|
8
|
+
|
|
9
|
+
## Field paths
|
|
10
|
+
|
|
11
|
+
Every assertion starts at the last instance, the request/response pair recorded by the most recent HTTP keyword. Path parts are separated by single spaces; array indices start at 0.
|
|
12
|
+
|
|
13
|
+
```robotframework
|
|
14
|
+
*** Test Cases ***
|
|
15
|
+
Paths
|
|
16
|
+
GET /users/1
|
|
17
|
+
Integer response status 200
|
|
18
|
+
String response headers Content-Type pattern=^application/json
|
|
19
|
+
String response body name
|
|
20
|
+
String response body address city Berlin
|
|
21
|
+
Integer response body roles 0 id
|
|
22
|
+
Number response seconds maximum=2
|
|
23
|
+
String request method GET
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
`response seconds` is the response time; `request …` paths see what was sent (`request body`, `request query`, `request headers`).
|
|
27
|
+
A path part that does not exist fails with `Expected property '…' was not found.` and logs the object it was looking in.
|
|
28
|
+
|
|
29
|
+
## JSONPath
|
|
30
|
+
|
|
31
|
+
A field that starts with `$` is JSONPath rooted at the response body. A path with wildcards asserts every match:
|
|
32
|
+
|
|
33
|
+
```robotframework
|
|
34
|
+
*** Test Cases ***
|
|
35
|
+
All Items
|
|
36
|
+
GET /users
|
|
37
|
+
Array response body minItems=1
|
|
38
|
+
Integer $[*].id minimum=1
|
|
39
|
+
String $[*].email format=email
|
|
40
|
+
String $[0].name Alice
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
A JSONPath that matches nothing fails with `JSONPath query '…' did not match anything.`
|
|
44
|
+
|
|
45
|
+
## Type keywords and validation arguments
|
|
46
|
+
|
|
47
|
+
`Integer`, `Number`, `String`, `Boolean`, `Null`, `Array` and `Object` assert the JSON type of the field. Extra positional values are the allowed values (JSON Schema `enum`, compared exactly); named arguments are JSON Schema validation keywords for that type:
|
|
48
|
+
|
|
49
|
+
| Type | Useful validation arguments |
|
|
50
|
+
|---|---|
|
|
51
|
+
| `String` | `pattern=`, `format=` (`email`, `date`, `ipv4`; other formats are only checked when `jsonschema`'s optional format packages are installed), `minLength=`, `maxLength=` |
|
|
52
|
+
| `Integer` / `Number` | `minimum=`, `maximum=`, `exclusiveMinimum=`, `multipleOf=` |
|
|
53
|
+
| `Array` | `minItems=`, `maxItems=`, `uniqueItems=true` |
|
|
54
|
+
| `Object` | `required=["id", "name"]`, `additionalProperties=false`, `minProperties=` |
|
|
55
|
+
| all | `nullable=true` (type or null), `skip=true` (update the schema, don't assert) |
|
|
56
|
+
|
|
57
|
+
`Boolean` takes one value: `Boolean response body active true`. `Missing response body error` passes when the property is absent.
|
|
58
|
+
An unknown validation keyword fails with `Unknown JSON Schema (draft-07) validation keyword for <type>`.
|
|
59
|
+
|
|
60
|
+
## Reading values for later requests
|
|
61
|
+
|
|
62
|
+
`Output` returns the value at a path (and prints it; `also_console=false` keeps the console quiet). The type keywords return a list of all matches.
|
|
63
|
+
|
|
64
|
+
```robotframework
|
|
65
|
+
*** Test Cases ***
|
|
66
|
+
Create Then Read
|
|
67
|
+
POST /users {"name": "Bo", "email": "bo@example.com"}
|
|
68
|
+
Integer response status 201
|
|
69
|
+
${id}= Output response body id also_console=false
|
|
70
|
+
GET /users/${id}
|
|
71
|
+
Integer response status 200
|
|
72
|
+
String response body name Bo
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Request bodies and query parameters
|
|
76
|
+
|
|
77
|
+
The body is the second argument of `POST`/`PUT`/`PATCH` (and optional on `DELETE`): a JSON string, a dictionary, or a path to a JSON file. RESTinstance sends it as JSON with `Content-Type: application/json` (the import default).
|
|
78
|
+
|
|
79
|
+
```robotframework
|
|
80
|
+
*** Test Cases ***
|
|
81
|
+
Bodies And Queries
|
|
82
|
+
VAR &{user} name=Bo email=bo@example.com
|
|
83
|
+
POST /users ${user}
|
|
84
|
+
POST /users ${CURDIR}/data/new_user.json
|
|
85
|
+
GET /users query={"page": "2", "limit": "10"}
|
|
86
|
+
GET /users?page=2
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
`data=` (a dictionary, bytes or a file path) exists, but the import default header `Content-Type: application/json` is still sent with it. For form-encoded or multipart requests use rf-requests, which sets those headers itself.
|
robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/loose-assertions.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Loose assertions
|
|
2
|
+
|
|
3
|
+
A check that cannot fail gives a green run against a broken API. Each pattern below passes when the endpoint returns the wrong data, so do not use one as the only check on a response.
|
|
4
|
+
|
|
5
|
+
## Patterns to avoid
|
|
6
|
+
|
|
7
|
+
| Loose check | Why it passes on a broken endpoint | Assert this instead |
|
|
8
|
+
|---|---|---|
|
|
9
|
+
| `Object response body required=["id"]` alone | it proves the key exists, not its value | `String response body name Alice` for the value, `Integer response body id minimum=1` for the range |
|
|
10
|
+
| `Integer response body id` alone | any integer passes | the value the test expects, or the bound the contract sets |
|
|
11
|
+
| `Integer response status 200` alone after a write | the server can accept the request and store something else | a `GET` of the new record, then the field checks |
|
|
12
|
+
|
|
13
|
+
## Rules
|
|
14
|
+
|
|
15
|
+
- Use the exact expected value for each field the test cares about.
|
|
16
|
+
- Use types and constraints for shape only, never as the only check of a value.
|
|
17
|
+
- Prove a new check can fail: change the expected value once, run the test, confirm it turns red, then restore the value.
|
|
18
|
+
- After a write, check the stored result with a read-back, not with the write's own status.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Migrating from RequestsLibrary to RESTinstance
|
|
2
|
+
|
|
3
|
+
A keyword map for moving API suites from RequestsLibrary to RESTinstance. Verify each replacement with `robotcode doc keyword <Library> "<Keyword>"` before you use it; argument orders differ.
|
|
4
|
+
|
|
5
|
+
| RequestsLibrary | RESTinstance | Note |
|
|
6
|
+
|---|---|---|
|
|
7
|
+
| `GET On Session api /path` | `GET /path` | base URL in the library import |
|
|
8
|
+
| `POST On Session api /path json=${data}` | `POST /path ${data}` | |
|
|
9
|
+
| `expected_status=200` | `Integer response status 200` | assertion after the request |
|
|
10
|
+
| `${resp.json()}[key]` | `String response body key` | typed field assertions |
|
|
11
|
+
| manual schema checks | `Expect Response Body schema.json` | |
|
|
12
|
+
|
|
13
|
+
RESTinstance keeps expectations and headers for the whole suite; see `rf-restinstance`.
|
|
14
|
+
|
|
15
|
+
After each file, check it with `robotcode analyze code` and run the affected tests by longname. The `rf-migration-guide` subagent (plugin `rf-core`) runs the phased migration and reports each file as migrated or unverified.
|
robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/schema-validation.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# Schemas, Expectations and OpenAPI in RESTinstance
|
|
2
|
+
|
|
3
|
+
- How RESTinstance uses JSON Schema
|
|
4
|
+
- Learning a schema from a response
|
|
5
|
+
- Expectations
|
|
6
|
+
- Scoping expectations
|
|
7
|
+
- OpenAPI specs
|
|
8
|
+
|
|
9
|
+
## How RESTinstance uses JSON Schema
|
|
10
|
+
|
|
11
|
+
Every request creates an instance whose schema starts as the one inferred from the response. Each type keyword (`Integer`, `String`, …) tightens the schema of the field it asserts and then validates the value against it. The schema is draft-07 by default; `format=` values are checked with `jsonschema`'s format checker.
|
|
12
|
+
|
|
13
|
+
Two ways to check a whole body against a contract:
|
|
14
|
+
|
|
15
|
+
| Approach | When |
|
|
16
|
+
|---|---|
|
|
17
|
+
| `Expect Response Body` with a schema file, set before the request | The contract is written down or was learned once; it should hold for several requests |
|
|
18
|
+
| `Object response body required=[…]` plus field assertions after the request | One-off checks in a single test |
|
|
19
|
+
|
|
20
|
+
## Learning a schema from a response
|
|
21
|
+
|
|
22
|
+
Let RESTinstance write the schema of a real response, review it (drop `default` values and anything that changes between runs), commit it and use it as an expectation:
|
|
23
|
+
|
|
24
|
+
```robotframework
|
|
25
|
+
*** Test Cases ***
|
|
26
|
+
Learn User Schema
|
|
27
|
+
GET /users/1
|
|
28
|
+
Output Schema response body file_path=${CURDIR}/schemas/user.json also_console=false
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
The learned schema lists every property as `required` and records the observed values as `default`, so it describes this one response. Loosen it by hand before using it for other records.
|
|
32
|
+
|
|
33
|
+
## Expectations
|
|
34
|
+
|
|
35
|
+
`Expect Response Body` merges the given schema (inline JSON, dictionary or file path) into the response body schema; the next HTTP keyword validates the response against it and fails itself when the body does not match:
|
|
36
|
+
|
|
37
|
+
```robotframework
|
|
38
|
+
*** Test Cases ***
|
|
39
|
+
Users Match The Contract
|
|
40
|
+
Expect Response Body ${CURDIR}/schemas/user.json
|
|
41
|
+
GET /users/1
|
|
42
|
+
Integer response status 200
|
|
43
|
+
GET /users/2
|
|
44
|
+
Integer response status 200
|
|
45
|
+
[Teardown] Clear Expectations
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
| Keyword | Validates | Notes |
|
|
49
|
+
|---|---|---|
|
|
50
|
+
| `Expect Response Body` | response body | updates the body schema (merges keys) |
|
|
51
|
+
| `Expect Response` | whole response (`status`, `headers`, `body`, `seconds`) | replaces the response schema; `merge=true` merges |
|
|
52
|
+
| `Expect Request` | what was sent (`body`, `query`, `headers`) | checked after the request is sent; fails the HTTP keyword |
|
|
53
|
+
| `Clear Expectations` | — | resets request and response expectations |
|
|
54
|
+
|
|
55
|
+
`validate=false` on one HTTP keyword skips expectations and the OpenAPI spec for that request.
|
|
56
|
+
|
|
57
|
+
Inline schemas are handy for small contracts:
|
|
58
|
+
|
|
59
|
+
```robotframework
|
|
60
|
+
*** Test Cases ***
|
|
61
|
+
Only Known Properties
|
|
62
|
+
Expect Response Body {"required": ["id", "name"], "additionalProperties": false}
|
|
63
|
+
GET /users/1
|
|
64
|
+
[Teardown] Clear Expectations
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Scoping expectations
|
|
68
|
+
|
|
69
|
+
The library instance lives for the whole suite, so expectations stay active for all later requests and tests in that suite until `Clear Expectations`. Two workable patterns:
|
|
70
|
+
|
|
71
|
+
- Per test: set the expectation in the test and clear it in `[Teardown]` (above).
|
|
72
|
+
- Per suite: set endpoint-wide rules with `Expect Response` in `Suite Setup` and extend them in a test with `Expect Response Body`; then every request in the suite has to satisfy them, including negative tests, which may need `validate=false`.
|
|
73
|
+
|
|
74
|
+
A new suite gets a fresh library instance, so expectations never cross suite boundaries.
|
|
75
|
+
|
|
76
|
+
## OpenAPI specs
|
|
77
|
+
|
|
78
|
+
Give the spec (JSON or YAML file, OpenAPI 3.x) on import; every request and response is then validated against the matching operation, and a mismatch fails the HTTP keyword:
|
|
79
|
+
|
|
80
|
+
```robotframework
|
|
81
|
+
*** Settings ***
|
|
82
|
+
Library REST ${API_URL} spec=${CURDIR}/openapi.yaml
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Swagger 2.0 specs still load but log a deprecation warning. Paths in the spec must match the URLs you call (including the server URL).
|
robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/troubleshooting.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# RESTinstance Troubleshooting
|
|
2
|
+
|
|
3
|
+
Error message → cause → fix. For installation and import problems (`No module named 'REST'`, Python version) use rf-setup (plugin rf-core).
|
|
4
|
+
|
|
5
|
+
- No instances: No requests made
|
|
6
|
+
- Expected property '…' was not found
|
|
7
|
+
- '…' is not one of [...]
|
|
8
|
+
- '…' is a required property, on a request that used to pass
|
|
9
|
+
- SSL certificate verify failed
|
|
10
|
+
- timed out
|
|
11
|
+
- Input is not valid JSON
|
|
12
|
+
- Input not is valid JSON, on a pattern
|
|
13
|
+
- Unknown JSON Schema validation keyword
|
|
14
|
+
- Response body content is not JSON
|
|
15
|
+
- Library import fails or requests go to the wrong host
|
|
16
|
+
- Finding what was sent and received
|
|
17
|
+
|
|
18
|
+
## No instances: No requests made
|
|
19
|
+
|
|
20
|
+
An assertion ran before any HTTP keyword in this suite. The instance list is per suite, so a request made in another suite does not count. Send the request first.
|
|
21
|
+
|
|
22
|
+
## Expected property '…' was not found
|
|
23
|
+
|
|
24
|
+
The path does not exist in the last response. Paths start with `response` (`response body id`, not `body id` or `id`), use single spaces between parts, and use numeric parts for arrays (`response body items 0 name`). Log the response with `Output response body` and copy the path from it. A JSONPath field (`$…`) that matches nothing fails with `did not match anything` instead.
|
|
25
|
+
|
|
26
|
+
## '…' is not one of [...]
|
|
27
|
+
|
|
28
|
+
Values after the path are an exact enum. Wildcards (`Ali*`), regexes (`/^A/`) and JSON Schemas are compared literally. Use `pattern=`, `minimum=`, `required=` and the other validation arguments, or pass the exact value. Numbers written as `200` are converted for `Integer`/`Number`; `${200}` also works.
|
|
29
|
+
|
|
30
|
+
## '…' is a required property, on a request that used to pass
|
|
31
|
+
|
|
32
|
+
An expectation set earlier in the suite (`Expect Response Body`, `Expect Response`, `Expect Request`, often from another test) is still active and validates this response. Add `[Teardown] Clear Expectations` to the test that sets it, or `validate=false` on a request that is meant to break the contract (negative tests).
|
|
33
|
+
|
|
34
|
+
## SSL certificate verify failed
|
|
35
|
+
|
|
36
|
+
The server certificate is self-signed or signed by a private CA. Point `ssl_verify` at the CA bundle on import (`ssl_verify=${CURDIR}/ca.pem`); only for throwaway test environments use `Set SSL Verify false`.
|
|
37
|
+
|
|
38
|
+
## timed out
|
|
39
|
+
|
|
40
|
+
There is no timeout by default, so a hanging server blocks the test until the Robot Framework test timeout. Pass `timeout=5` on the request (connect and read) to fail fast, then check the server.
|
|
41
|
+
|
|
42
|
+
## Input is not valid JSON
|
|
43
|
+
|
|
44
|
+
The full message is `Input is not valid JSON or a file`: a `query=`, `headers=`, `Set Headers` or schema argument is neither valid JSON nor an existing file path. Common causes: single quotes (`{'a': 1}`), a file path relative to the working directory instead of `${CURDIR}`, or a variable value that contains quotes. Build dictionaries with `VAR &{body} …` and pass `${body}`.
|
|
45
|
+
|
|
46
|
+
A request body is more forgiving and therefore more dangerous: `POST /users {'a': 1}` is not rejected but sent as the JSON string `"{'a': 1}"`. Check `Output request body` when the server answers 400 or 422.
|
|
47
|
+
|
|
48
|
+
## Input not is valid JSON, on a pattern
|
|
49
|
+
|
|
50
|
+
String values and validation arguments are decoded as JSON strings (the library adds the quotes), so a backslash starts a JSON escape. `pattern=^\\d+` in a `.robot` file reaches RESTinstance as `^\d+`, which is not a valid JSON string. Write `pattern=^\\\\d+`, or use a character class such as `[0-9]`.
|
|
51
|
+
|
|
52
|
+
## Unknown JSON Schema validation keyword
|
|
53
|
+
|
|
54
|
+
The named argument is not a draft-07 keyword for that type (for example `minLength=` on `Integer`, or `min=`). Check the table of validation arguments for the type.
|
|
55
|
+
|
|
56
|
+
## Response body content is not JSON
|
|
57
|
+
|
|
58
|
+
A warning, not a failure: the body is kept as a string, so `Object`/`Array` assertions on it fail. Assert the status and `String response body` instead, or check that the endpoint and `Accept` header are right.
|
|
59
|
+
|
|
60
|
+
## Library import fails or requests go to the wrong host
|
|
61
|
+
|
|
62
|
+
Import arguments are resolved before `Suite Setup` runs, so a `${API_URL}` that a setup keyword sets is still undefined at import. Define it in `*** Variables ***` or with `--variable`, or import `REST` without a URL and call full URLs. A URL without a scheme is prefixed with `http://`.
|
|
63
|
+
|
|
64
|
+
## Finding what was sent and received
|
|
65
|
+
|
|
66
|
+
- `Output` with no argument prints the last request and response.
|
|
67
|
+
- `Output Schema` prints the schema built so far for the last instance.
|
|
68
|
+
- `REST Instances ${OUTPUT DIR}/instances.json` writes every request, response and schema of the suite to a file, useful when a later test fails because of an earlier one.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "rf-core",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Robot Framework syntax, environment setup, Python keyword libraries, test design, debugging and migration subagents, and the validation hooks. Needed by every other Robot Framework plugin.",
|
|
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
|
+
"automation",
|
|
16
|
+
"robocop",
|
|
17
|
+
"robotcode"
|
|
18
|
+
]
|
|
19
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
The `rf-core` plugin, versioned on its own (`rf-core--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-language`, `rf-setup` and `rf-python-library`, the `rf-test-architect`, `rf-debug-expert` and `rf-migration-guide` subagents, and all hooks. Skill names are unchanged; their plugin prefix is now `rf-core:` instead of `rf-agentskills:`, for example `/rf-core:rf-language`.
|
|
8
|
+
|
|
9
|
+
- **Library install steps moved to the library skills.** `rf-setup` keeps environments, uv, pip, Poetry, robotcode, Robocop and troubleshooting, and a table naming each library's package, install command, skill and plugin.
|
|
10
|
+
- **Library migration tables moved** to `rf-browser` (plugin `rf-web`) and `rf-restinstance` (plugin `rf-api`); `rf-migration-guide` routes library moves there.
|
|
11
|
+
- **Core names the plugin of every library skill**, and the subagents, hooks and `rf-setup` suggest installing the plugin when its skill is missing.
|
|
12
|
+
- **Formatting drift is opt-in.** The per-file hook runs `robocop format --check --diff` only with `RF_AGENTSKILLS_FORMAT_CHECK=1`. Shown a diff, agents reformatted files that were otherwise correct.
|
|
13
|
+
- **The Stop test reminder stays quiet once the suite has run** (`robot`, `python -m robot` or `robotcode robot`, dry runs included) after the last `.robot`/`.resource` write. Its first step now says to run the tests where they can run.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# rf-core plugin
|
|
2
|
+
|
|
3
|
+
What every coding agent needs to automate Robot Framework, whatever the system under test: the `rf-language`, `rf-setup` and `rf-python-library` skills, the `rf-test-architect`, `rf-debug-expert` and `rf-migration-guide` subagents, and the validation and context hooks. The library skills come in the technology plugins `rf-web`, `rf-api`, `rf-mobile` and `rf-desktop`, which depend on this one. 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-core --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
|
+
## Requires robotcode
|
|
14
|
+
|
|
15
|
+
Install `robotcode[all]>=2.8` in the project's Python environment, next to Robot Framework. Don't use `uvx`, `pipx` or `uv tool` for it: an isolated robotcode cannot see the project's libraries.
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
uv add --dev "robotcode[all]>=2.8" # uv
|
|
19
|
+
poetry add --group dev "robotcode[all]>=2.8" # Poetry
|
|
20
|
+
pip install "robotcode[all]>=2.8" # venv + pip (venv active)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The `all` extra is needed because it is the only one that brings everything the skills and hooks run: `runner` (`robot`, `discover`, `results`, `libdoc`), `analyze` (`analyze code`), `repl` (`doc`, `repl`, `robot-debug`) and Robocop. A CI job that only runs tests can use `robotcode[runner]`. The `rf-setup` skill installs it for you.
|
|
24
|
+
|
|
25
|
+
## Recommended companion: the robotcode plugin
|
|
26
|
+
|
|
27
|
+
The RobotCode project publishes `robotcode@robotframework-agent-plugins`, which teaches agents to drive the robotcode CLI. Install it next to this plugin:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
claude plugin marketplace add robotcodedev/robotframework-agent-plugins
|
|
31
|
+
claude plugin install robotcode@robotframework-agent-plugins
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
(`copilot plugin …` and `codex plugin marketplace add … / codex plugin add …` work the same way. The RobotCode VS Code extension already bundles it for Copilot Chat.) This plugin does not declare a dependency on it, so it loads either way.
|
|
35
|
+
|
|
36
|
+
| The robotcode plugin owns | rf-core owns |
|
|
37
|
+
|---|---|
|
|
38
|
+
| running, discovery, keyword documentation, result analysis, static analysis, `robot.toml` configuration, the REPL and the debugger | Robot Framework syntax (`rf-language`), Python keyword libraries (`rf-python-library`), environment setup (`rf-setup`), the validation hooks, and the `rf-test-architect`, `rf-debug-expert` and `rf-migration-guide` subagents |
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rf-debug-expert
|
|
3
|
+
description: Diagnoses failing or flaky Robot Framework runs without editing files. Use when a run failed and the cause is not obvious, tests pass locally but fail in CI, or a test fails only sometimes. Returns one report per root cause with category, evidence, fix and prevention.
|
|
4
|
+
tools: Read, Grep, Glob, Bash
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Robot Framework Debug Expert
|
|
8
|
+
|
|
9
|
+
You diagnose Robot Framework failures and report them; you do not edit files. You read
|
|
10
|
+
the recorded results first, group the failures by cause, classify each cause, prove it
|
|
11
|
+
when the log is not enough, and return one report block per cause. The calling agent
|
|
12
|
+
applies the fix and re-runs the tests.
|
|
13
|
+
|
|
14
|
+
## Diagnosis method (agent-owned)
|
|
15
|
+
|
|
16
|
+
### 1. Read the recorded run before guessing
|
|
17
|
+
|
|
18
|
+
- `robotcode results summary --failed`, then `robotcode results show --failed`: one line
|
|
19
|
+
per failing test with its full longname and message.
|
|
20
|
+
- `robotcode results log -bl "<longname>" --max-depth 2`: the keyword tree of one test.
|
|
21
|
+
- When a rerun is needed, keep the full run's output file under its own name
|
|
22
|
+
(`robotcode robot --output results/full.xml`) and read it with `-o results/full.xml`;
|
|
23
|
+
every later run, including the debugger, overwrites the default `output.xml`.
|
|
24
|
+
- Don't read or grep raw `output.xml`.
|
|
25
|
+
|
|
26
|
+
### 2. Group failures by cause
|
|
27
|
+
|
|
28
|
+
Failures that share a message, a keyword or a suite are one cause until proven otherwise
|
|
29
|
+
(`robotcode results stats --by suite --failed`). Diagnose each cause once.
|
|
30
|
+
|
|
31
|
+
Give each group a fingerprint: take the error message, keep the status codes and counts, replace concrete ids with a placeholder, and drop hosts, query strings and timestamps. Keep endpoint paths as templates (`/orders/{id}`, not `/orders/42`). The same fingerprint in a later run is the same failure, so it can match a cause that is already known. Put the fingerprint in the bug title or report, not only in a file name.
|
|
32
|
+
|
|
33
|
+
### 3. Classify each cause
|
|
34
|
+
|
|
35
|
+
| Failure pattern | Category | Typical cause |
|
|
36
|
+
|---|---|---|
|
|
37
|
+
| element not found, strict mode violation | Locator | wrong selector, element not rendered, iframe or shadow DOM |
|
|
38
|
+
| timeout while waiting | Timing | page or request not finished, animation, missing wait condition |
|
|
39
|
+
| `!=`, "should be", assertion message | Assertion | wrong expectation, stale data, race condition |
|
|
40
|
+
| connection refused, DNS, 5xx | Environment | service down, wrong URL, proxy |
|
|
41
|
+
| "No keyword with name", "Multiple keywords" | Keyword resolution | missing import, typo, name conflict, embedded-argument mismatch |
|
|
42
|
+
| "contains no keywords", import error of a library | Library | Python library defect or wrong python-path |
|
|
43
|
+
| session or driver errors | Driver | driver or browser crash, version mismatch |
|
|
44
|
+
| passes and fails on the same code | Flakiness | timing, shared state, test order, external dependency |
|
|
45
|
+
|
|
46
|
+
### 4. Prove the cause only when the log doesn't
|
|
47
|
+
|
|
48
|
+
Debug one representative test per cause, scoped by longname and without overwriting the
|
|
49
|
+
kept output file:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
robotcode robot-debug -bl "<longname>" --output NONE --log NONE --report NONE
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
At the `(rdb)` stop use `.where`, `.vars` and `.print ${x}`, run keywords in the paused
|
|
56
|
+
context, and end with `.continue`, `.detach` or `.abort`. Run one debugger session at a
|
|
57
|
+
time. A failure that only happens in the full run (state leaking between tests) needs the
|
|
58
|
+
whole directory with `--break-on-failed-test` instead of one longname.
|
|
59
|
+
|
|
60
|
+
### 5. Flakiness: structural fixes only
|
|
61
|
+
|
|
62
|
+
| Pattern | Symptom | Fix |
|
|
63
|
+
|---|---|---|
|
|
64
|
+
| Asynchronous UI | passes locally, fails in CI | wait for the condition that proves readiness (element state, response, text) with the library's waiting keyword |
|
|
65
|
+
| Shared state | test B fails only after test A | isolate state in Setup/Teardown, a new browser context or session per test |
|
|
66
|
+
| Test data collisions | tests fail when run in parallel | unique identifiers per test, no shared records |
|
|
67
|
+
| Stale element | element reference invalid after re-render | re-query the element right before using it |
|
|
68
|
+
| External dependency | random 5xx or slow responses | stub or isolate the dependency; mark the test and report it |
|
|
69
|
+
|
|
70
|
+
Retry loops and longer timeouts hide the cause; recommend them only as a documented
|
|
71
|
+
temporary measure after the root cause is named.
|
|
72
|
+
|
|
73
|
+
### 6. Rule out the test before reporting an app or environment cause
|
|
74
|
+
|
|
75
|
+
Check these before a cause is reported as an app or environment defect. Each one is a common way to blame the system for a problem in the test.
|
|
76
|
+
|
|
77
|
+
- **Read the comparison in the right order.** RequestsLibrary puts the actual value first: in `Expected status: 400 != 200` the server answered 400 and the test expected 200. Other libraries order it differently, so check the library before reading the message. It does not show that validation stopped working.
|
|
78
|
+
- **Find the step that failed.** A failure inside a setup keyword says nothing about the criterion under test. Open the failing keyword chain and name the step.
|
|
79
|
+
- **Outage first.** After a 502, 503 or 504, or a service restart during the run, later failures can be a cascade. Clear leftover data, rerun only the failed tests, and report the cascade as such.
|
|
80
|
+
- **Shared state inside one test.** Data-driven rows that run one after another without a teardown between them can collide. Give each row its own data.
|
|
81
|
+
- **Long runs.** A 401 late in a long run usually means an expired token. Renew the token and rerun.
|
|
82
|
+
- **Absent is not null.** A missing key fails a null check. Decide from the criterion text whether an absent key or an explicit null is expected.
|
|
83
|
+
- **Correlation is not cause.** One crash during a test is a lead. Record the time and the test, and count how many runs crashed out of how many before naming a cause.
|
|
84
|
+
- **Trace the expected value.** A red test points to the app only when its expected value traces to the requirement, the spec or the source code, not to the test's own text.
|
|
85
|
+
|
|
86
|
+
## Routing
|
|
87
|
+
|
|
88
|
+
| Work | Skill |
|
|
89
|
+
|------|-------|
|
|
90
|
+
| Name conflicts, embedded-argument mismatches, `__init__.robot` setup visibility, variable scope | `rf-language` |
|
|
91
|
+
| "contains no keywords", library scope losing state between tests, listener errors | `rf-python-library` |
|
|
92
|
+
| Locators, waits and library-specific errors | `rf-browser` / `rf-selenium` (plugin `rf-web`), `rf-requests` / `rf-restinstance` (plugin `rf-api`), `rf-appium` (plugin `rf-mobile`), `rf-platynui` (plugin `rf-desktop`) |
|
|
93
|
+
| Missing packages, interpreter or environment errors, robotcode missing | `rf-setup` |
|
|
94
|
+
| Keyword names and arguments | `robotcode doc keyword <Library> "<Keyword>"` |
|
|
95
|
+
| Recorded results, stepping through a test | `robotcode results …`, `robotcode robot-debug -bl` (robotcode plugin) |
|
|
96
|
+
|
|
97
|
+
A library skill ships in a technology plugin that may not be installed. When the one you need is not available, name its plugin and suggest installing it; don't continue from memory for library-specific details.
|
|
98
|
+
|
|
99
|
+
## Output format
|
|
100
|
+
|
|
101
|
+
One block per root cause:
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
FAILURE: [longname(s)]
|
|
105
|
+
FINGERPRINT: [signature from section 2]
|
|
106
|
+
CATEGORY: [Locator | Timing | Assertion | Environment | Keyword resolution | Library | Driver | Flakiness]
|
|
107
|
+
ROOT CAUSE: [one-sentence explanation]
|
|
108
|
+
EVIDENCE: [error message, log line or debugger value]
|
|
109
|
+
FIX: [specific change for the calling agent to make]
|
|
110
|
+
PREVENTION: [pattern recommendation]
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Constraints
|
|
114
|
+
|
|
115
|
+
- Start from the recorded results, not from assumptions.
|
|
116
|
+
- Name the root cause before proposing a fix; a fix without a cause is a guess.
|
|
117
|
+
- Never recommend `Sleep` as a fix; use the library's waiting mechanism.
|
|
118
|
+
- Never propose changing an assertion, expected value or tag to make a test pass. When
|
|
119
|
+
the evidence shows the expectation itself is wrong, say so explicitly in EVIDENCE.
|
|
120
|
+
- Don't write or edit files; return the report.
|