Beta. Script runs are being tried with a few teams first. Android apps with UiAutomator2, and iOS apps with XCUITest on iPhone simulators. Ask the Minitap team to turn them on for your workspace.
Set up
Open Settings → Test frameworks and tick Appium. The setup walks you through the same three things:- An API key. Your tests sign in with a workspace API key. Keep it in your CI’s secret store as
MINITAP_API_KEY. - The app ID. The app the results belong to. Copy it from the setup; it isn’t a secret.
- The hub URL. Shown in the setup. Your tests open their session there.
minitap://build/<build id>, or the https:// URL of an APK. For an iOS app, see iOS.
WebdriverIO
Point the WebdriverIO runner at the hub and report each test inafterTest. Don’t add the Appium service: Minitap runs Appium for you.
Robot Framework
With AppiumLibrary, open the app on the hub in the test setup and report in the teardown:minitap:setStatus’s fields as named arguments: Execute Script sends them as the one object the command expects. Robot’s output.xml, log.html and report.html are written as usual. For iOS, use platformName=iOS, appium:automationName=XCUITest and an iOS build; in AppiumLibrary, iOS predicate locators are written predicate=label == "Sign In".
Capabilities
Your other
appium:* capabilities go to Appium as they are. appium:automationName must be UiAutomator2 on Android and XCUITest on iOS. Minitap keeps the capabilities you sent with each test, except the API key and anything named like a key, token, secret, password or credential.
Report each test
Minitap sees WebDriver commands, not tests, so tell it how the test went before you quit the driver:status is passed or failed, reason is what you’d read in the test report. A session that never calls it shows No status reported. The test’s status is yours: Minitap never changes it. When something goes wrong on Minitap’s side (no device, the app didn’t install, the session timed out), the test also shows a Minitap issue with the reason, apart from its status.
How tests form a run
Each WebDriver session is one test. Tests that share aminitap:runName form one run in Script runs, so set it from your CI’s run id, for example ${{ github.run_id }} in GitHub Actions or $CI_PIPELINE_ID in GitLab. Without a run name, tests on the same minitap:commitSha form one run, and a test with neither stands alone.
Choose the device
Script runs use Android emulators and iPhone simulators. Without device capabilities, an Android test runs on an Android 15 phone emulator and an iOS test on an iOS 27 iPhone simulator. Pick another one with:
Names that local setups often carry, like
Android Emulator, emulator-5554 or iPhone Simulator, don’t pick a model, so you can keep them. A device that doesn’t exist refuses the session with a message naming what you asked for.
A run never mixes devices of a platform. Its first test to get a device sets it, and every later test of the run gets the same one, waiting for it when it’s busy rather than running somewhere else. A later test asking for another device is refused: give it its own minitap:runName to run it apart. Android and iOS tests can share a run, each platform on its own device.
iOS
iOS tests run unchanged on an iPhone simulator, with XCUITest.minitap:setStatus included, is the same as on Android. A few things differ:
- The build is a simulator build: an
.appbuilt for the iOS simulator, zipped as.app.zip. A device.ipacan’t run on a simulator, and a test given one, or an Android build, is refused with a message naming the build. - Minitap installs the app before the test starts, and opens it. Installing another app during the test (
mobile: installApp) is refused. - Minitap records the screen, like on Android. Appium’s own screen recording (
mobile: startRecordingScreen) isn’t available. - Minitap sets how Appium reaches the simulator: the capabilities you’d use for a local WebDriverAgent (
appium:webDriverAgentUrl,appium:usePreinstalledWDA,appium:udid…) are ignored.
Coming soon. iPads, physical iPhones, app permissions (
mobile: setPermission) and the device’s system log aren’t available on iOS yet. A test asking for an iPad is refused.How many tests run at once
Your workspace runs as many tests at once as its plan allows. Start more than that, say 30 tests on a plan of 10 devices, and the first 10 run while the others wait their turn, first come first served. Each one starts as soon as a device frees up. A waiting test waits at most itsappium:newCommandTimeout. Past it, the session is refused with a message naming the device, how many tests asked for one and how many your workspace has, and the test shows a Minitap issue. For a long suite, raise appium:newCommandTimeout (up to 900 seconds), and make sure your Appium client’s own HTTP timeout is at least as long.
Once a test gets its device, it has 30 seconds to send its first command, whatever its appium:newCommandTimeout. A session that sends none is taken for a client that gave up waiting: it ends and its device goes to the next test. Appium clients send their first command right away, so this only matters if your test pauses between creating the driver and using it.
Read the results
Open Results → Script runs. Each run lists its tests with their status, failure reason and any Minitap issue. Open a test to watch its recording and read its Appium log, and download the run as a JUnit report. From the terminal, the CLI reads the same thing:How long we keep them
After 30 days, a test’s Appium log reads as deleted.
