Sign in

Generate test automation

Write the automation code for a test that has a description but no working test file yet. Explores the app on a device, writes the test, verifies it by running it several times in a row, and commits it to the organisation's test repository, after which the test is runnable via POST /tests/execute. By default this targets the newest build uploaded for every platform the organisation has one for; pass uploadId, bundleId, or platform to narrow that. Generation is fire-and-forget: it queues on the organisation's existing device slots and the response returns as soon as the work is dispatched, not once it finishes.

post/tests/generate

Request body

organisationIdstring required

Your MobileBoost organisation ID.

testIdsstring[] required

IDs of existing test cases to write automation for. Each test must already have a description, since generation writes code for the described behaviour rather than inventing one.

uploadIdstring

Write the automation against a specific uploaded build instead of the organisation's newest one.

bundleIdstring

Write the automation against the app already installed on your reserved device, instead of an uploaded build. May omit platform, which is then taken from the reserved device.

platformstring

Restrict generation to one platform (ios or android). Taken from the upload when omitted with uploadId; with neither uploadId nor bundleId, omitting this generates against every platform the organisation has a build for.

testsRepostring

Override the organisation's managed test repository. Normally left unset, since generation resolves the repo automatically and creates one if the organisation doesn't have one yet.

usePhysicalDeviceboolean

Run the generation on a physical device instead of a simulator/emulator. Forced on automatically for iOS .ipa builds and for bundle-only (buildless) generation.

verificationRoundsinteger

How many consecutive passing runs the generated test must produce before it is committed. Defaults to 3. Raising this increases confidence at the cost of one full test run per extra round.

tunnelNamestring

Name of the tunnel to route the device through, for apps whose flow touches an internal/non-public host.

Response

Successful response

startedobject[]

The generation run that was dispatched immediately, for the first platform.

queuedstring[]

Platforms queued to start once the first platform's generation finishes (only present when a test needs automation on more than one platform).

Changes