de.viadee.bpm.vPAV.processing.checker.ExtensionChecker 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.checker;

import de.viadee.bpm.vPAV.BpmnScanner;
import de.viadee.bpm.vPAV.Messages;
import de.viadee.bpm.vPAV.config.model.Rule;
import de.viadee.bpm.vPAV.config.model.Setting;
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.camunda.bpm.model.bpmn.impl.BpmnModelConstants;
import org.camunda.bpm.model.bpmn.instance.BaseElement;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class ExtensionChecker extends AbstractElementChecker {

	private static Logger logger = Logger.getLogger(ExtensionChecker.class.getName());

	private boolean isMisconfigured = false;

	public ExtensionChecker(Rule rule, BpmnScanner bpmnScanner) {
		super(rule, bpmnScanner);
	}

	@Override
	public Collection check(BpmnElement element) {
		final Collection issues = new ArrayList();
		final BaseElement bpmnElement = element.getBaseElement();
		final Map settings = rule.getSettings();
		final ArrayList whiteList = rule.getWhiteList();

		final Map keyPairs = new HashMap();
		final ArrayList optionalSettings = new ArrayList();
		final ArrayList mandatorySettings = new ArrayList();

		// Retrieve extension key pair from bpmn model
		keyPairs.putAll(bpmnScanner.getKeyPairs(bpmnElement.getId()));

		// Create ArrayList for easier manipulation
		for (Map.Entry settingsEntry : settings.entrySet()) {
			if (settingsEntry.getValue().getRequired()) {
				mandatorySettings.add(settingsEntry.getValue());
			} else {
				optionalSettings.add(settingsEntry.getValue());
			}
		}

		if (whiteList.contains(bpmnElement.getElementType().getInstanceType().getSimpleName())) {
			// Check for all mandatory extension pairs according to ruleset
			issues.addAll(checkManExtension(whiteList, mandatorySettings, keyPairs, bpmnElement, element));
			// Check for all optional extension pairs
			issues.addAll(checkOptExtension(whiteList, optionalSettings, keyPairs, bpmnElement, element));
		}

		checkMisconfiguration();

		return issues;

	}

	/**
	 * Checks all elements for mandatory settings
	 *
	 * @param settings
	 *            Mandatory settings as specified by ruleset
	 * @param keyPairs
	 *            Extension key pairs
	 * @param bpmnElement
	 *            BpmnElement
	 * @param element
	 *            Element
	 * @return
	 */
	private Collection checkManExtension(final ArrayList whiteList,
			final ArrayList settings, final Map keyPairs, final BaseElement bpmnElement,
			final BpmnElement element) {
		final Collection issues = new ArrayList();

		for (Setting setting : settings) {
			checkKey(whiteList, keyPairs, bpmnElement, element, issues, setting);
		}

		return issues;
	}

	/**
	 *
	 * Checks a certain setting against validity of key-value extension pair
	 *
	 * @param whiteList
	 *            whiteList contains types of task to check
	 * @param keyPairs
	 *            Extension key pairs
	 * @param bpmnElement
	 *            BpmnElement
	 * @param element
	 *            Element
	 * @param issues
	 *            List of issues
	 * @param setting
	 *            Concrete setting
	 */
	private void checkKey(final ArrayList whiteList, final Map keyPairs,
			final BaseElement bpmnElement, final BpmnElement element, final Collection issues,
			Setting setting) {
		// Check whether rule for ExtensionChecker is misconfigured
		if (!checkMisconfiguration(setting)) {

			// Type is specified in ruleSet
			if (setting.getType() != null && setting.getId() == null) {

				// Check whether specified type equals name of bpmnElement
				if (setting.getType().equals(bpmnElement.getElementType().getInstanceType().getSimpleName())) {

					// Check whether the key specified in the settings is contained in the model
					if (setting.getName() != null && keyPairs.containsKey(setting.getName())) {
						checkValue(keyPairs, bpmnElement, element, issues, setting, false);
					} else {

						issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element,
								String.format(Messages.getString("ExtensionChecker.0"), //$NON-NLS-1$
										CheckName.checkName(bpmnElement), setting.getName())));
					}
				}
			}

			// Check based on ID
			if (setting.getType() == null && setting.getId() != null) {
				if (setting.getId().equals(bpmnElement.getAttributeValue(BpmnModelConstants.BPMN_ATTRIBUTE_ID))) {
					checkValue(keyPairs, bpmnElement, element, issues, setting, false);
				}
			}

			// Check all elements
			if (setting.getType() == null && setting.getId() == null) {

				if (setting.getName() != null && keyPairs.containsKey(setting.getName())) {
					checkValue(keyPairs, bpmnElement, element, issues, setting, false);
				} else {
					issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element,
							String.format(Messages.getString("ExtensionChecker.1"), //$NON-NLS-1$
									CheckName.checkName(bpmnElement), setting.getName())));
				}
			}
		}
	}

	/**
	 * Checks all elements with optional settings
	 *
	 * @param settings
	 *            Mandatory settings as specified by ruleset
	 * @param keyPairs
	 *            Extension key pairs
	 * @param bpmnElement
	 *            BpmnElement
	 * @param element
	 *            Element
	 * @return
	 */
	private Collection checkOptExtension(final ArrayList whiteList,
			final ArrayList settings, final Map keyPairs, final BaseElement bpmnElement,
			final BpmnElement element) {
		final Collection issues = new ArrayList();

		for (Setting setting : settings) {

			if (!checkMisconfiguration(setting)) {

				// Type specified in ruleSet
				if (setting.getType() != null && setting.getId() == null) {

					// Check whether specified type equals name of bpmnElement
					if (setting.getType().equals(bpmnElement.getElementType().getInstanceType().getSimpleName())) {

						// Check whether the key specified in the settings is contained in the model
						if (setting.getName() != null && keyPairs.containsKey(setting.getName())) {
							checkValue(keyPairs, bpmnElement, element, issues, setting, true);
						}
					}
				}

				// ID specified in ruleSet
				if (setting.getType() == null && setting.getId() != null) {

					// Check whether specified id equals id of bpmnElement
					if (setting.getId().equals(bpmnElement.getAttributeValue(BpmnModelConstants.BPMN_ATTRIBUTE_ID))) {
						checkValue(keyPairs, bpmnElement, element, issues, setting, true);
					}
				}

				// Check all elements
				if (setting.getType() == null && setting.getId() == null) {

					// Check whether bpmnElement is contained in whitelist
					if (whiteList.contains(bpmnElement.getElementType().getInstanceType().getSimpleName())) {
						if (setting.getName() != null && keyPairs.containsKey(setting.getName())) {
							checkValue(keyPairs, bpmnElement, element, issues, setting, true);
						}
					}
				}
			}
		}
		return issues;
	}

	/**
	 * Checks the value of a given key-value pair
	 *
	 * @param setting
	 *            Certain setting out of all settings
	 * @param keyPairs
	 *            Extension key pairs
	 * @param bpmnElement
	 *            BpmnElement
	 * @param element
	 *            Element
	 * @param issues
	 *            List of Issues
	 */
	private void checkValue(final Map keyPairs, final BaseElement bpmnElement,
			final BpmnElement element, final Collection issues, final Setting setting,
			final Boolean check) {
		if (keyPairs.get(setting.getName()) != null && !keyPairs.get(setting.getName()).isEmpty()) {

			final String patternString = setting.getValue();
			final Pattern pattern = Pattern.compile(patternString);
			Matcher matcher = pattern.matcher(keyPairs.get(setting.getName()));

			// if predefined value of a key-value pair does not fit a given regex (e.g.
			// digits for
			// timeout)
			if (!matcher.matches()) {
				issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element,
						String.format(Messages.getString("ExtensionChecker.2"), //$NON-NLS-1$
								CheckName.checkName(bpmnElement), setting.getName())));
			}
		} else {
			if (!check) {
				issues.addAll(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element,
						String.format(Messages.getString("ExtensionChecker.3"), //$NON-NLS-1$
								CheckName.checkName(bpmnElement))));
			}
		}
	}

	/**
	 * Checks whether a misconfiguration of the ruleSet.xml occured
	 *
	 * @param setting
	 *            Certain setting out of all settings
	 * @return true/false
	 */
	public boolean checkMisconfiguration(Setting setting) {

		boolean misconfigured = false;

		if (setting.getType() != null && setting.getId() != null) {
			misconfigured = true;
			setIsMisconfigured(misconfigured);
			return misconfigured;
		}
		return misconfigured;
	}

	/**
	 * Checks whether a misconfiguration of the ruleSet.xml occured
	 *
	 */
	private void checkMisconfiguration() {
		if (getIsMisconfigured())
			logger.warning(
					"Misconfiguration of rule for ExtensionChecker. Please provide either tasktype or a specific ID of an element.");
	}

	public boolean getIsMisconfigured() {
		return isMisconfigured;
	}

	public void setIsMisconfigured(boolean isMisconfigured) {
		this.isMisconfigured = isMisconfigured;
	}

}