org.camunda.bpm.extension.process_test_coverage.util

Class BpmnJsReport

java.lang.Object

org.camunda.bpm.extension.process_test_coverage.util.BpmnJsReport

public class BpmnJsReport
extends Object

Util generating graphical process test coverage reports.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	JQUERY_RUNNING_FLOWNODE_MARKING_COMMAND
protected static String	JQUERY_SEQUENCEFLOW_MARKING_COMMAND JQuery command used for sequence flow SVG arrows coverage coloring.
protected static String	PLACEHOLDER_ANNOTATIONS Placeholder to be replaced with the addMarker annotation for all flow nodes.
protected static String	PLACEHOLDER_BPMN_XML Placeholder to be replaces with the BPMN content.
protected static String	PLACEHOLDER_COVERAGE Placeholder to be replaced with the process coverage percentage.
protected static String	PLACEHOLDER_PROCESS_KEY Placeholder to be replaced with the process key.
protected static String	PLACEHOLDER_TESTCLASS Placeholder to be replaced with the test class full qualified name.
protected static String	PLACEHOLDER_TESTMETHOD Placeholder to be replaced with the test method name.

Constructor Summary

Constructors

Constructor and Description
BpmnJsReport()

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	generateHtml(String javaScript, String bpmnXml, String processDefinitionKey, double coverage, String testClass, String testMethod, boolean classReport) Generates the report html.
protected static String	generateJavaScriptFlowNodeAnnotations(Collection<CoveredFlowNode> flowNodeIds) Generate the add marker javascript for the passed flow node IDs.
protected static String	generateJavaScriptSequenceFlowAnnotations(Collection<String> sequenceFlowIds) Generate jquery markers for the passed sequence flow IDs.
static void	generateReportWithHighlightedFlowNodesAndSequenceFlows(String bpmnXml, Collection<CoveredFlowNode> flowNodes, Collection<String> sequenceFlowIds, String reportName, String processDefinitionKey, double coverage, String testClass, String testMethod, boolean classReport, String targetDir) Generates a html coverage report for a process definition from the passed parameters.
protected static String	injectIntoHtmlTemplate(String javaScript, String bpmnXml, String html, String processDefinitionKey, double coverage, String testClass, String testMethod, boolean classReport) Inject the BPMN XML, javascript markers ad info-box fields into the html template.
protected static void	writeToFile(String targetDir, String fileName, String html) Write the html report.

Methods inherited from class java.lang.Object

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

Field Detail

PLACEHOLDER_PROCESS_KEY

protected static final String PLACEHOLDER_PROCESS_KEY

Placeholder to be replaced with the process key.

See Also:

Constant Field Values

PLACEHOLDER_COVERAGE

protected static final String PLACEHOLDER_COVERAGE

Placeholder to be replaced with the process coverage percentage.

See Also:

Constant Field Values

PLACEHOLDER_TESTCLASS

protected static final String PLACEHOLDER_TESTCLASS

Placeholder to be replaced with the test class full qualified name.

See Also:

Constant Field Values

PLACEHOLDER_TESTMETHOD

protected static final String PLACEHOLDER_TESTMETHOD

Placeholder to be replaced with the test method name.

See Also:

Constant Field Values

PLACEHOLDER_ANNOTATIONS

protected static final String PLACEHOLDER_ANNOTATIONS

Placeholder to be replaced with the addMarker annotation for all flow nodes. (canvas.addMarker())

See Also:

Constant Field Values

PLACEHOLDER_BPMN_XML

protected static final String PLACEHOLDER_BPMN_XML

Placeholder to be replaces with the BPMN content.

See Also:

Constant Field Values

JQUERY_SEQUENCEFLOW_MARKING_COMMAND

protected static final String JQUERY_SEQUENCEFLOW_MARKING_COMMAND

JQuery command used for sequence flow SVG arrows coverage coloring.

See Also:

Constant Field Values

JQUERY_RUNNING_FLOWNODE_MARKING_COMMAND

protected static final String JQUERY_RUNNING_FLOWNODE_MARKING_COMMAND

See Also:

Constant Field Values

Constructor Detail

BpmnJsReport

public BpmnJsReport()

Method Detail

generateReportWithHighlightedFlowNodesAndSequenceFlows

public static void generateReportWithHighlightedFlowNodesAndSequenceFlows(String bpmnXml,
                                                          Collection<CoveredFlowNode> flowNodes,
                                                          Collection<String> sequenceFlowIds,
                                                          String reportName,
                                                          String processDefinitionKey,
                                                          double coverage,
                                                          String testClass,
                                                          String testMethod,
                                                          boolean classReport,
                                                          String targetDir)
                                                                   throws IOException

Generates a html coverage report for a process definition from the passed parameters.

Parameters:

bpmnXml - The BPMN XML of the report process definition.

flowNodes - Flow nodes to be highlighted.

sequenceFlowIds - Sequence flows to be highlighted.

reportName - The file name of the report.

processDefinitionKey - The key of the report process definition.

coverage - The coverage percentage.

testClass - The name of the test class.

testMethod - The name of the test method if applicable.

classReport - When true a class report will be generated, otherwise a method report. The difference is mainly in the info-box method name field not appearing.

targetDir - The directory where the report will be stored.

Throws:

IOException - Thrown if an error occurs on report template read or report write.

generateHtml

protected static String generateHtml(String javaScript,
                  String bpmnXml,
                  String processDefinitionKey,
                  double coverage,
                  String testClass,
                  String testMethod,
                  boolean classReport)
                              throws IOException

Generates the report html.

Parameters:

javaScript - The covered element markers.

bpmnXml - The BPMN XML of the report process definition.

processDefinitionKey - The key of the report process definition.

coverage - The coverage percentage.

testClass - The name of the test class.

testMethod - The name of the test method if applicable.

classReport - When true a class report will be generated, otherwise a method report. The difference is mainly in the info-box method name field not appearing.

Returns:

Throws:

IOException - Thrown if an error occurs on report template read.

injectIntoHtmlTemplate

protected static String injectIntoHtmlTemplate(String javaScript,
                            String bpmnXml,
                            String html,
                            String processDefinitionKey,
                            double coverage,
                            String testClass,
                            String testMethod,
                            boolean classReport)

Inject the BPMN XML, javascript markers ad info-box fields into the html template.

Parameters:

javaScript - The covered element markers.

bpmnXml - The BPMN XML of the report process definition.

html - The report template html.

processDefinitionKey - The key of the report process definition.

coverage - The coverage percentage.

testClass - The name of the test class.

testMethod - The name of the test method if applicable.

classReport - When true a class report will be generated, otherwise a method report.

Returns:

Complete html report.

generateJavaScriptFlowNodeAnnotations

protected static String generateJavaScriptFlowNodeAnnotations(Collection<CoveredFlowNode> flowNodeIds)

Generate the add marker javascript for the passed flow node IDs.

Parameters:

flowNodeIds -

Returns:

generateJavaScriptSequenceFlowAnnotations

protected static String generateJavaScriptSequenceFlowAnnotations(Collection<String> sequenceFlowIds)

Generate jquery markers for the passed sequence flow IDs.

Parameters:

sequenceFlowIds -

Returns:

writeToFile

protected static void writeToFile(String targetDir,
               String fileName,
               String html)
                           throws IOException

Write the html report.

Parameters:

targetDir -

fileName -

html -

Throws:

IOException