Skip to main content

Appium With Kotlin

In this documentation, you will learn how to configure and run your Kotlin automation testing scripts with Appium on LambdaTest, set the desired capabilities for appium testing, and other advanced features of LambdaTest.

Prerequisites​

  • Your LambdaTest Username and Access key.
  • Install the latest version of IntelliJ IDEA. You can use any other IDE also.
  • Download and install Maven. You can use Homebrew package manager for Linux/macOS.
  • Make sure that Kotlin plugins are enabled/installed in the IntelliJ IDEA if you are using a previous version.

Try our Sample Repository​

Step 1: Get a Sample Project​

You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

Sample repo

All the code samples in this documentation can be found on LambdaTest's Github Repository. You can either download or clone the repository to quickly run your tests. Image View on GitHub

Step 2: Setup the Environment Variables​

You need to export your environment variables LT_USERNAME and LT_ACCESS_KEY that are available in your LambdaTest Profile page. Run the below mentioned commands in your terminal to setup the environment variables.

export LT_USERNAME="undefined"
export LT_ACCESS_KEY="undefined"

Step 3: Upload your Application​

Upload your iOS application (.ipa file) or android application (.apk or .aab file) to the LambdaTest servers using our REST API. You need to provide your Username and AccessKey in the format Username:AccessKey in the cURL command for authentication.

Make sure to add the path of the appFile in the cURL request. Below is an example cURL request to upload your app using our REST API:

curl -u "undefined:undefined" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"/Users/macuser/Downloads/proverbial_android.apk"" -F "name="proverbial_app""
tip

  • If you do not have any .apk or .ipa file, you can run your sample tests on LambdaTest by using our sample apps, 🔗 Android app or 🔗 iOS app.

  • Response of above cURL will be a JSON object containing the APP_URL of the format - lt://APP123456789123456789 and will be used in the next step.

Step 4: Update your Automation Script​

An automation script for the sample application available above has been provided here. Ensure to update the APP_URL, username and accesKey in the code scripts before running the tests.

android.kt
import io.appium.java_client.MobileBy
import io.appium.java_client.MobileElement
import io.appium.java_client.android.AndroidDriver
import io.appium.java_client.android.AndroidElement
import org.junit.jupiter.api.Test
import org.openqa.selenium.remote.DesiredCapabilities
import java.net.URL

class android {

    @Test
    fun `sample test`() {
        val username = "LT_USERNAME"   //Add your LambdaTest username here
        val accessKey = "LT_ACCESS_KEY"    //Add your LambdaTest accessKey here

        var driver: AndroidDriver<MobileElement>? = null

        val hub = URL("https://${username}:${accessKey}@mobile-hub.lambdatest.com/wd/hub")

        val caps = DesiredCapabilities()
        caps.setCapability("autoAcceptAlerts", true)
        caps.setCapability("platformName", "Android")
        caps.setCapability("deviceName", "Galaxy S20")
        caps.setCapability("platformVersion", "11")
        caps.setCapability("platformName", "Android")
        caps.setCapability("isRealMobile", true)
        caps.setCapability("app", "APP_URL") //Add the app (.apk) url here
        caps.setCapability("deviceOrientation", "PORTRAIT")
        caps.setCapability("build", "Kotlin Vanilla - Android")
        caps.setCapability("name", "Sample Test Kotlin")
        caps.setCapability("console", true)
        caps.setCapability("network", false)
        caps.setCapability("visual", true)
        caps.setCapability("device log", true)


        val app = AndroidDriver<AndroidElement>(hub, caps)

        Thread.sleep(4000)

        val color: MobileElement =
            app.findElement(MobileBy.id("com.lambdatest.proverbial:id/color")) as MobileElement
            color.click()

        val text: MobileElement =
            app.findElement(MobileBy.id("com.lambdatest.proverbial:id/Text")) as MobileElement
            text.click()

        val toast: MobileElement =
            app.findElement(MobileBy.id("com.lambdatest.proverbial:id/toast")) as MobileElement
            toast.click()

        val notification: MobileElement =
            app.findElement(MobileBy.id("com.lambdatest.proverbial:id/notification")) as MobileElement
            notification.click()

        val geo: MobileElement =
            app.findElement(MobileBy.id("com.lambdatest.proverbial:id/geoLocation")) as MobileElement
            geo.click()
        Thread.sleep(5000)

        val el3: MobileElement =
            app.findElementByAccessibilityId("Home") as MobileElement

        app.navigate().back()
        Thread.sleep(2000)

        val speedtest: MobileElement =
            app.findElement(MobileBy.id("com.lambdatest.proverbial:id/speedTest")) as MobileElement
            speedtest.click()
        Thread.sleep(5000)

        app.navigate().back()


        if (app != null) {
            app.quit()
        };

    }
}

Step 5: Configure the Test Capabilities​

You can update your custom capabilities in test scripts. In this sample project, we are passing platform name, platform version, device name and app url (generated earlier) along with other capabilities like build name and test name via capabilities object.

The capabilities object in the sample code are defined as:

val caps = DesiredCapabilities()
caps.setCapability("platformName", "ios")
caps.setCapability("deviceName", "iPhone 12")
caps.setCapability("platformVersion", "14")
caps.setCapability("isRealMobile", true)
caps.setCapability("app", "APP_URL") //Add the app (.ipa) url here
caps.setCapability("deviceOrientation", "PORTRAIT")
caps.setCapability("build", "Kotlin Vanilla - iOS")
caps.setCapability("name", "Sample Test Kotlin")
caps.setCapability("console", true)
caps.setCapability("network", false)
caps.setCapability("visual", true)
caps.setCapability("device log", true)
info

Step 6: Execute and Monitor your Tests​

  • Install the required dependencies:
mvn clean install
  1. Now, you have to successfully build the test in your IDE.
  2. Then run the current file by using Run button in the IDE.

Your test results would be displayed on the test console (or CLI if you are using terminal/cmd) and on the LambdaTest App Automation Dashboard.

Reference Guides​

Last updated on

Test across 3000+ combinations of browsers, real devices & OS.

Book Demo

Help and Support

Related Articles