Skip to content

Commit

Permalink
update package structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Hossiphi committed Mar 7, 2024
1 parent 489f587 commit 888de7e
Show file tree
Hide file tree
Showing 237 changed files with 496 additions and 523 deletions.
4 changes: 0 additions & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ on:
- '**/src/**'
- '**/pom.xml'
- 'pom.xml'

# Publish `v1.2.3` tags as releases.
tags:
- v*

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
# ArDoCo Traceability Link Recovery

The goal of this project is to connect architecture documentation and models with Traceability Link Recovery (TLR) 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.
The goal of this project is to create trace links between informal and formal artifacts like software architecture documentation, software architecture, and code.
For more information about the ArDoCo project visit the core website at [ArDoCo/Core](https://github.com/ArDoCo/Core).

ArDoCo is actively developed by researchers of
the _[Modelling for Continuous Software Engineering (MCSE) group](https://mcse.kastel.kit.edu)_
of _[KASTEL - Institute of Information Security and Dependability](https://kastel.kit.edu)_ at
the [KIT](https://www.kit.edu).

## Traceability Link Recovery

This repository contains modules to perform various TLR tasks with ArDoCo. For more information about the ArDoCo project visit the core website at [ArDoCo/Core](https://github.com/ArDoCo/Core).
19 changes: 7 additions & 12 deletions pipeline-tlr/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>parent-tlr</artifactId>
<version>${revision}</version>
<relativePath>../pom.xml</relativePath>
Expand All @@ -13,17 +13,17 @@

<dependencies>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>code-traceability</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>connection-generator</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>model-provider</artifactId>
<version>${revision}</version>
</dependency>
Expand All @@ -40,17 +40,17 @@
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>recommendation-generator</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>text-extraction</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>text-preprocessing</artifactId>
<version>${revision}</version>
</dependency>
Expand All @@ -61,11 +61,6 @@
<version>${revision}</version>
</dependency>

<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.reflections</groupId>
<artifactId>reflections</artifactId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
/* Licensed under MIT 2023-2024. */
package edu.kit.kastel.mcse.ardoco.core.execution;
package edu.kit.kastel.mcse.ardoco.tlr.execution;

import java.io.File;
import java.util.SortedMap;

import edu.kit.kastel.mcse.ardoco.core.codetraceability.SadCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.execution.ArDoCo;
import edu.kit.kastel.mcse.ardoco.tlr.codetraceability.SadCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.common.util.CommonUtilities;
import edu.kit.kastel.mcse.ardoco.core.common.util.DataRepositoryHelper;
import edu.kit.kastel.mcse.ardoco.core.connectiongenerator.ConnectionGenerator;
import edu.kit.kastel.mcse.ardoco.tlr.connectiongenerator.ConnectionGenerator;
import edu.kit.kastel.mcse.ardoco.core.execution.runner.ArDoCoRunner;
import edu.kit.kastel.mcse.ardoco.core.models.agents.ArCoTLModelProviderAgent;
import edu.kit.kastel.mcse.ardoco.core.recommendationgenerator.RecommendationGenerator;
import edu.kit.kastel.mcse.ardoco.core.text.providers.TextPreprocessingAgent;
import edu.kit.kastel.mcse.ardoco.core.textextraction.TextExtraction;
import edu.kit.kastel.mcse.ardoco.tlr.models.agents.ArCoTLModelProviderAgent;
import edu.kit.kastel.mcse.ardoco.tlr.recommendationgenerator.RecommendationGenerator;
import edu.kit.kastel.mcse.ardoco.tlr.text.providers.TextPreprocessingAgent;
import edu.kit.kastel.mcse.ardoco.tlr.textextraction.TextExtraction;

public class ArDoCoForSadCodeTraceabilityLinkRecovery extends ArDoCoRunner {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
/* Licensed under MIT 2023-2024. */
package edu.kit.kastel.mcse.ardoco.core.execution;
package edu.kit.kastel.mcse.ardoco.tlr.execution;

import java.io.File;
import java.util.SortedMap;

import edu.kit.kastel.mcse.ardoco.core.api.models.ArchitectureModelType;
import edu.kit.kastel.mcse.ardoco.core.codetraceability.SadSamCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.codetraceability.SamCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.execution.ArDoCo;
import edu.kit.kastel.mcse.ardoco.tlr.codetraceability.SadSamCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.tlr.codetraceability.SamCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.common.util.CommonUtilities;
import edu.kit.kastel.mcse.ardoco.core.common.util.DataRepositoryHelper;
import edu.kit.kastel.mcse.ardoco.core.connectiongenerator.ConnectionGenerator;
import edu.kit.kastel.mcse.ardoco.tlr.connectiongenerator.ConnectionGenerator;
import edu.kit.kastel.mcse.ardoco.core.execution.runner.ArDoCoRunner;
import edu.kit.kastel.mcse.ardoco.core.models.agents.ArCoTLModelProviderAgent;
import edu.kit.kastel.mcse.ardoco.core.recommendationgenerator.RecommendationGenerator;
import edu.kit.kastel.mcse.ardoco.core.text.providers.TextPreprocessingAgent;
import edu.kit.kastel.mcse.ardoco.core.textextraction.TextExtraction;
import edu.kit.kastel.mcse.ardoco.tlr.models.agents.ArCoTLModelProviderAgent;
import edu.kit.kastel.mcse.ardoco.tlr.recommendationgenerator.RecommendationGenerator;
import edu.kit.kastel.mcse.ardoco.tlr.text.providers.TextPreprocessingAgent;
import edu.kit.kastel.mcse.ardoco.tlr.textextraction.TextExtraction;

public class ArDoCoForSadSamCodeTraceabilityLinkRecovery extends ArDoCoRunner {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
/* Licensed under MIT 2023-2024. */
package edu.kit.kastel.mcse.ardoco.core.execution;
package edu.kit.kastel.mcse.ardoco.tlr.execution;

import java.io.File;
import java.util.SortedMap;

import edu.kit.kastel.mcse.ardoco.core.api.models.ArchitectureModelType;
import edu.kit.kastel.mcse.ardoco.core.common.util.CommonUtilities;
import edu.kit.kastel.mcse.ardoco.core.common.util.DataRepositoryHelper;
import edu.kit.kastel.mcse.ardoco.core.connectiongenerator.ConnectionGenerator;
import edu.kit.kastel.mcse.ardoco.tlr.connectiongenerator.ConnectionGenerator;
import edu.kit.kastel.mcse.ardoco.core.execution.runner.ArDoCoRunner;
import edu.kit.kastel.mcse.ardoco.core.models.agents.ArCoTLModelProviderAgent;
import edu.kit.kastel.mcse.ardoco.core.recommendationgenerator.RecommendationGenerator;
import edu.kit.kastel.mcse.ardoco.core.text.providers.TextPreprocessingAgent;
import edu.kit.kastel.mcse.ardoco.core.textextraction.TextExtraction;
import edu.kit.kastel.mcse.ardoco.tlr.models.agents.ArCoTLModelProviderAgent;
import edu.kit.kastel.mcse.ardoco.tlr.recommendationgenerator.RecommendationGenerator;
import edu.kit.kastel.mcse.ardoco.tlr.text.providers.TextPreprocessingAgent;
import edu.kit.kastel.mcse.ardoco.tlr.textextraction.TextExtraction;

public class ArDoCoForSadSamTraceabilityLinkRecovery extends ArDoCoRunner {
public ArDoCoForSadSamTraceabilityLinkRecovery(String projectName) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
/* Licensed under MIT 2023-2024. */
package edu.kit.kastel.mcse.ardoco.core.execution;
package edu.kit.kastel.mcse.ardoco.tlr.execution;

import java.io.File;
import java.util.SortedMap;

import edu.kit.kastel.mcse.ardoco.core.api.models.ArchitectureModelType;
import edu.kit.kastel.mcse.ardoco.core.codetraceability.SamCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.execution.ArDoCo;
import edu.kit.kastel.mcse.ardoco.tlr.codetraceability.SamCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.execution.runner.ArDoCoRunner;
import edu.kit.kastel.mcse.ardoco.core.models.agents.ArCoTLModelProviderAgent;
import edu.kit.kastel.mcse.ardoco.tlr.models.agents.ArCoTLModelProviderAgent;

public class ArDoCoForSamCodeTraceabilityLinkRecovery extends ArDoCoRunner {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
/* Licensed under MIT 2023. */
package edu.kit.kastel.mcse.ardoco.core.execution.runner;
package edu.kit.kastel.mcse.ardoco.tlr.execution.runner;

import java.io.File;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import edu.kit.kastel.mcse.ardoco.core.execution.ArDoCoForSadCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.tlr.execution.ArDoCoForSadCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.execution.CodeRunnerBaseTest;
import edu.kit.kastel.mcse.ardoco.core.execution.ConfigurationHelper;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* Licensed under MIT 2023. */
package edu.kit.kastel.mcse.ardoco.core.execution.runner;
package edu.kit.kastel.mcse.ardoco.tlr.execution.runner;

import java.io.File;

Expand All @@ -9,7 +9,7 @@
import org.junit.jupiter.api.Test;

import edu.kit.kastel.mcse.ardoco.core.api.models.ArchitectureModelType;
import edu.kit.kastel.mcse.ardoco.core.execution.ArDoCoForSadSamCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.tlr.execution.ArDoCoForSadSamCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.execution.CodeRunnerBaseTest;
import edu.kit.kastel.mcse.ardoco.core.execution.ConfigurationHelper;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* Licensed under MIT 2023. */
package edu.kit.kastel.mcse.ardoco.core.execution.runner;
package edu.kit.kastel.mcse.ardoco.tlr.execution.runner;

import java.io.File;

Expand All @@ -9,7 +9,7 @@
import org.junit.jupiter.api.Test;

import edu.kit.kastel.mcse.ardoco.core.api.models.ArchitectureModelType;
import edu.kit.kastel.mcse.ardoco.core.execution.ArDoCoForSadSamTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.tlr.execution.ArDoCoForSadSamTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.execution.ConfigurationHelper;
import edu.kit.kastel.mcse.ardoco.core.execution.RunnerBaseTest;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* Licensed under MIT 2023. */
package edu.kit.kastel.mcse.ardoco.core.execution.runner;
package edu.kit.kastel.mcse.ardoco.tlr.execution.runner;

import java.io.File;

Expand All @@ -9,7 +9,7 @@
import org.junit.jupiter.api.Test;

import edu.kit.kastel.mcse.ardoco.core.api.models.ArchitectureModelType;
import edu.kit.kastel.mcse.ardoco.core.execution.ArDoCoForSamCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.tlr.execution.ArDoCoForSamCodeTraceabilityLinkRecovery;
import edu.kit.kastel.mcse.ardoco.core.execution.CodeRunnerBaseTest;
import edu.kit.kastel.mcse.ardoco.core.execution.ConfigurationHelper;

Expand Down
16 changes: 5 additions & 11 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,15 @@
<parent>
<groupId>io.github.ardoco.core</groupId>
<artifactId>parent</artifactId>
<version>0.42.0-SNAPSHOT</version>
<version>1.0.0-SNAPSHOT</version>
</parent>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>parent-tlr</artifactId>
<version>${revision}</version>
<packaging>pom</packaging>

<name>ArDoCo (Core) - The Consistency Analyzer: TLR</name>
<description>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. ArDoCo is actively developed by researchers of the Modelling for Continuous Software
Engineering (MCSE) group of KASTEL - Institute of Information Security and Dependability at the KIT.
This work was supported by funding from the topic Engineering Secure Systems of the Helmholtz Association (HGF)
and by KASTEL Security Research Labs
(46.23.01).
<name>ArDoCo TLR</name>
<description>The goal of this project is to create trace links between informal and formal artifacts like software architecture documentation, software architecture, and code.
</description>
<url>https://github.com/ArDoCo/TLR</url>
<licenses>
Expand Down Expand Up @@ -76,7 +70,7 @@
</distributionManagement>

<properties>
<revision>0.42.0-SNAPSHOT</revision>
<revision>1.0.0-SNAPSHOT</revision>
<ardoco.version>${revision}</ardoco.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
Expand Down
14 changes: 7 additions & 7 deletions report/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>parent-tlr</artifactId>
<version>${revision}</version>
<relativePath>../pom.xml</relativePath>
Expand All @@ -18,25 +18,25 @@

<dependencies>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>connection-generator</artifactId>
<version>${revision}</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>model-provider</artifactId>
<version>${revision}</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>pipeline-tlr</artifactId>
<version>${revision}</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>recommendation-generator</artifactId>
<version>${revision}</version>
<scope>compile</scope>
Expand All @@ -54,13 +54,13 @@
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>text-extraction</artifactId>
<version>${revision}</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>text-preprocessing</artifactId>
<version>${revision}</version>
<scope>compile</scope>
Expand Down
7 changes: 1 addition & 6 deletions stages-tlr/code-traceability/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.github.ardoco.core</groupId>
<groupId>io.github.ardoco.tlr</groupId>
<artifactId>stages-tlr</artifactId>
<version>${revision}</version>
<relativePath>../pom.xml</relativePath>
Expand Down Expand Up @@ -42,11 +42,6 @@
<artifactId>opennlp-tools</artifactId>
<version>2.3.2</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

</project>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* Licensed under MIT 2023-2024. */
package edu.kit.kastel.mcse.ardoco.core.codetraceability;
package edu.kit.kastel.mcse.ardoco.tlr.codetraceability;

import java.util.Collection;
import java.util.LinkedHashSet;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/* Licensed under MIT 2023-2024. */
package edu.kit.kastel.mcse.ardoco.core.codetraceability;
package edu.kit.kastel.mcse.ardoco.tlr.codetraceability;

import java.util.List;
import java.util.SortedMap;

import edu.kit.kastel.mcse.ardoco.core.api.codetraceability.CodeTraceabilityState;
import edu.kit.kastel.mcse.ardoco.core.codetraceability.agents.ArchitectureLinkToCodeLinkTransformerAgent;
import edu.kit.kastel.mcse.ardoco.tlr.codetraceability.agents.ArchitectureLinkToCodeLinkTransformerAgent;
import edu.kit.kastel.mcse.ardoco.core.common.util.DataRepositoryHelper;
import edu.kit.kastel.mcse.ardoco.core.data.DataRepository;
import edu.kit.kastel.mcse.ardoco.core.pipeline.AbstractExecutionStage;
Expand Down
Loading

0 comments on commit 888de7e

Please sign in to comment.