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>

Class Overview

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 by which you can inject various dependencies and control the environment in which your Service is tested.

Lifecycle Support. Every Service is designed to be accessed within a specific sequence of calls. . In order to support the lifecycle of a Service, this test case will make the following calls at the following times.

The test case will not call onCreate() until your test calls startService(Intent) or bindService(Intent). This gives you a chance to set up or adjust any additional framework or test logic before onCreate().
When your test calls startService(Intent) or bindService(Intent) the test case will call onCreate(), and then call the corresponding entry point in your service. It will record any parameters or other support values necessary to support the lifecycle.
After your test completes, the test case tearDown() function is automatically called, and it will stop and destroy your service with the appropriate calls (depending on how your test invoked the service.)

Dependency Injection. Every service has two inherent dependencies, the Context in which it runs, and the Application with which it is associated. This framework allows you to inject modified, mock, or isolated replacements for these dependencies, and thus perform a true unit test.

If simply run your tests as-is, your Service will be injected with a fully-functional Context, and a generic MockApplication object. You can create and inject alternatives to either of these by calling setContext() or setApplication(). You must do this before calling startService() or bindService(). The test framework provides a number of alternatives for Context, including {link android.test.mock.MockContext MockContext}, RenamingDelegatingContext, and ContextWrapper.

Summary

[Expand]

Inherited Fields

From class android.test.AndroidTestCase

Public Constructors
	ServiceTestCase(Class<T> serviceClass)

Public Methods
Application	getApplication() Return the Application object being used by the Service under test.
T	getService()
Context	getSystemContext() Return a real (not mocked or instrumented) system Context that can be used when generating Mock or other Context objects for your Service under test.
void	setApplication(Application application) Set the application for use during the test.
void	testServiceTestCaseSetUpProperly()

Protected Methods
IBinder	bindService(Intent intent) Start the service under test, in the same way as if it was started by Context.bindService(), providing the arguments it supplied.
void	setUp() This will do the work to instantiate the Service under test.
void	setupService() Create the service under test and attach all injected dependencies (Context, Application) to it.
void	shutdownService() This will make the necessary calls to stop (or unbind) the Service under test, and call onDestroy().
void	startService(Intent intent) Start the service under test, in the same way as if it was started by Context.startService(), providing the arguments it supplied.
void	tearDown() Shuts down the Service under test.

[Expand]

Inherited Methods

From class android.test.AndroidTestCase

From class junit.framework.TestCase

int	countTestCases() Counts the number of test cases executed by run(TestResult result).
TestResult	createResult() Creates a default TestResult object
String	getName() Gets the name of a TestCase
void	run(TestResult result) Runs the test case and collects the results in TestResult.
TestResult	run() A convenience method to run this test, collecting the results with a default TestResult object.
void	runBare() Runs the bare test sequence.
void	runTest() Override to run the test and assert its state.
void	setName(String name) Sets the name of a TestCase
void	setUp() Sets up the fixture, for example, open a network connection.
void	tearDown() Tears down the fixture, for example, close a network connection.
String	toString() Returns a string representation of the test case

From class junit.framework.Assert

static void	assertEquals(long expected, long actual) Asserts that two longs are equal.
static void	assertEquals(String message, byte expected, byte actual) Asserts that two bytes are equal.
static void	assertEquals(String message, short expected, short actual) Asserts that two shorts are equal.
static void	assertEquals(boolean expected, boolean actual) Asserts that two booleans are equal.
static void	assertEquals(String message, char expected, char actual) Asserts that two chars are equal.
static void	assertEquals(String message, float expected, float actual, float delta) Asserts that two floats are equal concerning a delta.
static void	assertEquals(String message, double expected, double actual, double delta) Asserts that two doubles are equal concerning a delta.
static void	assertEquals(byte expected, byte actual) Asserts that two bytes are equal.
static void	assertEquals(String message, String expected, String actual) Asserts that two Strings are equal.
static void	assertEquals(double expected, double actual, double delta) Asserts that two doubles are equal concerning a delta.
static void	assertEquals(String message, long expected, long actual) Asserts that two longs are equal.
static void	assertEquals(String message, int expected, int actual) Asserts that two ints are equal.
static void	assertEquals(char expected, char actual) Asserts that two chars are equal.
static void	assertEquals(String message, Object expected, Object actual) Asserts that two objects are equal.
static void	assertEquals(Object expected, Object actual) Asserts that two objects are equal.
static void	assertEquals(short expected, short actual) Asserts that two shorts are equal.
static void	assertEquals(float expected, float actual, float delta) Asserts that two floats are equal concerning a delta.
static void	assertEquals(int expected, int actual) Asserts that two ints are equal.
static void	assertEquals(String expected, String actual) Asserts that two Strings are equal.
static void	assertEquals(String message, boolean expected, boolean actual) Asserts that two booleans are equal.
static void	assertFalse(boolean condition) Asserts that a condition is false.
static void	assertFalse(String message, boolean condition) Asserts that a condition is false.
static void	assertNotNull(String message, Object object) Asserts that an object isn't null.
static void	assertNotNull(Object object) Asserts that an object isn't null.
static void	assertNotSame(Object expected, Object actual) Asserts that two objects refer to the same object.
static void	assertNotSame(String message, Object expected, Object actual) Asserts that two objects refer to the same object.
static void	assertNull(String message, Object object) Asserts that an object is null.
static void	assertNull(Object object) Asserts that an object is null.
static void	assertSame(String message, Object expected, Object actual) Asserts that two objects refer to the same object.
static void	assertSame(Object expected, Object actual) Asserts that two objects refer to the same object.
static void	assertTrue(String message, boolean condition) Asserts that a condition is true.
static void	assertTrue(boolean condition) Asserts that a condition is true.
static void	fail() Fails a test with no message.
static void	fail(String message) Fails a test with the given message.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of Class which represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

From interface junit.framework.Test

Public Constructors

public ServiceTestCase (Class<T> serviceClass)

Public Methods

public Application getApplication ()

Return the Application object being used by the Service under test.

Returns

Returns the application object.

public T getService ()

Returns

Returns the actual service under test.

public Context getSystemContext ()

Return a real (not mocked or instrumented) system Context that can be used when generating Mock or other Context objects for your Service under test.

Returns

Returns a reference to a normal Context.

public void setApplication (Application application)

Set the application for use during the test. If your test does not call this function, a new MockApplication object will be generated.

Parameters

application	The Application object that will be injected into the Service under test.

public void testServiceTestCaseSetUpProperly ()

Throws

Exception

Protected Methods

protected IBinder bindService (Intent intent)

Start the service under test, in the same way as if it was started by Context.bindService(), providing the arguments it supplied. Return the communication channel to the service. May return null if clients can not bind to the service. The returned IBinder is usually for a complex interface that has been described using aidl. Note: In order to test with this interface, your service must implement a getService() method, as shown in samples.ApiDemos.app.LocalService.

Parameters

intent	The Intent as if supplied to bindService(Intent, ServiceConnection, int).

Returns

Return an IBinder for making further calls into the Service.

protected void setUp ()

This will do the work to instantiate the Service under test. After this, your test code must also start and stop the service.

Throws

Exception

protected void setupService ()

Create the service under test and attach all injected dependencies (Context, Application) to it. This will be called automatically by startService(Intent) or by bindService(Intent). If you wish to call setContext() or setApplication(), you must do so before calling this function.

protected void shutdownService ()

This will make the necessary calls to stop (or unbind) the Service under test, and call onDestroy(). Ordinarily this will be called automatically (by tearDown(), but you can call it directly from your test in order to check for proper shutdown behaviors.

protected void startService (Intent intent)

Start the service under test, in the same way as if it was started by Context.startService(), providing the arguments it supplied. If you use this method to start the service, it will automatically be stopped by tearDown().

Parameters

intent	The Intent as if supplied to startService(Intent).

protected void tearDown ()

Shuts down the Service under test. Also makes sure all resources are cleaned up and garbage collected before moving on to the next test. Subclasses that override this method should make sure they call super.tearDown() at the end of the overriding method.

Throws

Exception

Interfaces

Classes

Errors

ServiceTestCase

Class Overview

Summary

Public Constructors

public ServiceTestCase (Class<T> serviceClass)

Public Methods

public Application getApplication ()

Returns

See Also

public T getService ()

Returns

public Context getSystemContext ()

Returns

public void setApplication (Application application)

Parameters

public void testServiceTestCaseSetUpProperly ()

Throws

Protected Methods

protected IBinder bindService (Intent intent)

Parameters

Returns

protected void setUp ()

Throws

protected void setupService ()

protected void shutdownService ()

protected void startService (Intent intent)

Parameters

protected void tearDown ()

Throws