Zum Inhalt springen
Zuletzt geändert von Celina Bock am 2025/09/17 10:43
Zeige letzte Bearbeiter
1 == Checkstyle einrichten ==
2
3 Für die Programmierfächer aus Semester 1 und 2 wurde Checkstyle eingeführt mit mehr Einschränkungen als es die Java Sun Konvention vorsieht (Zeilenlänge, Npath Complexity und co).
4
5
6 __Steps__
7
8 * Bei der Aufgabenerstellung muss der Haken bei "statische Codeanalyse" gesetzt werden. //Späteres Hinzufügen von Checkstyle ist umständlich!//
9
10 [[image:StatCode.png||data-xwiki-image-style-border="true"]]
11
12
13 * Weitere Eingaben tätigen und Test Repository clonen.
14 * Geclontes Repo enthält 3 statische Codeanalyse Tools. Alle Konfigurationsdateien befinden sich unter **staticCodeAnalysisConfig.**
15
16 [[image:1751962116852-287.png]]
17
18
19 * Inhalt der Checkstyle Konfiguration austauschen mit unserer Konfiguration. (% style="color:#c0392b" %)**Checkstyle Konfiguration findet sich unten unter Anhänge.**
20 * **BeforeExecutionExclusionFileFilter **in der Konfiguration anpassen. Das enthaltene Regex filtert alle Dateien heraus, die nicht den genannten String enthalten. Das hat den Vorteil, wenn den Studierenden mehrere fertige Dateien zur Verfügung gestellt werden, diese nicht von Checkstyle geprüft werden. Dementsprechend werden im Regex nur Dateien gelistet, die von Studirenden bearbeitet werden. Nachteil ist, dass neue erstellte Dateien ggf auch nicht getestet werden. //Falls das Filtern nicht erwünscht ist, das gesamte Modul auskommentieren!//
21
22
23
24 == Sichtbarkeit ==
25
26 Die Sichtbarkeit der Chekstyle Warnings und Errors muss in der Bewertungsansicht konfiguriert werden. Ggf kann es sein, dass das Ruleset zwar korrekt definiert ist, aber die Ergebnisse nicht angezeigt werden.
27
28 Anders gesagt: **Checkstyle kann korrekt konfiguriert sein und der Studerende erhält dennoch kein Rückmeldung.**
29
30 Um den Studierenden das Feedback zu übermitteln muss min.Feedback angegeben sein. Je nach Wunsch kann hier auch eine Bewertung stattfinden.
31
32 [[image:Artemis_Checksyle_Feedback.png]]
33
34
35
36
37
38 == Entfernen von Spotbugs und PMD oder Checkstyle ==
39
40 Beim Erstellen von Aufgaben mit statischer Code Analyse erstellt Artemis ein Projekt mit [[Checkstyle>>https://maven.apache.org/plugins/maven-checkstyle-plugin/]], [[Apache PMD>>https://maven.apache.org/plugins/maven-pmd-plugin/]] und [[Spotbugs>>https://spotbugs.github.io/spotbugs-maven-plugin/]]. Wenn eines der Tools nicht benötigt wird, muss die Dependency im Projekt gelöscht werden **und** das Build Script angepasst werden.
41
42
43 Unter Build-Plane bearbeiten finden sich die mvn commands, um die genannten Tools auszuführen.
44
45 [[image:1751960876121-491.png||data-xwiki-image-style-border="true"]]
46
47
48 Die Methode staticCodeAnalysis alle Commands. Beim Entfernen von z.B. PMD muss nicht nur der Command //pmd:pmd pmd:cpd// entfernt werden, sondern auch die copy Commands für die Reports.
49
50 [[image:1751961576022-284.png||data-xwiki-image-style-border="true"]]
51
52
53 === Mögliche Seiteneffekte ===
54
55 Wenn eines der Plugins in dem Test Projekt entfernt wurde (pom.xml und Konfigurationsdatei), aber jedoch nicht das Build Skript angepasst wurde, kann es passieren, dass die verbliebenen Plugins keine Reports erstellen. Dementsprechend kann es sein, dass Checkstyle korrekt konfiguriert wurde, aber keine Ergebnisse mitgeteilt werden. Dies ist in der Oberfläche nicht ersichtlich!  Bei Problemen mit den genannten Plugins lohnt es sich den Build Log anzusehen. Die Weiterleitung zu unserem Build Agent lässt sich in der Übersicht mit den Einstellungen zur Aufgabe finden. Beim Click auf
56
57 [[image:1751964547791-705.png||data-xwiki-image-style-border="true"]]
58
59
60
61