Succest über die Web API steuern

Aus succestWiki
Wechseln zu: Navigation, Suche

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 REST-basierte 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.

(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 im Namen 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 'test InArguments'"
}

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 RunId. Diese wird zum Abfragen des Status benötigt.

Die Antwort enthält zwei Listen: ExpectedArguments und UnusedParameters. Erstere enthält die Namen aller nicht gesetzter InArgumente. Letztere enthält die Namen aller übergebener Parameter, die keinem InArgument zugewiesen werden können.

Anfrage (erfolgreich)

{
    "testcaseId":"02de5e62-3f0c-46d9-8ca1-a2586073b779",
    "inArguments":[
        {
            "Key":"einDecimal",
            "Value":"123.4"
        },
        {
            "Key":"einChar",
            "Value":"C"
        },
        {
            "Key":"GibtsNicht",
            "Value":"Hallo Welt!"
        }
    ]
}

Antwort (erfolgreich)

{
    "RunId":"db32fc47-7648-4209-bb75-b5ef98c1061a",
    "ExpectedArguments":[
        "einBool",
        "einString",
        "einDateTime",
        "eineGuid",
        "einInt32",
        "einInt16",
        "einInt64",
        "einDouble"
    ],
    "UnusedParameters":[
        "GibtsNicht",
    ],
    "Messages":"Testcase 'test InArguments' has been queued for execution on position 1. "
}

Anfrage (ungültige testcaseID)

{
    "testcaseId":"Hallo Welt"
}

Antwort (ungültige testcaseID)

{
    "RunId":"00000000-0000-0000-0000-000000000000",
    "ExpectedArguments":[
    ],
    "UnusedParameters":[
    ],
    "Messages":"Exception: GUID muss 32 Ziffern mit 4 Bindestrichen enthalten (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)."
}

Anfrage (Testfall nicht gefunden)

{
    "testcaseId":"00000000-1111-2222-3333-444444444444"
}

Antwort (Testfall nicht gefunden)

{
    "RunId":"00000000-0000-0000-0000-000000000000",
    "ExpectedArguments":[
    ],
    "UnusedParameters":[
    ],
    "Messages":"Exception: No testcase found with id 00000000-1111-2222-3333-444444444444"
}

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 RunId wurde beim Start des Testlaufs zurückgegeben. Ein Testlauf ist erst beendet, wenn der Status auf "Finished" steht Wenn der Testfall OutArgumente hat, dann werden diese hier mit ausgegeben.

Antwort

{
    "IdsReturnedFromTestrun":{
        "einInt64MalZwei":[
            "128"
        ],
        "einStringDoppelt":[
            "Hallo Welt! Hallo Welt! "
        ],
        "einDecimalMalZwei":[
            "24,68"
        ],
        "einInt32MalZwei":[
            "64"
        ],
        "eineListe":[
            "False",
            "Hallo Welt! Hallo Welt! ",
            "23.04.2011 20:25:43",
            "f20acd10-0e50-43a7-ada9-000000000000",
            "64",
            "256",
            "128",
            "24,68",
            "2469,1356",
            "XX"
        ],
        "einBoolInvertiert":[
            "False"
        ],
        "einDoubleMalZwei":[
            "2469,1356"
        ],
        "eineGuidNullenAmEnde":[
            "f20acd10-0e50-43a7-ada9-000000000000"
        ],
        "einDateTimeMinusEinJahr":[
            "23.04.2011 20:25:43"
        ],
        "einCharDoppelt":[
            "XX"
        ],
        "einInt16Doppelt":[
            "256"
        ]
    },
    "Status":"Finished",
    "Messages":"Got 20 ids in 11 OutArguments from run"
}

Antwort (Nicht alle Testfallschritte erfolgreich)

{  
    "IdsReturnedFromTestrun": {},
    "Status": "Finished",
    "RunErrorMessages": [
        "Mindestens ein Testschritt war fehlerhaft\r\n----------------------------------------------\r\n| Customer\r 
        \n----------------------------------------------\r\n<contentAsXml>\r\n      <root>\r\n            <Errors>\r\n          
        <Code>DuplicateEntity</Code>\r\n          <Key>EMail</Key>\r\n          <Value>There already is an account 
        with the id 'susi.sorglos@succest.de'.</Value>\r\n        </Errors>\r\n      </root>\r\n    </contentAsXml>\r
        \n<statusCode>422</statusCode>"
    ],
    "Messages": "Not all test steps finished succesfully, please check the history in the TCR"
}

Antwort (ungültige runId)

{
    "IdsReturnedFromTestrun":[
    ],
    "Status":null,
    "Messages":"Exception: GUID muss 32 Ziffern mit 4 Bindestrichen enthalten (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)."
}

Antwort (Testlauf nicht gefunden)

{
    "IdsReturnedFromTestrun":[
    ],
    "Status":null,
    "Messages":"Exception: No test run found for id 00000000-1111-2222-3333-444444444444"
}