Skip to content

aryapreetam/parikshan

Repository files navigation

Parikshan

Compose Multiplatform E2E Testing Framework

Compose Multiplatform Version Kotlin Version

Release workflow status Maven Central Version MIT License

Android iOS Desktop Web

Parikshan is a testing framework designed specifically for Compose Multiplatform. It provides a unified, cross-platform DSL to write end-to-end (E2E) UI tests that run on Android, iOS, Desktop, and Web (Wasm) using a single codebase.

Why Parikshan?

Writing E2E tests for multiplatform apps often requires juggling multiple tools like Appium, Maestro, and Playwright, each with its own configuration and production code "pollution." Parikshan aims to simplify this:

  • Zero-Pollution: No testing code or "test-only" modules are included in your production builds.
  • Unified DSL: Write once in Kotlin and run across all supported platforms.
  • Architecture-Aware: Automatically discovers your app modules and orchestrates the installation and execution lifecycle.
  • Built-in Recording: Automatically generates videos of your test runs (even in headless CI environments).

📖 Full Documentation & API Reference | 🌐 Wasm Demo


🛠️ Quick Start

1. Apply the Plugin

In your shared library (e.g., :composeApp) build.gradle.kts:

plugins {
    id("io.github.aryapreetam.parikshan") version "0.0.1"
}

2. Write your first test

Create a test in src/commonTest/kotlin:

class MyE2ETest {
    @Test
    fun testLoginFlow() = e2eTest {
        // Simple, intent-based DSL
        waitFor("login_button")
        inputText("username_field", "admin")
        click("login_button")
        
        assertVisible("dashboard_screen")
        screenshot("login-success")
    }
}

3. Run on any platform

./gradlew e2eAndroidTest
./gradlew e2eIosTest
./gradlew e2eDesktopTest
./gradlew e2eWasmTest

📦 Try the Sample App

Validate the library on your platform by downloading the pre-built sample application:

Platform Download Link
🍏 macOS (Intel) Download x64 DMG
🍎 macOS (Apple Silicon) Download arm64 DMG
🪟 Windows Download MSI
🤖 Android Download APK
🌐 Web (Wasm) Download ZIP
iOS Simulator Download ZIP

License

MIT License © 2026 aryapreetam and contributors. See LICENSE for details.


🙏 Acknowledgments

This library was built with inspiration from the excellent work of the Kotlin and Compose Multiplatform communities, including terrakok's KMP Web Wizard and the many developers pushing the boundaries of cross-platform testing.

About

Compose Multiplatform E2E testing made simple

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors