Add informal diagram consistency pipeline steps #308

jeanpmathes · 2023-12-05T12:15:19Z

This PR adds a module containing steps to find trace links between diagrams and models (architecture, code). Addionally, the code model is adapted to contain more information, including references to used types and parent classes for nested classes.

# Conflicts: # pom.xml

Release 0.23.0 # Conflicts: # framework/common/src/main/java/edu/kit/kastel/mcse/ardoco/core/api/models/arcotl/code/Datatype.java # pom.xml # stages/model-provider/src/main/java/edu/kit/kastel/mcse/ardoco/core/models/connectors/generators/code/java/JavaModel.java

Release 0.26.0 # Conflicts: # pom.xml

dfuchss

Some comments before CI build :)

stages/diagram-consistency/pom.xml

framework/common/pom.xml

Co-authored-by: Dominik Fuchß <[email protected]>

…ge structure

framework/common/pom.xml

dfuchss · 2023-12-05T23:45:32Z

Two points:

Could you run mvn spotless:apply once ?
Could you add a PR to ArDoCo/Benchmark instead of changing the benchmark in this repository directly :)

# Conflicts: # framework/common/pom.xml

jeanpmathes · 2023-12-06T09:35:29Z

PR in benchmark is here: ArDoCo/Benchmark#12

…m 7675243a..daeaee7e daeaee7e Update code models to contain parent class and reference info (ArDoCo#12) 4fae195e Format Code Model. Fix ArDoCo#13 814aa945 Remove duplicate in GS git-subtree-dir: tests/tests-base/src/main/resources/benchmark git-subtree-split: daeaee7e6273722b44a1a82b5d7bdd204edd743c

dfuchss · 2023-12-06T10:04:42Z

Thanks :) I've updated the benchmark. Let's wait for the CI

dfuchss · 2023-12-06T10:12:40Z

@jeanpmathes can you look at

Error:  Failures: 
Error:    DiagramLoadingTest.loadStageOne:86->EvaluationBase.getCodeModel:106 expected: not <null>
Error:    DiagramConsistencyTest.evaluateStage1VersionFinalLevenshtein:244->assertStage1Result:250 expected: <0.36> but was: <0.08>
Error:  Errors: 
Error:    DiagramConsistencyTest.evaluateAllStages:573->runAndEvaluateStage3:615 » NullPointer
[INFO] 
Error:  Tests run: 125, Failures: 2, Errors: 1, Skipped: 37

… available

jeanpmathes · 2023-12-06T14:38:55Z

The commits might fix the first failure, but I am not sure as I can't reproduce it. For the other two problems I am still looking for a reason.

dfuchss · 2023-12-06T16:05:54Z

Maybe you have to clear some AppData/ArDoCo folders.

dfuchss · 2023-12-08T14:17:48Z

@jeanpmathes in #315 we beautified the JSON of the Code Model. Could you regenerate the Code Model (adapted version) and create another PR in benchmark again :) Then the review should be easy.

…ailures

# Conflicts: # framework/common/src/main/java/edu/kit/kastel/mcse/ardoco/core/api/models/arcotl/code/Datatype.java

jeanpmathes · 2023-12-08T16:18:10Z

The new PR is here: ArDoCo/Benchmark#16

Concerning the failed tests, the problem seems to be an empty code model. When loading the model, no cloned code is available to extract from and just reading in does not work. The last commit clones when loading, this might not be an ideal solution.

…m daeaee7e..9bbc3a89 9bbc3a89 Update code models to contain parent class and reference info, using new formatting (ArDoCo#16) fe5a8549 Update the codemodel to be more (human) readable git-subtree-dir: tests/tests-base/src/main/resources/benchmark git-subtree-split: 9bbc3a89677ffba98bb861f0c0206a93c61ec5d1

...common/src/main/java/edu/kit/kastel/mcse/ardoco/core/api/diagramconsistency/common/Edge.java

...mmon/src/main/java/edu/kit/kastel/mcse/ardoco/core/api/diagramconsistency/common/Vertex.java

jeanpmathes · 2023-12-14T17:48:00Z

Something seems wrong with coverage calculation, it fails even before verify is done. Checking coverage locally leads to a higher value, which also makes sense because multiple of the tests run the entire pipeline that is added.

dfuchss · 2023-12-14T19:38:27Z

It works now :) I'll have a look at the code again but I think it will be good 👍

dfuchss

In summary, it looks good to me. Thanks a lot.

.../main/java/edu/kit/kastel/mcse/ardoco/core/api/diagramconsistency/common/TextSimilarity.java

...t/java/edu/kit/kastel/mcse/ardoco/core/diagramconsistency/evaluation/EvaluationTestBase.java

stages/model-provider/src/test/resources/interface/edu/AClass.java

sonarqubecloud · 2023-12-21T20:12:43Z

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
87.8% Coverage on New Code
1.1% Duplication on New Code

See analysis details on SonarCloud

dfuchss · 2023-12-21T20:18:47Z

@jeanpmathes thanks for the PR. Well done :) I'll merge it now !

jeanpmathes added 10 commits August 19, 2023 18:16

Adapt code model to support nested classes

cbb5572

Merge remote-tracking branch 'old-origin/main' into modified

145487d

# Conflicts: # pom.xml

Extend code model to store references of types to other types

d56594d

Merge tag 'v0.26.0' into modified

87371b7

Release 0.26.0 # Conflicts: # pom.xml

Move code from thesis repo into ArDoCo core

d93d160

Fix some test

280273f

Merge the two existing diagram classes

1f706ad

Fix the large graph test

5605fdc

Fix version name

9c4ddb0

jeanpmathes requested review from Gram21, Hossiphi and dfuchss as code owners December 5, 2023 12:15

Merge branch 'main' into modified

3ec41d2

dfuchss requested changes Dec 5, 2023

View reviewed changes

dfuchss reviewed Dec 5, 2023

View reviewed changes

framework/common/pom.xml Outdated Show resolved Hide resolved

jeanpmathes and others added 2 commits December 5, 2023 13:31

Update stages/diagram-consistency/pom.xml

918bdff

Co-authored-by: Dominik Fuchß <[email protected]>

Adapt pom.xml files as reviewed and adapt to changes related to packa…

3b6a34a

…ge structure

dfuchss reviewed Dec 5, 2023

View reviewed changes

framework/common/pom.xml Outdated Show resolved Hide resolved

Update framework/common/pom.xml

0083304

jeanpmathes added 2 commits December 6, 2023 09:38

Apply spotless

68a1bc0

Merge remote-tracking branch 'target/modified' into modified

37cf86e

# Conflicts: # framework/common/pom.xml

dfuchss added 3 commits December 6, 2023 11:01

Reset benchmark

979c261

Merge commit '1f6f1a6515c7f2e2d9b2d7bd5fe5e9b1b3833d5e' into modified

6b136cf

Let evaluation code extract code models if no already extracted model…

24bc6c0

… available

jeanpmathes added 3 commits December 8, 2023 15:55

Use assertion messages to gain more information about the occurring f…

d6987d1

…ailures

Merge remote-tracking branch 'target/main' into modified

8009807

# Conflicts: # framework/common/src/main/java/edu/kit/kastel/mcse/ardoco/core/api/models/arcotl/code/Datatype.java

When extracting a code model, clone first

169b624

jeanpmathes and others added 3 commits December 8, 2023 18:24

Delete directory before cloning

a5a12f7

Merge commit 'c4db18a640cc03c62f1c98976b89752b80ca5b43' into modified

ed842d2

dfuchss reviewed Dec 11, 2023

View reviewed changes

...common/src/main/java/edu/kit/kastel/mcse/ardoco/core/api/diagramconsistency/common/Edge.java Outdated Show resolved Hide resolved

...mmon/src/main/java/edu/kit/kastel/mcse/ardoco/core/api/diagramconsistency/common/Vertex.java Outdated Show resolved Hide resolved

dfuchss and others added 4 commits December 13, 2023 14:49

Merge branch 'main' into modified

fb180c8

Work on code smells

ccb7bd4

Merge remote-tracking branch 'target/modified' into modified

ef6933c

Merge branch 'main' into modified

550fd5a

dfuchss assigned dfuchss and jeanpmathes Dec 14, 2023

jeanpmathes added 2 commits December 14, 2023 15:02

Remove annotation that leads to compile error

8dfa1ba

Merge remote-tracking branch 'target/modified' into modified

5e23229

Register diagram-consistency to report

937e4fc

dfuchss self-requested a review December 14, 2023 21:57

dfuchss approved these changes Dec 15, 2023

View reviewed changes

.../main/java/edu/kit/kastel/mcse/ardoco/core/api/diagramconsistency/common/TextSimilarity.java Outdated Show resolved Hide resolved

...t/java/edu/kit/kastel/mcse/ardoco/core/diagramconsistency/evaluation/EvaluationTestBase.java Show resolved Hide resolved

Fix loading of ACM

be2030b

Gram21 approved these changes Dec 20, 2023

View reviewed changes

stages/model-provider/src/test/resources/interface/edu/AClass.java Outdated Show resolved Hide resolved

Remove commented out import

b144531

dfuchss merged commit 99b45b0 into ArDoCo:main Dec 21, 2023
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add informal diagram consistency pipeline steps #308

Add informal diagram consistency pipeline steps #308

jeanpmathes commented Dec 5, 2023

dfuchss left a comment

dfuchss commented Dec 5, 2023

jeanpmathes commented Dec 6, 2023

dfuchss commented Dec 6, 2023

dfuchss commented Dec 6, 2023

jeanpmathes commented Dec 6, 2023

dfuchss commented Dec 6, 2023

dfuchss commented Dec 8, 2023

jeanpmathes commented Dec 8, 2023

jeanpmathes commented Dec 14, 2023

dfuchss commented Dec 14, 2023

dfuchss left a comment

sonarqubecloud bot commented Dec 21, 2023

dfuchss commented Dec 21, 2023

Add informal diagram consistency pipeline steps #308

Add informal diagram consistency pipeline steps #308

Conversation

jeanpmathes commented Dec 5, 2023

dfuchss left a comment

Choose a reason for hiding this comment

dfuchss commented Dec 5, 2023

jeanpmathes commented Dec 6, 2023

dfuchss commented Dec 6, 2023

dfuchss commented Dec 6, 2023

jeanpmathes commented Dec 6, 2023

dfuchss commented Dec 6, 2023

dfuchss commented Dec 8, 2023

jeanpmathes commented Dec 8, 2023

jeanpmathes commented Dec 14, 2023

dfuchss commented Dec 14, 2023

dfuchss left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 21, 2023

Quality Gate passed

dfuchss commented Dec 21, 2023