Home How it Works Android APIMiner IDE Version More Info

to top

Added in API level 1

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 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:

The 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.
The test case waits to call 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.
When one of your test methods calls 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.
After each test method finishes, the test case calls the 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.

Summary

[Expand]

Inherited Fields

From class android.test.AndroidTestCase

Public Constructors
? Examples	ServiceTestCase( Class<T> serviceClass) Constructor

Public Methods
? Examples	Application	getApplication() Returns the Application object in use by the service under test.
? Examples	T	getService()
? Examples	Context	getSystemContext() Returns the real system context that is saved by `setUp()`.
? Examples	void	setApplication( Application application) Sets the application that is used during the test.
? Examples	void	testServiceTestCaseSetUpProperly() Tests that `setupService()` runs correctly and issues an `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.

[Expand]

Inherited Methods

From class android.test.AndroidTestCase

void	assertActivityRequiresPermission( String packageName, String className, String permission) Asserts that launching a given activity is protected by a particular permission by attempting to start the activity and validating that a `SecurityException` is thrown that mentions the permission in its error message.
void	assertReadingContentUriRequiresPermission( Uri uri, String permission) Asserts that reading from the content uri requires a particular permission by querying the uri and ensuring a `SecurityException` is thrown mentioning the particular permission.
void	assertWritingContentUriRequiresPermission( Uri uri, String permission) Asserts that writing to the content uri requires a particular permission by inserting into the uri and ensuring a `SecurityException` is thrown mentioning the particular permission.
Context	getContext()
void	scrubClass( Class<?> testCaseClass) This function is called by various TestCase implementations, at tearDown() time, in order to scrub out any class variables.
void	setContext( Context context)
void	setUp() Sets up the fixture, for example, open a network connection.
void	tearDown() Tears down the fixture, for example, close a network connection.
void	testAndroidTestCaseSetupProperly()

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
TestResult	run() A convenience method to run this test, collecting the results with a default TestResult object.
void	run( TestResult result) Runs the test case and collects the results in TestResult.
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(short expected, short actual) Asserts that two shorts are equal.
static void	assertEquals( String message, int expected, int actual) Asserts that two ints are equal.
static void	assertEquals( String message, short expected, short actual) Asserts that two shorts are equal.
static void	assertEquals(char expected, char actual) Asserts that two chars are equal.
static void	assertEquals( String message, String expected, String actual) Asserts that two Strings are equal.
static void	assertEquals(int expected, int actual) Asserts that two ints are equal.
static void	assertEquals( String message, 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(byte expected, byte actual) Asserts that two bytes are equal.
static void	assertEquals( Object expected, Object actual) Asserts that two objects are equal.
static void	assertEquals(boolean expected, boolean actual) Asserts that two booleans are equal.
static void	assertEquals( String message, float expected, float actual, float delta) Asserts that two floats are equal concerning a positive delta.
static void	assertEquals( String message, boolean expected, boolean actual) Asserts that two booleans are equal.
static void	assertEquals( String expected, String actual) Asserts that two Strings are equal.
static void	assertEquals(float expected, float actual, float delta) Asserts that two floats are equal concerning a delta.
static void	assertEquals( String message, byte expected, byte actual) Asserts that two bytes 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, 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(long expected, long actual) Asserts that two longs are equal.
static void	assertFalse( String message, boolean condition) Asserts that a condition is false.
static void	assertFalse(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 do not refer to the same object.
static void	assertNotSame( String message, Object expected, Object actual) Asserts that two objects do not refer to the same object.
static void	assertNull( Object object) Asserts that an object is null.
static void	assertNull( String message, Object object) Asserts that an object is null.
static void	assertSame( Object expected, Object actual) Asserts that two objects refer to the same object.
static void	assertSame( String message, 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( String message) Fails a test with the given message.
static void	fail() Fails a test with no message.
static void	failNotEquals( String message, Object expected, Object actual)
static void	failNotSame( String message, Object expected, Object actual)
static void	failSame( String message)
static String	format( String message, Object expected, Object actual)

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() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that 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() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method 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.

From interface junit.framework.Test

Public Constructors

public ServiceTestCase (Class<T> serviceClass)

Added in API level 1

Constructor

Parameters

serviceClass	The type of the service under test.

Public Methods

public Application getApplication ()

Added in API level 1

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

Returns

The application object.

public T getService ()

Added in API level 1

Returns

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

public Context getSystemContext ()

Added in API level 1

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

A normal system context.

public void setApplication (Application application)

Added in API level 1

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

Parameters

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

public void testServiceTestCaseSetUpProperly ()

Added in API level 1

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

Throws

Exception

Protected Methods

protected IBinder bindService (Intent intent)

Added in API level 1

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.

Parameters

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

Returns

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

protected void setUp ()

Added in API level 1

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

protected void setupService ()

Added in API level 1

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.

protected void shutdownService ()

Added in API level 1

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.

protected void startService (Intent intent)

Added in API level 1

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	An Intent that identifies a service, of the same form as the Intent passed to `Context.startService(Intent)`.

protected void tearDown ()

Added in API level 1

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

information

No examples for this method.

Frequently called with: [Clear]

This example was provided by APIMiner.

Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.

Results

Interfaces

Classes

Errors

ServiceTestCase

Class Overview

Developer Guides

Summary

Public Constructors

public ServiceTestCase (Class<T> serviceClass)

Parameters

Public Methods

public Application getApplication ()

Returns

See Also

public T getService ()

Returns

public Context getSystemContext ()

Returns

public void setApplication (Application application)

Parameters

See Also

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