Examples

Jetpack Compose - basic test

import io.mobileboost.gptdriver_ktl.GptDriver
import androidx.compose.ui.test.junit4.createComposeRule
import org.junit.Rule
import org.junit.Test

class LoginTest {

    @get:Rule
    val composeTestRule = createComposeRule()

    @Test
    fun testLoginFlow() {
        val gptDriver = GptDriver(
            apiKey = "<YOUR_API_KEY>",
            deviceName = "Emulator",
            platformVersion = "N/A",
            cachingMode = "INTERACTION_REGION",
            testId = "testLoginFlow",
            composeTestRule = composeTestRule
        )

        gptDriver.execute("Tap on the email field and type test@example.com")
        gptDriver.execute("Tap on the password field and type SecurePass123")
        gptDriver.execute("Tap the Sign In button")
        gptDriver.assert("The home screen is displayed with a welcome message")
    }
}

With additional context

val gptDriver = GptDriver(
    apiKey = "<YOUR_API_KEY>",
    deviceName = "Pixel 8",
    platformVersion = "14.0",
    additionalUserContext = "When asked about notifications, tap Allow. Dismiss any marketing banners.",
    cachingMode = "INTERACTION_REGION",
    testId = "testOnboarding",
    composeTestRule = composeTestRule
)

gptDriver.execute("Complete the onboarding by tapping Next on each screen")
gptDriver.execute("Tap Get Started")
gptDriver.assert("The main dashboard is visible")

Data extraction

val gptDriver = GptDriver(
    apiKey = "<YOUR_API_KEY>",
    deviceName = "Emulator",
    platformVersion = "N/A",
    composeTestRule = composeTestRule
)

gptDriver.execute("Navigate to the profile screen")
val values = gptDriver.extract(listOf("username", "email", "plan type"))
val username = values["username"] as? String

Native-first with AI fallback

Run your own Compose code first and let the SDK fall back to AI only when it throws. This is the pattern to reach for in a real suite: stable steps stay fast and deterministic, and a step that breaks because the UI moved keeps the test alive instead of failing it.

@Test
fun testSearch() {
    val gptDriver = GptDriver(
        apiKey = "<YOUR_API_KEY>",
        composeTestRule = composeTestRule,
        testId = "testSearch"
    )

    gptDriver.execute("Tap Search, type 'wireless headphones', and submit") { rule ->
        rule.onNodeWithTag("SearchField").performTextInput("wireless headphones")
        rule.onNodeWithContentDescription("Search").performClick()
    }

    gptDriver.assert("Search results for wireless headphones are shown") { rule ->
        rule.onNodeWithTag("SearchResults").assertExists()
    }
}

Keep the natural language command descriptive of what the native code does. It is the AI fallback and the label the step carries in the session recording, so "Tap the Sign In button" is worth more than "fallback".

Bulk assertions and checks

Verify several things against one screenshot rather than one call each. assertBulk fails the test when any condition is not met; checkBulk returns the results so you can branch on them.

@Test
fun testCartTotals() {
    val gptDriver = GptDriver(
        apiKey = "<YOUR_API_KEY>",
        composeTestRule = composeTestRule,
        testId = "testCartTotals"
    )

    gptDriver.execute("Open the cart")

    gptDriver.assertBulk(
        listOf(
            "The subtotal is 499 USD",
            "The grand total includes shipping",
            "The Place Order button is enabled"
        )
    )

    val results = gptDriver.checkBulk(
        listOf("A promo banner is visible", "A free shipping badge is visible")
    )

    if (results["A promo banner is visible"] == true) {
        gptDriver.execute("Dismiss the promo banner")
    }
}

Reporting the test result

Report the outcome so each run is recorded as passed or failed rather than as auto-completed, and so the session’s slot against your account’s parallel session limit is released as soon as the test ends. A JUnit TestWatcher sees both outcomes, and its failed hook hands you the throwable, so the dashboard gets the reason rather than a bare “Failed”.

import io.mobileboost.gptdriver_ktl.GptDriver
import androidx.compose.ui.test.junit4.createComposeRule
import org.junit.Before
import org.junit.Rule
import org.junit.Test
import org.junit.rules.TestWatcher
import org.junit.runner.Description

class CheckoutTest {

    @get:Rule
    val composeTestRule = createComposeRule()

    private lateinit var gptDriver: GptDriver

    @get:Rule
    val reportOutcome = object : TestWatcher() {
        override fun succeeded(description: Description) {
            if (::gptDriver.isInitialized) gptDriver.setSessionSucceeded()
        }

        override fun failed(e: Throwable, description: Description) {
            if (::gptDriver.isInitialized) gptDriver.setSessionFailed(e)
        }
    }

    @Before
    fun setUp() {
        gptDriver = GptDriver(
            apiKey = "<YOUR_API_KEY>",
            composeTestRule = composeTestRule,
            testId = "checkout"
        )
    }

    @Test
    fun testCheckout() {
        gptDriver.execute("Add the first product to the cart")
        gptDriver.execute("Open the cart and tap Checkout")
        gptDriver.assert("The order confirmation screen is displayed")
    }
}

The isInitialized guard matters: if setUp itself fails there is no driver to report through, and without it the watcher would throw over the real failure.

With CI metadata

Record what your CI knows and the SDK does not, so a session can be found again by it and reporting can be sliced by it.

val gptDriver = GptDriver(
    apiKey = "<YOUR_API_KEY>",
    composeTestRule = composeTestRule,
    testId = "testCheckout",
    metadata = mapOf(
        "branch" to BuildConfig.GIT_BRANCH,
        "commit" to BuildConfig.GIT_SHA,
        "job" to BuildConfig.CI_JOB_ID
    )
)

Values are strings, so convert anything else before passing it. Keys are free-form apart from language and version, which the SDK reserves to report itself. An instrumentation test cannot read the CI environment directly, so feed the values in through buildConfigField in your build.gradle.kts, or through InstrumentationRegistry.getArguments() if you pass them with -Pandroid.testInstrumentationRunnerArguments.

Local tooling

Agent skill

MCP

SDK

Jetpack Compose - basic test

With additional context

Data extraction

Native-first with AI fallback

Bulk assertions and checks

Reporting the test result

With CI metadata

​Jetpack Compose - basic test

​With additional context

​Data extraction

​Native-first with AI fallback

​Bulk assertions and checks

​Reporting the test result

​With CI metadata

Jetpack Compose - basic test

With additional context

Data extraction

Native-first with AI fallback

Bulk assertions and checks

Reporting the test result

With CI metadata