Succest über die Web API steuern: Unterschied zwischen den Versionen
(Die Seite wurde neu angelegt: „Das {{TCR}} ist großartig, um Ihre Daten zu verwalten, Testfälle auszuführen und einzuplanen und vieles mehr. Für au…“) |
K |
||
| Zeile 15: | Zeile 15: | ||
=== Antwort === | === Antwort === | ||
| − | <syntaxhighlight lang=" | + | <syntaxhighlight lang="json"> |
{ | { | ||
"Testcases":[ | "Testcases":[ | ||
| Zeile 39: | Zeile 39: | ||
=== Antwort === | === Antwort === | ||
| − | <syntaxhighlight lang=" | + | <syntaxhighlight lang="json"> |
{ | { | ||
"InArguments":[ | "InArguments":[ | ||
| Zeile 93: | Zeile 93: | ||
=== Anfrage === | === Anfrage === | ||
| − | <syntaxhighlight lang=" | + | <syntaxhighlight lang="json"> |
{ | { | ||
"testcaseId":"02de5e62-3f0c-46d9-8ca1-a2586073b779", | "testcaseId":"02de5e62-3f0c-46d9-8ca1-a2586073b779", | ||
| Zeile 110: | Zeile 110: | ||
=== Antwort === | === Antwort === | ||
| − | <syntaxhighlight lang=" | + | <syntaxhighlight lang="json"> |
{ | { | ||
"RunId":"70272b12-9c6e-42eb-b2ce-944284db69d0", | "RunId":"70272b12-9c6e-42eb-b2ce-944284db69d0", | ||
| Zeile 123: | Zeile 123: | ||
=== Antwort === | === Antwort === | ||
| − | <syntaxhighlight lang=" | + | <syntaxhighlight lang="json"> |
{ | { | ||
"IdsReturnedFromTestrun":[ | "IdsReturnedFromTestrun":[ | ||
Version vom 19. Juni 2018, 09:54 Uhr
Das succest Testcase Repository (TCR) ist großartig, um Ihre Daten zu verwalten, Testfälle auszuführen und einzuplanen und vieles mehr. Für automatisierte Aufgaben bietet es sich an, Aufgaben entweder über die Kommandozeile oder die Web API zu steuern.
Folgende Funktionen stehen über die Web API zur Verfügung:
- (Gefilterte) Liste von Testfällen ausgeben lassen
- Liste von InArgumenten eines Testfalls anzeigen lassen
- Testlauf für einen Testfall starten
- Status bzw. Ergebnis eines Laufes ausgeben lassen
Es wird nur JSON unterstützt, daher muss im Header der Anfrage immer content-type: application/json gesetzt sein.
Inhaltsverzeichnis
(Gefilterte) Liste von Testfällen ausgeben lassen
GET http://tcr.your-company.local/TestcaseExecutionApi/GetTestcases?filter=argu
Gibt eine Liste von allen verfügbaren Testfällen aus, inklusive ID, Name und dem aktuellen Status. Optional kann ein Filter eingegeben werden, der jeden Testfall rausfiltert, der nicht diesen Text enthält. Die Suche ignoriert Groß- und Kleinschreibung.
Antwort
{
"Testcases":[
{
"Id":"ed2f2e90-05b2-4155-a0c1-967cada94a7d",
"Name":"SSD-135 Argument TFURI bei Kiosk-Testfällen",
"Status":"Approved"
},
{
"Id":"02de5e62-3f0c-46d9-8ca1-a2586073b779",
"Name":"test InArguments",
"Status":"Approved"
}
],
"Messages":"Found 2 matching testcase(s)"
}
Liste von InArgumenten eines Testfalls anzeigen lassen
GET http://tcr.your-company.local/TestcaseExecutionApi/GetTestcaseInArguments?testcaseId=02de5e62-3f0c-46d9-8ca1-a2586073b779
Manche Testfälle haben sogenannte InArgumente. Deren Verwendung ist hier beschrieben. Damit man nicht extra im succest Testcase Editor (TCE) nachschauen muss, welche Argumente ein Testfall hat, gibt es diese Schnittstelle. Sie gibt den Namen und Typen eines jeden InArguments zurück.
Antwort
{
"InArguments":[
{
"Name":"einBool",
"Type":"Boolean"
},
{
"Name":"einChar",
"Type":"Char"
},
{
"Name":"einDateTime",
"Type":"DateTime"
},
{
"Name":"einDecimal",
"Type":"Decimal"
},
{
"Name":"einDouble",
"Type":"Double"
},
{
"Name":"eineGuid",
"Type":"Guid"
},
{
"Name":"einInt16",
"Type":"Int16"
},
{
"Name":"einInt32",
"Type":"Int32"
},
{
"Name":"einInt64",
"Type":"Int64"
},
{
"Name":"einString",
"Type":"String"
}
],
"Messages":"Found 10 InArgument(s) for testcase \u0027test InArguments\u0027"
}
Testlauf für einen Testfall starten
POST http://tcr.your-company.local/TestcaseExecutionApi/StartTestRun
Ein Testlauf kann hiermit gestartet werden. Wenn gewünscht, können Werte für die InArgumente mitgegeben werden. Als Antwort erhält man eine <ocde>RunId</syntaxhighlight>. Diese wird zum Abfragen des Status benötigt.
Anfrage
{
"testcaseId":"02de5e62-3f0c-46d9-8ca1-a2586073b779",
"inArguments":[
{
"Key":"einDecimal",
"Value":"123.4"
},
{
"Key":"einChar",
"Value":"C"
}
]
}
Antwort
{
"RunId":"70272b12-9c6e-42eb-b2ce-944284db69d0",
"Messages":"Testcase 'test InArguments' has been queued for execution on position 1"
}
Status bzw. Ergebnis eines Laufes ausgeben lassen
GET http://tcr.your-company.local/TestcaseExecutionApi/GetTestRunResult?runId=70272b12-9c6e-42eb-b2ce-944284db69d0
Der Status eines Testlaufs wird hier abgefragt. Die benötigte <ocde>RunId</syntaxhighlight> wurde beim Start des Testlaufs zurückgegeben. Ein Testlauf ist erst beendet, wenn der Status auf "Finished" steht Wenn der Testfall IDs zurückgegeben hat, dann werden diese hier mit ausgegeben.
Antwort
{
"IdsReturnedFromTestrun":[
],
"Status":"Finished",
"Messages":"Got 0 ids from run"
}