org.gecko.util.test

Class AbstractOSGiTest

java.lang.Object

org.gecko.util.test.AbstractOSGiTest

public abstract class AbstractOSGiTest
extends java.lang.Object

A basic test for OSGi. It provides convenient access to services and manages cleanup operations, when services are registered via the internal methods.

Since:

30 Jul 2018

Constructor Summary

Constructors

Constructor and Description
AbstractOSGiTest(BundleContext bundleContext) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	after() Cleanup Method
void	before()
protected <T> ServiceChecker<T>	createCheckerTrackedForCleanUp(java.lang.Class<T> serviceClass) Creates a ServiceChecker for a specific Service, where at least one Remove is expected.
protected Configuration	createConfigForCleanup(java.lang.String factoryPid, java.lang.String location, java.util.Dictionary<java.lang.String,java.lang.Object> props) A configuration is created and update will be called.
protected Configuration	createConfigForCleanup(java.lang.String factoryPid, java.lang.String name, java.lang.String location, java.util.Dictionary<java.lang.String,java.lang.Object> props) A configuration is created and update will be called.
protected <T> ServiceChecker<T>	createdCheckerTrackedForCleanUp(java.lang.String filter) Creates a ServiceChecker for a specific Service, where at least one Remove is expected.
protected Filter	createFilter(java.util.Dictionary<java.lang.String,java.lang.Object> properties) Creates a filter String looking for all properties in the Dictionary given.
protected void	deleteConfigurationAndRemoveFromCleanup(Configuration config) The Configuration to delete
protected void	deleteConfigurationAndRemoveFromCleanupBlocking(Configuration config) The Configuration to delete.
protected void	deleteConfigurationBlocking(Configuration config) The Configuration to delete.
abstract void	doAfter() will be called in the before the test performs its cleanup, after the Abstract tests has initialized
abstract void	doBefore() will be called in the do before, after the Abstract tests has initialized
BundleContext	getBundleContext() Returns the bundleContext.
ConfigurationAdmin	getConfigAdmin() Returns the configAdmin.
protected <T> T	getService(java.lang.Class<T> clazz) This method will retrieve a Service and does a Assert#assertNotNull(Object) check.
protected <T> T	getService(Filter filter, long timeout) This method will retrieve a Service and does a Assert#assertNotNull(Object) check.
protected void	getServiceAssertNull(Filter filter) This method will try to a Service and does a Assert#assertNull(Object) check.
protected ServiceChecker<?>	getServiceCheckerForConfiguration(Configuration configuration) Returns a service checker for the configuration
protected <T> <any>	getServiceObjects(java.lang.Class<T> clazz) This method will retrieve a Service and does a Assert#assertNotNull(Object) check.
protected <T> <any>	getServiceObjects(java.lang.Class<T> clazz, java.lang.String filter) This method will retrieve a Service and does a Assert#assertNotNull(Object) check.
java.util.Dictionary<java.lang.String,java.lang.Object>	getServiceProperties(java.lang.Object service) returns the service properties of the ServiceRegistration for the given Service
protected <T> <any>	getServiceReference(java.lang.Class<T> clazz) This method will retrieve a Service and does a Assert#assertNotNull(Object) check.
boolean	isRemoveConfigurationTrackServices() Returns true, if service are tracked for removal when cleaning up configurations.
protected void	registerServiceForCleanup(java.lang.Class<?> clazz, java.lang.Object service, java.util.Dictionary<java.lang.String,?> properties) Registers the given service Object.
protected void	registerServiceForCleanup(java.lang.Object service, java.util.Dictionary<java.lang.String,?> properties, java.lang.Class<?> clazz) Registers the given service Object.
protected void	registerServiceForCleanup(java.lang.Object service, java.util.Dictionary<java.lang.String,?> properties, java.lang.String... classes) Registers the given service Object.
void	setRemoveConfigurationTrackServices(boolean track) Enables or disables tracking of services when removing configurations.
protected void	ungetService(java.lang.Object service) Cleanly ungets the given service, if it was retrieved via the getService method.
protected void	unregisterService(java.lang.Object service) Asserts that the given Object is not null and that we know about a ServiceRegistration.
void	updateServiceRegistration(java.lang.Object service, java.util.Dictionary<java.lang.String,?> properties) Updates the given Service with the given Properties

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractOSGiTest

public AbstractOSGiTest(BundleContext bundleContext)

Creates a new instance.

Method Detail

before

public void before()

doBefore

public abstract void doBefore()

will be called in the do before, after the Abstract tests has initialized

isRemoveConfigurationTrackServices

public boolean isRemoveConfigurationTrackServices()

Returns true, if service are tracked for removal when cleaning up configurations.

Returns:

the removeConfigurationTrackServices

setRemoveConfigurationTrackServices

public void setRemoveConfigurationTrackServices(boolean track)

Enables or disables tracking of services when removing configurations. As default this is activated. When activated each time a configuration is removed, a corresponding service is tracked for removal.

Parameters:

track - the value to set

ungetService

protected void ungetService(java.lang.Object service)

Cleanly ungets the given service, if it was retrieved via the getService method.

Parameters:

service - the service to unget

getServiceReference

protected <T> <any> getServiceReference(java.lang.Class<T> clazz)

This method will retrieve a Service and does a Assert#assertNotNull(Object) check. When the test ends, the service will be unget as well.

Parameters:

clazz - The Service Class desired

Returns:

the ServiceReference

getServiceObjects

protected <T> <any> getServiceObjects(java.lang.Class<T> clazz)

This method will retrieve a Service and does a Assert#assertNotNull(Object) check. When the test ends, the service will be unget as well.

Parameters:

clazz - The Service Class desired

Returns:

the ServiceObjects

getServiceObjects

protected <T> <any> getServiceObjects(java.lang.Class<T> clazz,
                                      java.lang.String filter)
                               throws InvalidSyntaxException

This method will retrieve a Service and does a Assert#assertNotNull(Object) check. When the test ends, the service will be unget as well.

Parameters:

clazz - The Service Class desired

filter - the filter to apply as well

Returns:

the ServiceObjects

Throws:

InvalidSyntaxException

getService

protected <T> T getService(java.lang.Class<T> clazz)

This method will retrieve a Service and does a Assert#assertNotNull(Object) check. When the test ends, the service will be unget as well.

Parameters:

clazz - The Service Class desired

Returns:

the service will never be null

getService

protected <T> T getService(Filter filter,
                           long timeout)
                    throws java.lang.InterruptedException

This method will retrieve a Service and does a Assert#assertNotNull(Object) check. When the test ends, the service will be unget as well.

Parameters:

filter - the Filter to use

Returns:

the service, will never be null

Throws:

java.lang.InterruptedException

getServiceAssertNull

protected void getServiceAssertNull(Filter filter)
                             throws java.lang.InterruptedException

This method will try to a Service and does a Assert#assertNull(Object) check.

Parameters:

filter - the Filter to use

Throws:

java.lang.InterruptedException

createConfigForCleanup

protected Configuration createConfigForCleanup(java.lang.String factoryPid,
                                               java.lang.String location,
                                               java.util.Dictionary<java.lang.String,java.lang.Object> props)
                                        throws java.io.IOException

A configuration is created and update will be called. The config is furthermore stored for later cleanup. Note that the cleanup expects a Service that can be tracked on cleanup.

Parameters:

factoryPid - the factoryPid of the service

location - the location of the configuration

props - the properties for the service

Returns:

the config you desire

Throws:

java.io.IOException

createConfigForCleanup

protected Configuration createConfigForCleanup(java.lang.String factoryPid,
                                               java.lang.String name,
                                               java.lang.String location,
                                               java.util.Dictionary<java.lang.String,java.lang.Object> props)
                                        throws java.io.IOException

A configuration is created and update will be called. The config is furthermore stored for later cleanup. Note that the cleanup expects a Service that can be tracked on cleanup.

Parameters:

factoryPid - the factoryPid of the service

name - the addition configuration name of the service

location - the location of the configuration

props - the properties for the service

Returns:

the config you desire

Throws:

java.io.IOException

getServiceCheckerForConfiguration

protected ServiceChecker<?> getServiceCheckerForConfiguration(Configuration configuration)

Returns a service checker for the configuration

Parameters:

configuration - the configuration to get a tracker for

Returns:

the ServiceChecker or null

deleteConfigurationAndRemoveFromCleanup

protected void deleteConfigurationAndRemoveFromCleanup(Configuration config)
                                                throws java.io.IOException

The Configuration to delete

Parameters:

config - the Configuration to remove

Throws:

java.io.IOException

deleteConfigurationAndRemoveFromCleanupBlocking

protected void deleteConfigurationAndRemoveFromCleanupBlocking(Configuration config)
                                                        throws java.io.IOException,
                                                               java.lang.InterruptedException

The Configuration to delete. The method will block, until it receives the notification, that the service is removed. The method will throw a RuntimeException after 5 seconds if nothing happens.

Parameters:

config - the Configuration to remove

Throws:

java.io.IOException

java.lang.InterruptedException

deleteConfigurationBlocking

protected void deleteConfigurationBlocking(Configuration config)
                                    throws java.io.IOException,
                                           java.lang.InterruptedException

The Configuration to delete. The method will block, until it receives the notification, that the service is removed. The method will throw a RuntimeException after 5 seconds if nothing happens.

Parameters:

config - the Configuration to remove

Throws:

java.io.IOException

java.lang.InterruptedException

registerServiceForCleanup

protected void registerServiceForCleanup(java.lang.Object service,
                                         java.util.Dictionary<java.lang.String,?> properties,
                                         java.lang.Class<?> clazz)

Registers the given service Object. This serivce will re unregistered, when the test is teared down. Use unregisterService(Object) to unregister your service.

Parameters:

service - the Service Object to register

properties - the properties connected with this service

clazz - the clazz to register the service under

registerServiceForCleanup

protected void registerServiceForCleanup(java.lang.Class<?> clazz,
                                         java.lang.Object service,
                                         java.util.Dictionary<java.lang.String,?> properties)

Registers the given service Object. This serivce will re unregistered, when the test is teared down. Use unregisterService(Object) to unregister your service.

Parameters:

service - the Service Object to register

properties - the properties connected with this service

clazz - the clazz to register the service under

registerServiceForCleanup

protected void registerServiceForCleanup(java.lang.Object service,
                                         java.util.Dictionary<java.lang.String,?> properties,
                                         java.lang.String... classes)

Registers the given service Object. This serivce will re unregistered, when the test is teared down. Use unregisterService(Object) to unregister your service.

Parameters:

service - the Service Object to register

properties - the properties connected with this service

classes - the classes to register the service under

updateServiceRegistration

public void updateServiceRegistration(java.lang.Object service,
                                      java.util.Dictionary<java.lang.String,?> properties)

Updates the given Service with the given Properties

Parameters:

service - the service to update

properties - the properties to use

getServiceProperties

public java.util.Dictionary<java.lang.String,java.lang.Object> getServiceProperties(java.lang.Object service)

returns the service properties of the ServiceRegistration for the given Service

Parameters:

service - the service to look for

Returns:

the properties of the current service reference

unregisterService

protected void unregisterService(java.lang.Object service)

Asserts that the given Object is not null and that we know about a ServiceRegistration. The service will then be unregistered.

Parameters:

service - the service to unregister.

createFilter

protected Filter createFilter(java.util.Dictionary<java.lang.String,java.lang.Object> properties)

Creates a filter String looking for all properties in the Dictionary given.

Parameters:

properties - the Dictionary with the service properties.

Returns:

the Filter Object

createCheckerTrackedForCleanUp

protected <T> ServiceChecker<T> createCheckerTrackedForCleanUp(java.lang.Class<T> serviceClass)

Creates a ServiceChecker for a specific Service, where at least one Remove is expected. At the End of the Test, it will block until the service is definitely gone.

Parameters:

filter - the OSGi filter String to create the checker with

Returns:

the ServiceChecker

Throws:

InvalidSyntaxException - if the filter syntax is wrong

createdCheckerTrackedForCleanUp

protected <T> ServiceChecker<T> createdCheckerTrackedForCleanUp(java.lang.String filter)
                                                         throws InvalidSyntaxException

Creates a ServiceChecker for a specific Service, where at least one Remove is expected. At the End of the Test, it will block until the service is definitely gone.

Parameters:

filter - the OSGi filter String to create the checker with

Returns:

the ServiceChecker

Throws:

InvalidSyntaxException - if the filter syntax is wrong

after

public void after()
           throws java.lang.Exception

Cleanup Method

Throws:

java.lang.Exception

doAfter

public abstract void doAfter()

will be called in the before the test performs its cleanup, after the Abstract tests has initialized

getConfigAdmin

public ConfigurationAdmin getConfigAdmin()

Returns the configAdmin.

Returns:

the configAdmin

getBundleContext

public BundleContext getBundleContext()

Returns the bundleContext.

Returns:

the bundleContext