modellierung einer testdokumentation mit …kontext.fraunhofer.de/haenelt/kurs/referate/smw_swetlana...

Modellierung einer Testdokumentation mit

Suchfunktionen in Semantic MediaWiki und

Implementierung einer Jira-Anbindung als

Semantic MediaWiki Extension

Swetlana Stickhof

Universität Heidelberg

03.02.2013

03.02.2014 1 Modellierung einer Testdokumentation mit Suchfunktionen in Semantic MediaWiki und Implementierung einer Jira-Anbindung

als Semantic MediaWiki Extension

Swetlana Stickhof

Modellierung einer Testdokumentation mit Suchfunktionen in Semantic MediaWiki und Implementierung einer Jira-Anbindung


Swetlana Stickhof

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



Swetlana Stickhof



Swetlana Stickhof

Motivation

Motivation



Swetlana Stickhof



Swetlana Stickhof

Motivation

Semantic MediaWiki

Jira-Anbindung

Inline Query

Semantic Forms

Semantic Search Ad-hoc Abfragen zu getesteten Objekten,

Features usw.

Aktuelle Information über offene Bugs

Übersicht von allen Testberichten zu einem

Produkt, zu einem Release, zu einer Fixpack-

Version, zum bestimmten Zeitinterval

Vorgegebene Form um alle wichtigen Punkte zu

erfassen

Tool für Testdokumentation bzw. Erstellung von

Testberichten, die man auswerten kann.

Übersichtlichkeit bei der Erfassung von

Testberichten durch Registerkarten Header Tabs

Inhalt

Motivation


Semantic MediaWiki


Suchfunktionen


Jira


JIRAConnector

Weblinks



Swetlana Stickhof



Swetlana Stickhof


Semantische Annotation in Semantic MediaWiki



Swetlana Stickhof

Semantic MediaWiki

Typisierte Attribute und deren Werte:

Editor:

Festlegung eines festen Wertebereichs

durch Annotation, um die Datenkonsistenz

zu erhöhen:

Editor:

[[Datentyp::Datum]]

[[Datentyp::Seite]]

Wiki: Wiki-Formular:


Semantic Forms



Swetlana Stickhof

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


Anlegen von Formularen mit Semantic Forms



Swetlana Stickhof

Semantic Forms

Attribut 1

Attribut 2

Attribut 3

Attribut 4

Attribut 5

Attribut 6

…

Vorlage 1

Vorlage 2

…

Formular

Seite




Swetlana Stickhof

Semantic Forms

Testbericht

Maximal

test

Neuer Jira

Status

Integrationstest

Neuer Jira

Status

Negativ

test

Neuer Jira

Status

Prüfung der Über

setzung

Neuer Jira

Status

Prüfung aller sicht

baren Bereiche

Neuer Jira

Status

Allgemeiner

Funktions

test

Neuer Jira

Status

Prüfung von

Abnahme

kriterien

Neuer Jira

Status

Details

Projekt Fixpack-Version

Release Titel

Tester Jira-Nummer

Änderungsdatum Testdatum

Testobjekt Testsystem

Produkt Jira-Komponente

Formular

Attribute

Vorlagen


Erstellen von Seiten mit Formularen



Swetlana Stickhof

Semantic Forms

-


Anlegen von Formularen mit Semantic Forms



Swetlana Stickhof

Semantic Forms

Formular:

Vorlage:Prüfung_von_Abnahmekriterien

Pflichtfeld

Mehrfaches Einbinden der Vorlage (hier:

Vorlage:Prüfung_von_Abnahmekriterien)


Ansicht der mit dem Formular erstellten Seite



Swetlana Stickhof

Semantic Forms


Header Tabs



Swetlana Stickhof

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


Suchfunktionen: Suche nach Attributen



Swetlana Stickhof

Suchfunktionen

Einfaches Formular zur

Anzeige semantischer

Links, die zu einer

bestimmten Seite führen.

Ergebnis: alle Seiten,

die ein entsprechendes

Attribut haben


Suchfunktionen: Factbox



Swetlana Stickhof

Suchfunktionen

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: Semantisches Browsen



Swetlana Stickhof

Suchfunktionen

Eingabe: Seite => Ausgabe: Semantische Infos der Seite und der anderen Seiten, die auf diese Seite verweisen.


Suchfunktionen: Semantische Suche



Swetlana Stickhof

Suchfunktionen

Beliebiger Wert

Auswahlbedingugen


Suchfunktionen: Inline Queries



Swetlana Stickhof

Suchfunktionen

Anfrage, die in Wiki-Seiten eingebunden wird und das automatisch aktualisierte

Ergebnis zeigt.

Funktion

Auswahlbedingung

Zu selektierende Attribute

Ausgabeformat


Suchfunktionen: Inline Queries



Swetlana Stickhof

Suchfunktionen

Inhalt

Motivation


Semantic MediaWiki


Suchfunktionen


Jira


JIRAConnector

Weblinks



Swetlana Stickhof



Swetlana Stickhof


Jira



Swetlana Stickhof

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


Parser Functions



Swetlana Stickhof

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 }}


Loops



Swetlana Stickhof

Loops

Erweitert den Parser des Wikis um Loop-Funktionen:

#while

#dowhile

#loop

#forags

#fornumargs

Beispiel:

{{ #while: | Bedingung| auszuführender Quelltext}}


Variables



Swetlana Stickhof

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}}


JIRAConnector



Swetlana Stickhof

JIRAConnector

MediaWiki MediaWiki

JIRAConnector Extension

JIRA JIRA

HTTP GET Anfrage

http://localhost:8080/rest/api/

2/search?jql=key=DEMO-1

HTTP Antwort im JSON-

Format:

...

"key": ”DEMO-1",

"fields": {”status": ”Open”,

...

Wikiseite

{{#readjiraissue:jiraissuekey=

DEMO-1}}

1

2

3

4




Swetlana Stickhof

JIRAConnector

MediaWiki MediaWiki

JIR

AC

onnecto

r C

lass

JIR

AR

estA

piW

rapper

Cla

ss

1.RegisterParserFunctions(

parser)

2. new JIRARestApi

Wrapper(...)

3.setFunctionHook (

'readjiraissue',

'JIRAConnector::

ReadJIRAIssue' )

4. ReadJIRAIssue

(jiraissuekey=DEMO-1)

5. getIssues(

key=DEMO-1,...)

8. key=DEMO-1,

status=Open 9. key=DEMO-1,

status=Open

JIR

A

JIR

A

HTTP GET Anfrage

http://localhost:8080/rest/api/

2/search?jql=key=DEMO-1

HTTP Antwort im

JSON-Format:

...

"key": ”DEMO-1",

"fields": {”status":

”Open”, ...

Wikiseite

{{#readjiraissue:

jiraissuekey=

DEMO-1}}

6.

7.




Swetlana Stickhof

JIRAConnector


DEMO



Swetlana Stickhof

DEMO

DEMO

Weblinks

Weblinks



Swetlana Stickhof

Weblinks

http://semantic-mediawiki.org/wiki/Help:Einf%C3%BChrung_in_Semantic_MediaWiki

https://www.mediawiki.org/wiki/Extension:Semantic_Forms

http://www.mediawiki.org/wiki/Extension:Header_Tabs

http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions

http://www.mediawiki.org/wiki/Extension:Loops

https://www.mediawiki.org/wiki/Extension:Variables

https://www.atlassian.com/de/software/jira

https://confluence.atlassian.com/display/JIRA/JIRA+Documentation

http://www.mediawiki.org/wiki/Manual:Developing_extensions/de

https://semantic-mediawiki.org/wiki/Help:Ergebnisformat_template

http://semantic-mediawiki.org/wiki/Help:Selecting_pages

http://semantic-mediawiki.org/wiki/Help:Browsing_interfaces

https://semantic-mediawiki.org/wiki/Help:Eingebettete_Abfrage

http://meta.wikimedia.org/wiki/Wiki_color_formatting_help

Link zur Extension JiraConnector: http://www.mediawiki.org/wiki/Extension:JIRAConnector
















































































































































http://www.mediawiki.org/wiki/Extension:JIRAConnector












Swetlana Stickhof

modellierung einer testdokumentation mit …kontext.fraunhofer.de/haenelt/kurs/referate/smw_swetlana...

Documents