org.nuxeo.runtime.test

Class NXRuntimeTestCase

java.lang.Object

org.nuxeo.runtime.test.NXRuntimeTestCase

All Implemented Interfaces:

RuntimeHarness

public class NXRuntimeTestCase
extends Object
implements RuntimeHarness

Abstract base class for test cases that require a test runtime service.

The runtime service itself is conveniently available as the runtime instance variable in derived classes.

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
protected StandaloneBundleLoader	bundleLoader
protected Map<String,BundleFile>	bundles
protected org.jmock.Mockery	jmcontext
protected OSGiAdapter	osgi
protected boolean	restart
protected OSGiRuntimeService	runtime
protected org.osgi.framework.Bundle	runtimeBundle
protected TargetResourceLocator	targetResourceLocator
protected URL[]	urls
protected List<WorkingDirectoryConfigurator>	wdConfigs
protected File	workingDir

Constructor Summary

Constructors

Constructor and Description
NXRuntimeTestCase()
NXRuntimeTestCase(Class<?> clazz)
NXRuntimeTestCase(String name)

Method Summary

Modifier and Type	Method and Description
void	addWorkingDirectoryConfigurator(WorkingDirectoryConfigurator config)
void	deploy(String contrib) Deprecated. use deployContrib() instead
void	deployBundle(String name) Deploys a whole OSGI bundle.
void	deployContrib(String contrib) Deprecated. use the less ambiguous deployContrib(String, String)
void	deployContrib(String name, String contrib) Deploys a contribution from a given bundle.
protected void	deployContrib(URL url)
void	deployFolder(File folder, ClassLoader loader)
RuntimeContext	deployTestContrib(String bundle, String contrib) Deploy an XML contribution from outside a bundle.
RuntimeContext	deployTestContrib(String bundle, URL contrib)
void	fireFrameworkStarted() Fire the event FrameworkEvent.STARTED.
List<String>	getClassLoaderFiles()
RuntimeContext	getContext() Runtime context for deployment
OSGiAdapter	getOSGiAdapter() OSGI bridge
Properties	getProperties() Framework properties for variable injections
static URL	getResource(String name)
File	getWorkingDir() Gets the framework working directory.
protected OSGiRuntimeService	handleNewRuntime(OSGiRuntimeService aRuntime)
protected void	initOsgiRuntime()
protected void	initUrls()
static URL[]	introspectClasspath(ClassLoader loader)
boolean	isRestart()
boolean	isStarted()
protected static boolean	isVersionSuffix(String s)
BundleFile	lookupBundle(String bundleName)
protected URL	lookupBundleUrl(String bundle) Resolves an URL for bundle deployment code.
protected BundleFile	oldLookupBundle(String bundle) Deprecated.
protected String	readSymbolicName(BundleFile bf)
void	restart() Restarts the runtime and preserve homes directory.
void	setUp()
void	start()
void	stop()
void	tearDown()
void	undeploy(String contrib) Deprecated. use undeployContrib(String, String) instead
void	undeployContrib(String contrib) Deprecated. use undeployContrib(String, String) instead
void	undeployContrib(String name, String contrib) Undeploys a contribution from a given bundle.
protected void	wipeRuntime() Makes sure there is no previous runtime hanging around.

Methods inherited from class java.lang.Object

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

Field Detail

jmcontext

protected org.jmock.Mockery jmcontext

runtime

protected OSGiRuntimeService runtime

urls

protected URL[] urls

workingDir

protected File workingDir

bundleLoader

protected StandaloneBundleLoader bundleLoader

bundles

protected Map<String,BundleFile> bundles

restart

protected boolean restart

osgi

protected OSGiAdapter osgi

runtimeBundle

protected org.osgi.framework.Bundle runtimeBundle

wdConfigs

protected final List<WorkingDirectoryConfigurator> wdConfigs

targetResourceLocator

protected final TargetResourceLocator targetResourceLocator

Constructor Detail

NXRuntimeTestCase

public NXRuntimeTestCase()

NXRuntimeTestCase

public NXRuntimeTestCase(String name)

NXRuntimeTestCase

public NXRuntimeTestCase(Class<?> clazz)

Method Detail

isRestart

public boolean isRestart()

Specified by:

isRestart in interface RuntimeHarness

addWorkingDirectoryConfigurator

public void addWorkingDirectoryConfigurator(WorkingDirectoryConfigurator config)

Specified by:

addWorkingDirectoryConfigurator in interface RuntimeHarness

getWorkingDir

public File getWorkingDir()

Description copied from interface: RuntimeHarness

Gets the framework working directory.

Specified by:

getWorkingDir in interface RuntimeHarness

restart

public void restart()
             throws Exception

Restarts the runtime and preserve homes directory.

Specified by:

restart in interface RuntimeHarness

Throws:

Exception

start

public void start()
           throws Exception

Specified by:

start in interface RuntimeHarness

Throws:

Exception

setUp

public void setUp()
           throws Exception

Throws:

Exception

fireFrameworkStarted

public void fireFrameworkStarted()
                          throws Exception

Fire the event FrameworkEvent.STARTED.

Specified by:

fireFrameworkStarted in interface RuntimeHarness

Throws:

Exception

tearDown

public void tearDown()
              throws Exception

Throws:

Exception

stop

public void stop()
          throws Exception

Specified by:

stop in interface RuntimeHarness

Throws:

Exception

isStarted

public boolean isStarted()

Specified by:

isStarted in interface RuntimeHarness

initOsgiRuntime

protected void initOsgiRuntime()
                        throws Exception

Throws:

Exception

handleNewRuntime

protected OSGiRuntimeService handleNewRuntime(OSGiRuntimeService aRuntime)

introspectClasspath

public static URL[] introspectClasspath(ClassLoader loader)

initUrls

protected void initUrls()
                 throws Exception

Throws:

Exception

wipeRuntime

protected void wipeRuntime()
                    throws Exception

Makes sure there is no previous runtime hanging around.

This happens for instance if a previous test had errors in its setUp(), because tearDown() has not been called.

Throws:

Exception

getResource

public static URL getResource(String name)

deploy

@Deprecated
public void deploy(String contrib)

Deprecated. use deployContrib() instead

Specified by:

deploy in interface RuntimeHarness

deployContrib

protected void deployContrib(URL url)

deployContrib

@Deprecated
public void deployContrib(String contrib)

Deprecated. use the less ambiguous deployContrib(String, String)

Deploys a contribution file by looking for it in the class loader.

The first contribution file found by the class loader will be used. You have no guarantee in case of name collisions.

Specified by:

deployContrib in interface RuntimeHarness

Parameters:

contrib - the relative path to the contribution file

deployContrib

public void deployContrib(String name,
                          String contrib)
                   throws Exception

Deploys a contribution from a given bundle.

The path will be relative to the bundle root. Example: deployContrib("org.nuxeo.ecm.core", "OSGI-INF/CoreExtensions.xml")

For compatibility reasons the name of the bundle may be a jar name, but this use is discouraged and deprecated.

Specified by:

deployContrib in interface RuntimeHarness

Parameters:

name - the name of the bundle to peek the contrib in

contrib - the path to contrib in the bundle.

Throws:

Exception

deployTestContrib

public RuntimeContext deployTestContrib(String bundle,
                                        String contrib)
                                 throws Exception

Deploy an XML contribution from outside a bundle.

This should be used by tests wiling to deploy test contribution as part of a real bundle.

The bundle owner is important since the contribution may depend on resources deployed in that bundle.

Note that the owner bundle MUST be an already deployed bundle.

Specified by:

deployTestContrib in interface RuntimeHarness

Parameters:

bundle - the bundle that becomes the contribution owner

contrib - the contribution to deploy as part of the given bundle

Throws:

Exception

deployTestContrib

public RuntimeContext deployTestContrib(String bundle,
                                        URL contrib)
                                 throws Exception

Specified by:

deployTestContrib in interface RuntimeHarness

Throws:

Exception

undeploy

@Deprecated
public void undeploy(String contrib)

Deprecated. use undeployContrib(String, String) instead

Specified by:

undeploy in interface RuntimeHarness

undeployContrib

@Deprecated
public void undeployContrib(String contrib)

Deprecated. use undeployContrib(String, String) instead

Specified by:

undeployContrib in interface RuntimeHarness

undeployContrib

public void undeployContrib(String name,
                            String contrib)
                     throws Exception

Undeploys a contribution from a given bundle.

The path will be relative to the bundle root. Example: undeployContrib("org.nuxeo.ecm.core", "OSGI-INF/CoreExtensions.xml")

Specified by:

undeployContrib in interface RuntimeHarness

Parameters:

name - the bundle

contrib - the contribution

Throws:

Exception

isVersionSuffix

protected static boolean isVersionSuffix(String s)

lookupBundleUrl

protected URL lookupBundleUrl(String bundle)

Resolves an URL for bundle deployment code.

TODO: Implementation could be finer...

Returns:

the resolved url

deployBundle

public void deployBundle(String name)
                  throws Exception

Deploys a whole OSGI bundle.

The lookup is first done on symbolic name, as set in MANIFEST.MF and then falls back to the bundle url (e.g., nuxeo-platform-search-api) for backwards compatibility.

Specified by:

deployBundle in interface RuntimeHarness

Parameters:

name - the symbolic name

Throws:

Exception

readSymbolicName

protected String readSymbolicName(BundleFile bf)

lookupBundle

public BundleFile lookupBundle(String bundleName)
                        throws Exception

Throws:

Exception

oldLookupBundle

@Deprecated
protected BundleFile oldLookupBundle(String bundle)
                                          throws Exception

Deprecated.

Throws:

Exception

deployFolder

public void deployFolder(File folder,
                         ClassLoader loader)
                  throws Exception

Specified by:

deployFolder in interface RuntimeHarness

Throws:

Exception

getProperties

public Properties getProperties()

Description copied from interface: RuntimeHarness

Framework properties for variable injections

Specified by:

getProperties in interface RuntimeHarness

getContext

public RuntimeContext getContext()

Description copied from interface: RuntimeHarness

Runtime context for deployment

Specified by:

getContext in interface RuntimeHarness

getOSGiAdapter

public OSGiAdapter getOSGiAdapter()

Description copied from interface: RuntimeHarness

OSGI bridge

Specified by:

getOSGiAdapter in interface RuntimeHarness

getClassLoaderFiles

public List<String> getClassLoaderFiles()
                                 throws URISyntaxException

Specified by:

getClassLoaderFiles in interface RuntimeHarness

Throws:

URISyntaxException