Automatische Ausführung von CodeNARC, Groovydoc und JUnit

Installation

Installationsaufwand (PT)	0,125
Updateaufwand (PT)	0

Voraussetzungen für die Verwendung der Funktionalität

Die Tools Ant, CodeNARC und Groovy müssen im Verzeichnis "tools\QS" vorliegen. Die Datei build.xml ist anzupassen:
- build.user: Kürzel des technischen Benutzers in EVI, der für die Erzeugung der Daten verwendet werden soll
- build.user.pwd: Kennwort des oben angegebenen technischen Benutzers
- evi.crm.name: Sprechender Name des EVI-Systems
- evi.crm.url: Server-URL und Port des zu verwendenden Systems
Durch Kopieren und Anpassen des Blocks zwischen <!-- 3C-EVI System → ist das Abfragen mehrerer Systeme über eine Konfiguration möglich. Das Tool muss daher nicht auf allen Systemen eingerichtet werden. Es wird eine Mail mit den Ergebnissen aller konfigurierten Systeme versandt.
Die Prozesse "C12Reporting_CodeQualityResults" und "C12Reporting_TestResults" müssen veröffentlicht sein und per Timer täglich einmal gestartet werden.
Die globalen Variablen müssen konfiguriert sein

Update

Die globalen Variablen sind zu überprüfen.

Technische Dokumentation

Komponentenübersicht

Prozesse

C12Reporting_CodeQualityResults
C12Reporting_TestResults

Beim Einspielen des Moduls werden die Prozesse automatisch veröffentlicht, dennoch ist eine Prüfung des Veröffentlichungsstatus empfehlenswert. Entsprechende Hinweise werden auch beim Import des Moduls ausgegeben.

Skriptbibliothek

SC12QSUtils

Globale Variablen

C12QSMailRecipients
C12QSMailConfig
C12QSMailSender

Administrationsmöglichkeiten

Administration über globale Variablen

Globale Variable	Beschreibung
C12QSMailRecipients	Semikolon-getrennte Liste der Mailempfänger
C12QSMailConfig	ID der Mailkonfiguration, die verwendet werden soll.
C12QSMailSender	Mailadresse des Senders der Mail mit den Ergebnissen

Übersteuerungsmöglichkeiten

Grundsätzlich können die mit dem Modul bereitgestellten Komponenten wie BPM-Prozesse, -teilprozesse, Suchen und Skriptbibliotheksmethoden übersteuert werden, um diese an individuelle Anforderungen und Bedürfnisse anzupassen.
Nach dem Einspielen eines Moduls sollte geprüft werden, ob bereits Methoden im Projekt übersteuert wurden und ob die Methodenänderung aus dem Standard im Projekt übernommen werden sollte.

Skriptklasse	Methodenname	Funktionalität
SC12QSUtils	getQSPath	Diese Methode liefert den Pfad zum QS-Ordner mit den ant-Files. Sollte der Ordner verschoben worden sein, ist hier der neue Pfad zu hinterlegen
	runAntCommand	Führt das ant-Skript aus
	sendMailWithResults	Versendet die gesammelten Informationen als ZIP per Email an die Empfänger aus der globalen Variable C12QSMailRecipients

Interner Ablauf

Skriptklasse	Methodenname	Funktionalität
SC12QSUtils	runAntCommand	Startet das ant.Skript zur Erzeugung der QS-Informationen.
	sendMailWithResults	Versendet die gesammelten Informationen als ZIP per Email an die Empfänger aus der globalen Variable C12QSMailRecipients

Technische Ablaufbeschreibung

Um versteckte Konflikte im System frühzeitig erkennen zu können werden die Tools CodeNARC, Groovydoc und JUnit regelmäßig im Hintergrund ausgeführt.
Die Ergebnisse der Analysen werden anschließend an einen definierten Verteiler versandt. Dies ist vor allem für Systemadministratoren essenziell.

Zur Ausführung der Funktionalität werden folge Tools benötigt:
1. ANT
2. CodeNarc
3. Groovy
  Diese werden im Verzeichnis tools\QS geliefert.
Ein Timer-Prozess "C12Reporting_CodeQualityResults" führt die entsprechenden Aufrufe der Skriptbibliotheksklasse "SC12QSUtils" aus
Der Timer-Prozess "C12Reporting_CodeQualityResults" versendet das Ergebnis an die Empfänger, die in der globalen Variable "C12QSMailRecipients" definiert sind.
Die zu verwendende Mailkonfiguration wird über die globale Variable "C12QSMailConfig" ausgewählt.
Der Absender Mail wird in der globalen Variable "C12QSMailSender" festgelegt.
Ein zweiter Timer-Prozess "C12Reporting_TestResults" versendet die Ergebnisse der automatischen Testläufe per Mail über die gleiche Konfiguration wie oben beschrieben.