Eseguire i test pubblicati per tag
Descrizione
L'endpoint Run Published Test By Tag esegue tutti i test pubblicati nell'ambito di un API Hook che corrispondono ai tag specificati nel corpo della richiesta. Per ulteriori informazioni su come taggare un test, vedere Tagging a Test.
Richiesta HTTP
POST <API-Hook- URL >/test/run/tag
Invocazione di un metodo di esempio
curl -X POST \
-H X-API-Key:{API-Key} \
-H X-API-Secret:{API-Secret} \
-H Content-Type:application/json \
-d '
{
"options": {
"allAssertions": boolean,
"JUnitFormat": boolean
},
"variables": {
string: string,
},
"tags": {
"tagList": array[string],
"operator": enum['not' or 'and' or 'or']
}
}
' \
<API-Hook-URL>/tests/run/tag
Parametri dell'intestazione
Tipo MIME: application/json
{
options: {
allAssertions: boolean,
JUnitFormat: boolean
},
variables: {
string: string,
},
tags: {
tagList: array[string],
operator: enum['not' or 'and' or 'or']
}
}
Parametri del corpo
options(Richiesto solo se si fornisce un elemento figlio)- Un oggetto wrapper per le opzioni contenenti i dati da restituire nella risposta o la formattazione della risposta.
- Elementi per bambini:
allAssertions(facoltativo)- Quando
false, vengono restituiti solo i risultati delle asserzioni fallite nel test. Quandotrue, vengono restituite tutte le asserzioni del test.allAssertionsèfalseper impostazione predefinita.
- Quando
JUnitFormat(facoltativo)- Quando
false, viene restituito il formatoapplication/jsonper i risultati del test. Quandotrue,text/xmlviene utilizzato il formato JUnit per i risultati dei test (vedere la rispostatext/xml).JUnitFormatèfalseper impostazione predefinita.
- Quando
variables(facoltativo)- La sezione delle variabili è usata per passare un elenco di variabili nominate e i loro valori nei test in corso. Viene utilizzato solo dai test che sono stati scritti per fare uso di variabili e che hanno valori memorizzati accanto ad esse. Dichiarando il nome della variabile come chiave dell'oggetto e il suo nuovo valore come valore della chiave (come tipo stringa), si sovrascriverà il valore corrente della variabile nel test che condivide il nome con la chiave dell'oggetto.
tags(Obbligatorio)- Un oggetto wrapper contenente sia l'elenco dei tag che l'operatore da utilizzare su di essi.
- Elementi per bambini:
tagList(Obbligatorio)- L'elenco dei tag che corrispondono ai test che si desidera eseguire o ignorare (vedere l'elemento
operator).
- L'elenco dei tag che corrispondono ai test che si desidera eseguire o ignorare (vedere l'elemento
operator(Obbligatorio)- L'operatore indica come trattare l'elenco dei tag e può essere uno dei tre valori seguenti:
not,and,or.- L'operatore
notometterà l'esecuzione di qualsiasi test nell'ambito dell'API Hook che sia stato etichettato con un tag elencato intagList. - L'operatore
andincluderà qualsiasi test nell'ambito dell'API Hook che sia stato etichettato con tutti i tag forniti intagList. - L'operatore
orincluderà qualsiasi test nell'ambito dell'API Hook che sia stato etichettato con almeno uno dei tag forniti intagList.
- L'operatore
- L'operatore indica come trattare l'elenco dei tag e può essere uno dei tre valori seguenti:
Tipo MIME: application/json
application/json
[
{
testRunId: string,
testId: string,
testName: string,
location: string,
initiated: string,
duration: integer,
status: enum['passed' or 'failed'],
reportUrl: string,
results: {
warningsCount: integer,
failureCount: integer,
httpFailures: array[object],
criticalFailures: array[object],
assertions: array[object]
}
}
]
Descrizione della risposta
testRunID- ID dell'esecuzione del test.
testId- ID del test eseguito.
testName- Nome del test.
location- Posizione dell'agente che ha eseguito il test.
initiated- Data e ora in cui è stato avviato il test.
duration- Durata totale dell'esecuzione del test in secondi.
status- Risultato complessivo del test.
reportUrl- URL al rapporto di esecuzione del test.
results- Un oggetto wrapper contenente i risultati dell'esecuzione del test.
- Elementi per bambini:
warningsCount- Conteggio degli avvisi HTTP restituiti dalle asserzioni di test.
failureCount- Conteggio delle risposte del codice di stato HTTP superiori a 400.
httpFailures- Descrizione dei guasti il cui codice di risposta HTTP Status è maggiore o uguale a 400.
criticalFailures- Descrizione dei guasti il cui codice di risposta HTTP Status è maggiore o uguale a 500.
assertions- Descrizione delle asserzioni eseguite nel test. Per impostazione predefinita, vengono elencate solo le asserzioni che falliscono.
Tipo MIME: text/xml
<?xml version="1.0" encoding="UTF-8"?>
<testSuite name="" tests="" disabled="" errors="" failures="" timestamp="" time="">
<testcase name="" classname="" time="">
<failure message="" type="" />
</testcase>
</testSuite>
Descrizione della risposta
<testSuite>- Elementi per bambini:
<testCase> - Attributi:
name- Nome della suite di test.
tests- Numero di test pubblicati.
disabled- Numero di test disabilitati.
errors- Numero di errori.
failures- Numero di test non riusciti all'interno della suite di test.
timestamp- Data e ora di esecuzione dei test.
time- Durata totale di tutti i test in secondi.
- Elementi per bambini:
<testCase>- Elementi per bambini:
<failure> - Attributi:
name- Nome del test.
classname- ID del test eseguito.
time- Durata totale dell'esecuzione del test in secondi.
- Elementi per bambini:
<failure>- Attributi:
message- Messaggio di errore contenente la risposta attesa e quella effettiva.
type- Tipo di guasto.
- Attributi: