From d406df5d3669dd050246817240e5241f0a6c3cd2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Fuch=C3=9F?= Date: Fri, 5 Aug 2022 11:03:53 +0200 Subject: [PATCH 1/4] Add more information about the projects and licenses --- LICENSE | 2 +- README.md | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index cdd6ee203e..da67833190 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 ArDoCo +Copyright (c) 2022 Sophie Corallo, Dominik Fuchß, Jan Keim Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 2f40af7a72..e4b50bedb9 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,35 @@ # Benchmark +This repository contains a benchmark for traceability link recovery (TLR) between textual Software Architecture Documentation (SAD) and Software Architecture Models (SAM). + +Each project of the benchmark is structured as follows: + +* The folder `pcm` contains a Palladio Component Model (PCM) of the system. It has at least the repository view (components) of the system. +* The text file(s) in the project folder contains the SAD of the projects as plain text. +* 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). + +## Using the benchmark +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). +Therefore, the benchmark is linked to the STD repository via a [git subtree](https://github.com/ArDoCo/SimpleTracelinkDiscovery/tree/main/src/test/resources/benchmark). ## References +:warning: The 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 :warning: ### BigBlueButton +BigBlueButton (BBB) is a non-scientific application that provides a web conferencing system with the focus on creating a "global teaching platform". +The [documentation of BBB](https://docs.bigbluebutton.org/2.4/architecture.html) is licensed under LGPL. +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. ### MediaStore +MediaStore is a "model application built after the iTunes Store". +Its architecture was used for exemplary performance analyses on software architecture models. +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). ### Teammates +TEAMMATES is an open-source "online tool for manageing peer evaluations and other feedback paths of your students". +The documentation of TEAMMATES is part of their [repository](https://github.com/TEAMMATES/teammates). +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. ### Teastore +Teastore is a scientific application that is used as a "micro-service reference test application". +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). +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. From 8dbeebba981d23cd86ec9338e6a9d484e6ceeaa6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Fuch=C3=9F?= Date: Fri, 5 Aug 2022 11:04:39 +0200 Subject: [PATCH 2/4] Add codeowners --- .github/CODEOWNERS | 1 + README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000000..5acf279341 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @Gram21 @dfuchss @Hossiphi \ No newline at end of file diff --git a/README.md b/README.md index e4b50bedb9..faa98582e4 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Therefore, the benchmark is linked to the STD repository via a [git subtree](htt ### BigBlueButton BigBlueButton (BBB) is a non-scientific application that provides a web conferencing system with the focus on creating a "global teaching platform". The [documentation of BBB](https://docs.bigbluebutton.org/2.4/architecture.html) is licensed under LGPL. -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. +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. ### MediaStore MediaStore is a "model application built after the iTunes Store". From fc851a6c787bfa915871ccab8a6cdebb5f4cd11a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Fuch=C3=9F?= Date: Fri, 5 Aug 2022 11:19:53 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index faa98582e4..5de5a8d297 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,9 @@ In order to provide an easy approach to use the benchmark, we provide an example Therefore, the benchmark is linked to the STD repository via a [git subtree](https://github.com/ArDoCo/SimpleTracelinkDiscovery/tree/main/src/test/resources/benchmark). ## References -:warning: The 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 :warning: +> **Note** +> +> 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. ### BigBlueButton BigBlueButton (BBB) is a non-scientific application that provides a web conferencing system with the focus on creating a "global teaching platform". From 85876db0dd25b1308cf3c51c385d55908fc853f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Fuch=C3=9F?= Date: Fri, 5 Aug 2022 11:51:33 +0200 Subject: [PATCH 4/4] added statistics --- README.md | 1 + bigbluebutton/README.md | 34 ++++++++++++++++++++++++++++++++++ mediastore/README.md | 16 ++++++++++++++++ teammates/README.md | 23 +++++++++++++++++++++++ teastore/README.md | 25 +++++++++++++++++++++++++ 5 files changed, 99 insertions(+) create mode 100644 bigbluebutton/README.md create mode 100644 mediastore/README.md create mode 100644 teammates/README.md create mode 100644 teastore/README.md diff --git a/README.md b/README.md index 5de5a8d297..2af19ca314 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ This repository contains a benchmark for traceability link recovery (TLR) betwee Each project of the benchmark is structured as follows: +* The README of each project contains some information about the used languages and lines of code created with [cloc](https://github.com/AlDanial/cloc). * The folder `pcm` contains a Palladio Component Model (PCM) of the system. It has at least the repository view (components) of the system. * The text file(s) in the project folder contains the SAD of the projects as plain text. * 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). diff --git a/bigbluebutton/README.md b/bigbluebutton/README.md new file mode 100644 index 0000000000..8650c362de --- /dev/null +++ b/bigbluebutton/README.md @@ -0,0 +1,34 @@ +# BigBlueButton Statistics (cloc) +``` +-------------------------------------------------------------------------------- +Language files blank comment code +-------------------------------------------------------------------------------- +JSON 84 182 0 100980 +JavaScript 949 10983 10387 68930 +JSX 342 5919 1382 47177 +CSS 39 3350 1079 28297 +Scala 421 4861 2439 22317 +Java 379 5058 5219 21372 +XML 62 494 1301 20119 +Ruby 60 1443 1667 6588 +Bourne Shell 148 1133 615 3556 +Groovy 18 589 516 3116 +Bourne Again Shell 9 448 484 2308 +YAML 14 54 345 1147 +SVG 20 8 16 1065 +HTML 8 138 129 762 +Markdown 19 256 0 580 +Python 2 110 64 512 +Scheme 6 86 0 381 +Maven 2 9 23 240 +Gradle 4 21 8 159 +DOS Batch 2 44 4 130 +SQL 1 8 0 67 +ERB 1 2 0 33 +Cucumber 2 5 0 21 +Dockerfile 1 2 0 13 +TOML 1 0 1 2 +-------------------------------------------------------------------------------- +SUM: 2594 35203 25679 329872 +-------------------------------------------------------------------------------- +``` diff --git a/mediastore/README.md b/mediastore/README.md new file mode 100644 index 0000000000..9513c93232 --- /dev/null +++ b/mediastore/README.md @@ -0,0 +1,16 @@ +# MediaStore Statistics (cloc) +``` +----------------------------------------------------------------------------------- +Language files blank comment code +----------------------------------------------------------------------------------- +Java 97 1126 1978 3709 +Maven 23 154 43 1193 +XML 24 2 25 590 +Visualforce Component 22 0 0 378 +XHTML 5 59 8 214 +CSS 1 63 0 68 +SQL 4 0 0 7 +----------------------------------------------------------------------------------- +SUM: 176 1404 2054 6159 +----------------------------------------------------------------------------------- +``` diff --git a/teammates/README.md b/teammates/README.md new file mode 100644 index 0000000000..82b7094911 --- /dev/null +++ b/teammates/README.md @@ -0,0 +1,23 @@ +# TEAMMATES Statistics (cloc) +``` +------------------------------------------------------------------------------- +Language files blank comment code +------------------------------------------------------------------------------- +JSON 93 60 0 91232 +Java 826 22948 11357 90733 +TypeScript 782 7652 5963 53747 +HTML 298 706 85 16447 +Sass 121 441 4 2129 +Markdown 35 764 0 1622 +XML 10 40 35 854 +YAML 13 42 114 696 +Gradle 1 69 11 509 +Bourne Shell 3 32 112 128 +CSS 2 27 6 120 +JavaScript 6 4 0 100 +DOS Batch 1 21 2 68 +Dockerfile 3 6 0 11 +------------------------------------------------------------------------------- +SUM: 2194 32812 17689 258396 +------------------------------------------------------------------------------- +``` diff --git a/teastore/README.md b/teastore/README.md new file mode 100644 index 0000000000..112f07c9ee --- /dev/null +++ b/teastore/README.md @@ -0,0 +1,25 @@ +# TeaStore Statistics (cloc) +``` +----------------------------------------------------------------------------------- +Language files blank comment code +----------------------------------------------------------------------------------- +Java 200 2591 7933 12295 +CSS 5 58 24 7598 +YAML 32 44 59 2824 +JavaScript 13 644 250 1848 +JSON 4 0 0 1280 +Maven 14 61 24 991 +XML 24 18 37 769 +JSP 17 35 10 760 +Markdown 3 138 0 352 +SVG 1 0 0 288 +Bourne Shell 5 27 10 209 +Visualforce Component 13 0 0 154 +SQL 2 31 48 146 +Lua 2 14 52 122 +Python 1 11 37 87 +Dockerfile 7 23 12 67 +----------------------------------------------------------------------------------- +SUM: 343 3695 8496 29790 +----------------------------------------------------------------------------------- +```