de.viadee.bpm.vPAV.processing.checker.TimerExpressionChecker 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 com.cronutils.model.Cron;
import com.cronutils.model.CronType;
import com.cronutils.model.definition.CronDefinition;
import com.cronutils.model.definition.CronDefinitionBuilder;
import com.cronutils.parser.CronParser;
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.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 net.time4j.range.IsoRecurrence;
import net.time4j.range.MomentInterval;
import org.camunda.bpm.model.bpmn.impl.BpmnModelConstants;
import org.camunda.bpm.model.bpmn.instance.BaseElement;
import org.camunda.bpm.model.bpmn.instance.BoundaryEvent;
import org.camunda.bpm.model.bpmn.instance.IntermediateCatchEvent;
import org.camunda.bpm.model.bpmn.instance.StartEvent;
import org.w3c.dom.Element;

import javax.xml.bind.DatatypeConverter;
import javax.xml.datatype.DatatypeFactory;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

public class TimerExpressionChecker extends AbstractElementChecker {

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

	/**
	 * Check TimerEvents for correct usage of ISO 8601 and CRON definitions
	 *
	 * @return issues
	 */
	@Override
	public Collection check(final BpmnElement element) {

		final BaseElement baseElement = element.getBaseElement();
		final Collection issues = new ArrayList<>();

		// Map with string (contains the timer definiton) and the element itself
		// (contains name and id)

		// check if the element is an event and retrieve id
		if (baseElement.getId() != null && (baseElement instanceof IntermediateCatchEvent
				|| baseElement instanceof StartEvent || baseElement instanceof BoundaryEvent)) {

			final Map timerMap = new HashMap<>(bpmnScanner.getTimerImplementation(baseElement.getId()));
			String timerDefinition = "";

			for (Map.Entry entry : timerMap.entrySet()) {

				if (entry.getValue() != null) {
					timerDefinition = entry.getValue().getParentNode().getTextContent().trim();
				}

				if (!timerDefinition.trim().isEmpty()) {

					// BpmnModelConstants.BPMN_ELEMENT_TIME_DATE
					if (entry.getValue() != null && (entry.getValue().getNodeName() != null
							&& entry.getValue().getNodeName().contains(BpmnModelConstants.BPMN_ELEMENT_TIME_DATE))) {
						try {
							DatatypeConverter.parseDateTime(timerDefinition);
						} catch (Exception e) {
							issues.add(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element, entry,
									String.format(Messages.getString("TimerExpressionChecker.1"), //$NON-NLS-1$
											CheckName.checkTimer(entry.getKey()))));
						}
					}
					// BpmnModelConstants.BPMN_ELEMENT_TIME_DURATION
					if (entry.getValue() != null && (entry.getValue().getNodeName() != null && entry.getValue()
							.getNodeName().contains(BpmnModelConstants.BPMN_ELEMENT_TIME_DURATION))) {
						try {
							DatatypeFactory.newInstance().newDuration(timerDefinition);
						} catch (Exception e) {
							issues.add(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element, entry,
									String.format(Messages.getString("TimerExpressionChecker.2"), //$NON-NLS-1$
											CheckName.checkTimer(entry.getKey()))));
						}
					}
					// BpmnModelConstants.BPMN_ELEMENT_TIME_CYCLE
					if (entry.getValue() != null && (entry.getValue().getNodeName() != null
							&& entry.getValue().getNodeName().contains(BpmnModelConstants.BPMN_ELEMENT_TIME_CYCLE))) {

						boolean isCron = false;
						boolean isDur = false;
						boolean hasRepeatingIntervals = false;

						if (!timerDefinition.contains("P") && !timerDefinition.contains("Z") //$NON-NLS-1$ //$NON-NLS-2$
								&& timerDefinition.contains(" ")) { //$NON-NLS-1$
							isCron = true;
						}

						if (timerDefinition.startsWith("R")) { //$NON-NLS-1$
							hasRepeatingIntervals = true;
						}

						if (timerDefinition.startsWith("P") //$NON-NLS-1$
								&& !(timerDefinition.contains("/") || timerDefinition.contains("--"))) { //$NON-NLS-1$ //$NON-NLS-2$
							isDur = true;
						}

						if (isCron) {
							try {
								CronDefinition cronDef = CronDefinitionBuilder.instanceDefinitionFor(CronType.QUARTZ);
								CronParser cronParser = new CronParser(cronDef);
								Cron cronJob = cronParser.parse(timerDefinition);
								cronJob.validate();
							} catch (IllegalArgumentException e) {
								issues.add(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element, entry,
										String.format(Messages.getString("TimerExpressionChecker.10"), //$NON-NLS-1$
												CheckName.checkTimer(entry.getKey()))));
							}
						}

						if (!isCron && !hasRepeatingIntervals && !isDur) {
							try {
								MomentInterval.parseISO(timerDefinition);
							} catch (ParseException e) {
								issues.add(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element, entry,
										String.format(Messages.getString("TimerExpressionChecker.11"), //$NON-NLS-1$
												CheckName.checkTimer(entry.getKey()))));
							}
						}

						if (!isCron && hasRepeatingIntervals && !isDur) {
							try {
								IsoRecurrence.parseMomentIntervals(timerDefinition);
							} catch (ParseException ex) {
								issues.add(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element, entry,
										String.format(Messages.getString("TimerExpressionChecker.12"), //$NON-NLS-1$
												CheckName.checkTimer(entry.getKey()))));
							}
						}

						if (isDur && !isCron && !hasRepeatingIntervals) {
							try {
								DatatypeFactory.newInstance().newDuration(timerDefinition);
							} catch (Exception ex) {
								issues.add(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element, entry,
										String.format(Messages.getString("TimerExpressionChecker.13"), //$NON-NLS-1$
												CheckName.checkTimer(entry.getKey()))));
							}
						}
					}

				} else if (entry.getValue() == null || entry.getValue().getLocalName() == null
						|| entry.getValue().getLocalName().isEmpty()) {
					issues.add(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element, entry,
							String.format(Messages.getString("TimerExpressionChecker.14"), //$NON-NLS-1$
									CheckName.checkTimer(entry.getKey()))));
				} else if (timerDefinition.trim().isEmpty()) {
					issues.add(IssueWriter.createIssue(rule, CriticalityEnum.ERROR, element, entry,
							String.format(Messages.getString("TimerExpressionChecker.15"), //$NON-NLS-1$
									CheckName.checkTimer(entry.getKey()))));
				}
			}
		}

		return issues;
	}
}