* WireMock response transformers may be specified by declaring public static fields with the @WorkflowTestTransformer * annotation. For example: * *
* @WorkflowTestTransformer * public static final ResponseTransformer sdncAdapterMockTransformer = new SDNCAdapterMockTransformer(); **/ public abstract class WorkflowTest { private static final Logger logger = LoggerFactory.getLogger(WorkflowTest.class); // TODO this is not used anymore, can maybe be removed @Rule public ProcessEngineRule processEngineRule; @Autowired protected WorkflowResource workflowResourceSync; @Autowired protected ProcessEngine processEngine; @Autowired protected RuntimeService runtimeService; @Autowired protected HistoryService historyService; @Autowired private WorkflowAsyncResource workflowResource; @Autowired private WorkflowMessageResource workflowMessageResource; @Autowired SDNCAdapterCallbackServiceImpl callbackService; /** * Content-Type for XML. */ protected static final String XML = "application/xml"; /** * Content-Type for JSON. */ protected static final String JSON = "application/json; charset=UTF-8"; private static final int timeout = 2000; /** * Constructor. */ public WorkflowTest() throws RuntimeException {} /** * The current request ID. Normally set when an "invoke" method is called. */ protected volatile String msoRequestId = null; /** * The current service instance ID. Normally set when an "invoke" method is called. */ protected volatile String msoServiceInstanceId = null; /** * Logs a test start method. */ protected void logStart() { logger.debug("STARTED TEST"); } /** * Logs a test end method. */ protected void logEnd() { logger.debug("ENDED TEST"); } /** * Invokes a subprocess. * * @param processKey the process key * @param businessKey a unique key that will identify the process instance * @param injectedVariables variables to inject into the process */ protected void invokeSubProcess(String processKey, String businessKey, Map
* reserve, assign, delete:ERR
*
*
* Errors are handled with junit assertions and will cause the test to fail.
*
* @param callbacks an object containing callback data for the program
* @param program the program to execute
*/
protected void injectSDNCRestCallbacks(CallbackSet callbacks, String program) {
String[] cmds = program.replaceAll("\\s+", "").split(",");
for (String cmd : cmds) {
String action = cmd;
String modifier = "STD";
if (cmd.contains(":")) {
String[] parts = cmd.split(":");
action = parts[0];
modifier = parts[1];
}
String content = null;
String contentType = null;
if ("STD".equals(modifier)) {
CallbackData callbackData = callbacks.get(action);
if (callbackData == null) {
String msg = "No callback defined for '" + action + "' SDNC request";
logger.debug(msg);
fail(msg);
}
content = callbackData.getContent();
contentType = callbackData.getContentType();
} else if ("ERR".equals(modifier)) {
content =
"{\"SDNCServiceError\":{\"sdncRequestId\":\"((REQUEST-ID))\",\"responseCode\":\"500\",\"responseMessage\":\"SIMULATED ERROR FROM SDNC ADAPTER\",\"ackFinalIndicator\":\"Y\"}}";
contentType = JSON;
} else {
String msg = "Invalid SDNC program modifier: '" + modifier + "'";
logger.debug(msg);
fail(msg);
}
if (contentType == null) {
// Default for backward compatibility with existing tests.
contentType = JSON;
}
if (!injectSDNCRestCallback(contentType, content, 10000)) {
fail("Failed to inject SDNC '" + action + "' callback");
}
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
fail("Interrupted after injection of SDNC '" + action + "' callback");
}
}
}
/**
* Runs a program to inject SDNC events into the test environment. A program is essentially just a list of keys that
* identify event data to be injected, in sequence. An example program:
*
*
* event1, event2
*
*
* NOTE: Each callback must have a message type associated with it, e.g. "SDNCAEvent". Errors are handled with junit
* assertions and will cause the test to fail.
*
* @param callbacks an object containing event data for the program
* @param program the program to execute
*/
protected void injectSDNCEvents(CallbackSet callbacks, String program) {
injectWorkflowMessages(callbacks, program);
}
/**
* Runs a program to inject SDNC callback data into the test environment. A program is essentially just a list of
* keys that identify callback data to be injected, in sequence. An example program:
*
*
* reserve, assign, delete:ERR
*
*
* Errors are handled with junit assertions and will cause the test to fail. Uses the static/default timeout value
* for backward compatibility.
*
* @param callbacks an object containing callback data for the program
* @param program the program to execute
*/
protected void injectSDNCCallbacks(CallbackSet callbacks, String program) {
injectSDNCCallbacks(callbacks, program, timeout);
}
/**
* Runs a program to inject SDNC callback data into the test environment. A program is essentially just a list of
* keys that identify callback data to be injected, in sequence. An example program:
*
*
* reserve, assign, delete:ERR
*
*
* Errors are handled with junit assertions and will cause the test to fail.
*
* @param callbacks an object containing callback data for the program
* @param program the program to execute
* @param timeout a timeout value to wait for the callback
*/
protected void injectSDNCCallbacks(CallbackSet callbacks, String program, int timeout) {
String[] cmds = program.replaceAll("\\s+", "").split(",");
for (String cmd : cmds) {
String action = cmd;
String modifier = "STD";
if (cmd.contains(":")) {
String[] parts = cmd.split(":");
action = parts[0];
modifier = parts[1];
}
String content = null;
int respCode = 200;
String respMsg = "OK";
if ("STD".equals(modifier)) {
CallbackData callbackData = callbacks.get(action);
if (callbackData == null) {
String msg = "No callback defined for '" + action + "' SDNC request";
logger.debug(msg);
fail(msg);
}
content = callbackData.getContent();
respCode = 200;
respMsg = "OK";
} else if ("CREATED".equals(modifier)) {
CallbackData callbackData = callbacks.get(action);
if (callbackData == null) {
String msg = "No callback defined for '" + action + "' SDNC request";
logger.debug(msg);
fail(msg);
}
content = callbackData.getContent();
respCode = 201;
respMsg = "Created";
} else if ("ERR".equals(modifier)) {
content =
"
* create, rollback
*
*
* Errors are handled with junit assertions and will cause the test to fail.
*
* @param callbacks an object containing callback data for the program
* @param program the program to execute
*/
protected void injectVNFRestCallbacks(CallbackSet callbacks, String program) {
String[] cmds = program.replaceAll("\\s+", "").split(",");
for (String cmd : cmds) {
String action = cmd;
String modifier = "STD";
if (cmd.contains(":")) {
String[] parts = cmd.split(":");
action = parts[0];
modifier = parts[1];
}
String content = null;
String contentType = null;
if ("STD".equals(modifier)) {
CallbackData callbackData = callbacks.get(action);
if (callbackData == null) {
String msg = "No callback defined for '" + action + "' VNF REST request";
logger.debug(msg);
fail(msg);
}
content = callbackData.getContent();
contentType = callbackData.getContentType();
} else if ("ERR".equals(modifier)) {
content = "SIMULATED ERROR FROM VNF ADAPTER";
contentType = "text/plain";
} else {
String msg = "Invalid VNF REST program modifier: '" + modifier + "'";
logger.debug(msg);
fail(msg);
}
if (contentType == null) {
// Default for backward compatibility with existing tests.
contentType = XML;
}
if (!injectVnfAdapterRestCallback(contentType, content, 10000)) {
fail("Failed to inject VNF REST '" + action + "' callback");
}
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
fail("Interrupted after injection of VNF REST '" + action + "' callback");
}
}
}
/**
* Waits for the number of running processes with the specified process definition key to equal a particular count.
*
* @param processKey the process definition key
* @param count the desired count
* @param timeout the timeout in milliseconds
*/
protected void waitForRunningProcessCount(String processKey, int count, long timeout) {
logger.debug("Waiting {}ms for there to be {} {} instances", timeout, count, processKey);
long now = System.currentTimeMillis() + timeout;
long endTime = now + timeout;
int last = -1;
while (now <= endTime) {
int actual = runtimeService.createProcessInstanceQuery().processDefinitionKey(processKey).list().size();
if (actual != last) {
logger.debug("There are now {} {} instances", actual, processKey);
last = actual;
}
if (actual == count) {
return;
}
try {
Thread.sleep(200);
} catch (InterruptedException e) {
String msg = "Interrupted waiting for there to be " + count + " " + processKey + " instances";
logger.debug(msg);
fail(msg);
}
now = System.currentTimeMillis();
}
String msg = "Timed out waiting for there to be " + count + " " + processKey + " instances";
logger.debug(msg);
fail(msg);
}
/**
* Waits for the specified process variable to be set.
*
* @param processKey the process definition key
* @param variable the variable name
* @param timeout the timeout in milliseconds
* @return the variable value, or null if it cannot be obtained in the specified time
*/
protected Object getProcessVariable(String processKey, String variable, long timeout) {
logger.debug("Waiting " + timeout + "ms for " + processKey + "." + variable + " to be set");
long now = System.currentTimeMillis() + timeout;
long endTime = now + timeout;
ProcessInstance processInstance = null;
Object value = null;
while (value == null) {
if (now > endTime) {
if (processInstance == null) {
logger.debug("Timed out waiting for " + processKey + " to start");
} else {
logger.debug("Timed out waiting for " + processKey + "[" + processInstance.getId() + "]." + variable
+ " to be set");
}
return null;
}
ProcessInstanceQuery processInstanceQuery = null;
if (processInstance == null) {
processInstanceQuery = runtimeService.createProcessInstanceQuery().processDefinitionKey(processKey);
}
if (processInstanceQuery.count() == 1 || processInstanceQuery.count() == 0) {
processInstance = processInstanceQuery.singleResult();
} else {
// TODO There shouldnt be more than one in the list but seems to be happening, need to figure out why
// happening and best way to get correct one from list
logger.debug("Process Instance Query returned {} instance. Getting the last instance in the list",
processInstanceQuery.count());
List
* event1, event2
*
*
* Errors are handled with junit assertions and will cause the test to fail. NOTE: Each callback must have a
* workflow message type associated with it.
*
* @param callbacks an object containing event data for the program
* @param program the program to execute
*/
protected void injectWorkflowMessages(CallbackSet callbacks, String program) {
String[] cmds = program.replaceAll("\\s+", "").split(",");
for (String cmd : cmds) {
String action = cmd;
String modifier = "STD";
if (cmd.contains(":")) {
String[] parts = cmd.split(":");
action = parts[0];
modifier = parts[1];
}
String messageType = null;
String content = null;
String contentType = null;
if ("STD".equals(modifier)) {
CallbackData callbackData = callbacks.get(action);
if (callbackData == null) {
String msg = "No '" + action + "' workflow message callback is defined";
logger.debug(msg);
fail(msg);
}
messageType = callbackData.getMessageType();
if (messageType == null || messageType.trim().equals("")) {
String msg = "No workflow message type is defined in the '" + action + "' callback";
logger.debug(msg);
fail(msg);
}
content = callbackData.getContent();
contentType = callbackData.getContentType();
} else {
String msg = "Invalid workflow message program modifier: '" + modifier + "'";
logger.debug(msg);
fail(msg);
}
if (!injectWorkflowMessage(contentType, messageType, content, 10000)) {
fail("Failed to inject '" + action + "' workflow message");
}
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
fail("Interrupted after injection of '" + action + "' workflow message");
}
}
}
/**
* Injects a workflow message. The specified callback data may contain the placeholder string ((CORRELATOR)) which
* is replaced with the actual correlator value.
*
* @param contentType the HTTP contentType for the message (possibly null)
* @param messageType the message type
* @param content the message content (possibly null)
* @param timeout the timeout in milliseconds
* @return true if the message could be injected, false otherwise
*/
protected boolean injectWorkflowMessage(String contentType, String messageType, String content, long timeout) {
String correlator = (String) getProcessVariable("ReceiveWorkflowMessage", messageType + "_CORRELATOR", timeout);
if (correlator == null) {
return false;
}
if (content != null) {
content = content.replace("((CORRELATOR))", correlator);
}
logger.debug("Injecting " + messageType + " message");
Response response = workflowMessageResource.deliver(contentType, messageType, correlator, content);
logger.debug("Workflow response to {} message: {}", messageType, response);
return true;
}
/**
* Wait for the process to end.
*
* @param businessKey the process business key
* @param timeout the amount of time to wait, in milliseconds
*/
protected void waitForProcessEnd(String businessKey, long timeout) {
logger.debug("Waiting {}ms for process with business key {} to end", timeout, businessKey);
long now = System.currentTimeMillis() + timeout;
long endTime = now + timeout;
while (now <= endTime) {
if (isProcessEnded(businessKey)) {
logger.debug("Process with business key {} has ended", businessKey);
return;
}
try {
Thread.sleep(200);
} catch (InterruptedException e) {
String msg = "Interrupted waiting for process with business key " + businessKey + " to end";
logger.debug(msg);
fail(msg);
}
now = System.currentTimeMillis();
}
String msg = "Process with business key " + businessKey + " did not end within " + timeout + "ms";
logger.debug(msg);
fail(msg);
}
/**
* Wait for the process to end. Must be used when multiple process instances exist with this same business key such
* as when its passed to subflows or shared across multiple processes.
*
* @param businessKey the process business key
* @param processName the process definition name
* @param timeout the amount of time to wait, in milliseconds
* @author cb645j
*/
protected void waitForProcessEnd(String businessKey, String processName, long timeout) {
logger.debug("Waiting {}ms for process with business key {} to end", timeout, businessKey);
long now = System.currentTimeMillis() + timeout;
long endTime = now + timeout;
while (now <= endTime) {
if (isProcessEnded(businessKey, processName)) {
logger.debug("Process with business key {} has ended", businessKey);
return;
}
try {
Thread.sleep(200);
} catch (InterruptedException e) {
String msg = "Interrupted waiting for process with business key " + businessKey + " to end";
logger.debug(msg);
fail(msg);
}
now = System.currentTimeMillis();
}
String msg = "Process with business key " + businessKey + " did not end within " + timeout + "ms";
logger.debug(msg);
fail(msg);
}
/**
* Verifies that the specified historic process variable has the specified value. If the variable does not have the
* specified value, the test is failed.
*
* @param businessKey the process business key
* @param variable the variable name
* @param value the expected variable value
*/
protected void checkVariable(String businessKey, String variable, Object value) {
if (!isProcessEnded(businessKey)) {
fail("Cannot get historic variable " + variable + " because process with business key " + businessKey
+ " has not ended");
}
Object variableValue = getVariableFromHistory(businessKey, variable);
assertEquals(value, variableValue);
}
/**
* Checks to see if the specified process is ended.
*
* @param businessKey the process business Key
* @return true if the process is ended
*/
protected boolean isProcessEnded(String businessKey) {
HistoricProcessInstance processInstance = historyService.createHistoricProcessInstanceQuery()
.processInstanceBusinessKey(businessKey).singleResult();
return processInstance != null && processInstance.getEndTime() != null;
}
/**
* Checks to see if the specified process is ended.
*
* @param processInstanceId the process Instance Id
* @return true if the process is ended
*/
protected boolean isProcessEndedByProcessInstanceId(String processInstanceId) {
HistoricProcessInstance processInstance =
historyService.createHistoricProcessInstanceQuery().processInstanceId(processInstanceId).singleResult();
return processInstance != null && processInstance.getEndTime() != null;
}
/**
* Checks to see if the specified process is ended.
*
* @author cb645j
*/
// TODO combine into 1
private boolean isProcessEnded(String businessKey, String processName) {
HistoricProcessInstance processInstance = historyService.createHistoricProcessInstanceQuery()
.processInstanceBusinessKey(businessKey).processDefinitionName(processName).singleResult();
return processInstance != null && processInstance.getEndTime() != null;
}
/**
* Gets a variable value from a historical process instance. The business key must be unique.
*
* @param businessKey the process business key
* @param variableName the variable name
* @return the variable value or null if the variable does not exist
*/
protected Object getVariableFromHistory(String businessKey, String variableName) {
try {
HistoricProcessInstance processInstance = historyService.createHistoricProcessInstanceQuery()
.processInstanceBusinessKey(businessKey).singleResult();
if (processInstance == null) {
return null;
}
HistoricVariableInstance v = historyService.createHistoricVariableInstanceQuery()
.processInstanceId(processInstance.getId()).variableName(variableName).singleResult();
return v == null ? null : v.getValue();
} catch (Exception e) {
logger.debug("Error retrieving variable {} from historical process with business key {}: ", variableName,
businessKey, e);
return null;
}
}
protected Object getVariableFromHistoryByProcessInstanceId(String processInstanceId, String variableName) {
try {
HistoricVariableInstance v = historyService.createHistoricVariableInstanceQuery()
.processInstanceId(processInstanceId).variableName(variableName).singleResult();
return v == null ? null : v.getValue();
} catch (Exception e) {
logger.debug("Error retrieving variable {} from historical process with processInstanceId {}: ",
variableName, processInstanceId, e);
return null;
}
}
/**
* Gets a variable value from a process instance based on businessKey and process name. Must be used when multiple
* instances exist with the same business key such as when business key is passed to subflows or shared across
* multiple processes. This method can obtain variables from mainflows and from subflows.
*
* @param businessKey the process business key
* @param processName the process definition name
* @param variableName the variable name
* @return the variable value or null if the variable does not exist
* @author cb645j
*/
protected Object getVariableFromHistory(String businessKey, String processName, String variableName) {
try {
HistoricProcessInstance processInstance = historyService.createHistoricProcessInstanceQuery()
.processInstanceBusinessKey(businessKey).processDefinitionName(processName).singleResult();
if (processInstance == null) {
return null;
}
HistoricVariableInstance variable = historyService.createHistoricVariableInstanceQuery()
.processInstanceId(processInstance.getId()).variableName(variableName).singleResult();
return variable == null ? null : variable.getValue();
} catch (ProcessEngineException e) {
logger.debug(
"Multiple proccess instances exist with process name {} and business key {}. Must pass instance "
+ "index as a parameter.",
processName, businessKey);
return null;
} catch (Exception e) {
logger.debug("Error retrieving variable {} from historical process for process {} with business key {}: ",
variableName, processName, businessKey, e);
return null;
}
}
/**
* Gets the value of a process variable from x instance of y process. Must be used when multiple instances exist
* with the same business key AND process name. This method shall be used primarily for obtaining subflow variables
* when the business key is passed to the subflow AND the subflow is called multiple times in a given flow.
*
* @param businessKey the process business key
* @param processName the name of the subflow that contains the variable
* @param variableName the variable name
* @param processInstanceIndex the instance in which the subprocess was called
* @return the variable value or null if the variable does not exist
* @author cb645j
*/
protected Object getVariableFromHistory(String businessKey, int subflowInstanceIndex, String processName,
String variableName) {
try {
List