Instrumented tests in Android Kotlin

Introduction

Instrumented tests check how your app works on a real device or emulator. They help make sure your app behaves correctly when users interact with it.

To test if buttons and screens respond correctly when tapped.

To check if your app saves data properly on a device.

To verify navigation between different screens works as expected.

To ensure your app handles device features like camera or GPS correctly.

To catch bugs that only appear when running on a real device or emulator.

Syntax

Android Kotlin

import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.platform.app.InstrumentationRegistry
import org.junit.Test
import org.junit.runner.RunWith
import org.junit.Assert.*

@RunWith(AndroidJUnit4::class)
class ExampleInstrumentedTest {
  @Test
  fun useAppContext() {
    val appContext = InstrumentationRegistry.getInstrumentation().targetContext
    assertEquals("com.example.myapp", appContext.packageName)
  }
}

Use @RunWith(AndroidJUnit4::class) to tell Android to run the test on a device or emulator.

Use InstrumentationRegistry.getInstrumentation().targetContext to get the app context during the test.

Examples

This test checks if the app package name is correct on the device.

Android Kotlin

import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.platform.app.InstrumentationRegistry
import org.junit.Test
import org.junit.runner.RunWith
import org.junit.Assert.*

@RunWith(AndroidJUnit4::class)
class SimpleInstrumentedTest {
  @Test
  fun checkPackageName() {
    val context = InstrumentationRegistry.getInstrumentation().targetContext
    assertEquals("com.example.app", context.packageName)
  }
}

This test checks if the device has a camera feature.

Android Kotlin

import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.platform.app.InstrumentationRegistry
import org.junit.Test
import org.junit.runner.RunWith
import org.junit.Assert.*

@RunWith(AndroidJUnit4::class)
class DeviceFeatureTest {
  @Test
  fun hasCamera() {
    val context = InstrumentationRegistry.getInstrumentation().targetContext
    val pm = context.packageManager
    val hasCamera = pm.hasSystemFeature("android.hardware.camera")
    assertTrue(hasCamera)
  }
}

Sample App

This is a simple instrumented test that runs on a device or emulator. It checks if the app's package name is "com.example.myapp". If the package name matches, the test passes. This helps confirm the app is installed and running correctly.

Android Kotlin

import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.platform.app.InstrumentationRegistry
import org.junit.Test
import org.junit.runner.RunWith
import org.junit.Assert.*

@RunWith(AndroidJUnit4::class)
class ExampleInstrumentedTest {
  @Test
  fun useAppContext() {
    val appContext = InstrumentationRegistry.getInstrumentation().targetContext
    assertEquals("com.example.myapp", appContext.packageName)
  }
}

Important Notes

Instrumented tests run on a real device or emulator, so they take longer than simple unit tests.

Make sure your device or emulator is connected and ready before running instrumented tests.

Use Android Studio's Run or Debug options to execute instrumented tests easily.

Summary

Instrumented tests check app behavior on real devices or emulators.

They help test UI, device features, and app context.

Use @RunWith(AndroidJUnit4::class) and InstrumentationRegistry to write these tests.

Practice

1. What is the main purpose of instrumented tests in Android development?

easy

A. To test only the backend logic without UI

B. To write unit tests that run on the local JVM

C. To run tests on real devices or emulators to check app behavior

D. To create UI layouts for the app

Solution

1. Step 1: Understand what instrumented tests do

   Instrumented tests run on actual devices or emulators to test app behavior in a real environment.

2. Step 2: Compare with other test types

   Unit tests run locally on JVM and do not test device features or UI on real devices.

3. Final Answer:

   To run tests on real devices or emulators to check app behavior -> Option C

4. Quick Check:

   Instrumented tests = run on device/emulator [OK]

Hint: Instrumented tests run on devices, not just local JVM [OK]

Common Mistakes:

• Confusing instrumented tests with unit tests
• Thinking instrumented tests only test backend logic
• Assuming instrumented tests create UI layouts

2. Which annotation is required to run an instrumented test with AndroidJUnit4?

easy

A. @RunWith(AndroidJUnit4::class)

B. @Ignore

C. @Before

D. @Test

Solution

1. Step 1: Identify the runner annotation

   Instrumented tests need the @RunWith(AndroidJUnit4::class) annotation to specify the test runner.

2. Step 2: Differentiate from other annotations

   @Test marks test methods, @Before runs setup code, @Ignore skips tests; none specify the runner.

3. Final Answer:

   @RunWith(AndroidJUnit4::class) -> Option A

4. Quick Check:

   Runner annotation = @RunWith(AndroidJUnit4::class) [OK]

Hint: Use @RunWith(AndroidJUnit4::class) to set test runner [OK]

Common Mistakes:

• Using @Test instead of @RunWith for runner
• Confusing @Before with runner annotation
• Forgetting to add any runner annotation

3. Given this instrumented test code snippet, what will be the output?

val appContext = InstrumentationRegistry.getInstrumentation().targetContext
val packageName = appContext.packageName
println(packageName)

medium

A. An empty string

B. The package name of the app under test

C. The package name of the test app

D. A runtime exception

Solution

1. Step 1: Understand InstrumentationRegistry usage

   InstrumentationRegistry.getInstrumentation().targetContext returns the context of the app under test, not the test app.

2. Step 2: Extract package name from app context

   appContext.packageName gives the package name of the app being tested, which is printed.

3. Final Answer:

   The package name of the app under test -> Option B

4. Quick Check:

   targetContext.packageName = app package [OK]

Hint: targetContext is app under test, not test app [OK]

Common Mistakes:

• Confusing targetContext with testContext
• Expecting empty string instead of package name
• Assuming runtime exception without cause

4. What is wrong with this instrumented test code?

@RunWith(AndroidJUnit4::class)
class ExampleInstrumentedTest {
  @Test
  fun useAppContext() {
    val context = InstrumentationRegistry.getContext()
    assertEquals("com.example.app", context.packageName)
  }
}

medium

A. InstrumentationRegistry.getContext() is deprecated; should use getInstrumentation().targetContext

B. Missing @Before annotation for setup

C. assertEquals syntax is incorrect

D. Missing @RunWith annotation

Solution

1. Step 1: Check InstrumentationRegistry usage

   InstrumentationRegistry.getContext() is deprecated and does not return the app context; getInstrumentation().targetContext should be used.

2. Step 2: Verify other parts of the code

   @RunWith is present, assertEquals syntax is correct, and @Before is not required here.

3. Final Answer:

   InstrumentationRegistry.getContext() is deprecated; should use getInstrumentation().targetContext -> Option A

4. Quick Check:

   Use getInstrumentation().targetContext, not getContext() [OK]

Hint: Use getInstrumentation().targetContext, not getContext() [OK]

Common Mistakes:

• Using deprecated getContext() method
• Assuming @Before is mandatory for all tests
• Thinking assertEquals syntax is wrong

5. You want to write an instrumented test that verifies a button click updates a TextView on a real device. Which steps should you follow to correctly implement this test?

hard

A. Use @RunWith(AndroidJUnit4::class), get test context, launch activity, perform click, check TextView text

B. Write a unit test with @Test, mock the button click, and check TextView text without device

C. Write a UI test without annotations, directly call button click method and check TextView

D. Use @RunWith(AndroidJUnit4::class), get app context with InstrumentationRegistry.getInstrumentation().targetContext, launch activity, perform click, check TextView text

Solution

1. Step 1: Setup instrumented test with correct runner and context

   Use @RunWith(AndroidJUnit4::class) and get app context via InstrumentationRegistry.getInstrumentation().targetContext to access real app environment.

2. Step 2: Launch activity, perform UI action, and verify result

   Launch the activity, simulate button click, and check if TextView text updates as expected on device/emulator.

3. Final Answer:

   Use @RunWith(AndroidJUnit4::class), get app context with InstrumentationRegistry.getInstrumentation().targetContext, launch activity, perform click, check TextView text -> Option D

4. Quick Check:

   Instrumented UI test = runner + app context + UI actions [OK]

Hint: Instrumented UI tests need real context and runner [OK]

Common Mistakes:

• Using test context instead of app context
• Writing unit tests for UI behavior
• Skipping @RunWith annotation