# Virgo Test Framework

The Virgo Test Framework is designed to ease the construction of integration tests that require an OSGi framework. It is maintained in its own git repository. It is fairly primitive, providing just two test runners and an annotation.

## Test Runners

The test framework provides the following test runners.

### OsgiTestRunner

The OsgiTestRunner is for testing components that need a simple OSGi environment. It is invoked via the JUnit @RunWith class annotation, for example:

    import org.junit.runner.RunWith;
    import org.eclipse.virgo.test.framework.OsgiTestRunner;

    @RunWith(OsgiTestRunner.class)
    public class EventLogIntegrationTests { ...

OsgiTestRunner launches Equinox, installs the project containing the testcase class as a bundle, starts the bundle, and then runs the testcase class from inside the bundle using a standard JUnit runner.

### DmKernelTestRunner

The DmKernelTestRunner, which should probably be renamed to VirgoKernelTestRunner, is for testing components that need a Virgo kernel environment complete with kernel and user regions. It must be used in combination with suitable configuration to launch the kernel bundles and the bundle on which the kernel depends.

It is invoked via the JUnit @RunWith class annotation, for example:

    import org.junit.runner.RunWith;
    import org.eclipse.virgo.test.framework.dmkernel.DmKernelTestRunner;

    @RunWith(DmKernelTestRunner.class)
    public abstract class AbstractKernelIntegrationTest { ...

The DmKernelTestRunner extends the function of the OsgiTestRunner to wait for the user region to start before running the testcase.

## Annotations

+ Test Framework Annotations
Annotation | Type | Purpose | Default Value
--- | --- | --- | ---
ConfigLocation | class | Specifies the location from which the test framework should load its configuration | META-INF/test.config.properties

## Test Configuration

The test configuration file specifies a list of bundles to be installed and optionally started as well as kernel and other properties. It is an extended form of the kernel launch properties configuration file.

The Virgo web layer has a fairly typical test configuration file.

The following properties may be specified which would not normally appear in a non-test kernel launch properties configuration file.

+ Test Kernel Launch Properties
Property name | Definition | Default value
--- | --- | ---
A comma separated list of "file:" URLs relative to the current working directory each referring to a properties file. Properties files may provide property placeholders in other configuration files. | Empty list

## Utilities

The standard OSGi utility class FrameworkUtil is used to obtain the test bundle context as in the following example:

    protected final BundleContext testBundleContext = FrameworkUtil.getBundle(getClass()).getBundleContext();