Skip to content
/ Core Public

Core framework for traceability link recovery between architecture documentation and models while identifying inconsistencies.

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE.md
Unknown
license-header
Notifications You must be signed in to change notification settings

ArDoCo/Core

Repository files navigation

Core

SonarCloud

Maven Verify

The goal of this project is to connect architecture documentation and models while identifying missing or deviating elements (inconsistencies). An element can be any representable item of the model, like a component or a relation. To do so, we first create trace links and then make use of them and other information to identify inconsistencies.

CLI

The Core Project contains a CLI that currently supports to find trace links between PCM Models and Textual SW Architecture Documentation. The CLI is part of the pipeline module of this project. The PCM models have to be converted to ontologies using Ecore2OWL. The model can also contain a (java) code model that you can insert using the CodeModelExtractors.

Usage

usage: java -jar ardoco-core-pipeline.jar
-c,--conf <arg>                  path to the additional config file
-h,--help                        show this message
-ma,--model-architecture <arg>   path to the architecture model
-mc,--model-code <arg>           path to the java code model
-n,--name <arg>                  name of the run
-o,--out <arg>                   path to the output directory
-p,--provided <arg>              path to a JSON Text (already
								preprocessed)
-t,--text <arg>                  path to the text file

Wiki

For more information about the setup or the architecture have a look on the wiki. The wiki is at some points deprecated, the general overview and setup should still hold.

Case Studies / Benchmarks

To test the Core, you could use case studies and benchmarks provided in ..

Attribution

The base for this project is based on the master thesis Linking Software Architecture Documentation and Models.