Package org.robolectric

Class RobolectricTestRunner

java.lang.Object

org.junit.runner.Runner

org.junit.runners.ParentRunner<org.junit.runners.model.FrameworkMethod>

org.junit.runners.BlockJUnit4ClassRunner

org.robolectric.internal.SandboxTestRunner

org.robolectric.RobolectricTestRunner

All Implemented Interfaces:

org.junit.runner.Describable, org.junit.runner.manipulation.Filterable, org.junit.runner.manipulation.Orderable, org.junit.runner.manipulation.Sortable

public class RobolectricTestRunner
extends SandboxTestRunner

Loads and runs a test in a SandboxClassLoader in order to provide a simulation of the Android runtime environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RobolectricTestRunner.DeprecatedTestRunnerDefaultConfigProvider	Deprecated.
static class	RobolectricTestRunner.HelperTestRunner
static class	RobolectricTestRunner.RobolectricFrameworkMethod	Fields in this class must be serializable using XStream.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_PROPERTIES

Fields inherited from class org.robolectric.internal.SandboxTestRunner

classHandlerBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
	RobolectricTestRunner(Class<?> testClass)	Creates a runner to run testClass.
protected	RobolectricTestRunner(Class<?> testClass, Injector injector)

Method Summary

Modifier and Type	Method	Description
protected void	afterClass()
protected void	afterTest(org.junit.runners.model.FrameworkMethod method, Method bootstrappedMethod)
protected void	beforeTest(Sandbox sandbox, org.junit.runners.model.FrameworkMethod method, Method bootstrappedMethod)
protected Config	buildGlobalConfig()	Deprecated. Provide a service implementation of GlobalConfigProvider instead.
static AndroidManifest	createAndroidManifest(ManifestIdentifier manifestIdentifier)	Deprecated. Do not use.
protected ClassHandler	createClassHandler(ShadowMap shadowMap, Sandbox sandbox)	Create a ClassHandler appropriate for the given arguments.
protected InstrumentationConfiguration	createClassLoaderConfig(org.junit.runners.model.FrameworkMethod method)	Create an InstrumentationConfiguration suitable for the provided FrameworkMethod.
Object	createTest()
protected static Injector.Builder	defaultInjector()
protected void	finallyAfterTest(org.junit.runners.model.FrameworkMethod method)
protected Collection<Interceptor>	findInterceptors()
protected Properties	getBuildSystemApiProperties()
protected List<org.junit.runners.model.FrameworkMethod>	getChildren()
Config	getConfig(Method method)	Deprecated. Provide an implementation of Provider instead.
protected Class<?>[]	getExtraShadows(org.junit.runners.model.FrameworkMethod frameworkMethod)
protected SandboxTestRunner.HelperTestRunner	getHelperTestRunner(Class bootstrappedTestClass)
protected ManifestFactory	getManifestFactory(Config config)	Detects which build system is in use and returns the appropriate ManifestFactory implementation.
protected AndroidSandbox	getSandbox(org.junit.runners.model.FrameworkMethod method)
protected Class<? extends TestLifecycle>	getTestLifecycleClass()	An instance of the returned class will be created for each test invocation.
protected static Properties	staticGetBuildSystemApiProperties()

Methods inherited from class org.robolectric.internal.SandboxTestRunner

classBlock, configureSandbox, getInterceptors, methodBlock, withPotentialTimeout

Methods inherited from class org.junit.runners.BlockJUnit4ClassRunner

collectInitializationErrors, computeTestMethods, createTest, describeChild, getTestRules, isIgnored, methodInvoker, possiblyExpectingExceptions, rules, runChild, testName, validateConstructor, validateFields, validateInstanceMethods, validateNoNonStaticInnerClass, validateOnlyOneConstructor, validateTestMethods, validateZeroArgConstructor, withAfters, withBefores

Methods inherited from class org.junit.runners.ParentRunner

childrenInvoker, classRules, createTestClass, filter, getDescription, getName, getRunnerAnnotations, getTestClass, order, run, runLeaf, setScheduler, sort, validatePublicVoidNoArgMethods, withAfterClasses, withBeforeClasses, withInterruptIsolation

Methods inherited from class org.junit.runner.Runner

testCount

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONFIG_PROPERTIES

public static final String CONFIG_PROPERTIES

See Also:

Constant Field Values

Constructor Details

RobolectricTestRunner

public RobolectricTestRunner(Class<?> testClass) throws org.junit.runners.model.InitializationError

Creates a runner to run testClass. Use the Config annotation to configure.

Parameters:

testClass - the test class to be run

Throws:

org.junit.runners.model.InitializationError - if junit says so

RobolectricTestRunner

protected RobolectricTestRunner(Class<?> testClass, Injector injector) throws org.junit.runners.model.InitializationError

Throws:

org.junit.runners.model.InitializationError

Method Details

defaultInjector

protected static Injector.Builder defaultInjector()

createClassHandler

@Nonnull protected ClassHandler createClassHandler(ShadowMap shadowMap, Sandbox sandbox)

Create a ClassHandler appropriate for the given arguments.

Robolectric may chose to cache the returned instance, keyed by shadowMap and sandbox.

Custom TestRunner subclasses may wish to override this method to provide alternate configuration.

Overrides:

createClassHandler in class SandboxTestRunner

Parameters:

shadowMap - the ShadowMap in effect for this test

sandbox - the Sdk in effect for this test

Returns:

an appropriate ShadowWrangler.

Since:

2.3

findInterceptors

@Nonnull protected Collection<Interceptor> findInterceptors()

Overrides:

findInterceptors in class SandboxTestRunner

createClassLoaderConfig

@Nonnull protected InstrumentationConfiguration createClassLoaderConfig(org.junit.runners.model.FrameworkMethod method)

Create an InstrumentationConfiguration suitable for the provided FrameworkMethod.

Adds configuration for Android using AndroidConfigurer.

Custom TestRunner subclasses may wish to override this method to provide additional configuration.

Overrides:

createClassLoaderConfig in class SandboxTestRunner

Parameters:

method - the test method that's about to run

Returns:

an InstrumentationConfiguration

getTestLifecycleClass

@Nonnull protected Class<? extends TestLifecycle> getTestLifecycleClass()

An instance of the returned class will be created for each test invocation.

Custom TestRunner subclasses may wish to override this method to provide alternate configuration.

Returns:

a class which implements TestLifecycle. This implementation returns a DefaultTestLifecycle.

getChildren

protected List<org.junit.runners.model.FrameworkMethod> getChildren()

Overrides:

getChildren in class org.junit.runners.BlockJUnit4ClassRunner

getSandbox

@Nonnull protected AndroidSandbox getSandbox(org.junit.runners.model.FrameworkMethod method)

Overrides:

getSandbox in class SandboxTestRunner

beforeTest

protected void beforeTest(Sandbox sandbox, org.junit.runners.model.FrameworkMethod method, Method bootstrappedMethod) throws Throwable

Overrides:

beforeTest in class SandboxTestRunner

Throws:

Throwable

afterTest

protected void afterTest(org.junit.runners.model.FrameworkMethod method, Method bootstrappedMethod)

Overrides:

afterTest in class SandboxTestRunner

finallyAfterTest

protected void finallyAfterTest(org.junit.runners.model.FrameworkMethod method)

Overrides:

finallyAfterTest in class SandboxTestRunner

getHelperTestRunner

protected SandboxTestRunner.HelperTestRunner getHelperTestRunner(Class bootstrappedTestClass)

Overrides:

getHelperTestRunner in class SandboxTestRunner

getManifestFactory

protected ManifestFactory getManifestFactory(Config config)

Detects which build system is in use and returns the appropriate ManifestFactory implementation.

Custom TestRunner subclasses may wish to override this method to provide alternate configuration.

Parameters:

config - Specification of the SDK version, manifest file, package name, etc.

getBuildSystemApiProperties

protected Properties getBuildSystemApiProperties()

staticGetBuildSystemApiProperties

protected static Properties staticGetBuildSystemApiProperties()

createAndroidManifest

@Deprecated public static AndroidManifest createAndroidManifest(ManifestIdentifier manifestIdentifier)

Deprecated.

Do not use.

Internal use only.

getConfig

@Deprecated public Config getConfig(Method method)

Deprecated.

Provide an implementation of Provider instead. This method will be removed in Robolectric 4.3.

Compute the effective Robolectric configuration for a given test method.

Configuration information is collected from package-level robolectric.properties files and Config annotations on test classes, superclasses, and methods.

Custom TestRunner subclasses may wish to override this method to provide alternate configuration.

Parameters:

method - the test method

Returns:

the effective Robolectric configuration for the given test method

Since:

2.0

See Also:

Migration Notes for more details.

buildGlobalConfig

@Deprecated protected Config buildGlobalConfig()

Deprecated.

Provide a service implementation of GlobalConfigProvider instead. This method will be removed in Robolectric 4.3.

Provides the base Robolectric configuration Config used for all tests.

Configuration provided for specific packages, test classes, and test method configurations will override values provided here.

Custom TestRunner subclasses may wish to override this method to provide alternate configuration. Consider using a Config.Builder.

The default implementation has appropriate values for most use cases.

Returns:

global Config object

Since:

3.1.3

See Also:

Migration Notes for more details.

getExtraShadows

@Nonnull protected Class<?>[] getExtraShadows(org.junit.runners.model.FrameworkMethod frameworkMethod)

Overrides:

getExtraShadows in class SandboxTestRunner

afterClass

protected void afterClass()

Overrides:

afterClass in class SandboxTestRunner

createTest

public Object createTest() throws Exception

Overrides:

createTest in class org.junit.runners.BlockJUnit4ClassRunner

Throws:

Exception