NXRuntimeTestCase (Nuxeo ECM Projects 10.1 API)

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.
Warning: NXRuntimeTestCase subclasses must
- not declare they own @Before and @After.
- override doSetUp and doTearDown (and postSetUp if needed) instead of setUp and tearDown.
- never call deployXXX methods outside the doSetUp method.
Author:

Bogdan Stefanescu

Field Summary

Fields
Modifier and Type	Field and Description
`protected StandaloneBundleLoader`	`bundleLoader`
`protected Map<String,BundleFile>`	`bundles`
`protected List<String[]>`	`deploymentStack`
`protected boolean`	`frameworkStarted` Whether or not the runtime components were started.
`protected boolean`	`isTestUnit` Set to true when the instance of this class is a JUnit test case.
`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()` Used when subclassing to create standalone test cases
`NXRuntimeTestCase(Class<?> clazz)` Used by the features runner to manage the Nuxeo framework

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addWorkingDirectoryConfigurator(WorkingDirectoryConfigurator config)`
`protected void`	`applyInlineDeployments()` Should be called by subclasses after one or more inline deployments are made inside a test method.
`void`	`deployBundle(String name)` Deploys a whole OSGI bundle.
`void`	`deployContrib(String uri)` Deploy a contribution specified as a "bundleName:path" uri
`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`	`deployPartial(String name, Set<TargetExtensions> targetExtensions)` Deploys a subset of a Bundle defined per the targetExtensions parameter
`protected void`	`deployPartialComponent(RuntimeContext ctx, Set<TargetExtensions> extensionPoints, StreamRef component)` Read a component from his StreamRef and create a new component (suffixed with `-partial`, and the base component name aliased) with only matching contributions of the extensionPoints parameter.
`RuntimeContext`	`deployTestContrib(String bundle, String contrib)` Deprecated. since 10.1, use `deployContrib(String, String)`
`RuntimeContext`	`deployTestContrib(String bundle, URL contrib)` Deprecated. since 10.1, use `deployContrib(String, String)`
`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)`
`protected Stream<URL>`	`listBundleComponents(org.osgi.framework.Bundle bundle)` Listing component's urls of a bundle.
`BundleFile`	`lookupBundle(String bundleName)`
`protected URL`	`lookupBundleUrl(String bundle)` Resolves an URL for bundle deployment code.
`void`	`popInlineDeployments()` Remove the latest deployed components using `pushInlineDeployments(String...)`.
`void`	`popInlineDeployments(int index)`
`protected void`	`postSetUp()` Called after framework was started (at the end of setUp).
`void`	`pushInlineDeployments(String... deploymentUris)` Hot deploy the given components (identified by an URI).
`protected String`	`readSymbolicName(BundleFile bf)`
`protected void`	`removeInlineDeployments()` Should be called by subclasses to remove any inline deployments made in the current test method.
`void`	`restart()` Restarts the runtime and preserve homes directory.
`protected void`	`setUp()` Implementors should override this method to setup tests and not the `startRuntime()` method.
`void`	`start()`
`void`	`startRuntime()`
`void`	`stop()`
`void`	`stopRuntime()`
`protected void`	`tearDown()` Implementors should override this method to implement any specific test tear down and not the `stopRuntime()` method
`void`	`undeployContrib(String uri)`
`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
```
  - deploymentStack
```
protected List<String[]> deploymentStack
```
  - frameworkStarted
```
protected boolean frameworkStarted
```
    Whether or not the runtime components were started. This is useful to ensure the runtime is started once.
  - osgi
```
protected OSGiAdapter osgi
```
  - runtimeBundle
```
protected org.osgi.framework.Bundle runtimeBundle
```
  - wdConfigs
```
protected final List<WorkingDirectoryConfigurator> wdConfigs
```
  - targetResourceLocator
```
protected final TargetResourceLocator targetResourceLocator
```
  - isTestUnit
```
protected final boolean isTestUnit
```
    Set to true when the instance of this class is a JUnit test case. Set to false when the instance of this class is instantiated by the FeaturesRunner to manage the framework If the class is a JUnit test case then the runtime components will be started at the end of the setUp method
- Constructor Detail
  - NXRuntimeTestCase
```
public NXRuntimeTestCase()
```
    Used when subclassing to create standalone test cases
  - NXRuntimeTestCase
```
public NXRuntimeTestCase(Class<?> clazz)
```
    Used by the features runner to manage the Nuxeo framework
- 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
  - startRuntime
```
public void startRuntime()
                  throws Exception
```
    Throws:
    
    Exception
  - setUp
```
protected void setUp()
              throws Exception
```
    Implementors should override this method to setup tests and not the startRuntime() method. This method should contain all the bundle or component deployments needed by the tests. At the time this method is called the components are not yet started. If you need to perform component/service lookups use instead the postSetUp() method
    
    Throws:
    
    Exception
  - tearDown
```
protected void tearDown()
                 throws Exception
```
    Implementors should override this method to implement any specific test tear down and not the stopRuntime() method
    
    Throws:
    
    Exception
  - postSetUp
```
protected void postSetUp()
                  throws Exception
```
    Called after framework was started (at the end of setUp). Implementors may use this to use deployed services to initialize fields etc.
    
    Throws:
    
    Exception
  - fireFrameworkStarted
```
public void fireFrameworkStarted()
                          throws Exception
```
    Fire the event FrameworkEvent.STARTED. This will start all the resolved Nuxeo components
    
    Specified by:
    
    fireFrameworkStarted in interface RuntimeHarness
    
    Throws:
    
    Exception
    
    See Also:
    
    OSGiRuntimeService.frameworkEvent(FrameworkEvent)
  - stopRuntime
```
public void stopRuntime()
                 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)
```
  - deployContrib
```
protected void deployContrib(URL url)
```
  - 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
  - deployContrib
```
public void deployContrib(String uri)
                   throws Exception
```
    Deploy a contribution specified as a "bundleName:path" uri
    
    Throws:
    
    Exception
  - deployTestContrib
```
@Deprecated
public RuntimeContext deployTestContrib(String bundle,
                                                    String contrib)
                                             throws Exception
```
    Deprecated. since 10.1, use deployContrib(String, String)
    
    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
```
@Deprecated
public RuntimeContext deployTestContrib(String bundle,
                                                    URL contrib)
                                             throws Exception
```
    Deprecated. since 10.1, use deployContrib(String, String)
    
    Specified by:
    
    deployTestContrib in interface RuntimeHarness
    
    Throws:
    
    Exception
  - deployPartial
```
public RuntimeContext deployPartial(String name,
                                    Set<TargetExtensions> targetExtensions)
                             throws Exception
```
    Description copied from interface: RuntimeHarness
    
    Deploys a subset of a Bundle defined per the targetExtensions parameter
    
    Specified by:
    
    deployPartial in interface RuntimeHarness
    
    Parameters:
    
    name - the name of the component
    
    targetExtensions - Set of allowed TargetExtensions in the final contribution
    
    Throws:
    
    Exception
  - deployPartialComponent
```
protected void deployPartialComponent(RuntimeContext ctx,
                                      Set<TargetExtensions> extensionPoints,
                                      StreamRef component)
                               throws IOException
```
    Read a component from his StreamRef and create a new component (suffixed with `-partial`, and the base component name aliased) with only matching contributions of the extensionPoints parameter.
    
    Parameters:
    
    ctx - RuntimeContext in which the new component will be deployed
    
    extensionPoints - Set of white listed TargetExtensions
    
    component - Reference to the original component
    
    Throws:
    
    IOException
  - listBundleComponents
```
protected Stream<URL> listBundleComponents(org.osgi.framework.Bundle bundle)
```
    Listing component's urls of a bundle. Inspired from org.nuxeo.runtime.osgi.OSGiRuntimeService#loadComponents but without deploying anything.
    
    Parameters:
    
    bundle - Bundle to be read
  - 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
  - undeployContrib
```
public void undeployContrib(String uri)
                     throws Exception
```
    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
  - 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
  - applyInlineDeployments
```
protected void applyInlineDeployments()
                               throws Exception
```
    Should be called by subclasses after one or more inline deployments are made inside a test method. Without calling this the inline deployment(s) will not have any effects.
    Be Warned that if you reference runtime services or components you should lookup them again after calling this method!
    This method also calls postSetUp() for convenience.
    
    Throws:
    
    Exception
  - removeInlineDeployments
```
protected void removeInlineDeployments()
                                throws Exception
```
    Should be called by subclasses to remove any inline deployments made in the current test method.
    Be Warned that if you reference runtime services or components you should lookup them again after calling this method!
    This method also calls postSetUp() for convenience.
    
    Throws:
    
    Exception
  - pushInlineDeployments
```
public void pushInlineDeployments(String... deploymentUris)
                           throws Exception
```
    Hot deploy the given components (identified by an URI). All the started components are stopped, the new ones are registered and then all components are started. You can undeploy these components by calling popInlineDeployments()
    A component URI is of the form: bundleSymbolicName:pathToComponentXmlInBundle
    
    Throws:
    
    Exception
  - popInlineDeployments
```
public void popInlineDeployments()
                          throws Exception
```
    Remove the latest deployed components using pushInlineDeployments(String...).
    
    Throws:
    
    Exception
  - popInlineDeployments
```
public void popInlineDeployments(int index)
                          throws Exception
```
    Throws:
    
    Exception

Class NXRuntimeTestCase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

jmcontext

runtime

urls

workingDir

bundleLoader

bundles

restart

deploymentStack

frameworkStarted

osgi

runtimeBundle

wdConfigs

targetResourceLocator

isTestUnit

Constructor Detail

NXRuntimeTestCase

NXRuntimeTestCase

Method Detail

isRestart

addWorkingDirectoryConfigurator

getWorkingDir

restart

start

startRuntime

setUp

tearDown

postSetUp

fireFrameworkStarted

stopRuntime

stop

isStarted

initOsgiRuntime

handleNewRuntime

introspectClasspath

initUrls

wipeRuntime

getResource

deployContrib

deployContrib

deployContrib

deployTestContrib

deployTestContrib

deployPartial

deployPartialComponent

listBundleComponents

undeployContrib

undeployContrib

isVersionSuffix

lookupBundleUrl

deployBundle

readSymbolicName

lookupBundle

deployFolder

getProperties

getContext

getOSGiAdapter

getClassLoaderFiles

applyInlineDeployments

removeInlineDeployments

pushInlineDeployments

popInlineDeployments

popInlineDeployments