org.ops4j.pax.exam

Interface TestContainer

public interface TestContainer

Management of an OSGi framework that can be used as a integration test container. Each container is also a test target. When constucting TestContainers, it is good practice to not put the parsing part (from Option[]) into the implementation. Instead, make the native container construction really simple and tied to the underlying container.

Since:

0.3.0, December 09, 2008

Author:

Alin Dreghiciu (adreghiciu@gmail.com), Toni Menzel (toni@okidokiteam.com), Harald Wellmann

Method Summary

Modifier and Type	Method and Description
void	call(TestAddress address)
long	install(InputStream stream)
long	install(String location, InputStream stream)
long	installProbe(InputStream stream) Installs a probe from the given stream.
TestContainer	start() Starts the test container.
TestContainer	stop() Stops the regression container.
void	uninstallProbe() Uninstalls the current probe.

Method Detail

start

TestContainer start()

Starts the test container.

Returns:

this for fluent api

Throws:

TimeoutException - - if timeout occured and the test container cannot be started

install

long install(InputStream stream)

Parameters:

stream - stream the content

Returns:

Bundle ID

install

long install(String location,
             InputStream stream)

Parameters:

location - update location of the installed stream. (used on bundle.update())

stream - stream the content

Returns:

Bundle ID

installProbe

long installProbe(InputStream stream)

Installs a probe from the given stream. A test container supports at most one probe at a time. The installed probe (if any) can be uninstalled using uninstallProbe().

Parameters:

stream - probe bundle

Returns:

bundle ID of probe bundle, or -1 if not in OSGi mode

uninstallProbe

void uninstallProbe()

Uninstalls the current probe. The container keeps running and can be reused with a new probe.

Throws:

TestContainerException - if no probe installed.

call

void call(TestAddress address)

Parameters:

address - the target to be called.

Throws:

TestContainerException - exception

stop

TestContainer stop()

Stops the regression container. Implementations should take care of calling cleanup() internally, too.

Returns:

this for fluent api

Throws:

TimeoutException - - if timeout occured and the regression container cannot be stopped