ViewModel testing in Android Kotlin

Introduction

Testing ViewModels helps ensure your app's data logic works correctly without needing the full app UI. It catches bugs early and makes your app more reliable.

When you want to check if your ViewModel updates data correctly after user actions.

When you need to verify that LiveData emits the right values in response to events.

When you want to test business logic separately from UI components.

When you want to automate tests to avoid manual checking of app behavior.

When you want to ensure your ViewModel handles errors and loading states properly.

Syntax

Android Kotlin

class MyViewModelTest {
  private lateinit var viewModel: MyViewModel

  @Before
  fun setup() {
    viewModel = MyViewModel()
  }

  @Test
  fun testExample() {
    // test code here
  }
}

Use @Before to set up your ViewModel before each test.

Use @Test to mark functions that run as tests.

Examples

This test checks if calling increment() increases the count LiveData value by 1.

Android Kotlin

class CounterViewModelTest {
  private lateinit var viewModel: CounterViewModel

  @Before
  fun setup() {
    viewModel = CounterViewModel()
  }

  @Test
  fun increment_increasesCount() {
    viewModel.increment()
    assertEquals(1, viewModel.count.value)
  }
}

This test verifies that a successful login updates the loginSuccess LiveData to true.

Android Kotlin

class LoginViewModelTest {
  private lateinit var viewModel: LoginViewModel

  @Before
  fun setup() {
    viewModel = LoginViewModel()
  }

  @Test
  fun login_withValidCredentials_setsSuccess() {
    viewModel.login("user", "pass")
    assertEquals(true, viewModel.loginSuccess.value)
  }
}

Sample App

This example shows a simple ViewModel with a count LiveData and an increment function. The test checks that calling increment updates the count from 0 to 1.

Android Kotlin

import androidx.lifecycle.MutableLiveData
import androidx.lifecycle.ViewModel

class SimpleViewModel : ViewModel() {
  val count = MutableLiveData(0)

  fun increment() {
    count.value = (count.value ?: 0) + 1
  }
}

// Test class
import org.junit.Before
import org.junit.Test
import org.junit.Assert.assertEquals

class SimpleViewModelTest {
  private lateinit var viewModel: SimpleViewModel

  @Before
  fun setup() {
    viewModel = SimpleViewModel()
  }

  @Test
  fun increment_increasesCount() {
    viewModel.increment()
    assertEquals(1, viewModel.count.value)
  }
}

Important Notes

Use MutableLiveData to hold data in ViewModel that can change.

Use assertEquals(expected, actual) to check if your test result matches what you expect.

Tests run quickly and do not need the full Android UI to work.

Summary

ViewModel testing checks your app's data logic without UI.

Use @Before to prepare your ViewModel before tests.

Use assertions like assertEquals to verify expected results.

Practice

1.

What is the main purpose of testing a ViewModel in Android development?

easy

A. To validate user input directly on the screen

B. To verify the data handling and business logic without UI involvement

C. To test the navigation between different screens

D. To check the layout and visual appearance of the app

Solution

1. Step 1: Understand ViewModel role

   The ViewModel holds and manages UI-related data but does not handle UI rendering.

2. Step 2: Identify testing focus

   Testing ViewModel focuses on data logic and state management, not UI or navigation.

3. Final Answer:

   To verify the data handling and business logic without UI involvement -> Option B

4. Quick Check:

   ViewModel testing = data logic check [OK]

Hint: ViewModel tests focus on data, not UI or navigation [OK]

Common Mistakes:

• Confusing ViewModel testing with UI testing
• Thinking ViewModel tests check screen layouts
• Assuming navigation is tested in ViewModel tests

2.

Which annotation is commonly used to set up a ViewModel instance before each test method runs?

easy

A. @Ignore

B. @Test

C. @After

D. @Before

Solution

1. Step 1: Recall JUnit lifecycle annotations

   @Before runs before each test method to prepare test environment.

2. Step 2: Match annotation to ViewModel setup

   Use @Before to initialize ViewModel before tests run.

3. Final Answer:

   @Before -> Option D

4. Quick Check:

   Setup before tests = @Before [OK]

Hint: Use @Before to prepare ViewModel before each test [OK]

Common Mistakes:

• Using @Test instead of @Before for setup
• Confusing @After with setup annotation
• Skipping setup annotation entirely

3.

Given the following test code snippet, what will be the value of result after running the test?

class MyViewModelTest {
  private lateinit var viewModel: MyViewModel

  @Before
  fun setup() {
    viewModel = MyViewModel()
  }

  @Test
  fun testIncrement() {
    viewModel.increment()
    val result = viewModel.counter
  }
}

Assuming counter starts at 0 and increment() adds 1.

medium

A. 1

B. 0

C. null

D. Throws an exception

Solution

1. Step 1: Understand initial state

   ViewModel's counter starts at 0 before increment.

2. Step 2: Apply increment method

   Calling increment() adds 1, so counter becomes 1.

3. Final Answer:

   1 -> Option A

4. Quick Check:

   Initial 0 + 1 increment = 1 [OK]

Hint: Increment adds 1 to counter starting at 0 [OK]

Common Mistakes:

• Assuming counter remains 0 after increment
• Thinking result is null without initialization
• Expecting an exception without error in code

4.

Identify the error in this ViewModel test code snippet:

class SampleViewModelTest {
  private lateinit var viewModel: SampleViewModel

  @Test
  fun testReset() {
    viewModel.reset()
    assertEquals(0, viewModel.counter)
  }
}

Assuming viewModel is not initialized anywhere else.

medium

A. Missing @Before setup to initialize viewModel before test

B. Incorrect assertEquals parameter order

C. reset() method does not exist in ViewModel

D. Test method missing @Test annotation

Solution

1. Step 1: Check viewModel initialization

   viewModel is declared but never initialized before test runs.

2. Step 2: Identify missing setup

   Without @Before method to initialize viewModel, calling reset() causes error.

3. Final Answer:

   Missing @Before setup to initialize viewModel before test -> Option A

4. Quick Check:

   Initialize viewModel before test = @Before needed [OK]

Hint: Always initialize ViewModel before tests with @Before [OK]

Common Mistakes:

• Forgetting to initialize viewModel before use
• Mixing assertEquals parameter order
• Assuming reset() method is missing without checking

5.

You want to test a ViewModel method that fetches data asynchronously and updates a LiveData property. Which approach is best to test this behavior?

hard

A. Mock the LiveData property and verify it was called

B. Call the method and immediately check LiveData value without waiting

C. Use a coroutine test rule to run suspend functions and observe LiveData changes synchronously

D. Test only the UI observing the LiveData, not the ViewModel method

Solution

1. Step 1: Understand asynchronous data fetching

   ViewModel uses coroutines to fetch data and update LiveData asynchronously.

2. Step 2: Use coroutine test tools

   Coroutine test rules allow running suspend functions in tests synchronously for reliable assertions.

3. Step 3: Observe LiveData changes properly

   Observing LiveData synchronously ensures test waits for updates before asserting values.

4. Final Answer:

   Use a coroutine test rule to run suspend functions and observe LiveData changes synchronously -> Option C

5. Quick Check:

   Async ViewModel test = coroutine test rule + LiveData observe [OK]

Hint: Use coroutine test rule to handle async LiveData updates [OK]

Common Mistakes:

• Checking LiveData immediately without waiting
• Mocking LiveData instead of testing real updates
• Testing UI instead of ViewModel logic