TestChimp RUM — Android

Kotlin/Android library for emitting structured RUM events to TestChimp, aligned with:

• @testchimp/rum-js (browser)
• testchimp-rum-ios (Swift)

Same HTTP paths, headers (Project-Id, TestChimp-Api-Key, optional ci-test-info), validation rules, and Mobilewright automation URL contract.

Requirements

• minSdk 24, compileSdk 34
• Kotlin 1.9+, Java 17 (AGP 8.2)

Add to your app

Option A — JitPack (recommended for public installs)

JitPack builds this repo on each git tag and serves Maven artifacts without Maven Central or GitHub Packages credentials for consumers.

1. Add the repository in settings.gradle.kts (or settings.gradle):

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven(url = "https://jitpack.io")
    }
}

2. Depend on the library module (this is a multi-module Gradle project; artifact id = module folder name):

dependencies {
    implementation("com.github.testchimphq:testchimp-rum-android:0.1.0")
}

Use the exact version JitPack lists for your git tag (e.g. 0.1.0), or a snapshot such as master-SNAPSHOT while testing—see JitPack — testchimp-rum-android.

If the site shows a slightly different line after the build completes, prefer their copy-paste.

Option B — Git submodule / local module

1. Clone or submodule this repo next to your app.
2. In settings.gradle.kts:

include(":testchimp-rum")
project(":testchimp-rum").projectDir = file("../testchimp-rum-android/testchimp-rum")

3. In app/build.gradle.kts:

dependencies {
    implementation(project(":testchimp-rum"))
}

Option C — Maven Central (optional)

When io.testchimp:rum-android is published to Central, consumers use Maven Central only — see libraryVersion / groupId in testchimp-rum/build.gradle.kts.

Option D — Publish to Maven Local (development)

From this repo (with ANDROID_HOME or sdk.dir in local.properties):

./gradlew :testchimp-rum:publishToMavenLocal

In the consumer:

repositories { mavenLocal() }
dependencies { implementation("io.testchimp:rum-android:0.1.0") }

Usage

Initialize once (typically in Application.onCreate), then emit events from UI code.

import io.testchimp.rum.TestChimpEmitInput
import io.testchimp.rum.TestChimpRum
import io.testchimp.rum.TestChimpRumConfig

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
        TestChimpRum.initialize(
            this,
            TestChimpRumConfig(
                projectId = BuildConfig.TC_PROJECT_ID,
                apiKey = BuildConfig.TC_API_KEY,
                environment = BuildConfig.BUILD_TYPE,
                release = BuildConfig.VERSION_NAME,
            ),
        )
    }
}

// Elsewhere
TestChimpRum.emit(TestChimpEmitInput(title = "button_tap", metadata = mapOf("screen" to "Home")))

Advanced options

Pass options = TestChimpRumConfig.Options(...) for the same knobs as the JS SDK (captureEnabled, maxEventsPerSession, eventSendIntervalMillis, testchimpEndpoint, automationContextTtlSeconds, etc.).

TrueCoverage (Mobilewright)

1. CI / runner: set TESTCHIMP_PROJECT_TYPE=android and use @testchimp/playwright installTestChimp so device.openUrl pushes CI JSON into the app on every test (see that package’s README).

2. Deep link: declare an intent filter so testchimp-rum://truecoverage/... opens your app (often your launcher activity or a dedicated transparent activity).

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data
        android:scheme="testchimp-rum"
        android:host="truecoverage"
        android:pathPrefix="/v1" />
</intent-filter>

3. Deliver to the SDK in onCreate / onNewIntent:

override fun onNewIntent(intent: Intent?) {
    super.onNewIntent(intent)
    TestChimpRum.handleAutomationIntent(intent)
}

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    TestChimpRum.handleAutomationIntent(intent)
}

URLs (defaults, aligned with iOS + Playwright):

• Set context: testchimp-rum://truecoverage/v1/set?p=<base64url(JSON)>
• Clear: testchimp-rum://truecoverage/v1/clear

Optional env overrides on the runner: TESTCHIMP_RUM_AUTOMATION_SET_PREFIX, TESTCHIMP_RUM_AUTOMATION_CLEAR_URL.

Building the AAR locally

export ANDROID_HOME=/path/to/Android/sdk   # or create local.properties with sdk.dir=...
./gradlew :testchimp-rum:assembleRelease

Output: testchimp-rum/build/outputs/aar/testchimp-rum-release.aar.

Releasing (maintainers — JitPack)

1. Bump val libraryVersion in testchimp-rum/build.gradle.kts (used in the published POM).
2. Commit and push to your default branch.
3. Run ./scripts/release-jitpack.sh — creates and pushes a git tag matching that version (or tag manually with the same name).
4. Wait for a green build on JitPack, then use the dependency coordinate from the site if it differs.

jitpack.yml pins JDK 17 and runs assembleRelease + publishReleasePublicationToMavenLocal for reproducible builds.

License

MIT — see LICENSE.