Package de.xima.fc.e2e.environment.api

Class FormcycleEnvironments

java.lang.Object

de.xima.fc.e2e.environment.api.FormcycleEnvironments

public final class FormcycleEnvironments
extends Object

Main entry point for creating and working with FORMCYCLE E2E test environments. Such an environment consists of a servlet container and a fully configured FORMCYCLE web app.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
static void	configureConfigBuilderWithDefaults(IFormcycleEnvironmentConfigBuilder builder)	Applies the defaults for a standard FORMCYCLE app to the builder.
static void	configureE2EEnvironment(de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironmentConfigBuilder<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState> builder, IFormcycleEnvironmentConfig config)	Configures a builder for running a FORMCYCLE app in the E2E test environment.
static IFormcycleEnvironmentConfigBuilder	newConfigBuilder()
static IFormcycleEnvironmentConfig	newDefaultConfig(URI defaultWarFile)	Creates a new configuration with the defaults for a standard FORMCYCLE app already applied.
static IFormcycleEnvironmentConfigBuilder	newDefaultConfigBuilder(URI defaultWarFile)	Creates a new configuration builder with the defaults for a standard FORMCYCLE app already applied.
static de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironment<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState>	newDefaultEnvironment(URI defaultWarFile)	Creates a new environment with the defaults for a standard FORMCYCLE app already applied.
static de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironment<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState>	newEnvironment(IFormcycleEnvironmentConfig config)
static IExternalClientServicesBuilder	newExternalServicesBuilder()
static IFormcycleProvisioner	newProvisioner(de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironment<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState> environment)	Creates a new provisioner for setting up the FORMCYCLE system before a test case can be run.
static IFormcycleUriManager	newUriManager(de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironment<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState> environment, FormcycleSetupResult setupResult)	Creates a URI manager for evaluating the results of a certain setup result.

Methods inherited from class java.lang.Object

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

Method Detail

configureConfigBuilderWithDefaults

public static void configureConfigBuilderWithDefaults(IFormcycleEnvironmentConfigBuilder builder)
                                               throws Exception

Applies the defaults for a standard FORMCYCLE app to the builder.

Parameters:

builder - Builder to configure.

Throws:

Exception - When the builder could not be configured.

configureE2EEnvironment

public static void configureE2EEnvironment(de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironmentConfigBuilder<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState> builder,
                                           IFormcycleEnvironmentConfig config)
                                    throws Exception

Configures a builder for running a FORMCYCLE app in the E2E test environment.

Parameters:

builder - Builder to configure.

config - Configuration for the FORMCYCLE app.

Throws:

Exception - When the builder could not be configured.

newConfigBuilder

public static IFormcycleEnvironmentConfigBuilder newConfigBuilder()

Returns:

A new builder for creating and configuring a IFormcycleEnvironmentConfigBuilder.

newExternalServicesBuilder

public static IExternalClientServicesBuilder newExternalServicesBuilder()

newDefaultConfig

public static IFormcycleEnvironmentConfig newDefaultConfig(URI defaultWarFile)
                                                    throws Exception

Creates a new configuration with the defaults for a standard FORMCYCLE app already applied.

Parameters:

defaultWarFile - WAR file to use when no override via a system property was specified.

Returns:

A new config with the FORMCYCLE default applied.

Throws:

Exception - When the configuration could not be created.

newDefaultConfigBuilder

public static IFormcycleEnvironmentConfigBuilder newDefaultConfigBuilder(URI defaultWarFile)
                                                                  throws Exception

Creates a new configuration builder with the defaults for a standard FORMCYCLE app already applied.

Parameters:

defaultWarFile - WAR file to use when no override via a system property was specified.

Returns:

A new builder with the FORMCYCLE default applied.

Throws:

Exception - When the builder could not be configured.

newDefaultEnvironment

public static de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironment<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState> newDefaultEnvironment(URI defaultWarFile)
                                                                                                                                                                            throws Exception

Creates a new environment with the defaults for a standard FORMCYCLE app already applied.

Parameters:

defaultWarFile - WAR file to use when no override via a system property was specified.

Returns:

A new environment with the FORMCYCLE defaults applied.

Throws:

Exception - When the environment could not be created.

newEnvironment

public static de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironment<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState> newEnvironment(IFormcycleEnvironmentConfig config)
                                                                                                                                                                     throws Exception

Parameters:

config - Configuration for the environment.

Returns:

Creates and starts a new environment with gthe given configuration.

Throws:

Exception - When the environment could not be created or started.

newProvisioner

public static IFormcycleProvisioner newProvisioner(de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironment<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState> environment)

Creates a new provisioner for setting up the FORMCYCLE system before a test case can be run.

Parameters:

environment - Current environment with the FORMCYCLE app to set up.

Returns:

A provisioner for the given environment.

newUriManager

public static IFormcycleUriManager newUriManager(de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironment<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState> environment,
                                                 FormcycleSetupResult setupResult)

Creates a URI manager for evaluating the results of a certain setup result.

Parameters:

environment - Current environment with the FORMCYCLE app to test.

setupResult - Setup result obtained by a provisioner.

Returns:

A URI manager for the given setup result.