Stratigraph is at the moment is a small command line tools to automatically detect the interconnection of soure code packages and the resulting layering of the overall system.
It can be used to check, if the code analysed follows a layering structure and if the intended structure matches the one derived from the code.
Please use the issues section of this repository at github for feedback.
Stratigraph produces a graph of the mutual usages of source code packages of a software system and derives a layering from this graph, where some packages form the lowest layer of functionality not used by any other layer. Higher layers of the system are defined by the usage of lower layers down to the first layer.
In these analysis runs certain packages can be left unconcidered or other packages might be combined for a more coarse view if needed.
- Java
The latest packages ready to use can be found at the on GitLab at the
latest build pipeline
at GitLab. Download the Snapshot artifacts from the last build marked
as passed like with the download-button above.
Call the start script with no parameter to analyse the current directory:
stg
Parameters are described with the help option -h
stg -h
Starting at directory /home/martin/proj/development/analyze/source
usage: tool
-d,--basedir <arg> base directory to scan for java source files.
-g,--graphstream Use Graphstream library instead of JUNG.
-h,--help Issue this help message and exit.
-i,--internal Only take references internal to the project into account.
-j,--jgrapht Use JGraphT library instead of JUNG.
-t,--delay <arg> Delay in ms when drawing with the Graphstream 1library.
-w,--draw When using JUNG library really draw the graph in a window.
The original goal was to analyse the package structure of a software system and derive a visualization of the mutual usage of packages illustrating the layering of the overall system.
It turned out that the automated placement provided by a set of libraries tried doesn't meet the expectation to at least get a decent starting point for some later manual refinements.
The leftovers from this ultimate goal can be found in the graph visualization options on the command line, which still can be used to trigger graphical windows to be opened with a view of the software structure using different graph libraries.
Stratigraph supports the automated visualization of the resulting graph based on the JUNG library. Alternatively the graph can be handled using the graphstream library or the JGraphT Library.
Stratigraph itself is a Java program which can be built with the Gradle build tool.
./gradlew assembleDist
The full test cycle can be achieved - like CI does it - with
./gradlew jacocoTestReport audit build assemble
While the source code in this repository is covered by the license mentioned in the file LICENSE, the libraries it depends on retain their own respective license which needs to be taken into account.
-
Apache License 2.0: Groovy, Guava, Scala, Apache Commons Lang, Apache Commons Collections
-
BSD 3-Clause: JUNG
-
MIT: Slf4j
-
LGPL 2.1: JGraphtT, Logback
-
LGPL 3: GraphStream