lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

ServiceTestCase

public abstract class ServiceTestCase
extends AndroidTestCase

java.lang.Object
   ↳ junit.framework.Assert
     ↳ junit.framework.TestCase
       ↳ android.test.AndroidTestCase
         ↳ android.test.ServiceTestCase<T extends android.app.Service>


This class was deprecated in API level 24.
Use ServiceTestRule instead. New tests should be written using the Android Testing Support Library.

This test case provides a framework in which you can test Service classes in a controlled environment. It provides basic support for the lifecycle of a Service, and hooks with which you can inject various dependencies and control the environment in which your Service is tested.

Developer Guides

For more information about application testing, read the Testing developer guide.

Lifecycle Support. A Service is accessed with a specific sequence of calls, as described in the Services document. In order to support the lifecycle of a Service, ServiceTestCase enforces this protocol:

Dependency Injection. A service has two inherent dependencies, its Context and its associated Application. The ServiceTestCase framework allows you to inject modified, mock, or isolated replacements for these dependencies, and thus perform unit tests with controlled dependencies in an isolated environment.

By default, the test case is injected with a full system context and a generic MockApplication object. You can inject alternatives to either of these by invoking setContext() or setApplication(). You must do this before calling startService() or bindService(). The test framework provides a number of alternatives for Context, including MockContext, RenamingDelegatingContext, ContextWrapper, and IsolatedContext.

Summary

Inherited fields

Public constructors

ServiceTestCase(Class<T> serviceClass)

Constructor

Public methods

Application getApplication()

Returns the Application object in use by the service under test.

T getService()
Context getSystemContext()

Returns the real system context that is saved by setUp().

void setApplication(Application application)

Sets the application that is used during the test.

void testServiceTestCaseSetUpProperly()

Tests that setupService() runs correctly and issues an Assert.assertNotNull(String, Object) if it does.

Protected methods

IBinder bindService(Intent intent)

Starts the service under test, in the same way as if it were started by Context.bindService(Intent, ServiceConnection, flags) with an Intent that identifies a service.

void setUp()

Gets the current system context and stores it.

void setupService()

Creates the service under test and attaches all injected dependencies (Context, Application) to it.

void shutdownService()

Makes the necessary calls to stop (or unbind) the service under test, and calls onDestroy().

void startService(Intent intent)

Starts the service under test, in the same way as if it were started by Context.startService(Intent) with an Intent that identifies a service.

void tearDown()

Shuts down the service under test.

Inherited methods

Public constructors

ServiceTestCase

added in API level 1
public ServiceTestCase (Class<T> serviceClass)

Constructor

Parameters
serviceClass Class: The type of the service under test.

Public methods

getApplication

added in API level 1
public Application getApplication ()

Returns the Application object in use by the service under test.

Returns
Application The application object.

getService

added in API level 1
public T getService ()

Returns
T An instance of the service under test. This instance is created automatically when a test calls startService(Intent) or bindService(Intent).

getSystemContext

added in API level 1
public Context getSystemContext ()

Returns the real system context that is saved by setUp(). Use it to create mock or other types of context objects for the service under test.

Returns
Context A normal system context.

setApplication

added in API level 1
public void setApplication (Application application)

Sets the application that is used during the test. If you do not call this method, a new MockApplication object is used.

Parameters
application Application: The Application object that is used by the service under test.

See also:

testServiceTestCaseSetUpProperly

added in API level 1
public void testServiceTestCaseSetUpProperly ()

Tests that setupService() runs correctly and issues an Assert.assertNotNull(String, Object) if it does. You can override this test method if you wish.

Throws
Exception

Protected methods

bindService

added in API level 1
protected IBinder bindService (Intent intent)

Starts the service under test, in the same way as if it were started by Context.bindService(Intent, ServiceConnection, flags) with an Intent that identifies a service.

Notice that the parameters are different. You do not provide a ServiceConnection object or the flags parameter. Instead, you only provide the Intent. The method returns an object whose type is a subclass of IBinder, or null if the method fails. An IBinder object refers to a communication channel between the application and the service. The flag is assumed to be Context.BIND_AUTO_CREATE.

See Designing a Remote Interface Using AIDL for more information about the communication channel object returned by this method.

Note: To be able to use bindService in a test, the service must implement getService() method. An example of this is in the ApiDemos sample application, in the LocalService demo.

Parameters
intent Intent: An Intent object of the form expected by Context.bindService(Intent, ServiceConnection, int).

Returns
IBinder An object whose type is a subclass of IBinder, for making further calls into the service.

setUp

added in API level 1
protected void setUp ()

Gets the current system context and stores it. Extend this method to do your own test initialization. If you do so, you must call super.setUp() as the first statement in your override. The method is called before each test method is executed.

Throws
Exception

setupService

added in API level 1
protected void setupService ()

Creates the service under test and attaches all injected dependencies (Context, Application) to it. This is called automatically by startService(Intent) or by bindService(Intent). If you need to call setContext() or setApplication(), do so before calling this method.

shutdownService

added in API level 1
protected void shutdownService ()

Makes the necessary calls to stop (or unbind) the service under test, and calls onDestroy(). Ordinarily this is called automatically (by tearDown(), but you can call it directly from your test in order to check for proper shutdown behavior.

startService

added in API level 1
protected void startService (Intent intent)

Starts the service under test, in the same way as if it were started by Context.startService(Intent) with an Intent that identifies a service. If you use this method to start the service, it is automatically stopped by tearDown().

Parameters
intent Intent: An Intent that identifies a service, of the same form as the Intent passed to Context.startService(Intent).

tearDown

added in API level 1
protected void tearDown ()

Shuts down the service under test. Ensures all resources are cleaned up and garbage collected before moving on to the next test. This method is called after each test method.

Subclasses that override this method must call super.tearDown() as their last statement.

Throws
Exception