de.viadee.bpm.vPAV.processing.ProcessVariablesScanner 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;
import de.viadee.bpm.vPAV.FileScanner;
import de.viadee.bpm.vPAV.constants.CamundaMethodServices;
import soot.*;
import soot.jimple.AssignStmt;
import soot.jimple.InvokeStmt;
import soot.jimple.internal.JInterfaceInvokeExpr;
import soot.options.Options;
import java.util.*;
public class ProcessVariablesScanner {
private Set javaResources;
private Map> messageIdToVariableMap = new HashMap>();
private Map> processIdToVariableMap = new HashMap>();
private Set camundaProcessEntryPoints = new HashSet();
private List entryPoints = new ArrayList<>();
private List intermediateEntryPoints = new ArrayList<>();
public ProcessVariablesScanner(final Set javaResources) {
this.javaResources = javaResources;
camundaProcessEntryPoints.add(CamundaMethodServices.START_PROCESS_INSTANCE_BY_ID);
camundaProcessEntryPoints.add(CamundaMethodServices.START_PROCESS_INSTANCE_BY_KEY);
camundaProcessEntryPoints.add(CamundaMethodServices.START_PROCESS_INSTANCE_BY_MESSAGE);
camundaProcessEntryPoints.add(CamundaMethodServices.START_PROCESS_INSTANCE_BY_MESSAGE_AND_PROCESS_DEF);
camundaProcessEntryPoints.add(CamundaMethodServices.CORRELATE_MESSAGE);
}
/**
* scan java resources for variables and retrieve important information such as message ids and entrypoints
*
*/
public void scanProcessVariables() {
for (final String filePath : javaResources) {
if (!filePath.startsWith("javax")) {
// TODO: Use ids properly to resolve process variable manipulation
final Set messageIds = new HashSet<>();
final Set processIds = new HashSet<>();
retrieveMethod(filePath, messageIds, processIds);
}
}
}
/**
* Retrieve the method name which contains the entrypoint (e.g. "startProcessByXYZ")
*
* @param filePath
* fully qualified path to the java class
* @param messageIds
* Set of messageIds (used to retrieve variable manipulation later on)
* @param processIds
* Set of processIds (used to retrieve variable manipulation later on)
*/
private void retrieveMethod(final String filePath, final Set messageIds, final Set processIds) {
final String sootPath = FileScanner.getSootPath();
System.setProperty("soot.class.path", sootPath);
Options.v().set_whole_program(true);
Options.v().set_allow_phantom_refs(true);
ArrayList excludedClasses = new ArrayList<>();
excludedClasses.add("java.*");
excludedClasses.add("sun.*");
excludedClasses.add("jdk.*");
excludedClasses.add("javax.*");
Options.v().set_exclude(excludedClasses);
Options.v().set_no_bodies_for_excluded(true);
Scene.v().extendSootClassPath(Scene.v().defaultClassPath());
SootClass sootClass = Scene.v().forceResolve(cleanString(filePath, true), SootClass.SIGNATURES);
if (sootClass != null && !sootClass.isInterface()) {
sootClass.setApplicationClass();
Scene.v().loadNecessaryClasses();
for (SootMethod method : sootClass.getMethods()) {
if (!method.isPhantom()) {
final Body body = method.retrieveActiveBody();
for (String entryPoint : camundaProcessEntryPoints) {
if (body.toString().contains(entryPoint)) {
final PatchingChain pc = body.getUnits();
for (Unit unit : pc) {
if (unit instanceof AssignStmt) {
final String rightBox = ((AssignStmt) unit).getRightOpBox().getValue().toString();
if (rightBox.contains(entryPoint)) {
if (((AssignStmt) unit).getRightOpBox()
.getValue() instanceof JInterfaceInvokeExpr) {
final JInterfaceInvokeExpr expr = (JInterfaceInvokeExpr) ((AssignStmt) unit)
.getRightOpBox().getValue();
checkExpression(filePath, messageIds, method, entryPoint, expr);
}
}
}
if (unit instanceof InvokeStmt) {
final String rightBox = ((InvokeStmt) unit).getInvokeExprBox().getValue().toString();
if (rightBox.contains(entryPoint)) {
if (((InvokeStmt) unit).getInvokeExprBox()
.getValue() instanceof JInterfaceInvokeExpr) {
final JInterfaceInvokeExpr expr = (JInterfaceInvokeExpr) ((InvokeStmt) unit)
.getInvokeExprBox().getValue();
checkExpression(filePath, messageIds, method, entryPoint, expr);
}
}
}
}
}
if (body.toString().contains(CamundaMethodServices.CORRELATE_MESSAGE)) {
processIds.add(entryPoint);
}
}
}
}
}
}
/**
* Checks the current expression and creates a new entrypoint
*
* @param filePath
* Current filePath of the model
* @param messageIds
* List of message ids
* @param method
* Current method
* @param entryPoint
* Current entryPoint
* @param expr
* Current expression
*/
private void checkExpression(final String filePath, final Set messageIds, final SootMethod method,
final String entryPoint, final JInterfaceInvokeExpr expr) {
if (expr != null) {
final String ex = expr.getArgBox(0).getValue().toString();
if (entryPoint.equals(CamundaMethodServices.CORRELATE_MESSAGE)) {
intermediateEntryPoints
.add(new EntryPoint(filePath, method.getName(), ex.replaceAll("\"", ""), entryPoint));
} else {
messageIds.add(entryPoint);
entryPoints.add(new EntryPoint(filePath, method.getName(), ex.replaceAll("\"", ""), entryPoint));
}
}
}
/**
* Strips unnecessary characters and returns cleaned name
*
* @param className
* Classname to be stripped of unused chars
* @param dot
* Replace dots
* @return cleaned String
*/
static String cleanString(String className, boolean dot) {
final String replaceDot = ".";
final String replaceEmpty = "";
final String replaceSingleBackSlash = "\\";
final String replaceSingleForwardSlash = "/";
final String replaceDotJava = ".java";
if (dot) {
if (System.getProperty("os.name").startsWith("Windows")) {
className = className.replace(replaceSingleBackSlash, replaceDot)
.replace(replaceSingleForwardSlash, replaceDot).replace(replaceDotJava, replaceEmpty);
} else {
className = className.replace(replaceSingleForwardSlash, replaceDot).replace(replaceDotJava,
replaceEmpty);
}
} else {
if (System.getProperty("os.name").startsWith("Windows")) {
className = className.replace(replaceDot, replaceSingleBackSlash);
className = className.concat(replaceDotJava);
} else {
className = className.replace(replaceDot, replaceSingleForwardSlash);
className = className.concat(replaceDotJava);
}
}
return className;
}
/**
* get list of intermediate entrypoints (process message, method) where process variables have been found
*
* @return returns list of locations
*/
public List getIntermediateEntryPoints() {
return intermediateEntryPoints;
}
/**
* get list of entrypoints (process message, method) where process variables have been found
*
* @return returns list of locations
*/
public List getEntryPoints() {
return entryPoints;
}
/**
* get mapping for message id
*
* @return messageIdToVariableMap returns messageIdToVariableMap
*/
public Map> getMessageIdToVariableMap() {
return messageIdToVariableMap;
}
/**
* get mapping for process id
*
* @return processIdToVariableMap returns processIdToVariableMap
*/
public Map> getProcessIdToVariableMap() {
return processIdToVariableMap;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy