README

Module

cardsplus-plugin

Modul mit dem Plugin.

selenium

Experimetelles Modul für einen End-to-End-Test für das Plugin mit Selenium.

Plugin bauen

Der Aufruf von

gradle clean

löscht alle build-Verzeichnisse.

Der Aufruf von

gradle build

baut und testet Artefakte. Das Plugin ist fertig, wenn folgende Ausgabe angezeigt wird:

[INFO] Project POM found
Executing: /opt/atlassian-plugin-sdk-8.2.6/apache-maven-3.5.4/bin/mvn clean -gs /opt/atlassian-plugin-sdk-8.2.6/apache-maven-3.5.4/conf/settings.xml
[INFO] Scanning for projects...
[INFO]
[INFO] --------------< de.cardsplus.confluence.plugin:cardsplus >--------------
[INFO] Building cards+ for confluence 2.1.1
[INFO] --------------------------[ atlassian-plugin ]--------------------------

u.v.m.

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 04:07 min
[INFO] Finished at: 2021-03-22T12:33:22Z
[INFO] ------------------------------------------------------------------------

Plugin mit dem Plugin-SDK testen

Der Aufruf von

docker run --rm -it -v ${PWD}/cardsplus-plugin:/plugin -v ${HOME}/.m2:/m2 registry.gitlab.emundo.eu/erd/cardsplus/plugin-sdk:8.2.6 shell

startet einen interaktiven Prozess mit dem Plugin-SDK zur Kommandoeingabe.

Der Aufruf von

atlas-run --server localhost

startet einen lokalen Server mit dem Plugin.

Der Aufruf von

atlas-debug --server localhost

startet einen lokalen Server mit dem Plugin im Debug-Modus für Remote-Debugging. Das Plugin kann mit Quick-Reload zur Laufzeit aktualisiert werden.

Der Server ist bereit, wenn folgende Ausgabe angezeigt wird:

[INFO] Project POM found
Executing: /opt/atlassian-plugin-sdk-8.2.6/apache-maven-3.5.4/bin/mvn com.atlassian.maven.plugins::8.0.0:run -gs /opt/atlassian-plugin-sdk-8.2.6/apache-maven-3.5.4/conf/settings.xml -Dserver='localhost'
[INFO] Scanning for projects...
[INFO]
[INFO] ----------< de.cardsplus.confluencexite.plugin:cardsplus >----------
[INFO] Building cards+ for Confluence 2.1.1
[INFO] --------------------------[ atlassian-plugin ]--------------------------

u.v.m.

[INFO] [talledLocalContainer] Mai 03, 2019 12:49:22 PM org.apache.coyote.AbstractProtocol start
[INFO] [talledLocalContainer] INFORMATION: Starting ProtocolHandler ["http-nio-1990"]
[INFO] [talledLocalContainer] Mai 03, 2019 12:49:23 PM org.apache.coyote.AbstractProtocol start
[INFO] [talledLocalContainer] INFORMATION: Starting ProtocolHandler ["ajp-nio-8009"]
[INFO] [talledLocalContainer] Mai 03, 2019 12:49:23 PM org.apache.catalina.startup.Catalina start
[INFO] [talledLocalContainer] INFORMATION: Server startup in 409932 ms
[INFO] [talledLocalContainer] Tomcat 9.x started on port [1990]
[INFO] confluence started successfully in 571s at http://localhost:1990/confluence
[INFO] Type Ctrl-C to shutdown gracefully

u.s.w.

Die Startseite von Confluence ist lokal unter der Adresse

http://localhost:1990/confluence

erreichbar.

Der Plugin-Manager ist unter der Adresse

http://localhost:1990/confluence/plugins/servlet/upm

erreichbar.

Plugin mit einem lokalen Server testen

Der Aufruf von

docker run --name="confluence" --rm -d -p 8090:8090 -p 8091:8091 registry.gitlab.emundo.eu/erd/cardsplus/confluence-server-builtin:7.4.7

startet einen vorkonfigurierten Confluence-Server mit einer eingebauten H2-Datenbank.

docker ps

muss in der Spalter STATUS anzeigen, dass der Prozess healty ist. Diesen Zustand sollte der Prozess nach maximal drei Minuten erreichen.

Die Startseite von Confluence ist lokal unter der Adresse

http://localhost:8090/

erreichbar.

Der Plugin-Manager ist unter der Adresse

http://localhost:8090/plugins/servlet/upm

erreichbar. Mit der Funktion App hochladen rechts oben in der Ansicht kann das lokal gebaute Plugin aus der Datei

target/cardsplus-2.1.1.jar

installiert werden.

Die Funktionsfähigkeit kann manuell mit folgenden Schritten getestet werden:

1. In der Startseite von Confluence die Funktion Bereich hinzufügen rechts oben in der Ansicht aufrufen.

2. Im Popup mit dem Titel Bereich erstellen die Option Dokumentationsbereich mit cards+ wählen.

3. Im Popup mit dem Titel Dokumentationsbereich erstellen einen Bereichsnamen und einen eindeutigen Bereichsschlüssel eingeben.

4. Mit Klick auf Erstellen wird der Bereich angelegt. Das dauert ein paar Sekunden.

5. Die Seite Glossar aufrufen und mit der globalen Vorlage Term einen neue Seite anlegen.

6. Die Seite Linksammlung aufrufen und mit der globalen Vorlage Link einen neue Seite anlegen.

7. Die Seite Medienbibliothek aufrufen und mit der globalen Vorlage File einen neue Seite anlegen.

8. Die Seite Entscheidungen aufrufen und mit der globalen Vorlage Decision einen neue Seite anlegen.

9. Die Seite Konzepte aufrufen und mit der globalen Vorlage Spec einen neue Seite anlegen.

10. Die Seite Module aufrufen und mit der globalen Vorlage Spec einen neue Seite anlegen.

11. Die Seite Systembeschreibung aufrufen und

    1. mit der globalen Vorlage Topic einen neue Seite anlegen.

    2. mit der globalen Vorlage Epic einen neue Seite anlegen.

    3. mit der globalen Vorlage Case einen neue Seite anlegen.

12. Die Seite Systemstruktur aufrufen und

    1. mit der globalen Vorlage Domain einen neue Seite anlegen.

    2. mit der globalen Vorlage Service einen neue Seite anlegen.

    3. mit der globalen Vorlage Entity einen neue Seite anlegen.

    4. mit der globalen Vorlage Event einen neue Seite anlegen.

    5. mit der globalen Vorlage Layout einen neue Seite anlegen.

Damit ist sichergestellt, dass die Seitenstruktur vollständig angelegt wurde und alle globalen Seitenvorlagen verfügbar sind.