Skip to content
This repository has been archived by the owner on Sep 6, 2023. It is now read-only.

viadee/vPAV

Repository files navigation

viadee Process Application Validator (vPAV)

Maven Central

The tool checks Camunda projects for consistency and discovers errors in process-driven applications. Called as 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.

⚠️⚠️⚠️

Due to the paradigm shift at Camunda towards SaaS / cloud based process orchestration with Camunda 8 and the recent (incompatible) changes of the Soot project for static code analysis (which we rely on), this project is no longer actively maintained (Sept. 2023). It remains in read-only mode as a reference point and for the research papers linking here.

⚠️⚠️⚠️

A list of the consistency checks can be found here.

To get started with the viadee Process Application Validator read Installation and Usage and Output. We forked the Camunda BPM examples to demonstrate the easy integration of vPAV.

We recommend to integrate the consistency check in your CI builds - you can't find these inconsistencies early enough.

Release Notes

You can find our release notes over here.

Commitments

This library will remain under an open source licence indefinately.

We follow the semantic versioning scheme (2.0.0).

In the sense of semantic versioning, the resulting XML and JSON outputs are the only public API provided here. We will keep these as stable as possible, in order to enable users to analyse and integrate results into the toolsets of their choice.

Cooperation

Feel free to report issues, questions, ideas or patches. We are looking forward to it.

Resources

Status of the development branch: Build Status

Licenses

All licenses of reused components can be found on the maven site


Additionally we use the following third-party dependencies, that are not covered via maven-found licences:

Soot and bpmn.io provide the basis for the two most exciting features of the validator, i.e. finding inconsistencies in the data and control flow across model and code an the visualization thereof. We would like to explicitly thank these two communities for their continued effort.

BSD 3-Clause License

Copyright (c) 2019, viadee IT-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.