Ejecutar prueba publicada por ID

Descripción

El punto final Ejecutar prueba publicada por ID ejecuta una sola prueba especificada dentro del ámbito de un enganche de API.

Solicitud HTTP

POST <API-Hook- URL > /tests/ {Test-ID} /run

Ejemplo de invocación de método

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,
          }
        }
      ' \
    <API-Hook-URL>/tests/{Test-ID}/run

Parámetros de encabezado

Clave API Secreto API

Tipo MIME: application/json


{
    options: {
        allAssertions: boolean,
        JUnitFormat: boolean
    },
    variables: {
        string: string,
    }
  }

Parámetros del cuerpo

  • options (Sólo es necesario si se proporciona un elemento hijo)
    • Un objeto derivador para las opciones que contienen sobre cómo deben devolverse los datos en la respuesta, o cómo debe formatearse la respuesta.
    • Elementos hijo:
      • allAssertions (opcional)
        • Cuando false, sólo se devuelven los resultados de las aserciones anómalas en la prueba. Cuando true, se devuelven todas las aserciones de la prueba. allAssertions es false de forma predeterminada.
      • JUnitFormat (opcional)
        • Cuando false, se devuelve el formato application/json para los resultados de la prueba. Cuando true, se utiliza el formato JUnit de text/xml para los resultados de la prueba (consulte la respuesta text/xml ). JUnitFormat es false de forma predeterminada.
  • variables (opcional)
    • La sección de variables se utiliza para pasar una lista de variables con nombre y sus valores en las pruebas que se están ejecutando. Sólo lo utilizan las pruebas que se han escrito para hacer uso de las variables y que tienen valores almacenados junto a ellas. Si se declara el nombre de la variable como clave de objeto y su nuevo valor como valor de la clave (como serie de tipo), se sobrescribirá el valor actual de la variable en la prueba que comparte su nombre con la clave de objeto.

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]
      }
    }
  ]

Descripción de respuesta

  • testRunID
    • ID de la ejecución de prueba.
  • testId
    • ID de la prueba que se ha ejecutado.
  • testName
    • Nombre de la prueba.
  • location
    • Ubicación del agente que ha excusado la prueba.
  • initiated
    • Fecha y hora en que se inició la prueba.
  • duration
    • Duración total de la ejecución de prueba en segundos.
  • status
    • Resultado global de la prueba.
  • reportUrl
    • URL al informe de ejecución de la prueba.
  • results
    • Un objeto derivador que contiene los resultados de la ejecución de prueba.
    • Elementos hijo:
      • warningsCount
        • Recuento de las advertencias HTTP devueltas por las aserciones de prueba.
      • failureCount
        • Recuento de las respuestas de código de estado HTTP que son superiores a 400.
      • httpFailures
        • Descripción de los fallos cuyo código de respuesta HTTP Status es mayor o igual a 400.
      • criticalFailures
        • Descripción de los fallos cuyo código de respuesta HTTP Status es mayor o igual a 500.
      • assertions
        • Una descripción de las aserciones ejecutadas en la prueba. De forma predeterminada, sólo se listarán las aserciones anómalas.

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>

Descripción de respuesta

  • <testSuite>
    • Elementos hijo: <testCase>
    • Atributos:
      • name
        • Nombre de suite de pruebas.
      • tests
        • Número de pruebas publicadas ejecutadas.
      • disabled
        • Número de pruebas inhabilitadas.
      • errors
        • Número de errores.
      • failures
        • Número de pruebas dentro de la suite de pruebas que han fallado.
      • timestamp
        • Fecha y hora en que se ejecutaron las pruebas.
      • time
        • Duración total de todas las ejecuciones de prueba en segundos.
  • <testCase>
    • Elementos hijo: <failure>
    • Atributos:
      • name
        • Nombre de prueba.
      • classname
        • ID de la prueba que se ha ejecutado.
      • time
        • Duración total de la ejecución de prueba en segundos.
  • <failure>
    • Atributos:
      • message
        • Mensaje de error que contiene la respuesta esperada y real.
      • type
        • Tipo de anomalía.