VIVIT TQA Treffen in Köln am API- Programmierung und Nutzung bei HP Quality Center / ALM. Michael Oestereich IT Consultant QA

Transkript

1 VIVIT TQA Treffen in Köln am API- Programmierung und Nutzung bei HP Quality Center / ALM Michael Oestereich IT Consultant QA

2 Agenda Vorstellung der API- Versionen OTA- API SA- API REST- API Voraussetzungen Art der ImplementaQon internes Workflowscript im ALM- Customizing externes Script als VB- Script externes Script innerhalb eines Excel- / Word- Makros externe Anwendung als EXE- Datei, Windows- Dienst etc. DokumentaQon / Ressourcen Bekannte Probleme, Fallstricke sowie Tipps und Tricks

3 OTA API Begriffe: OTA... Open Test Architecture FunkQonsumfang: Zugriff auf alle Objekte / Klassen eines HP- ALM- Projektes Lesen/Schreiben beliebiger InformaQonen aus/in ALM wie: Anforderungen, Tests, TestSets, Defects... incl. deren Steps, Parameter, Abachments etc. Testausführungen Projekt- Customizing wie BerechQgungen, Gruppen, DB- Felder, Projektlisten etc. Plaeorm: beschränkt auf Windows- Systeme (COM Library)

4 SA API Begriffe: SA... Site AdministraQon FunkQonsumfang: Zugriff auf Objekte der zentralen ALM- Site- AdministraQon Domains, Projekte... Plaeorm: anlegen, löschen, imporqeren, exporqeren, migrieren etc. Benutzer... anlegen, löschen, akqvieren, deakqvieren, Projekten zuordnen, Benutzereigenschajen bearbeiten etc. Verwaltung der DB- Server Verlinkung von Templates und Projekten (bei ALM- Premier- EdiQon) etc. beschränkt auf Windows- Systeme (COM Library)

5 REST API Begriffe: REST... RepresentaQonal State Transfer FunkQonsumfang: Zugriff auf Objekte / Klassen eines HP- ALM- Projektes per URL (mit Einschränkungen da noch nicht vollständig implemenqert) Lesen/Schreiben beliebiger InformaQonen aus/in ALM wie: Plaeorm: Anforderungen, Tests, TestSets, Defects... incl. deren Steps, Parameter, Abachments etc. Testausführungen Projekt- Customizing wie BerechQgungen, Gruppen, DB- Felder, Projektlisten etc. Plaeormunabhängig da Zugriff allein durch REST- spezifische FunkQonen wie GET, PUT, DELETE,... per HTTP erfolgt.

6 Voraussetzungen OTA/SA API - Allgemein Erfolgreicher Download und RegistraQon der COM Libraries OTAClient.dll bzw. SAClient.dll beispielsweise durch InstallaQon der ConnecQvity- Komponenten ACHTUNG: Es müssen immer die aktuellen COM Libraries (passend zu Serverversion und Patch- Stand) installiert sein. Nach Einspielen eines neuen Patches auf dem ALM- Server muss die Registrierung erneut erfolgen!

7 Voraussetzungen OTA/SA API - Eigene Scripte / Makros / ApplikaQonen Die Entwicklungsumgebung muss COM Libraries unterstützen. In der Entwicklungsumgebung muss ein Verweis auf COM Library erzeugt werden. Bei VBS kann der Verweis auf ein COM Object über die FunkQon CreateObject erzeugt werden: OTA: CreateObject("TDApiOle80.TDConnecQon") SA: CreateObject("SAClient.SaApi.9")

8 Internes Workflowscript im ALM- Customizing Programmiersprache: VBS (Visual Basic Script) Entwicklungsumgebung: In ALM Integriert (Tools à Customizing à Workflow à Script Editor) Aufruf: AutomaQsch aus einem ALM- Ereignishandler bei Eintrib des jeweiligen Ereignisses AuthenQfizierung an ALM: keine explizite AuthenQfizierung nöqg wird im Kontext des in ALM angemeldeten Benutzers ausgeführt BerechQgungen des in ALM angemeldeten Users werden übernommen

9 Externes Script als VB- Script Programmiersprache: VBS (Visual Basic Script) Entwicklungsumgebung: Beliebiger Editor (Notepad, Ultra- Edit, System- Scripter etc.) Aufruf: Start der.vbs - Datei (Kommandozeile, Desktop- Icon, Windows- Aufgabenmanager etc.)

10 Externes Script innerhalb eines Excel- / Word- Makros Programmiersprache: VBA (Visual Basic for ApplicaQons) Entwicklungsumgebung: Makro- Editor in Word bzw. Excel Aufruf: Start des Makros innerhalb Excel / Word mit den üblichen OpQonen

11 Externe Anwendung als EXE- Datei, Windows- Dienst etc. Programmiersprache: VB.Net (Visual Basic.Net) C / C# (Windows), ObjecQve- C (Mac / nur Rest API verfügbar)... Entwicklungsumgebung: MS Visual Studio (Windows) Xcode (Mac)... Aufruf: Start der ApplikaQon Start des Dienstes...

12 DokumentaQon / Ressourcen VBScript Language Reference URL: hbp://msdn.microsoj.com/en- us/library/d1wf56b.aspx

13 DokumentaQon / Ressourcen HP QTP / UFT Hilfe Verfügbar über Windows- Startmenü (nur wenn QTP / UFT installiert ist) Ähnliche FunkQonalität wie MSDN- DokumentaQon Rubrik VBScript Reference Hier werden beispielsweise auch die Unterschiede zwischen VBS und VBA beschrieben

14 DokumentaQon / Ressourcen DocumentaQon Library Verfügbar direkt in HP ALM oder SiteAdmin (Menü Help à DocumentaQon Library ) HINWEIS: Hilfedatei nicht direkt öffnen sondern lokal abspeichern und dann öffnen!

15 DokumentaQon / Ressourcen Weitere... Google ist dein bester Freund... Speziell zu VB/VBS/VBA gibt es sehr viele Einträge zu den unterschiedlichsten Themen... Knowledgebase / Foren: hbp://support.openview.hp.com/selfsolve/documents hbp:// hbp:// hbp://forum.proficom.de

16 Bekannte Probleme, Fallstricke sowie Tipps und Tricks Command - Objekt bei OTA- API Mibels Command - Objekt kann direkt auf die ALM- Datenbanken zugegriffen werden, wobei beliebig Datenbankabfragen per SQL- Statement abgesetzt und anschließend ausgewertet werden können. Der Zugriff kann aus Sicherheits- gründen per SiteAdmin- Parameter DISABLE_COMMAND_INTERFACE eingeschränkt werden. Mögliche Werte: Wenn der Parameter auf Y gesetzt ist (oder nicht exisqert), können nur Benutzer der Gruppe TDAdmin das Objekt verwenden. (Standardeinstellung) Wenn der Parameter auf N gesetzt ist, können alle Benutzer das Objekt verwenden. Wenn der Parameter auf ALL gesetzt ist, kann kein Benutzer das Objekt verwenden.

17 Bekannte Probleme, Fallstricke sowie Tipps und Tricks Ojmals laufen Scripte auf einem neuen 64- Bit- Betriebssystem (Windows 7) nicht mehr, die vorher klaglos funkqonierten. Die APIs gibt es bisher nur als 32- Bit- Versionen. Daher muss das Script durch den 32- Bit- ScripQng- Host ausgeführt werden. Standardmäßig wird vom System aber der 64- Bit- ScripQng- Host verwendet Hierfür zwei Lösungen: 64- Bit- Problem expliziter Aufruf für ein spezielles Script: C:\Windows\SysWOW64\wscript.exe Laufwerk\Pfad\Script.vbs standardmäßige Verwendung des 32- Bit- ScripQng- Host: Registry- Schlüssel HKEY_CLASSES_ROOT\VBSFile\Shell\Open\Command von %SystemRoot%\System32\WScript.exe" "%1" %* auf %SystemRoot%\SysWOW64\WScript.exe" "%1" %* umstellen. à Damit werden zukünjig alle Scripte als 32- Bit ausgeführt.

18 Bekannte Probleme, Fallstricke sowie Tipps und Tricks PageSize bei REST API Aus Performancegründen ist die Anzahl der standardmäßig oder maximal zurückgegebenen EnQtäten innerhalb einer CollecQon (bei Antwort auf eine Get - Anfrage) per SiteAdmin- Parameter beschränkt: REST_API_DEFAULT_PAGE_SIZE (Default: 100) Wenn innerhalb der GET- Anfrage keine andere PageSize definiert wurde wird maximal die angegebene Anzahl Einträge zurückgeliefert. REST_API_MAX_PAGE_SIZE (Default: 5000) Es wird maximal die angegebene Anzahl Einträge zurückgeliefert. Bei Überschreitung wird eine entsprechende Ausnahme ausgelöst. Hinweis: Die Gesamtzahl der Elemente auf dem Server wird immer im Element EnQQes zurückgeliefert. Die ApplikaQon selbst muss für die Abrufe der restlichen Seiten sorgen. (Query- Parameter start- index )