Skip to content

Latest commit

 

History

History
88 lines (69 loc) · 5.02 KB

README.md

File metadata and controls

88 lines (69 loc) · 5.02 KB
Raw

pete

Build Status

DISCLAIMER: pete has been renamed and moved to prope

pete is a tool for computing metrics that characterize the portability of executable service-oriented processes implemented in several process languages. So far, BPMN 2.0 and BPEL 2.0 process definitions are supported.

Quality Characteristics

Pete aims to support the computation of metrics for four quality characteristics which are aligned to the ISO/IEC 25010 Systems and software Quality Requirements and Evaluation (SQuaRE) method. These are:

Quality Characteristic Status (package)
Direct code portability implemented (pete.metrics.portability)
Installability implemented (pete.metrics.installability)
Adaptability implemented (pete.metrics.adaptability)
Replaceability ongoing

Software Requirements

Pete uses the gradle wrapper, so anything besides Java will be downloaded and installed automatically.

  • JDK 1.8.X
    • JAVA_HOME should point to the jdk directory
    • PATH should include JAVA_HOME/bin

Licensing

MIT license

Usage

Pete can be built, but also executed using gradle.

$ gradlew run -Pargs="<ARGS>"

# usage: <metric-option> <path-to-files>

<path-to-files>: Pete parses single files or recursively traverses directory structures, looking for relevant files. Everything that is analyzed in an execution run is aggregated to a result set and written to CSV files, ready to be consumed by MS Excel or R. Pete is forgiving: It tries to analyzes as many files as possible, sometimes depending on the type, but if the analysis for a file fails or nothing relevant is found, that file is just ignored.

<metric-option>: Pete allows for the computation of various types of metrics and the files to be analyzed depend on that type. For that reason, the type of metrics to be computed must be stated on execution. Following options are implemented so far:

  • p: pete computes direct portability metrics, such as weighted elements portability or activity portability, for process files
  • d: pete computes deployability metrics, such as deployment descriptor size or effort of package construction, for deployment archives
  • i: pete computes installability metrics for process engines, such as average installation time or installation effort
  • a: pete computes adaptability metrics for processes, such as binary or weighted adaptability
# Examples
$ gradlew run -Pargs="-p src/test/resources/portability/Invoke-Empty.bpel" # Compute portability metrics for a process from the test directory
$ gradlew run -Pargs="-i src/test/resources/installability/server" # Compute installability metrics from all files of a specific test directory 
$ gradlew run -Pargs="-i src/test/resources/installability/deployment" # Compute deployability metrics from all files of a specific test directory 
$ gradlew run -Pargs="-a src/test/resources/adaptability" # Compute adaptability metrics from all files of a specific test directory

Pete comes with tasks for IntelliJ and Eclipse

# Generate project files 
$ gradlew idea # Generates Intellij IDEA project files
$ gradlew eclipse # Generates Eclipse project files

# Manually purge temporary files
$ gradlew deleteTmpDir # purge temporary files manually

Output

Pete produces three different files that are written to the root directory and can be analyzed by statistical tooling:

  • results.csv: A list of all metrics of the selected type and their values for the files analyzed. Values are separated with a semicolon.
  • raw.csv: A list of raw data from which several metrics of the above metrics can be computed. Values are separated with a semicolon.

Project Structure

Package Purpose
src/main/java the main source code
src/main/java/pete/executables classes that implement the main workflow, such as traversing a directory structure and triggering the metrics computation and reporting
src/main/java/pete/metrics/adaptability classes for computing adaptability metrics
src/main/java/pete/metrics/installability classes for computing installability metrics
src/main/java/pete/metrics/portability classes for computing portability metrics
src/main/java/pete/reporting classes for writing reports and result files to the file system
src/main/r scripts written in R that consume the CSV file produced by pete and perform several simple analyses of the data
src/test/java JUnit tests for pete
src/test/resources files that are analyzed during the unit tests

Authors

Joerg Lenhard

Contribution Guide

Contribution is appreciated! Feel free to open issues. Apart from that, the normal git workflow applies:

  • Fork
  • Send Pull Request