initial commit

Author: jochen-testingbot

.github/workflows/test-python.yml

@@ -0,0 +1,43 @@
+name: Validate RobotFramework App Example
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+jobs:
+  test-robotframework:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - run: |
+          PYTHONPATH=$PYTHONPATH:. robot \
+            --variable PLATFORM:Android \
+            --variable VERSION:14.0 \
+            --variable DEVICE:Pixel.* \
+            --variable APP:https://testingbot.com/appium/sample.apk \
+            test.robot
+        env:
+          TB_KEY: ${{ secrets.TB_KEY }}
+          TB_SECRET: ${{ secrets.TB_SECRET }}
+      - name: Upload Robot Framework reports
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: robot-reports
+          path: |
+            log.html
+            report.html
+            output.xml

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

AppOptions.py

@@ -0,0 +1,11 @@
+from appium.options.android import UiAutomator2Options
+from appium.options.ios import XCUITestOptions
+
+
+def get_app_options(platform):
+	if platform.lower() == "android":
+		return UiAutomator2Options()
+	elif platform.lower() == "ios":
+		return XCUITestOptions()
+	else:
+		raise ValueError(f"Unsupported platform: {platform}")

CLAUDE.md

@@ -0,0 +1,45 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Purpose
+
+Example project showing how to drive a remote Appium session on the TestingBot cloud device grid from Robot Framework to run native mobile app tests. It is intentionally small — one suite (`test.robot`) plus two Python helper libraries.
+
+## Running tests
+
+`PYTHONPATH` must include the repo root so Robot Framework can import the local Python libraries (`AppOptions.py`, `TestingBot.py`) as libraries named `AppOptions` / `TestingBot`.
+
+```
+pip install -r requirements.txt
+export TB_KEY=<key>
+export TB_SECRET=<secret>
+PYTHONPATH=$PYTHONPATH:. robot \
+  --variable PLATFORM:Android \
+  --variable VERSION:14.0 \
+  --variable DEVICE:Pixel.* \
+  --variable APP:https://testingbot.com/appium/sample.apk \
+  test.robot
+```
+
+Run a single test case: add `--test "Simple App Test"` (or `-t`) to the `robot` invocation.
+
+`TB_KEY` / `TB_SECRET` are read from `os.environ` inside `TestingBot.py` — **do not** pass them via `--variable` or embed them in the remote URL, or they will leak into `log.html` / `output.xml`. The four `--variable` args (`PLATFORM`, `VERSION`, `DEVICE`, `APP`) are required — the suite references them with no defaults. CI (`.github/workflows/test-python.yml`) injects `TB_KEY`/`TB_SECRET` via the job's `env:` block from GitHub secrets.
+
+## Architecture
+
+The suite is three pieces that plug together via Robot Framework's `Library` imports:
+
+- **`test.robot`** — declares `AppiumLibrary`, `AppOptions`, and `TestingBot` as libraries. `Test Setup` calls `Get App Options` to get an Appium platform-specific `*Options` object (e.g. `UiAutomator2Options` / `XCUITestOptions`), attaches W3C + Appium capabilities and a `tb:options` dict (TestingBot-specific metadata like build name) via `Call Method ... set_capability`, then hands the configured options off to `Open Testingbot App`. The suite never references credentials.
+
+- **`AppOptions.py`** — factory returning `UiAutomator2Options` / `XCUITestOptions` based on the `PLATFORM` variable. Keeping this in Python (rather than Robot keywords) is deliberate: the test needs a real Appium options *object* to call `set_capability` on.
+
+- **`TestingBot.py`** — owns all TestingBot/credential concerns. Reads `TB_KEY`/`TB_SECRET` from `os.environ`, builds a `selenium.webdriver.remote.client_config.ClientConfig` with basic auth, and creates the remote Appium driver via `appium.webdriver.Remote(...)`. It then registers the driver in the running `AppiumLibrary` instance's `_cache` — this both avoids URL-embedded credentials (which would be logged) and means subsequent AppiumLibrary keywords (`Wait Until Page Contains Element`, `Click Element`, …) just work. `Report Testingbot Status` then reaches into the running `AppiumLibrary` instance for the live `session_id` and PUTs pass/fail to `api.testingbot.com/v1/tests/<session_id>`. This only works while the app session is still open, which is why it runs *before* `Close Application` in the teardown.
+
+Note: `AppiumLibrary`'s own `Open Application` keyword also creates the driver, but only accepts capability kwargs and would require embedding credentials in the remote URL. Registering our own driver in `appium._cache` is the escape hatch that keeps credentials out of the URL and the logs.
+
+When changing capabilities or adding platform-specific flags, edit `test.robot` (capabilities) or `AppOptions.py` (options object construction) — don't try to do it purely in Robot syntax. If you need to change how the driver is created or how auth is handled, that all lives in `TestingBot.py:open_testingbot_app` — keep credentials out of `test.robot` and out of Robot variables.
+
+## Ignorable artifacts
+
+`log.html`, `report.html`, `output.xml`, `.pabotsuitenames`, and `pabot_results/` are generated by `robot`/`pabot` runs and should not be committed or treated as source.

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) TestingBot.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,55 @@
+[![Validate RobotFramework App Example](https://github.com/testingbot/robotframework-app-example/actions/workflows/test-python.yml/badge.svg)](https://github.com/testingbot/robotframework-app-example/actions/workflows/test-python.yml)
+
+## TestingBot RobotFramework Appium Example
+
+TestingBot provides an online grid of real devices and emulators/simulators to run automated native app tests on via Appium.
+This example demonstrates how to use RobotFramework together with [AppiumLibrary](https://docs.robotframework.org/docs/different_libraries/appium) to run a native mobile app test on a remote TestingBot device.
+
+### Environment Setup
+
+1. Setup
+    * Clone the repo
+    * Install the dependencies `pip install -r requirements.txt`
+
+2. TestingBot Credentials
+
+   Retrieve your TestingBot Key and Secret from the [TestingBot Dashboard](https://testingbot.com/members/) and export them as environment variables:
+
+   ```
+   export TB_KEY=<your TestingBot Key>
+   export TB_SECRET=<your TestingBot Secret>
+   ```
+
+3. Upload your app
+
+   Upload your `.apk` or `.ipa` to TestingBot (or host it on a public URL). See [TestingBot App Automate](https://testingbot.com/support/app-automate/help).
+
+4. Run test:
+
+    Android example:
+    ```
+    PYTHONPATH=$PYTHONPATH:. robot \
+      --variable PLATFORM:Android \
+      --variable VERSION:14.0 \
+      --variable DEVICE:Pixel.* \
+      --variable APP:https://testingbot.com/appium/sample.apk \
+      test.robot
+    ```
+
+    iOS example:
+    ```
+    PYTHONPATH=$PYTHONPATH:. robot \
+      --variable PLATFORM:iOS \
+      --variable VERSION:17.0 \
+      --variable DEVICE:iPhone.* \
+      --variable APP:https://testingbot.com/appium/sample.ipa \
+      test.robot
+    ```
+
+
+### Resources
+##### [TestingBot Documentation](https://testingbot.com/support/app-automate)
+
+##### [AppiumLibrary Documentation](https://docs.robotframework.org/docs/different_libraries/appium)
+
+##### [RobotFramework Documentation](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html)

TestingBot.py

@@ -0,0 +1,46 @@
+import os
+import requests
+from appium import webdriver
+from appium.webdriver.client_config import AppiumClientConfig
+from robot.libraries.BuiltIn import BuiltIn
+
+HUB_URL = "https://hub.testingbot.com/wd/hub"
+API_URL = "https://api.testingbot.com/v1/tests/{session_id}"
+
+
+def _credentials():
+	key = os.environ.get("TB_KEY")
+	secret = os.environ.get("TB_SECRET")
+	if not key or not secret:
+		raise RuntimeError("TB_KEY and TB_SECRET environment variables must be set")
+	return key, secret
+
+
+def open_testingbot_app(options):
+	key, secret = _credentials()
+	client_config = AppiumClientConfig(
+		remote_server_addr=HUB_URL,
+		username=key,
+		password=secret,
+	)
+	driver = webdriver.Remote(
+		command_executor=HUB_URL,
+		options=options,
+		client_config=client_config,
+	)
+	appium = BuiltIn().get_library_instance("AppiumLibrary")
+	appium._cache.register(driver, alias="testingbot")
+
+
+def report_testingbot_status(name, status):
+	key, secret = _credentials()
+	appium = BuiltIn().get_library_instance("AppiumLibrary")
+	session_id = appium._current_application().session_id
+	payload = {"test[name]": name, "test[success]": int(status == "PASS")}
+	response = requests.put(
+		API_URL.format(session_id=session_id),
+		data=payload,
+		auth=(key, secret),
+		timeout=30,
+	)
+	assert response.status_code == 200, response.text

requirements.txt

@@ -0,0 +1,4 @@
+robotframework
+robotframework-appiumlibrary
+Appium-Python-Client>=3.0
+requests