de.viadee.bpm.vPAV.processing.checker.BoundaryErrorChecker Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of viadeeProcessApplicationValidator Show documentation
Show all versions of viadeeProcessApplicationValidator Show documentation
The tool checks Camunda projects for consistency and discovers errors in process-driven applications.
Called as a Maven plugin or JUnit test, it discovers esp. inconsistencies of a given BPMN model in the classpath and the
sourcecode of an underlying java project, such as a delegate reference to a non-existing java class or a non-existing Spring bean.
/**
* BSD 3-Clause License
*
* Copyright © 2019, viadee Unternehmensberatung AG
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package de.viadee.bpm.vPAV.processing.checker;
import de.odysseus.el.tree.IdentifierNode;
import de.odysseus.el.tree.Tree;
import de.odysseus.el.tree.TreeBuilder;
import de.odysseus.el.tree.impl.Builder;
import de.viadee.bpm.vPAV.BpmnScanner;
import de.viadee.bpm.vPAV.Messages;
import de.viadee.bpm.vPAV.RuntimeConfig;
import de.viadee.bpm.vPAV.config.model.Rule;
import de.viadee.bpm.vPAV.constants.BpmnConstants;
import de.viadee.bpm.vPAV.constants.ConfigConstants;
import de.viadee.bpm.vPAV.output.IssueWriter;
import de.viadee.bpm.vPAV.processing.CheckName;
import de.viadee.bpm.vPAV.processing.code.flow.BpmnElement;
import de.viadee.bpm.vPAV.processing.model.data.CheckerIssue;
import de.viadee.bpm.vPAV.processing.model.data.CriticalityEnum;
import org.apache.commons.io.IOUtils;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.types.Resource;
import org.camunda.bpm.model.bpmn.impl.BpmnModelConstants;
import org.camunda.bpm.model.bpmn.instance.BaseElement;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Map;
import java.util.logging.Logger;
public class BoundaryErrorChecker extends AbstractElementChecker {
private static Logger logger = Logger.getLogger(BoundaryErrorChecker.class.getName());
public BoundaryErrorChecker(final Rule rule, BpmnScanner bpmnScanner) {
super(rule, bpmnScanner);
}
@Override
public Collection check(BpmnElement element) {
final Collection issues = new ArrayList();
final BaseElement bpmnElement = element.getBaseElement();
String mappedTaskId = null;
String implementation = null;
String implementationRef = null;
// Grab only boundaryEvents
if (bpmnElement.getElementType().getTypeName().equals(BpmnModelConstants.BPMN_ELEMENT_BOUNDARY_EVENT)) {
// Map errorEventDef -> "errorRef" , "camunda:errorMessageVariable"
final Map errorEventDef = bpmnScanner.getErrorEvent(bpmnElement.getId());
// Check if boundaryEvent consists of an errorEventDefinition
if (errorEventDef.size() != 0) {
mappedTaskId = bpmnScanner.getErrorEventMapping(bpmnElement.getId());
implementation = bpmnScanner.getImplementation(mappedTaskId);
implementationRef = bpmnScanner.getImplementationReference(mappedTaskId,
implementation);
// No error has been referenced
if (errorEventDef.entrySet().iterator().next().getKey() == null
|| errorEventDef.entrySet().iterator().next().getKey().isEmpty()) {
final String errorCode = bpmnScanner.getErrorCodeVar(bpmnElement.getId());
if (errorCode == null || errorCode.isEmpty()) {
issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element,
String.format(Messages.getString("BoundaryErrorChecker.0"), //$NON-NLS-1$
CheckName.checkName(bpmnElement))));
} else {
issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element,
String.format(Messages.getString("BoundaryErrorChecker.1"), //$NON-NLS-1$
CheckName.checkName(bpmnElement))));
}
} else {
// Error reference could be resolved, retrieve errorDefinition
final Map errorDef = bpmnScanner
.getErrorDef(errorEventDef.entrySet().iterator().next().getKey());
// No errorCode has been specified
if (errorDef.entrySet().iterator().next().getValue() == null
|| errorDef.entrySet().iterator().next().getValue().isEmpty()) {
issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.WARNING, element,
String.format(Messages.getString("BoundaryErrorChecker.2"), //$NON-NLS-1$
CheckName.checkName(bpmnElement))));
} else {
if (implementation != null) {
// Check the BeanMapping to resolve delegate expression
if (implementation.equals(BpmnConstants.CAMUNDA_DEXPRESSION)) {
checkBeanMapping(element, issues, bpmnElement,
errorDef.entrySet().iterator().next().getValue(), implementationRef);
// Check the directly referenced class
} else if (implementation.equals(BpmnConstants.CAMUNDA_CLASS)) {
if (!readResourceFile(implementationRef,
errorDef.entrySet().iterator().next().getValue())) {
issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element,
String.format(
Messages.getString("BoundaryErrorChecker.3"), //$NON-NLS-1$
CheckName.checkName(bpmnElement), implementationRef)));
}
}
}
}
// No errorName has been specified
if (errorDef.entrySet().iterator().next().getKey() == null
|| errorDef.entrySet().iterator().next().getKey().isEmpty()) {
issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.WARNING, element,
String.format(Messages.getString("BoundaryErrorChecker.4"), //$NON-NLS-1$
CheckName.checkName(bpmnElement))));
}
// No ErrorMessageVariable has been specified
if (errorEventDef.entrySet().iterator().next().getValue() == null
|| errorEventDef.entrySet().iterator().next().getValue().isEmpty()) {
issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.WARNING, element,
String.format(Messages.getString("BoundaryErrorChecker.5"), //$NON-NLS-1$
CheckName.checkName(bpmnElement))));
}
}
}
}
return issues;
}
/**
* In case a bean mapping exists, we check for validity of a bean, so the event can be mapped against the respective
* task If the class or bean can be resolved, the ErrorCode gets validated
*
* @param element
* @param issues
* @param bpmnElement
* @param errorDefEntry
* @param implementationRef
*/
private void checkBeanMapping(BpmnElement element, final Collection issues,
final BaseElement bpmnElement, final String errorDefEntry, final String implementationRef) {
if (RuntimeConfig.getInstance().getBeanMapping() != null) {
final TreeBuilder treeBuilder = new Builder();
final Tree tree = treeBuilder.build(implementationRef);
final Iterable identifierNodes = tree.getIdentifierNodes();
// if beanMapping ${...} reference
if (identifierNodes.iterator().hasNext()) {
for (final IdentifierNode node : identifierNodes) {
final String classFile = RuntimeConfig.getInstance().getBeanMapping()
.get(node.getName());
// correct beanmapping was found -> check if class exists
if (classFile != null && classFile.trim().length() > 0) {
if (checkClassFile(classFile)) {
if (!readResourceFile(classFile, errorDefEntry)) {
issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element,
String.format(
Messages.getString("BoundaryErrorChecker.6"), //$NON-NLS-1$
CheckName.checkName(bpmnElement), node.getName())));
}
} else {
issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element,
Messages.getString("BoundaryErrorChecker.7"))); //$NON-NLS-1$
}
} else {
// incorrect beanmapping
issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element, String.format(
Messages.getString("BoundaryErrorChecker.8"), //$NON-NLS-1$
implementationRef)));
}
}
}
} else {
if (!checkClassFile(implementationRef)) {
issues.addAll(
IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element,
String.format(
Messages.getString("BoundaryErrorChecker.9"), //$NON-NLS-1$
implementationRef, CheckName.checkName(bpmnElement))));
}
}
}
/**
* Reads a resource and retrieves content as String
*
* @param className
* @param errorCode
* @return boolean
*/
private boolean readResourceFile(final String className, final String errorCode) {
final String fileName = className.replaceAll("\\.", "/") + ".java"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
boolean matchingErrorCode = false;
if (fileName != null && fileName.trim().length() > 0) {
try {
final DirectoryScanner scanner = new DirectoryScanner();
if (RuntimeConfig.getInstance().isTest()) {
if (fileName.endsWith(".java")) //$NON-NLS-1$
scanner.setBasedir(ConfigConstants.TEST_JAVAPATH);
else
scanner.setBasedir(ConfigConstants.TEST_BASEPATH);
} else {
if (fileName.endsWith(".java")) //$NON-NLS-1$
scanner.setBasedir(ConfigConstants.JAVAPATH);
else
scanner.setBasedir(ConfigConstants.getInstance().getBasepath());
}
Resource s = scanner.getResource(fileName);
if (s.isExists()) {
InputStreamReader resource = new InputStreamReader(new FileInputStream(s.toString()));
final String methodBody = IOUtils.toString(resource);
return validateContent(methodBody, errorCode);
} else {
logger.warning("Class " + fileName + " could not be read or does not exist"); //$NON-NLS-1$ //$NON-NLS-2$
}
} catch (final IOException ex) {
logger.warning("Resource '" + fileName + "' could not be read: " + ex.getMessage()); //$NON-NLS-1$ //$NON-NLS-2$
}
}
return matchingErrorCode;
}
/**
* Check methodBody for content and return true if a "throw new BpmnError.." declaration is found
*
* @param errorCode
* @param methodBody
* @return boolean
*/
private boolean validateContent(final String methodBody, final String errorCode) {
if (methodBody != null && !methodBody.isEmpty()) {
if (methodBody.contains("throw new BpmnError")) { //$NON-NLS-1$
String temp = methodBody.substring(methodBody.indexOf("throw new BpmnError")); //$NON-NLS-1$
temp = temp.substring(0, temp.indexOf(";") + 1); //$NON-NLS-1$
final String delErrorCode = temp.substring(temp.indexOf("\"") + 1, temp.lastIndexOf("\"")); //$NON-NLS-1$ //$NON-NLS-2$
if (delErrorCode.equals(errorCode)) {
return true;
}
}
}
return false;
}
/**
* Check if class reference for a given element exists
*
* @param className
* @return boolean
*/
private boolean checkClassFile(final String className) {
@SuppressWarnings("unused")
final String classPath = className.replaceAll("\\.", "/") + ".java"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
try {
RuntimeConfig.getInstance().getClassLoader().loadClass(className);
} catch (final ClassNotFoundException e) {
return false;
}
return true;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy