flexagon.fd.core.workflow

Class MockWorkflowExecutionContext

java.lang.Object

flexagon.ff.common.core.pojos.BasePOJO

flexagon.fd.core.workflow.WorkflowExecutionContext

flexagon.fd.core.workflow.MockWorkflowExecutionContext

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MockWorkflowExecutionContext
extends WorkflowExecutionContext

MockWorkflowExecutionContext is used for testing plugins. MockWorkflowExecutionContext sets up the file structure necessary for a project. Please set Java Option: -Dflexagon.fd.install.root to the path where the folders will be created. The directories are created like this: flexagon.fd.install.root\ work \ 1 \ 1 \ temp,artifacts,etc. You can modify execution folders by changing Project Id and/or WorkflowExecutionId. Add properties and input by calling various add methods. Change Environment and Instance code by calling set methods if necessary. It is recommended to set flexagon.fd.install.root to a unique path for each plugin developed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MockWorkflowExecutionContext() Create a MockWorkflowExecutionContext with no inputs.
MockWorkflowExecutionContext(java.util.Map<java.lang.String,PropertyValue> pInputs) Create a MockWorkflowExecutionContext with no inputs.

Method Summary

Modifier and Type	Method and Description
void	addBooleanCurrentInstanceProperty(java.lang.String pKey, java.lang.Boolean pValue)
void	addBooleanInput(java.lang.String pKey, java.lang.Boolean pValue)
void	addBooleanInstanceProperty(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Boolean pValue)
void	addBooleanProjectProperty(java.lang.String pKey, java.lang.Boolean pValue)
void	addDoubleCurrentInstanceProperty(java.lang.String pKey, java.lang.Double pValue)
void	addDoubleInput(java.lang.String pKey, java.lang.Double pValue)
void	addDoubleInstanceProperty(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Double pValue)
void	addDoubleProjectProperty(java.lang.String pKey, java.lang.Double pValue)
void	addIntegerCurrentInstanceProperty(java.lang.String pKey, java.lang.Integer pValue)
void	addIntegerInput(java.lang.String pKey, java.lang.Integer pValue)
void	addIntegerInstanceProperty(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Integer pValue)
void	addIntegerProjectProperty(java.lang.String pKey, java.lang.Integer pValue)
void	addStringCurrentInstanceProperty(java.lang.String pKey, java.lang.String pValue)
void	addStringInput(java.lang.String pKey, java.lang.String pValue)
void	addStringInstanceProperty(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.String pValue)
void	addStringProjectProperty(java.lang.String pKey, java.lang.String pValue)
void	cleanArtifactsDirectory()
void	cleanInternalDirectory()
void	cleanObjectResultsDirectory()
void	cleanReportsDirectory()
void	cleanScanResultsDirectory()
void	cleanTempDirectory()
void	cleanTestResultsDirectory()
void	cleanTransferDirectory()
void	cleanWorkingDirectory() This cleans all the directories inside the Working directory as well.
java.lang.String	getInstallPluginsDirectory(java.lang.String pluginName, java.lang.String pluginVersion) Returns the plugin installation sub-directory for the given plugin name and plugin version.
boolean	isWindows()
void	mkdirs()
void	setEnvironmentCode(java.lang.String pCode)
void	setInstanceCode(java.lang.String pCode)
void	setIsWindows(boolean pIsWindows)
void	setOrginatingWorkflowExecutionId(java.lang.Long pOrginatingWorkflowExecutionId) INTERNAL USE ONLY
void	setProjectId(java.lang.Long pProjectId)
void	setWorkflowExecutionId(java.lang.Long pWorkflowExecutionId) INTERNAL USE ONLY

Methods inherited from class flexagon.fd.core.workflow.WorkflowExecutionContext

addProperty, addProperty, clone, getArtifactsDirectory, getBackupsDirectory, getBaseInstallDirectory, getBaseWorkingDirectory, getCommits, getEnvironment, getInput, getInputMap, getInstallPluginsDirectory, getInstance, getInternalDirectory, getIssues, getLastEndPoint, getMainInstance, getObjectResultsDirectory, getOrginatingWorkflowExecutionId, getOutputMap, getPackageObjects, getPluginExecutionId, getPrintablePropertyValue, getPrintablePropertyValue, getProject, getProjectSourcesDirectory, getProperties, getPropertyDefinitions, getPropertyValue, getPropertyValue, getPropertyValueOrDefault, getPropertyValueOrDefault, getReportsDirectory, getScanResultsDirectory, getTempDirectory, getTestResultsDirectory, getTransferDirectory, getWorkflowExecutionId, getWorkflowRequestId, getWorkflowType, getWorkingDirectory, isBuildWorkflow, isConsumesArtifacts, isDeployOrPreDeployWorkflow, isDeployOrUtilityWorkflow, isDeployWorkflow, isForceDeploy, isPostRefresh, isPreDeployWorkflow, isProducesArtifacts, isSyncStateWorkflow, isTestWorkflow, isUtilityWorkflow, setBaseInstallDirectory, setCommits, setConsumesArtifacts, setEnvironment, setForceDeploy, setInstance, setIssues, setLastEndPoint, setMainInstance, setOutput, setPackageObjects, setPluginExecutionId, setPostRefresh, setProducesArtifacts, setProject, setProperties, setPropertyDefinitions, setWorkflowRequestId, setWorkflowType, toString

Methods inherited from class flexagon.ff.common.core.pojos.BasePOJO

areEqual

Methods inherited from class java.lang.Object

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

Constructor Detail

MockWorkflowExecutionContext

public MockWorkflowExecutionContext()

Create a MockWorkflowExecutionContext with no inputs. Properties are added later.

MockWorkflowExecutionContext

public MockWorkflowExecutionContext(java.util.Map<java.lang.String,PropertyValue> pInputs)

Create a MockWorkflowExecutionContext with no inputs. Properties are added later.

Method Detail

setProjectId

public void setProjectId(java.lang.Long pProjectId)

setWorkflowExecutionId

public void setWorkflowExecutionId(java.lang.Long pWorkflowExecutionId)

Description copied from class: WorkflowExecutionContext

INTERNAL USE ONLY

Overrides:

setWorkflowExecutionId in class WorkflowExecutionContext

setOrginatingWorkflowExecutionId

public void setOrginatingWorkflowExecutionId(java.lang.Long pOrginatingWorkflowExecutionId)

Description copied from class: WorkflowExecutionContext

INTERNAL USE ONLY

Overrides:

setOrginatingWorkflowExecutionId in class WorkflowExecutionContext

mkdirs

public void mkdirs()

cleanTempDirectory

public void cleanTempDirectory()
                        throws FlexCheckedException

Throws:

FlexCheckedException

cleanArtifactsDirectory

public void cleanArtifactsDirectory()
                             throws FlexCheckedException

Throws:

FlexCheckedException

cleanInternalDirectory

public void cleanInternalDirectory()
                            throws FlexCheckedException

Throws:

FlexCheckedException

cleanTransferDirectory

public void cleanTransferDirectory()
                            throws FlexCheckedException

Throws:

FlexCheckedException

cleanObjectResultsDirectory

public void cleanObjectResultsDirectory()
                                 throws FlexCheckedException

Throws:

FlexCheckedException

cleanScanResultsDirectory

public void cleanScanResultsDirectory()
                               throws FlexCheckedException

Throws:

FlexCheckedException

cleanTestResultsDirectory

public void cleanTestResultsDirectory()
                               throws FlexCheckedException

Throws:

FlexCheckedException

cleanReportsDirectory

public void cleanReportsDirectory()
                           throws FlexCheckedException

Throws:

FlexCheckedException

cleanWorkingDirectory

public void cleanWorkingDirectory()
                           throws FlexCheckedException

This cleans all the directories inside the Working directory as well. This includes all other directories.

Throws:

FlexCheckedException

isWindows

public boolean isWindows()

Overrides:

isWindows in class WorkflowExecutionContext

setIsWindows

public void setIsWindows(boolean pIsWindows)

addBooleanInput

public void addBooleanInput(java.lang.String pKey,
                            java.lang.Boolean pValue)

addDoubleInput

public void addDoubleInput(java.lang.String pKey,
                           java.lang.Double pValue)

addIntegerInput

public void addIntegerInput(java.lang.String pKey,
                            java.lang.Integer pValue)

addStringInput

public void addStringInput(java.lang.String pKey,
                           java.lang.String pValue)

addBooleanCurrentInstanceProperty

public void addBooleanCurrentInstanceProperty(java.lang.String pKey,
                                              java.lang.Boolean pValue)

addDoubleCurrentInstanceProperty

public void addDoubleCurrentInstanceProperty(java.lang.String pKey,
                                             java.lang.Double pValue)

addIntegerCurrentInstanceProperty

public void addIntegerCurrentInstanceProperty(java.lang.String pKey,
                                              java.lang.Integer pValue)

addStringCurrentInstanceProperty

public void addStringCurrentInstanceProperty(java.lang.String pKey,
                                             java.lang.String pValue)

addBooleanInstanceProperty

public void addBooleanInstanceProperty(java.lang.String pInstanceCode,
                                       java.lang.String pKey,
                                       java.lang.Boolean pValue)

addDoubleInstanceProperty

public void addDoubleInstanceProperty(java.lang.String pInstanceCode,
                                      java.lang.String pKey,
                                      java.lang.Double pValue)

addIntegerInstanceProperty

public void addIntegerInstanceProperty(java.lang.String pInstanceCode,
                                       java.lang.String pKey,
                                       java.lang.Integer pValue)

addStringInstanceProperty

public void addStringInstanceProperty(java.lang.String pInstanceCode,
                                      java.lang.String pKey,
                                      java.lang.String pValue)

addBooleanProjectProperty

public void addBooleanProjectProperty(java.lang.String pKey,
                                      java.lang.Boolean pValue)

addDoubleProjectProperty

public void addDoubleProjectProperty(java.lang.String pKey,
                                     java.lang.Double pValue)

addIntegerProjectProperty

public void addIntegerProjectProperty(java.lang.String pKey,
                                      java.lang.Integer pValue)

addStringProjectProperty

public void addStringProjectProperty(java.lang.String pKey,
                                     java.lang.String pValue)

setInstanceCode

public void setInstanceCode(java.lang.String pCode)

setEnvironmentCode

public void setEnvironmentCode(java.lang.String pCode)

getInstallPluginsDirectory

public java.lang.String getInstallPluginsDirectory(java.lang.String pluginName,
                                                   java.lang.String pluginVersion)

Description copied from class: WorkflowExecutionContext

Returns the plugin installation sub-directory for the given plugin name and plugin version. This directory is located in the following path on the endpoint:

   [plugin installation directory]/[plugin name]/[plugin version] 

Overrides:

getInstallPluginsDirectory in class WorkflowExecutionContext

Parameters:

pluginName - the name of the plugin

pluginVersion - the plugin version

Returns:

the plugin installation directory for a specific plugin name and version