de.viadee.bpm.vPAV.processing.code.flow.Node Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
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.
There is a newer version: 3.0.8
Show newest version
/**
 * 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.code.flow;

import de.viadee.bpm.vPAV.processing.model.data.AnomalyContainer;
import de.viadee.bpm.vPAV.processing.model.data.ProcessVariableOperation;
import org.camunda.bpm.model.bpmn.instance.BaseElement;
import soot.toolkits.graph.Block;

import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

public class Node implements AnalysisElement {

	private ControlFlowGraph controlFlowGraph;

	private LinkedHashMap operations;
	private LinkedHashMap defined;
	private LinkedHashMap used;
	private LinkedHashMap killed;
	private LinkedHashMap inUsed;
	private LinkedHashMap inUnused;
	private LinkedHashMap outUsed;
	private LinkedHashMap outUnused;

	private Block block;
	private BpmnElement parentElement;

	private LinkedHashMap predecessors;
	private LinkedHashMap successors;

	private String id;

	public Node(final ControlFlowGraph controlFlowGraph, final BpmnElement parentElement, final Block block) {
		this.controlFlowGraph = controlFlowGraph;
		this.parentElement = parentElement;
		this.block = block;

		this.predecessors = new LinkedHashMap<>();
		this.successors = new LinkedHashMap<>();

		this.operations = new LinkedHashMap<>();
		this.defined = new LinkedHashMap<>();
		this.used = new LinkedHashMap<>();
		this.killed = new LinkedHashMap<>();
		this.inUsed = new LinkedHashMap<>();
		this.inUnused = new LinkedHashMap<>();
		this.outUsed = new LinkedHashMap<>();
		this.outUnused = new LinkedHashMap<>();
	}

	/**
	 * Adds an operation to the list of operations (used for line by line checking)
	 * Based on operation type adds the operation to the set of corresponding
	 * operations
	 *
	 * @param processVariableOperation
	 *            Current process variable operation
	 */
	public void addOperation(final ProcessVariableOperation processVariableOperation) {
		final String id = String.valueOf(controlFlowGraph.getDefCounter());
		this.operations.put(String.valueOf(id), processVariableOperation);
		switch (processVariableOperation.getOperation()) {
		case WRITE:
			defined.put(id, processVariableOperation);
			break;
		case READ:
			used.put(id, processVariableOperation);
			break;
		case DELETE:
			killed.put(id, processVariableOperation);
			break;
		}
		controlFlowGraph.incrementDefCounter();
	}

	/**
	 * Set the predecessor nodes of the current node for intraprocedural methods
	 */
	void setPredsIntraProcedural(final String key) {
		AnalysisElement ae = controlFlowGraph.getNodes().get(key);
		this.predecessors.put(ae.getId(), ae);
	}

	/**
	 * Set the predecessor nodes of the current node
	 */
	void setPreds() {
		final Pattern blockPattern = Pattern.compile("(Block\\s#)(\\d)");
		final Pattern idPattern = Pattern
				.compile(this.getParentElement().getBaseElement().getId() + "__(\\d\\.)*(\\d)");

		for (Block block : this.block.getPreds()) {
			Matcher blockMatcher = blockPattern.matcher(block.toShortString());
			createIds(idPattern, blockMatcher, true);
		}
	}

	/**
	 * Set the successor nodes of the current node
	 */
	void setSuccs() {
		final Pattern blockPattern = Pattern.compile("(Block\\s#)(\\d)");
		final Pattern idPattern = Pattern
				.compile(this.getParentElement().getBaseElement().getId() + "__(\\d\\.)*(\\d)");

		for (Block block : this.block.getSuccs()) {
			Matcher blockMatcher = blockPattern.matcher(block.toShortString());
			createIds(idPattern, blockMatcher, false);
		}
	}

	/**
	 * Matches the ids and creates the references to nodeSuccessors and
	 * nodePredecessors
	 *
	 * @param idPattern
	 *            Pattern for resolving the id
	 * @param blockMatcher
	 *            Pattern to extract the local id of a node's block
	 * @param pred
	 *            Boolean to indicate whether the current node is a predecessor or
	 *            successor
	 */
	private void createIds(final Pattern idPattern, final Matcher blockMatcher, final boolean pred) {
		if (blockMatcher.matches()) {
			String key = blockMatcher.group(2);
			Matcher idMatcher = idPattern.matcher(this.id);
			if (idMatcher.matches()) {
				String id = idMatcher.group();
				id = id.substring(0, id.length() - 1).concat(key);
				AnalysisElement ae = controlFlowGraph.getNodes().get(id);
				if (pred) {
					this.addPredecessor(ae);
				} else {
					this.addSuccessor(ae);
				}
			}
		}
	}

	ProcessVariableOperation lastOperation() {
		Iterator iterator = operations.values().iterator();
		if (iterator.hasNext()) {
			return iterator.next();
		}
		return null;
	}

	ProcessVariableOperation firstOperation() {
		Iterator iterator = operations.values().iterator();
		ProcessVariableOperation processVariableOperation = null;
		while (iterator.hasNext()) {
			processVariableOperation = iterator.next();
		}
		return processVariableOperation;
	}

	@Override
	public ControlFlowGraph getControlFlowGraph() {
		return null;
	}

	public void setId(final String id) {
		this.id = id;
	}

	public String getId() {
		return id;
	}

	public Block getBlock() {
		return block;
	}

	public LinkedHashMap getOperations() {
		return operations;
	}

	public void setOperations(LinkedHashMap operations) {
		this.operations = operations;
	}

	public LinkedHashMap getDefined() {
		return defined;
	}

	@Override
	public void addSourceCodeAnomaly(AnomalyContainer anomalyContainer) {
		this.parentElement.addSourceCodeAnomaly(anomalyContainer);
	}

	@Override
	public void clearPredecessors() {
		this.predecessors.clear();
	}

	@Override
	public void removePredecessor(String predecessor) {
		this.predecessors.remove(predecessor);
	}

	@Override
	public Map> getAnomalies() {
		return getParentElement().getAnomalies();
	}

	@Override
	public BaseElement getBaseElement() {
		return this.parentElement.getBaseElement();
	}

	public void setDefined(LinkedHashMap defined) {
		this.defined = defined;
	}

	@Override
	public void addDefined(LinkedHashMap defined) {
		this.defined.putAll(defined);
	}

	public LinkedHashMap getUsed() {
		return used;
	}

	public void setUsed(LinkedHashMap used) {
		this.used = used;
	}

	public LinkedHashMap getKilled() {
		return killed;
	}

	public void setKilled(LinkedHashMap killed) {
		this.killed = killed;
	}

	public LinkedHashMap getInUsed() {
		return inUsed;
	}

	public void setInUsed(LinkedHashMap inUsed) {
		this.inUsed = inUsed;
	}

	public LinkedHashMap getInUnused() {
		return inUnused;
	}

	public void setInUnused(LinkedHashMap inUnused) {
		this.inUnused = inUnused;
	}

	public LinkedHashMap getOutUsed() {
		return outUsed;
	}

	public void setOutUsed(LinkedHashMap outUsed) {
		this.outUsed = outUsed;
	}

	public LinkedHashMap getOutUnused() {
		return outUnused;
	}

	@Override
	public void setOutUnused(LinkedHashMap outUnused) {
		this.outUnused = outUnused;
	}

	public BpmnElement getParentElement() {
		return parentElement;
	}

	@Override
	public void setPredecessors(LinkedHashMap predecessors) {
		this.predecessors = predecessors;
	}

	@Override
	public void addPredecessor(AnalysisElement predecessor) {
		this.predecessors.put(predecessor.getId(), predecessor);
	}

	@Override
	public List getPredecessors() {
		return this.predecessors.values().stream().map(NodeDecorator::new).collect(Collectors.toList());
	}

	@Override
	public List getSuccessors() {
		return this.successors.values().stream().map(NodeDecorator::new).collect(Collectors.toList());
	}

	@Override
	public void setSuccessors(LinkedHashMap successors) {
		this.successors = successors;
	}

	@Override
	public void addSuccessor(AnalysisElement successor) {
		this.successors.put(successor.getId(), successor);
	}

}