Swetlana Stickhof. Universität Heidelberg

Transkript

1 Modellierung einer Testdokumentation mit Suchfunktionen in Semantic MediaWiki und Implementierung einer Jira-Anbindung als Semantic MediaWiki Extension Universität Heidelberg

2 Inhalt Motivation Modellierung einer Testdokumentation Semantic MediaWiki Verwendete Extensions: Semantic Forms, Header Tabs Suchfunktionen Extension für Jira-Anbindung Jira Verwendete Extensions: Parser Functions, Loops, Variables JIRAConnector mit Demo Weblinks 2

3 Motivation Motivation Motivation Tool für Testdokumentation bzw. Erstellung von Testberichten, die man auswerten kann. Semantic MediaWiki Vorgegebene Form um alle wichtigen Punkte zu erfassen Semantic Forms Übersichtlichkeit bei der Erfassung von Testberichten durch Registerkarten Übersicht von allen Testberichten zu einem Produkt, zu einem Release, zu einer Fixpack- Version, zum bestimmten Zeitinterval Ad-hoc Abfragen zu getesteten Objekten, Features usw. Header Tabs Inline Query Semantic Search Aktuelle Information über offene Bugs Jira-Anbindung 3

4 Inhalt Motivation Modellierung einer Testdokumentation Semantic MediaWiki Verwendete Extensions: Semantic Forms, Header Tabs Suchfunktionen Extension für Jira-Anbindung Jira Verwendete Extensions: Parser Functions, Loops, Variables JIRAConnector Weblinks 4

5 Modellierung einer Testdokumentation Semantic MediaWiki Semantische Annotation in Semantic MediaWiki Typisierte Attribute und deren Werte: Festlegung eines festen Wertebereichs durch Annotation, um die Datenkonsistenz zu erhöhen: Editor: [[Datentyp::Datum]] Editor: [[Datentyp::Seite]] Wiki: Wiki-Formular: 5

6 Modellierung einer Testdokumentation Semantic Forms Semantic Forms Benutzerfreundlichkeit: Komfortable Benutzungsoberfläche zum Anlegen von Formularen Erstelllung und Bearbeitung semantisch annotierter Wiki-Seiten (z.b. Testberichte) durch Ausfüllen von Formularen Viele Eingabetypen: Text, Radiobuttons, Dropdownleisten, Checkboxen, Felder für die Datumseingabe usw. Datenkonsistenz: Autovervollständigung Feldvalidierung mit Fehlermeldungen bei Eingabe von falschen Datentypen und dem Auslassen von Pflichtfeldern 6

7 Modellierung einer Testdokumentation Semantic Forms Anlegen von Formularen mit Semantic Forms Attribut 1 Attribut 2 Attribut 3 Attribut 4 Attribut 5 Attribut 6 Vorlage 1 Vorlage 2 Formular Seite 7

8 Modellierung einer Testdokumentation Semantic Forms Formular Testbericht Vorlagen Details Prüfung von Abnahme kriterien Allgemein er Funktions test Prüfung aller sicht baren Bereiche Prüfung der Über setzung Negativ test Integratio nstest Maximal test Fixpack-Version Projekt Neuer Jira Neuer Jira Neuer Jira Neuer Jira Neuer Jira Neuer Jira Neuer Jira Titel Release Status Status Status Status Status Status Status Jira-Nummer Testdatum Tester Änderungsdatum Attribute Testsystem Testobjekt Jira-Komponente Produkt 8

9 Modellierung einer Testdokumentation Semantic Forms Erstellen von Seiten mit Formularen - 9

10 Modellierung einer Testdokumentation Semantic Forms Anlegen von Formularen mit Semantic Forms Vorlage:Prüfung_von_Abnahmekriterien Formular: Mehrfaches Einbinden der Vorlage (hier: Vorlage:Prüfung_von_Abnahmekriterien) Pflichtfeld 10

11 Modellierung einer Testdokumentation Semantic Forms Ansicht der mit dem Formular erstellten Seite 11

12 Modellierung einer Testdokumentation Header Tabs Header Tabs Übersichtlichkeit Aufteilung einer Wikiseite oder eines Formulars in Registerkarten Reduzierung des vertikalen Bildlaufs Syntax: Überschriften der Kategorie 1 werden in Registerkarten umgewandelt, wenn am Ende des Wiki-Quelltextes das Tag <headertabs/> eingefügt wird 12

13 Modellierung einer Testdokumentation Suchfunktionen Suchfunktionen: Suche nach Attributen Einfaches Formular zur Anzeige semantischer Links, die zu einer bestimmten Seite führen. Ergebnis: alle Seiten, die ein entsprechendes Attribut haben 13

14 Modellierung einer Testdokumentation Factbox Kasten am unteren Ende von Wiki-Seiten Anzeige von semantischen Informationen zu einer Seite Links zum Finden weiterer Infos Aktivierung in LocalSettings.php mit Setzen des Wertes true für $smwgshowfactbox Einbindung von SHOWFACTBOX im Quelltext einer Seite Suchfunktionen: Factbox Suchfunktionen 14

15 Modellierung einer Testdokumentation Suchfunktionen Suchfunktionen: Semantisches Browsen Eingabe: Seite => Ausgabe: Semantische Infos der Seite und der anderen Seiten, die auf diese Seite verweisen. 15

16 Modellierung einer Testdokumentation Suchfunktionen Suchfunktionen: Semantische Suche Auswahlbedingugen Beliebiger Wert 16

17 Modellierung einer Testdokumentation Suchfunktionen Suchfunktionen: Inline Queries Anfrage, die in Wiki-Seiten eingebunden wird und das automatisch aktualisierte Ergebnis zeigt. Funktion Auswahlbedingung Zu selektierende Attribute Ausgabeformat 17

18 Modellierung einer Testdokumentation Suchfunktionen Suchfunktionen: Inline Queries 18

19 Inhalt Motivation Modellierung einer Testdokumentation Semantic MediaWiki Verwendete Extensions: Semantic Forms, Header Tabs Suchfunktionen Extension für Jira-Anbindung Jira Verwendete Extensions: Parser Functions, Loops, Variables JIRAConnector Weblinks 19

20 Extension für Jira-Anbindung Jira Jira proprietäre webbasierte Anwendung zur Bugverwaltung und zum Projektmanagement in der Softwareentwicklung Entwicklung durch Atlassian Programmiersprache Java plattformunabhängig kostenlos für nicht kommerzielle Projekte kostenlose Testversion für 30 Tage 20

21 Extension für Jira-Anbindung Parser Functions Parser Functions Erweitert den Parser des Wikis um weitere Funktionen Generelle Syntax für Funktionen: {{#functionname: argument 1 argument 2 argument 3... }} Einige wichtige Funktionen: {{ #ifexpr: math. expression value if true value if false }} {{ #switch: comparison string case = result1 case = result 2 default result }} 21

22 Extension für Jira-Anbindung Loops Loops Erweitert den Parser des Wikis um Loop-Funktionen: #while #dowhile #loop #forags #fornumargs Beispiel: {{ #while: Bedingung auszuführender Quelltext}} 22

23 Extension für Jira-Anbindung Variables Variables Nutzung von Variablen auf Wiki-Seiten Möglichkeit zum Zwischenspeichern von Ergebnissen von z.b. Parser Functions Syntax: Definition einer Variablen: {{#vardefine:variablename specifiedvalue}} Zugriff auf den Wert: {{#var:variablename}} 23

24 Extension für Jira-Anbindung JIRAConnector JIRAConnector MediaWiki JIRA Wikiseite {{#readjiraissue:jiraissuekey= DEMO-1}} 1 4 JIRAConnector Extension 2 HTTP GET Anfrage 2/search?jql=key=DEMO-1 HTTP Antwort im JSON- Format:... "key": DEMO-1", "fields": { status": Open,

25 Extension für Jira-Anbindung JIRAConnector Class JIRARestApiWrapper Class JIRAConnector JIRA MediaWiki 1.RegisterParserFunctions( parser) 2. new JIRARestApi Wrapper(...) 3.setFunctionHook ( 'readjiraissue', Wikiseite 'JIRAConnector:: ReadJIRAIssue' ) 4. ReadJIRAIssue 5. getissues( key=demo-1,...) 6. HTTP GET Anfrage 2/search?jql=key=DEMO-1 {{#readjiraissue: jiraissuekey= DEMO-1}} (jiraissuekey=demo-1) 9. key=demo-1, 8. key=demo-1, status=open 7. HTTP Antwort im JSON-Format:... status=open "key": DEMO-1", "fields": { status": Open,... 25

26 Extension für Jira-Anbindung JIRAConnector 26

27 Extension für Jira-Anbindung DEMO DEMO DEMO 27

28 Weblinks Weblinks Weblinks Link zur Extension JiraConnector: 28

29 29