Package de.xima.fc.e2e.environment.impl

Class FormcycleProvisioner

java.lang.Object

de.xima.fc.e2e.environment.impl.FormcycleProvisioner

All Implemented Interfaces:

IFormcycleProvisioner, AutoCloseable

public final class FormcycleProvisioner
extends Object
implements IFormcycleProvisioner

Provisions the FORMCYVLE app to meet the necessary preconditions before a test case can be executed.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
FormcycleProvisioner(de.xima.e2e.test_harness_selenium.environment.api.IE2EEnvironment<IIntegrationTestLifecycleListener,IFormcycleEnvironmentLifecycleState> environment)	Creates a new provisioner for a FORMCYCLE app environment.

Method Summary

Modifier and Type	Method	Description
void	close()
IFormcycleAppState	createNewDefaultClient(IExternalClientServices services)	Creates a new default client with default settings, similar to how a new client would be created in the UI.
IFormcycleAppState	createSystem()	Ensures the FORMCYCLE system is up and running, but does not create any clients.
IFormcycleAppState	importClient(URI pathToExportDir, IExternalClientServices services)	Reads a client export file and creates a new client with the data from that export file.
IFormcycleAppState	importProject(URI pathToExportDir, IExternalClientServices services)	Reads a project export file, creates a new client and import the project contained in the export file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.e2e.environment.api.IFormcycleProvisioner

createNewDefaultClient, importClient, importProject

Constructor Detail

FormcycleProvisioner

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

Creates a new provisioner for a FORMCYCLE app environment.

Parameters:

environment - E2E environment for the FORMCYCLE app.

Method Detail

close

public void close()
           throws InterruptedException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IFormcycleProvisioner

Throws:

InterruptedException

createNewDefaultClient

public IFormcycleAppState createNewDefaultClient(IExternalClientServices services)
                                          throws de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException

Description copied from interface: IFormcycleProvisioner

Creates a new default client with default settings, similar to how a new client would be created in the UI.

Specified by:

createNewDefaultClient in interface IFormcycleProvisioner

Parameters:

services - External services to use for the new client.

Returns:

Context with data about the created client.

Throws:

de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException - When the client could not be created.

createSystem

public IFormcycleAppState createSystem()
                                throws de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException

Description copied from interface: IFormcycleProvisioner

Ensures the FORMCYCLE system is up and running, but does not create any clients.

Specified by:

createSystem in interface IFormcycleProvisioner

Returns:

Context with data about the performed setup.

Throws:

de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException - When the system could not be prepared.

importClient

public IFormcycleAppState importClient(URI pathToExportDir,
                                       IExternalClientServices services)
                                throws de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException

Description copied from interface: IFormcycleProvisioner

Reads a client export file and creates a new client with the data from that export file.

Specified by:

importClient in interface IFormcycleProvisioner

Parameters:

pathToExportDir - Path to the directory containing the client export.

services - External services to use for the new client.

Returns:

Context with data about the imported data.

Throws:

de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException - When the client could not be imported.

importProject

public IFormcycleAppState importProject(URI pathToExportDir,
                                        IExternalClientServices services)
                                 throws de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException

Description copied from interface: IFormcycleProvisioner

Reads a project export file, creates a new client and import the project contained in the export file.

Specified by:

importProject in interface IFormcycleProvisioner

Parameters:

pathToExportDir - Path to the directory containing the client export.

services - External services to use for the new client.

Returns:

Context with data about the imported data.

Throws:

de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException - When the project could not be imported.