java.lang.Object | ||||
↳ | junit.framework.Assert | |||
↳ | junit.framework.TestCase | |||
↳ | android.test.AndroidTestCase | |||
↳ | android.test.ServiceTestCase<T extends android.app.Service> |
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.
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:
setUp()
method is called before each test method. The base implementation
gets the system context. If you override setUp()
, you must call
super.setUp()
as the first statement in your override.
onCreate()
until one of your
test methods calls startService(Intent)
or bindService(Intent)
. This gives you an
opportunity to set up or adjust any additional framework or test logic before you test
the running service.
ServiceTestCase.startService()
or ServiceTestCase.bindService()
, the test case calls
Service.onCreate()
and then calls either
Service.startService(Intent)
or
Service.bindService(Intent, ServiceConnection, int)
, as appropriate. It also stores
values needed to track and support the lifecycle.
tearDown()
method. This
method stops and destroys the service with the appropriate calls, depending on how the
service was started. If you override tearDown()
, your must call the
super.tearDown()
as the last statement in your override.
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
.
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.test.AndroidTestCase
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructor
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the Application object in use by the service under test.
| |||||||||||
Returns the real system context that is saved by
setUp() . | |||||||||||
Sets the application that is used during the test.
| |||||||||||
Tests that
setupService() runs correctly and issues an
assertNotNull(String, Object) if it does. |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Starts the service under test, in the same way as if it were started by
| |||||||||||
Gets the current system context and stores it.
| |||||||||||
Creates the service under test and attaches all injected dependencies
(Context, Application) to it.
| |||||||||||
Makes the necessary calls to stop (or unbind) the service under test, and
calls onDestroy().
| |||||||||||
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. | |||||||||||
Shuts down the service under test. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.test.AndroidTestCase
| |||||||||||
From class
junit.framework.TestCase
| |||||||||||
From class
junit.framework.Assert
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
junit.framework.Test
|
Constructor
serviceClass | The type of the service under test. |
---|
Returns the Application object in use by the service under test.
startService(Intent)
or bindService(Intent)
.
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.
Sets the application that is used during the test. If you do not call this method,
a new MockApplication
object is used.
application | The Application object that is used by the service under test. |
---|
Tests that setupService()
runs correctly and issues an
assertNotNull(String, Object)
if it does.
You can override this test method if you wish.
Exception |
---|
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 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.intent | An Intent object of the form expected by
bindService(Intent, ServiceConnection, int) . |
---|
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.
Exception |
---|
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.
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.
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()
.
intent | An Intent that identifies a service, of the same form as the Intent passed to
Context.startService(Intent) .
|
---|
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.
Exception |
---|