de.viadee.bpm.vPAV.processing.dataflow.SimpleDataFlowRule 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.dataflow;

import de.viadee.bpm.vPAV.processing.model.data.CriticalityEnum;
import de.viadee.bpm.vPAV.processing.model.data.ProcessVariable;

import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * Implementation of a data flow rule containing all necessary data for evaluating it.
 * Also contains evaluation logic.
 */
class SimpleDataFlowRule implements DataFlowRule {
    private static final String RULE_VIOLATION_DESCRIPTION_TEMPLATE = "Rule '%s' was violated %s times%s:\n";
    private static final String RULE_DESCRIPTION_TEMPLATE = "Process variables%s should be %s%s";
    private static final String VIOLATION_TEMPLATE = "'%s' needed to be %s%s";
    private final DescribedPredicateEvaluator constraint;
    private final DescribedPredicateEvaluator condition;
    private String reason;
    private CriticalityEnum criticality = CriticalityEnum.ERROR;

    SimpleDataFlowRule(DescribedPredicateEvaluator constraint, DescribedPredicateEvaluator condition) {
        this.constraint = constraint;
        this.condition = condition;
    }

    public Collection> evaluate(Collection variables) {
        Stream variableStream = variables.stream();
        if (constraint != null)
            variableStream = variableStream.filter(p -> constraint.evaluate(p).isFulfilled());
        List> results = variableStream
                .map(condition::evaluate)
                .collect(Collectors.toList());
        return results;
    }

    public void check(Collection variables) {
        assertNoViolations(evaluate(variables));
    }

    private void assertNoViolations(Collection> result) {
        List> violations = result.stream()
                .filter(r -> !r.isFulfilled())
                .collect(Collectors.toList());
        if (violations.size() > 0) {
            String ruleDescription = createRuleDescriptionMessage(violations.size());

            String violationsString = violations.stream()
                    .map(this::getViolationMessageFor)
                    .collect(Collectors.joining("\n"));
            throw new AssertionError( ruleDescription + violationsString);
        }
    }

    public String getRuleDescription() {
        String constraintDescription = constraint != null ?
                " that are " + constraint.getDescription() :
                "";
        String reasonMessage = reason != null ? " because " + reason : "";
        return String.format(RULE_DESCRIPTION_TEMPLATE, constraintDescription, condition.getDescription(), reasonMessage);
    }

    @Override
    public CriticalityEnum getCriticality() {
        return criticality;
    }

    @Override
    public DataFlowRule because(String reason) {
        this.reason = reason;
        return this;
    }

    @Override
    public DataFlowRule withCriticality(CriticalityEnum criticality) {
        this.criticality = criticality;
        return this;
    }

    private String createRuleDescriptionMessage(int violationCount) {
        String criticalityMessage = criticality != null ? " [Criticality: " + criticality + "]": "";
        return String.format(RULE_VIOLATION_DESCRIPTION_TEMPLATE, getRuleDescription(), violationCount, criticalityMessage);
    }

    @Override
    public String getViolationMessageFor(EvaluationResult result) {
        String violationMessage = result.getMessage().isPresent() ?
                " but was " + result.getMessage().get() :
                "";
        return String.format(VIOLATION_TEMPLATE,
                result.getEvaluatedVariable().getName(), condition.getDescription(), violationMessage);
    }
}