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.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 and Description
static class	RobolectricTestRunner.HelperTestRunner

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
RobolectricTestRunner(java.lang.Class<?> testClass) Creates a runner to run testClass.

Method Summary

Modifier and Type	Method and Description
protected void	afterClass()
protected void	afterTest(org.junit.runners.model.FrameworkMethod method, java.lang.reflect.Method bootstrappedMethod)
protected void	beforeTest(Sandbox sandbox, org.junit.runners.model.FrameworkMethod method, java.lang.reflect.Method bootstrappedMethod)
protected Config	buildGlobalConfig() Provides the base Robolectric configuration Config used for all tests.
protected void	configureSandbox(Sandbox sandbox, org.junit.runners.model.FrameworkMethod method)
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.
protected SdkPicker	createSdkPicker() Create a SdkPicker for determining which SDKs will be tested.
java.lang.Object	createTest()
protected void	finallyAfterTest(org.junit.runners.model.FrameworkMethod method)
protected java.util.Collection<Interceptor>	findInterceptors()
protected java.util.Properties	getBuildSystemApiProperties()
protected java.util.List<org.junit.runners.model.FrameworkMethod>	getChildren()
Config	getConfig(java.lang.reflect.Method method) Compute the effective Robolectric configuration for a given test method.
protected java.lang.Class<?>[]	getExtraShadows(org.junit.runners.model.FrameworkMethod frameworkMethod)
protected SandboxTestRunner.HelperTestRunner	getHelperTestRunner(java.lang.Class bootstrappedTestClass)
protected DependencyResolver	getJarResolver()
protected ManifestFactory	getManifestFactory(Config config) Detects which build system is in use and returns the appropriate ManifestFactory implementation.
protected SdkEnvironment	getSandbox(org.junit.runners.model.FrameworkMethod method)
protected SandboxFactory	getSandboxFactory()
protected java.lang.Class<? extends TestLifecycle>	getTestLifecycleClass() An instance of the returned class will be created for each test invocation.
protected void	internalAfterTest(org.junit.runners.model.FrameworkMethod frameworkMethod, java.lang.reflect.Method method)
protected boolean	shouldIgnore(org.junit.runners.model.FrameworkMethod method)

Methods inherited from class org.robolectric.internal.SandboxTestRunner

classBlock, createShadowMap, getInterceptors, getPerfStatsReporters, methodBlock, runChild

Methods inherited from class org.junit.runners.BlockJUnit4ClassRunner

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

Methods inherited from class org.junit.runners.ParentRunner

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

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 Detail

CONFIG_PROPERTIES

public static final java.lang.String CONFIG_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

RobolectricTestRunner

public RobolectricTestRunner(java.lang.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

Method Detail

getJarResolver

protected DependencyResolver getJarResolver()

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 sdkConfig.

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 SdkConfig in effect for this test

Returns:

an appropriate ClassHandler. This implementation returns a ShadowWrangler.

Since:

2.3

createSdkPicker

@Nonnull
protected SdkPicker createSdkPicker()

Create a SdkPicker for determining which SDKs will be tested.

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

Returns:

an SdkPicker.

Since:

3.2

findInterceptors

@Nonnull
protected java.util.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

configureSandbox

protected void configureSandbox(Sandbox sandbox,
                                org.junit.runners.model.FrameworkMethod method)

Overrides:

configureSandbox in class SandboxTestRunner

getTestLifecycleClass

@Nonnull
protected java.lang.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 java.util.List<org.junit.runners.model.FrameworkMethod> getChildren()

Overrides:

getChildren in class org.junit.runners.BlockJUnit4ClassRunner

shouldIgnore

protected boolean shouldIgnore(org.junit.runners.model.FrameworkMethod method)

Overrides:

shouldIgnore in class SandboxTestRunner

getSandbox

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

Overrides:

getSandbox in class SandboxTestRunner

getSandboxFactory

protected SandboxFactory getSandboxFactory()

beforeTest

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

Overrides:

beforeTest in class SandboxTestRunner

Throws:

java.lang.Throwable

afterTest

protected void afterTest(org.junit.runners.model.FrameworkMethod method,
                         java.lang.reflect.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(java.lang.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 java.util.Properties getBuildSystemApiProperties()

createAndroidManifest

@Deprecated
public static AndroidManifest createAndroidManifest(ManifestIdentifier manifestIdentifier)

Deprecated. Do not use.

Internal use only.

getConfig

public Config getConfig(java.lang.reflect.Method method)

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

buildGlobalConfig

protected Config buildGlobalConfig()

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

getExtraShadows

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

Overrides:

getExtraShadows in class SandboxTestRunner

internalAfterTest

protected void internalAfterTest(org.junit.runners.model.FrameworkMethod frameworkMethod,
                                 java.lang.reflect.Method method)

afterClass

protected void afterClass()

Overrides:

afterClass in class SandboxTestRunner

createTest

public java.lang.Object createTest()
                            throws java.lang.Exception

Overrides:

createTest in class org.junit.runners.BlockJUnit4ClassRunner

Throws:

java.lang.Exception