Succest über die Web API steuern

Aus succestWiki
Version vom 18. Oktober 2021, 15:28 Uhr von WikiAdmin (Diskussion | Beiträge) (Link für Release geändert)
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 & OutArgumenten eines Testfalls anzeigen lassen
  • Testlauf für einen Testfall starten
  • Status bzw. Ergebnis eines Laufes ausgeben lassen
  • Komplettes Protokoll eines Testlaufes abfragen

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 (In)Argumenten eines Testfalls anzeigen lassen

Mit Release 2021.01 abgekündigt:
GET http://tcr.your-company.local/TestcaseExecutionApi/GetTestcaseInArguments?testcaseId=02de5e62-3f0c-46d9-8ca1-a2586073b779

Seit Release 2021.01:
GET http://tcr.your-company.local/TestcaseExecutionApi/GetTestcaseArguments?testcaseId=02de5e62-3f0c-46d9-8ca1-a2586073b779[&valueSuggestionsCount=50]

Manche Testfälle haben sogenannte InArgumente und OutArgumente. Deren Verwendung ist hier beschrieben. Damit man nicht extra im succest Testcase Editor (TCE) nachschauen muss, welche Argumente ein Testfall hat, gibt es diese beiden Schnittstellen. Sie gibt den Namen und Typen eines jeden InArguments zurück.

Über die neue Schnittstelle http://tcr.your-company.local/TestcaseExecutionApi/GetTestcaseArguments werden nicht mehr nur die InArgumente eines Testfalls ausgegeben, sondern auch die OutArgumente. OutArgumente sind die Werte, die ein Testfall nach erfolgreicher Ausführung nach außen geben kann.
Für die InArgumente, denen über die Seite Kiosk pflegen eine Datenquelle zugeordnet ist, gibt diese Schnittstelle sogar einige Wertvorschläge mit aus. Die Anzahl der Wertvorschläge lassen sich mit dem Filter valueSuggestionsCount=[Anzahl der Wertvorschläge] sogar festlegen. Der Standard gibt 50 Einträge zurück, sofern die zugewiesene Datenquelle auch 50 Einträge beinhaltet.


Antwort

{
    "InArguments":[
        {
            "ValueSuggestions": [
                {
                    "Value": "True",
                    "Description": "001 (Wert: True)"
                },
                {
                    "Value": "False",
                    "Description": "002 (Wert: False)"
                }
            ],
            "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"
        },
        {
            "ValueSuggestions": [
                {
                    "Value": "String-1",
                    "Description": "001 (Wert: String-1)"
                },
                {
                    "Value": "String-2",
                    "Description": "002 (Wert: String-2)"
                },
                {
                    "Value": "String-2",
                    "Description": "003 (Wert: String-3)"
                }
            ],
            "Name":"einString",
            "Type":"String"
        }
    ],
    "OutArguments": [
        {
            "Name": "Geschaeftspartnernummer",
            "Type": "SuccestReference"
        }
    ],
    "Messages":"Found 10 InArgument(s) for testcase 'test InArguments'.\r\nFound 1 OutArgument(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"
}

Komplettes Protokoll eines Testlaufs abfragen

GET http://tcr.your-company.local/TestcaseExecutionApi/GetTestRunFileLog?runId=70272b12-9c6e-42eb-b2ce-944284db69d0

Über diese Schnittstelle kann das komplette Protokoll eines Testlaufs abgefragt werden. Das Protokoll wird als Dateistream zum Download bereitgestellt.

Antwort

========================================================================================================================
Testschritt: XMLTest
Erwartetes Ergebnis: Erfolg erwartet
Status: Passed
Letzter Schritt: False
========================================================================================================================

------------------------------------------------------------------------------------------------------------------------
Testcase execution step report including details on loading data and execution results
---------------------------------

Testrun id:          9b15c96e-0fa7-4e88-862d-5dfda5b805bd
Runtime:             2021-03-01 15:38:41 - 2021-03-01 15:38:45 (duration: 0 00:00:03)

Testcase name:       SUC2-T410-3 Mehrere XML-Schritte ohne XML-ID append
Testcase id:         da284285-35b6-4e6b-8c42-2ebe4843b1f6

Teststep name:       XMLTest
Teststep id:         56cbaca9-26ee-4a7f-a802-46505b8f0ea8
Target system:       stdfc://File

Calculation base:    SystemDate
Calculation value:   01.03.2021

Generation template: 0-Amarijke-SUC2-T419-1 root
Result template:     Erfolg erwartet

Testcase arguments:

------------------------------------------------------------------------------------------------------------------------

Loadingfile: D:\SUCCEST-TCR\LoadingFiles\9b15c96e0fa74e88862d5dfda5b805bd\c3RkZmM6Ly9GaWxl_SD20210301_XML_9b15c96e0fa74e88862d5dfda5b805bd_060_1538447127.xml.txt
<!--
00S00000000da28428535b64e6b8c422ebe4843b1f656cbaca926ee4a7fa80246505b8f0ea8-->
<!--
00S00000000da28428535b64e6b8c422ebe4843b1f6d6ef7572afef4a49b55c15554cec89d6-->
<CATALOG>
  <CD>
    <TITLE>Hide your heart</TITLE>
    <ARTIST>Bonnie Tyler</ARTIST>
    <COUNTRY>UK</COUNTRY>
    <COMPANY>CBS Records</COMPANY>
    <PRICE>9.90</PRICE>
    <YEAR>1988</YEAR>
  </CD>
  <CD>
    <TITLE>Greatest Hits</TITLE>
    <ARTIST>Dolly Parton</ARTIST>
    <COUNTRY>USA</COUNTRY>
    <COMPANY>RCA</COMPANY>
    <PRICE>9.90</PRICE>
    <YEAR>1982</YEAR>
  </CD>
  <CD>
    <TITLE>Empire Burlesque</TITLE>
    <ARTIST>Bob Dylan</ARTIST>
    <COUNTRY>USA</COUNTRY>
    <COMPANY>Columbia</COMPANY>
    <PRICE>10.90</PRICE>
    <YEAR>1985</YEAR>
  </CD>
</CATALOG>
---------------------------------
Logfile: D:\SUCCEST-TCR\Logs\9b15c96e0fa74e88862d5dfda5b805bd\56cbaca926ee4a7fa80246505b8f0ea8.log
;S;Entry was successfully delivered to file consumer.
LoadingFileName: XMLFile_FILEID_1_9b15c96e0fa74e88862d5dfda5b805bd.xml
----------------------------------------------
Response has to contain substring ";S;".
Response may not contain substring ";E;".
----------------------------------------------
...