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

Interface IFormcycleProvisioner

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FormcycleProvisioner

public interface IFormcycleProvisioner
extends AutoCloseable

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

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
void	close()
default IFormcycleAppState	createNewDefaultClient()	Creates a new default client with default settings, similar to how a new client would be created in the UI.
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.
default IFormcycleAppState	importClient(URI pathToExportDir)	Reads a client export file and creates a new client with the data from that export file.
IFormcycleAppState	importClient(URI pathToExportDir, IExternalClientServices services)	Reads a client export file and creates a new client with the data from that export file.
default IFormcycleAppState	importProject(URI pathToExportDir)	Reads a project export file, creates a new client and import the project contained in the 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.

Method Detail

close

void close()
    throws InterruptedException

Specified by:

close in interface AutoCloseable

Throws:

InterruptedException

createNewDefaultClient

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

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

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.

createNewDefaultClient

default IFormcycleAppState createNewDefaultClient()
                                           throws de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException

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

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

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

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

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

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

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

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.

importClient

default IFormcycleAppState importClient(URI pathToExportDir)
                                 throws de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException

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

Parameters:

pathToExportDir - Path to the directory containing the client export.

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

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

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

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.

importProject

default IFormcycleAppState importProject(URI pathToExportDir)
                                  throws de.xima.e2e.test_harness_selenium.common.exception.TestCaseSetupFailedException

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

Parameters:

pathToExportDir - Path to the directory containing the client export.

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.