Android

dependencies {
    androidTestImplementation("dev.tracera:tracera-android:<version>")
    // Optional — richer screenshots (quality/scale) + hierarchy via UiDevice:
    // androidTestImplementation("androidx.test.uiautomator:uiautomator:2.3.0")
    // Robolectric (host):
    // testImplementation("dev.tracera:tracera-android:<version>")
}

Requires JDK ≥ 17, Android minSdk ≥ 26, and AndroidX Test (JUnit 4 / AndroidJUnitRunner). Prefer @RunWith(TraceraAndroidJUnit4::class) (see Autotest adapters). tracera-android on Maven Central.

Environment variables and run mode: Autotest adapters.

Set TRACERA_* with testInstrumentationRunnerArguments (or am instrument -e).

android {
    defaultConfig {
        testInstrumentationRunner = "dev.tracera.TraceraAndroidJUnitRunner"
        testInstrumentationRunnerArguments += mapOf(
            "TRACERA_BASE_URL" to "https://app.example",
            "TRACERA_AUTOTEST_TOKEN" to System.getenv("TRACERA_AUTOTEST_TOKEN")!!,
            "TRACERA_PROJECT_ID" to "1",
        )
    }
}

Bind `testCaseId` and `autotestName`

Import stock JUnit 4 / AndroidX Test APIs, and Tracera from dev.tracera.

At declaration (preferred — bind runs even if the body skips early):

import dev.tracera.Tracera
import dev.tracera.TraceraAndroidJUnit4
import org.junit.Test
import org.junit.runner.RunWith

@RunWith(TraceraAndroidJUnit4::class)
class LoginTest {
    @Tracera.Id(42, name = "e2e/login")
    @Test
    fun login() {
        assert(true)
    }
}

Inside the test:

import dev.tracera.Tracera
import dev.tracera.TraceraAndroidJUnit4
import org.junit.Test
import org.junit.runner.RunWith

@RunWith(TraceraAndroidJUnit4::class)
class LoginTest {
    @Test
    fun login() {
        Tracera.testCase(42, "e2e/login")
        assert(true)
    }
}

Skip

Use stock JUnit skip (Assume.assumeTrue, @Ignore, …). The skip reason is added to the result as comment.

Steps

Use Tracera.step("…") { … } or Tracera.suspendStep("…") { … } for coroutines. Nest with Tracera.step("…") { … }. Steps inside @Before / @After go to the result’s Setup / Teardown; steps inside the test go to Test. @BeforeClass / @AfterClass are not reported.

On-device, use Tracera.step("…") { … } — ART does not support method-step instrumentation. On Robolectric / host JVM, @Tracera.Step on methods works like other JVM runners.

import dev.tracera.Tracera
import dev.tracera.TraceraAndroidJUnit4
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith

@RunWith(TraceraAndroidJUnit4::class)
class CheckoutTest {
    @Before
    fun openShop() {
        Tracera.step("open shop") { }
    }

    @Tracera.Id(10, name = "e2e/checkout")
    @Test
    fun checkout() {
        Tracera.step("body outer") {
            Tracera.step("nested leaf") { }
        }
        Tracera.step("pay") { }
    }
}

Comments, errors, and attachments

Comments, errors, and attachments: Autotest adapters.

Tracera.comment("result-level note")
Tracera.error("result-level error text")
Tracera.step("open login") {
    Tracera.comment("landed on login")
}

Screenshots and device debug

Screenshots, logcat, and window hierarchy are opt-in (not automatic). Paste the three rules on the test class (or a base class). Screenshots work without extra deps; add androidx.test.uiautomator:uiautomator only if you want quality / scale on Tracera.screenshot (and UiDevice-based hierarchy).

ScreenshotRule.Mode: FAILURE (default), SUCCESS, or END.

import dev.tracera.LogcatRule
import dev.tracera.ScreenshotRule
import dev.tracera.Tracera
import dev.tracera.TraceraAndroidJUnit4
import dev.tracera.WindowHierarchyRule
import org.junit.Rule
import org.junit.Test
import org.junit.runner.RunWith

@RunWith(TraceraAndroidJUnit4::class)
class LoginDebugTest {
    @get:Rule
    val screenshots = ScreenshotRule(mode = ScreenshotRule.Mode.FAILURE, fileName = "failure.png")

    @get:Rule
    val logcat = LogcatRule()

    @get:Rule
    val hierarchy = WindowHierarchyRule()

    @Tracera.Id(42, name = "e2e/login")
    @Test
    fun login() {
        // Optional mid-test shot:
        // Tracera.screenshot("login.png", quality = 90, scale = 1.0f)
        assert(true)
    }
}

Parameterized tests

Use @RunWith(Parameterized::class). Put @Tracera.Id on the test method. Optional name may use {param_id} — the JUnit test name (for example login[ok]). If name is omitted, autotestName takes the value of the JUnit test name. Constructor fields are not filled into the template: call Tracera.testCase inside the test when you need them in the name.

import dev.tracera.Tracera
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith
import org.junit.runners.Parameterized

@RunWith(Parameterized::class)
class LoginRows(private val login: String) {
    companion object {
        @JvmStatic
        @Parameterized.Parameters(name = "{0}")
        fun data() = listOf(arrayOf("ok"), arrayOf("sso"))
    }

    @Before
    fun openForm() {
        Tracera.step("open form") { }
    }

    @Tracera.Id(42, name = "login as {param_id}")
    @Test
    fun login() {
        assert(login.isNotEmpty())
    }
}