-
Notifications
You must be signed in to change notification settings - Fork 0
/
TraceLinkEvaluationIT.java
265 lines (222 loc) · 11.2 KB
/
TraceLinkEvaluationIT.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
/* Licensed under MIT 2023. */
package edu.kit.kastel.mcse.ardoco.core.tests.integration;
import static edu.kit.kastel.mcse.ardoco.core.tests.eval.ProjectHelper.ANALYZE_CODE_DIRECTLY;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.EnumMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Predicate;
import org.eclipse.collections.api.factory.Lists;
import org.eclipse.collections.api.list.MutableList;
import org.eclipse.collections.api.tuple.Pair;
import org.junit.jupiter.api.*;
import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;
import org.junit.jupiter.params.provider.MethodSource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import edu.kit.kastel.mcse.ardoco.core.api.models.ArchitectureModelType;
import edu.kit.kastel.mcse.ardoco.core.api.models.tracelinks.SadSamTraceLink;
import edu.kit.kastel.mcse.ardoco.core.api.output.ArDoCoResult;
import edu.kit.kastel.mcse.ardoco.core.common.RepositoryHandler;
import edu.kit.kastel.mcse.ardoco.core.common.util.DataRepositoryHelper;
import edu.kit.kastel.mcse.ardoco.core.execution.ArDoCo;
import edu.kit.kastel.mcse.ardoco.core.tests.TestUtil;
import edu.kit.kastel.mcse.ardoco.core.tests.eval.CodeProject;
import edu.kit.kastel.mcse.ardoco.core.tests.eval.Project;
import edu.kit.kastel.mcse.ardoco.core.tests.eval.results.EvaluationResults;
import edu.kit.kastel.mcse.ardoco.core.tests.eval.results.calculator.ResultCalculatorUtil;
import edu.kit.kastel.mcse.ardoco.core.tests.integration.tlrhelper.TestLink;
import edu.kit.kastel.mcse.ardoco.core.tests.integration.tlrhelper.files.TLDiffFile;
import edu.kit.kastel.mcse.ardoco.core.tests.integration.tlrhelper.files.TLLogFile;
import edu.kit.kastel.mcse.ardoco.core.tests.integration.tlrhelper.files.TLModelFile;
import edu.kit.kastel.mcse.ardoco.core.tests.integration.tlrhelper.files.TLPreviousFile;
import edu.kit.kastel.mcse.ardoco.core.tests.integration.tlrhelper.files.TLSentenceFile;
import edu.kit.kastel.mcse.ardoco.core.tests.integration.tlrhelper.files.TLSummaryFile;
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
class TraceLinkEvaluationIT {
protected static final Logger logger = LoggerFactory.getLogger(TraceLinkEvaluationIT.class);
protected static final String OUTPUT = "src/test/resources/testout";
protected static final String LOGGING_ARDOCO_CORE = "org.slf4j.simpleLogger.log.edu.kit.kastel.mcse.ardoco.core";
protected static AtomicBoolean analyzeCodeDirectly = ANALYZE_CODE_DIRECTLY;
protected static final List<Pair<Project, EvaluationResults<TestLink>>> RESULTS = new ArrayList<>();
protected static final MutableList<EvaluationResults<String>> PROJECT_RESULTS = Lists.mutable.empty();
protected static final Map<Project, ArDoCoResult> DATA_MAP = new EnumMap<>(Project.class);
@BeforeAll
static void beforeAll() {
System.setProperty(LOGGING_ARDOCO_CORE, "info");
}
@AfterAll
static void afterAll() {
logOverallResultsForSadSamTlr();
writeOutputForSadSamTlr();
System.setProperty(LOGGING_ARDOCO_CORE, "error");
}
private static void cleanUpCodeRepository(CodeProject codeProject) {
RepositoryHandler.removeRepository(codeProject.getCodeLocation());
}
private static void logOverallResultsForSadSamTlr() {
if (logger.isInfoEnabled()) {
var name = "Overall Weighted";
var results = ResultCalculatorUtil.calculateWeightedAverageResults(PROJECT_RESULTS.toImmutable());
TestUtil.logResults(logger, name, results);
name = "Overall Macro";
results = ResultCalculatorUtil.calculateAverageResults(PROJECT_RESULTS.toImmutable());
TestUtil.logResults(logger, name, results);
}
}
private static void writeOutputForSadSamTlr() {
var evalDir = Path.of(OUTPUT).resolve("ardoco_eval_tl");
try {
Files.createDirectories(evalDir);
TLSummaryFile.save(evalDir.resolve("summary.txt"), RESULTS, DATA_MAP);
TLModelFile.save(evalDir.resolve("models.txt"), DATA_MAP);
TLSentenceFile.save(evalDir.resolve("sentences.txt"), DATA_MAP);
TLLogFile.append(evalDir.resolve("log.txt"), RESULTS);
TLPreviousFile.save(evalDir.resolve("previous.csv"), RESULTS, logger); // save before loading
TLDiffFile.save(evalDir.resolve("diff.txt"), RESULTS, TLPreviousFile.load(evalDir.resolve("previous.csv"), DATA_MAP), DATA_MAP);
} catch (IOException e) {
logger.error("Failed to write output.", e);
}
}
private static List<Project> getHistoricalProjects() {
return filterForHistoricalProjects(List.of(Project.values()));
}
private static List<CodeProject> getNonHistoricalCodeProjects() {
return filterForNonHistoricalProjects(List.of(CodeProject.values()));
}
private static <T extends Enum<T>> List<T> filterForHistoricalProjects(Collection<T> unfilteredProjects) {
return filterForProjects(unfilteredProjects, p -> p.name().endsWith("HISTORICAL"));
}
private static <T extends Enum<T>> List<T> filterForNonHistoricalProjects(Collection<T> unfilteredProjects) {
return filterForProjects(unfilteredProjects, p -> !p.name().endsWith("HISTORICAL"));
}
private static <T extends Enum<T>> List<T> filterForProjects(Collection<T> unfilteredProjects, Predicate<T> filter) {
List<T> projects = new ArrayList<>();
for (var project : unfilteredProjects) {
if (filter.test(project)) {
projects.add(project);
}
}
return projects;
}
@EnabledIfEnvironmentVariable(named = "testCodeFull", matches = ".*")
@DisplayName("Evaluate SAD-SAM-Code TLR (Full)")
@ParameterizedTest(name = "{0}")
@MethodSource("getNonHistoricalCodeProjects")
@Order(1)
void evaluateSadSamCodeTlrFullIT(CodeProject project) {
analyzeCodeDirectly.set(true);
if (analyzeCodeDirectly.get())
cleanUpCodeRepository(project);
var evaluation = new SadSamCodeTraceabilityLinkRecoveryEvaluation();
ArDoCoResult results = evaluation.runTraceLinkEvaluation(project);
Assertions.assertNotNull(results);
}
@EnabledIfEnvironmentVariable(named = "testCodeFull", matches = ".*")
@DisplayName("Evaluate SAM-Code TLR (Full)")
@ParameterizedTest(name = "{0}")
@EnumSource(value = CodeProject.class, mode = EnumSource.Mode.MATCH_NONE, names = "^.*HISTORICAL$")
@Order(2)
void evaluateSamCodeTlrFullIT(CodeProject project) {
analyzeCodeDirectly.set(true);
if (analyzeCodeDirectly.get())
cleanUpCodeRepository(project);
var evaluation = new SamCodeTraceabilityLinkRecoveryEvaluation();
var results = evaluation.runTraceLinkEvaluation(project);
Assertions.assertNotNull(results);
}
@DisplayName("Evaluate SAD-SAM-Code TLR")
@ParameterizedTest(name = "{0}")
@MethodSource("getNonHistoricalCodeProjects")
@Order(9)
void evaluateSadSamCodeTlrIT(CodeProject project) {
analyzeCodeDirectly.set(false);
if (analyzeCodeDirectly.get())
cleanUpCodeRepository(project);
var evaluation = new SadSamCodeTraceabilityLinkRecoveryEvaluation();
var results = evaluation.runTraceLinkEvaluation(project);
Assertions.assertNotNull(results);
TraceabilityLinkRecoveryEvaluation.resultMap.put(project.getProject(), results);
}
@DisplayName("Evaluate SAM-Code TLR")
@ParameterizedTest(name = "{0}")
@MethodSource("getNonHistoricalCodeProjects")
@Order(10)
void evaluateSamCodeTlrIT(CodeProject project) {
analyzeCodeDirectly.set(false);
if (analyzeCodeDirectly.get())
cleanUpCodeRepository(project);
var evaluation = new SamCodeTraceabilityLinkRecoveryEvaluation();
ArDoCoResult results = evaluation.runTraceLinkEvaluation(project);
Assertions.assertNotNull(results);
}
@DisplayName("Evaluate SAD-SAM TLR")
@ParameterizedTest(name = "{0}")
@MethodSource("getNonHistoricalCodeProjects")
@Order(20)
void evaluateSadSamTlrIT(CodeProject project) {
analyzeCodeDirectly.set(false);
if (analyzeCodeDirectly.get())
cleanUpCodeRepository(project);
var evaluation = new SadSamTraceabilityLinkRecoveryEvaluation();
var results = evaluation.runTraceLinkEvaluation(project);
Assertions.assertNotNull(results);
}
@EnabledIfEnvironmentVariable(named = "testHistoric", matches = ".*")
@DisplayName("Evaluate TLR (Historical)")
@ParameterizedTest(name = "{0}")
@MethodSource("getHistoricalProjects")
@Order(21)
void evaluateSadSamTlrHistoricalIT(Project project) {
analyzeCodeDirectly.set(false);
var evaluation = new SadSamTraceabilityLinkRecoveryEvaluation();
ArDoCoResult arDoCoResult = evaluation.getArDoCoResult(project);
Assertions.assertNotNull(arDoCoResult);
SadSamTraceabilityLinkRecoveryEvaluation.checkResults(project, arDoCoResult);
SadSamTraceabilityLinkRecoveryEvaluation.writeDetailedOutput(project, arDoCoResult);
}
/**
* Test if the results from executing ArDoCo with UML are the same as with PCM
*
* @param project the project, provided by the EnumSource
*/
@Disabled("Only enable this for local tests.")
@DisplayName("Compare TLR for UML/PCM")
@ParameterizedTest(name = "{0}")
@EnumSource(value = Project.class)
@Order(29)
void compareSadSamTlRForPcmAndUmlIT(Project project) {
String name = project.name();
var inputText = project.getTextFile();
var evaluation = new SadSamTraceabilityLinkRecoveryEvaluation();
var ardocoRunForPCM = evaluation.getArDoCoResult(project);
Assertions.assertNotNull(ardocoRunForPCM);
var arDoCo = ArDoCo.getInstance(name);
var preprocessingData = ardocoRunForPCM.getPreprocessingData();
DataRepositoryHelper.putPreprocessingData(arDoCo.getDataRepository(), preprocessingData);
File umlModelFile = project.getModelFile(ArchitectureModelType.UML);
File additionalConfigurations = project.getAdditionalConfigurationsFile();
var ardocoRunForUML = evaluation.getArDoCoResult(name, inputText, umlModelFile, ArchitectureModelType.UML, additionalConfigurations);
Assertions.assertNotNull(ardocoRunForUML);
var pcmTLs = ardocoRunForPCM.getAllTraceLinks()
.toList()
.sortThisBy(SadSamTraceLink::getModelElementUid)
.sortThisByInt(SadSamTraceLink::getSentenceNumber);
var umlTLs = ardocoRunForUML.getAllTraceLinks()
.toList()
.sortThisBy(SadSamTraceLink::getModelElementUid)
.sortThisByInt(SadSamTraceLink::getSentenceNumber);
Assertions.assertAll( //
() -> Assertions.assertEquals(pcmTLs.size(), umlTLs.size()), //
() -> Assertions.assertIterableEquals(pcmTLs, umlTLs) //
);
}
}