Skip to content

Commit 0237ea1

Browse files
dfuchssdfuchss
authored
Merge pull request #2 from ArDoCo/feature/docs
Revise documentation of Benchmark
2 parents 8561a49 + 85876db commit 0237ea1

7 files changed

Lines changed: 127 additions & 1 deletion

File tree

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @Gram21 @dfuchss @Hossiphi

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2022 ArDoCo
3+
Copyright (c) 2022 Sophie Corallo, Dominik Fuchß, Jan Keim
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,38 @@
11
# Benchmark
2+
This repository contains a benchmark for traceability link recovery (TLR) between textual Software Architecture Documentation (SAD) and Software Architecture Models (SAM).
3+
4+
Each project of the benchmark is structured as follows:
5+
6+
* The README of each project contains some information about the used languages and lines of code created with [cloc](https://github.com/AlDanial/cloc).
7+
* The folder `pcm` contains a Palladio Component Model (PCM) of the system. It has at least the repository view (components) of the system.
8+
* The text file(s) in the project folder contains the SAD of the projects as plain text.
9+
* The file `goldstandard.csv` contains the traceability links between SAD and SAM. It links the model elements by id with the sentences by their number (index starting at 1).
10+
11+
## Using the benchmark
12+
In order to provide an easy approach to use the benchmark, we provide an example TLR approach called [Simple Tracelink Discovery (STD)](https://github.com/ArDoCo/SimpleTracelinkDiscovery/) that uses this benchmark in its [evaluation](https://github.com/ArDoCo/SimpleTracelinkDiscovery/tree/main/src/test/java/io/github/ardoco/simpletracelinkdiscovery/eval).
13+
Therefore, the benchmark is linked to the STD repository via a [git subtree](https://github.com/ArDoCo/SimpleTracelinkDiscovery/tree/main/src/test/resources/benchmark).
214

315
## References
16+
> **Note**
17+
>
18+
> Our LICENSE does only apply to the PCM models and the Gold Standards (CSV files). The texts are licensed w.r.t. to the actual projects.
419
520
### BigBlueButton
21+
BigBlueButton (BBB) is a non-scientific application that provides a web conferencing system with the focus on creating a "global teaching platform".
22+
The [documentation of BBB](https://docs.bigbluebutton.org/2.4/architecture.html) is licensed under LGPL.
23+
Therefore, the text we extracted from their documentation is licensed according to the [license of BBB](https://bigbluebutton.org/open-source-project/open-source-license/) under LGPL.
624

725
### MediaStore
26+
MediaStore is a "model application built after the iTunes Store".
27+
Its architecture was used for exemplary performance analyses on software architecture models.
28+
The text we extracted from their documentation originates from the publication [Modeling and Simulating Software Architectures: The Palladio Approach](https://books.google.de/books?id=g6BSDQAAQBAJ).
829

930
### Teammates
31+
TEAMMATES is an open-source "online tool for manageing peer evaluations and other feedback paths of your students".
32+
The documentation of TEAMMATES is part of their [repository](https://github.com/TEAMMATES/teammates).
33+
Therefore, the text we extracted from their documentation is licensed according to the [license of TEAMMATES](https://github.com/TEAMMATES/teammates/blob/master/LICENSE) under GPL-2.0.
1034

1135
### Teastore
36+
Teastore is a scientific application that is used as a "micro-service reference test application".
37+
The [documentation](https://web.archive.org/web/20201102180945/https://github.com/DescartesResearch/teastore/wiki/Services) of Teastore was part of their [repository](https://github.com/DescartesResearch/teastore).
38+
Therefore, the text we extracted from their documentation is licensed according to the [license of Teastore](https://github.com/DescartesResearch/TeaStore/blob/master/README.md) under Apache-2.0.

‎bigbluebutton/README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# BigBlueButton Statistics (cloc)
2+
```
3+
--------------------------------------------------------------------------------
4+
Language files blank comment code
5+
--------------------------------------------------------------------------------
6+
JSON 84 182 0 100980
7+
JavaScript 949 10983 10387 68930
8+
JSX 342 5919 1382 47177
9+
CSS 39 3350 1079 28297
10+
Scala 421 4861 2439 22317
11+
Java 379 5058 5219 21372
12+
XML 62 494 1301 20119
13+
Ruby 60 1443 1667 6588
14+
Bourne Shell 148 1133 615 3556
15+
Groovy 18 589 516 3116
16+
Bourne Again Shell 9 448 484 2308
17+
YAML 14 54 345 1147
18+
SVG 20 8 16 1065
19+
HTML 8 138 129 762
20+
Markdown 19 256 0 580
21+
Python 2 110 64 512
22+
Scheme 6 86 0 381
23+
Maven 2 9 23 240
24+
Gradle 4 21 8 159
25+
DOS Batch 2 44 4 130
26+
SQL 1 8 0 67
27+
ERB 1 2 0 33
28+
Cucumber 2 5 0 21
29+
Dockerfile 1 2 0 13
30+
TOML 1 0 1 2
31+
--------------------------------------------------------------------------------
32+
SUM: 2594 35203 25679 329872
33+
--------------------------------------------------------------------------------
34+
```

‎mediastore/README.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# MediaStore Statistics (cloc)
2+
```
3+
-----------------------------------------------------------------------------------
4+
Language files blank comment code
5+
-----------------------------------------------------------------------------------
6+
Java 97 1126 1978 3709
7+
Maven 23 154 43 1193
8+
XML 24 2 25 590
9+
Visualforce Component 22 0 0 378
10+
XHTML 5 59 8 214
11+
CSS 1 63 0 68
12+
SQL 4 0 0 7
13+
-----------------------------------------------------------------------------------
14+
SUM: 176 1404 2054 6159
15+
-----------------------------------------------------------------------------------
16+
```

‎teammates/README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# TEAMMATES Statistics (cloc)
2+
```
3+
-------------------------------------------------------------------------------
4+
Language files blank comment code
5+
-------------------------------------------------------------------------------
6+
JSON 93 60 0 91232
7+
Java 826 22948 11357 90733
8+
TypeScript 782 7652 5963 53747
9+
HTML 298 706 85 16447
10+
Sass 121 441 4 2129
11+
Markdown 35 764 0 1622
12+
XML 10 40 35 854
13+
YAML 13 42 114 696
14+
Gradle 1 69 11 509
15+
Bourne Shell 3 32 112 128
16+
CSS 2 27 6 120
17+
JavaScript 6 4 0 100
18+
DOS Batch 1 21 2 68
19+
Dockerfile 3 6 0 11
20+
-------------------------------------------------------------------------------
21+
SUM: 2194 32812 17689 258396
22+
-------------------------------------------------------------------------------
23+
```

‎teastore/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# TeaStore Statistics (cloc)
2+
```
3+
-----------------------------------------------------------------------------------
4+
Language files blank comment code
5+
-----------------------------------------------------------------------------------
6+
Java 200 2591 7933 12295
7+
CSS 5 58 24 7598
8+
YAML 32 44 59 2824
9+
JavaScript 13 644 250 1848
10+
JSON 4 0 0 1280
11+
Maven 14 61 24 991
12+
XML 24 18 37 769
13+
JSP 17 35 10 760
14+
Markdown 3 138 0 352
15+
SVG 1 0 0 288
16+
Bourne Shell 5 27 10 209
17+
Visualforce Component 13 0 0 154
18+
SQL 2 31 48 146
19+
Lua 2 14 52 122
20+
Python 1 11 37 87
21+
Dockerfile 7 23 12 67
22+
-----------------------------------------------------------------------------------
23+
SUM: 343 3695 8496 29790
24+
-----------------------------------------------------------------------------------
25+
```

0 commit comments

Comments
 (0)