If you are implementing a local Service
as a component of your app, you
can create instrumented tests to verify that its behavior is correct.
AndroidX Test provides an API for testing your Service
objects in
isolation. The ServiceTestRule
class is a JUnit 4 rule that starts your
service before your unit test methods run, and shuts down the service after
tests complete. To learn more about JUnit 4 rules, see the JUnit
documentation.
Set up your testing environment
Before building your integration test for the service, make sure to configure your project for instrumented tests, as described in Set up project for AndroidX Test.
Create an integration test for services
Your integration test should be written as a JUnit 4 test class. To learn more about creating JUnit 4 test classes and using JUnit 4 assertion methods, see Create an instrumented test class.
Create a ServiceTestRule
instance in your test by using the @Rule
annotation.
Kotlin
@get:Rule val serviceRule = ServiceTestRule()
Java
@Rule public final ServiceTestRule serviceRule = new ServiceTestRule();
The following example shows how you might implement an integration test for a
service. The test method testWithBoundService()
verifies that the app binds
successfully to a local service and that the service interface behaves
correctly.
Kotlin
@Test @Throws(TimeoutException::class) fun testWithBoundService() { // Create the service Intent. val serviceIntent = Intent( ApplicationProvider.getApplicationContext<Context>(), LocalService::class.java ).apply { // Data can be passed to the service via the Intent. putExtra(SEED_KEY, 42L) } // Bind the service and grab a reference to the binder. val binder: IBinder = serviceRule.bindService(serviceIntent) // Get the reference to the service, or you can call // public methods on the binder directly. val service: LocalService = (binder as LocalService.LocalBinder).getService() // Verify that the service is working correctly. assertThat(service.getRandomInt(), `is`(any(Int::class.java))) }
Java
@Test public void testWithBoundService() throws TimeoutException { // Create the service Intent. Intent serviceIntent = new Intent(ApplicationProvider.getApplicationContext(), LocalService.class); // Data can be passed to the service via the Intent. serviceIntent.putExtra(LocalService.SEED_KEY, 42L); // Bind the service and grab a reference to the binder. IBinder binder = serviceRule.bindService(serviceIntent); // Get the reference to the service, or you can call // public methods on the binder directly. LocalService service = ((LocalService.LocalBinder) binder).getService(); // Verify that the service is working correctly. assertThat(service.getRandomInt()).isAssignableTo(Integer.class); }
Additional resources
To learn more about this topic, consult the following additional resources.