REST Resource: projects.histories.executions.steps

Recurso: Paso

Un paso representa una sola operación realizada como parte de la ejecución. Un paso se puede utilizar para representar la ejecución de una herramienta (por ejemplo, la ejecución de un corredor de prueba o la ejecución de un compilador).

Los pasos pueden superponerse (por ejemplo, dos pasos pueden tener la misma hora de inicio si algunas operaciones se realizan en paralelo).

Aquí hay un ejemplo, consideremos que tenemos una compilación continua que ejecuta un corredor de prueba para cada iteración. El flujo de trabajo se vería así: - el usuario crea una ejecución con id 1 - el usuario crea un TestExecutionStep con id 100 para la ejecución 1 - el usuario actualiza TestExecutionStep con id 100 para agregar un registro xml sin procesar + el servicio analiza los registros xml y devuelve un TestExecutionStep con Resultados de prueba actualizados. - el usuario actualiza el estado de TestExecutionStep con id 100 para COMPLETAR

Un paso se puede actualizar hasta que su estado se establece en COMPLETO, momento en el que se vuelve inmutable.

Representación JSON
{
  "stepId": string,
  "creationTime": {
    object (Timestamp)
  },
  "completionTime": {
    object (Timestamp)
  },
  "name": string,
  "description": string,
  "state": enum (State),
  "outcome": {
    object (Outcome)
  },
  "hasImages": boolean,
  "labels": {
    string: string,
    ...
  },
  "dimensionValue": {
    string: string,
    ...
  },
  "runDuration": {
    object (Duration)
  },
  "deviceUsageDuration": {
    object (Duration)
  },
  "multiStep": {
    object (MultiStep)
  },

  // Union field step can be only one of the following:
  "testExecutionStep": {
    object (TestExecutionStep)
  },
  "toolExecutionStep": {
    object (ToolExecutionStep)
  }
  // End of list of possible types for union field step.
}
Campos
stepId

string

Un identificador único dentro de una ejecución para este paso.

Devuelve INVALID_ARGUMENT si la persona que llama establece o sobrescribe este campo.

  • En respuesta: siempre establecido
  • En solicitud de creación/actualización: nunca establecer
creationTime

object ( Timestamp )

La hora en que se creó el paso.

  • En respuesta: siempre establecido
  • En solicitud de creación/actualización: nunca establecer
completionTime

object ( Timestamp )

La hora a la que el estado del paso se configuró para completar.

Este valor se establecerá automáticamente cuando el estado cambie a COMPLETO.

  • En respuesta: establezca si el estado de ejecución es COMPLETO.
  • En solicitud de creación/actualización: nunca establecer
name

string

Un nombre corto legible por humanos para mostrar en la interfaz de usuario. Máximo de 100 caracteres. Por ejemplo: compilación limpia

Se devolverá PRECONDITION_FAILED al crear un nuevo paso si comparte su nombre y dimensionValue con un paso existente. Si dos pasos representan una acción similar, pero tienen valores de dimensión diferentes, deben compartir el mismo nombre. Por ejemplo, si se ejecuta el mismo conjunto de pruebas en dos plataformas diferentes, los dos pasos deben tener el mismo nombre.

  • En respuesta: siempre establecido
  • En la solicitud de creación: establecer siempre
  • En la solicitud de actualización: nunca configurar
description

string

Una descripción de esta herramienta Por ejemplo: mvn clean package -D skipTests=true

  • En respuesta: presente si se establece mediante una solicitud de creación/actualización
  • En solicitud de creación/actualización: opcional
state

enum ( State )

El estado inicial es IN_PROGRESS. Las únicas transiciones de estado legales son * IN_PROGRESS -> COMPLETE

Se devolverá PRECONDITION_FAILED si se solicita una transición no válida.

Es válido crear un Paso con un estado establecido en COMPLETO. El estado solo se puede establecer en COMPLETO una vez. Se devolverá PRECONDITION_FAILED si el estado se establece en COMPLETE varias veces.

  • En respuesta: siempre establecido
  • En solicitud de creación/actualización: opcional
outcome

object ( Outcome )

Clasificación del resultado, por ejemplo en ÉXITO o FALLO

  • En respuesta: presente si se establece mediante una solicitud de creación/actualización
  • En solicitud de creación/actualización: opcional
hasImages

boolean

Si alguna de las salidas de este paso son imágenes cuyas miniaturas se pueden obtener con thumbnails.list.

  • En respuesta: siempre establecido
  • En solicitud de creación/actualización: nunca establecer
labels

map (key: string, value: string)

Pares arbitrarios de clave/valor proporcionados por el usuario que están asociados con el paso.

Los usuarios son responsables de administrar el espacio de nombres clave de manera que las claves no colisionen accidentalmente.

Se devolverá un INVALID_ARGUMENT si el número de etiquetas supera las 100 o si la longitud de cualquiera de las claves o valores supera los 100 caracteres.

  • En respuesta: siempre establecido
  • En crear solicitud: opcional
  • En solicitud de actualización: opcional; cualquier par clave/valor nuevo se agregará al mapa, y cualquier valor nuevo para una clave existente actualizará el valor de esa clave

Un objeto que contiene una lista de "key": value . Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

dimensionValue

map (key: string, value: string)

Si la ejecución que contiene este paso tiene definida una definición de dimensión, este campo permite que el elemento secundario especifique los valores de las dimensiones.

Las claves deben coincidir exactamente con la definición de dimensión de la ejecución.

Por ejemplo, si la ejecución tiene dimension_definition = ['attempt', 'device'] , entonces un paso debe definir valores para esas dimensiones, p. dimensionValue = ['attempt': '1', 'device': 'Nexus 6']

Si un paso no participa en una dimensión de la matriz, el valor de esa dimensión debe ser una cadena vacía. Por ejemplo, si una de las pruebas la ejecuta un corredor que no admite reintentos, el paso podría tener dimensionValue = ['attempt': '', 'device': 'Nexus 6']

Si el paso no participa en ninguna dimensión de la matriz, puede dejar dimensionValue sin establecer.

Se devolverá PRECONDITION_FAILED si alguna de las claves no existe en dimension_definition de la ejecución.

Se devolverá PRECONDITION_FAILED si otro paso en esta ejecución ya tiene el mismo nombre y dimensionValue, pero difiere en otros campos de datos, por ejemplo, el campo de paso es diferente.

Se devolverá PRECONDITION_FAILED si se establece dimensionValue y hay una dimension_definition en la ejecución que no está especificada como una de las claves.

  • En respuesta: presente si lo establece create
  • En crear solicitud: opcional
  • En la solicitud de actualización: nunca configurar

Un objeto que contiene una lista de "key": value . Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

runDuration

object ( Duration )

El tiempo que tardó en ejecutarse este paso.

Si no se establece, se establece en la diferencia entre la hora de creación y la hora de finalización cuando el paso se establece en el estado COMPLETO. En algunos casos, es apropiado establecer este valor por separado: por ejemplo, si se crea un paso, pero la operación que representa se pone en cola durante unos minutos antes de ejecutarse, sería apropiado no incluir el tiempo en cola en su runDuration.

Se devolverá PRECONDITION_FAILED si se intenta establecer una duración de ejecución en un paso que ya tiene este campo establecido.

  • En respuesta: presente si se estableció previamente; siempre presente en el paso COMPLETO
  • En crear solicitud: opcional
  • En solicitud de actualización: opcional
deviceUsageDuration

object ( Duration )

Cuánto se utiliza el recurso del dispositivo para realizar la prueba.

Este es el uso del dispositivo utilizado con fines de facturación, que es diferente de la duración de la ejecución; por ejemplo, no se cobrará por el uso del dispositivo si falla la infraestructura.

Se devolverá PRECONDITION_FAILED si se intenta establecer un uso de dispositivo en un paso que ya tiene este campo establecido.

  • En respuesta: presente si se estableció previamente.
  • En crear solicitud: opcional
  • En solicitud de actualización: opcional
multiStep

object ( MultiStep )

Detalles cuando se ejecutan varios pasos con la misma configuración que un grupo. Estos detalles se pueden utilizar para identificar de qué grupo forma parte este paso. También identifica el 'paso principal' de los grupos que indexa a todos los miembros del grupo.

  • En respuesta: presente si se estableció previamente.
  • En crear solicitud: opcional, configure si este paso se realizó más de una vez.
  • En solicitud de actualización: opcional

step de campo de unión.

step puede ser solo uno de los siguientes:

testExecutionStep

object ( TestExecutionStep )

Una ejecución de un corredor de prueba.

toolExecutionStep

object ( ToolExecutionStep )

Una ejecución de una herramienta (usada para pasos que no admitimos explícitamente).

TestExecutionStep

Un paso que representa ejecutar pruebas.

Acepta archivos xml ant-junit que el servicio analizará en resultados de prueba estructurados. Las rutas de los archivos xml se actualizan para agregar más archivos, sin embargo, no se pueden eliminar.

Los usuarios también pueden agregar resultados de pruebas manualmente usando el campo test_result.

Representación JSON
{
  "testSuiteOverviews": [
    {
      object (TestSuiteOverview)
    }
  ],
  "toolExecution": {
    object (ToolExecution)
  },
  "testIssues": [
    {
      object (TestIssue)
    }
  ],
  "testTiming": {
    object (TestTiming)
  }
}
Campos
testSuiteOverviews[]

object ( TestSuiteOverview )

Lista de contenidos de descripción general del conjunto de pruebas. Esto podría ser analizado desde el registro XML de xUnit por el servidor o cargado directamente por el usuario. Estas referencias solo deben llamarse cuando los conjuntos de pruebas se analizan o cargan por completo.

El número máximo permitido de resúmenes de conjuntos de pruebas por paso es 1000.

  • En respuesta: siempre establecido
  • En crear solicitud: opcional
  • En la solicitud de actualización: nunca (en su lugar, utilice el método personalizadopublishXunitXmlFiles)
toolExecution

object ( ToolExecution )

Representa la ejecución del corredor de prueba.

El código de salida de esta herramienta se utilizará para determinar si pasó la prueba.

  • En respuesta: siempre establecido
  • En solicitud de creación/actualización: opcional
testIssues[]

object ( TestIssue )

Problemas observados durante la ejecución de la prueba.

Por ejemplo, si la aplicación móvil que se está probando falla durante la prueba, el mensaje de error y el contenido del seguimiento de la pila se pueden registrar aquí para ayudar en la depuración.

  • En respuesta: presente si está establecido por crear o actualizar
  • En solicitud de creación/actualización: opcional
testTiming

object ( TestTiming )

El desglose de tiempo de la ejecución de la prueba.

  • En respuesta: presente si está establecido por crear o actualizar
  • En solicitud de creación/actualización: opcional

Ejecución de herramienta

Una ejecución de una herramienta arbitraria. Podría ser un ejecutor de pruebas o una herramienta que copia artefactos o implementa código.

Representación JSON
{
  "commandLineArguments": [
    string
  ],
  "toolLogs": [
    {
      object (FileReference)
    }
  ],
  "exitCode": {
    object (ToolExitCode)
  },
  "toolOutputs": [
    {
      object (ToolOutputReference)
    }
  ]
}
Campos
commandLineArguments[]

string

La línea de comando tokenizada completa, incluido el nombre del programa (equivalente a argv en un programa C).

  • En respuesta: presente si se establece mediante una solicitud de creación
  • En crear solicitud: opcional
  • En la solicitud de actualización: nunca configurar
toolLogs[]

object ( FileReference )

Las referencias a cualquier registro de texto sin formato generan la ejecución de la herramienta.

Este campo se puede configurar antes de que la herramienta haya salido para poder tener acceso a una vista en vivo de los registros mientras la herramienta se está ejecutando.

El número máximo permitido de registros de herramientas por paso es 1000.

  • En respuesta: presente si se establece mediante una solicitud de creación/actualización
  • En crear solicitud: opcional
  • En la solicitud de actualización: opcional, cualquier valor proporcionado se agregará a la lista existente
exitCode

object ( ToolExitCode )

Código de salida de ejecución de herramienta. Este campo se establecerá una vez que la herramienta haya salido.

  • En respuesta: presente si se establece mediante una solicitud de creación/actualización
  • En crear solicitud: opcional
  • En la solicitud de actualización: opcional, se devolverá un error FAILED_PRECONDITION si ya se ha establecido un código de salida.
toolOutputs[]

object ( ToolOutputReference )

Referencias a archivos opacos de cualquier formato generados por la ejecución de la herramienta.

El número máximo permitido de salidas de herramienta por paso es 1000.

  • En respuesta: presente si se establece mediante una solicitud de creación/actualización
  • En crear solicitud: opcional
  • En la solicitud de actualización: opcional, cualquier valor proporcionado se agregará a la lista existente

ToolExitCode

Código de salida de la ejecución de una herramienta.

Representación JSON
{
  "number": integer
}
Campos
number

integer

Código de salida de ejecución de herramienta. Un valor de 0 significa que la ejecución fue exitosa.

  • En respuesta: siempre establecido
  • En la solicitud de creación/actualización: establecer siempre

Problema de prueba

Un problema detectado durante la ejecución de una prueba.

Representación JSON
{
  "errorMessage": string,
  "stackTrace": {
    object (StackTrace)
  },
  "warning": {
    object (Any)
  },
  "severity": enum (Severity),
  "type": enum (Type),
  "category": enum (Category)
}
Campos
errorMessage

string

Un breve mensaje legible por humanos que describe el problema. Requerido.

stackTrace
(deprecated)

object ( StackTrace )

En desuso a favor de campos de seguimiento de pila dentro de advertencias específicas.

warning

object ( Any )

Mensaje de advertencia con detalles adicionales del problema. Siempre debe ser un mensaje de com.google.devtools.toolresults.v1.warnings

severity

enum ( Severity )

Gravedad del problema. Requerido.

type

enum ( Type )

Tipo de problema. Requerido.

category

enum ( Category )

Categoría de problema. Requerido.

Cualquier

Any contiene un mensaje de búfer de protocolo serializado arbitrario junto con una URL que describe el tipo de mensaje serializado.

La biblioteca Protobuf proporciona soporte para empaquetar/desempaquetar valores Any en forma de funciones de utilidad o métodos generados adicionales del tipo Any.

Ejemplo 1: empaquetar y desempaquetar un mensaje en C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Ejemplo 2: Empaquetar y desempaquetar un mensaje en Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Ejemplo 3: Empaquetar y desempaquetar un mensaje en Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Ejemplo 4: Empaquetar y desempaquetar un mensaje en Go

 foo := &pb.Foo{...}
 any, err := ptypes.MarshalAny(foo)
 ...
 foo := &pb.Foo{}
 if err := ptypes.UnmarshalAny(any, foo); err != nil {
   ...
 }

Los métodos de paquete proporcionados por la biblioteca protobuf usarán de manera predeterminada 'type.googleapis.com/full.type.name' como URL de tipo y los métodos de desempaquetado solo usan el nombre de tipo completo después del último '/' en la URL de tipo, por ejemplo, "foo.bar.com/x/yz" generará el nombre de tipo "yz".

JSON

La representación JSON de un valor Any utiliza la representación normal del mensaje incrustado deserializado, con un campo adicional @type que contiene el tipo de URL. Ejemplo:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

Si el tipo de mensaje incrustado es conocido y tiene una representación JSON personalizada, esa representación se incrustará agregando un value de campo que contenga el JSON personalizado además del campo @type . Ejemplo (para el mensaje google.protobuf.Duration ):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Representación JSON
{
  "typeUrl": string,
  "value": string
}
Campos
typeUrl

string

Un nombre de URL/recurso que identifica de forma exclusiva el tipo de mensaje de búfer de protocolo serializado. Esta cadena debe contener al menos un carácter "/". El último segmento de la ruta de la URL debe representar el nombre completo del tipo (como en path/google.protobuf.Duration ). El nombre debe estar en una forma canónica (por ejemplo, no se acepta "." inicial).

En la práctica, los equipos generalmente precompilan en el binario todos los tipos que esperan que use en el contexto de Any. Sin embargo, para las URL que utilizan el esquema http , https o ningún esquema, se puede configurar opcionalmente un servidor de tipos que asigne las URL de tipo a las definiciones de mensajes de la siguiente manera:

  • Si no se proporciona ningún esquema, se asume https .
  • Un HTTP GET en la URL debe generar un valor google.protobuf.Type en formato binario o producir un error.
  • Las aplicaciones pueden almacenar en caché los resultados de búsqueda en función de la URL, o tenerlos precompilados en un binario para evitar cualquier búsqueda. Por lo tanto, la compatibilidad binaria debe conservarse en los cambios de tipos. (Use nombres de tipo versionados para administrar los cambios importantes).

Nota: esta funcionalidad no está disponible actualmente en la versión oficial de protobuf y no se usa para las URL de tipo que comienzan con type.googleapis.com.

Los esquemas que no sean http , https (o el esquema vacío) se pueden usar con una semántica específica de implementación.

value

string ( bytes format)

Debe ser un búfer de protocolo serializado válido del tipo especificado anteriormente.

Una cadena codificada en base64.

Gravedad

Gravedad de los problemas.

Enumeraciones
unspecifiedSeverity Gravedad no especificada predeterminada. No utilice. Solo para versionado.
info Problema no crítico, que proporciona a los usuarios información sobre la ejecución de la prueba.
suggestion Problema no crítico, que brinda a los usuarios algunos consejos para mejorar su experiencia de prueba, por ejemplo, sugerir el uso de Game Loops.
warning Problema potencialmente crítico.
severe Tema crítico.

Tipo

Tipos de problemas.

Enumeraciones
unspecifiedType Tipo predeterminado no especificado. No utilice. Solo para versionado.
fatalException El problema es una excepción fatal.
nativeCrash El problema es un bloqueo nativo.
anr El problema es un bloqueo de ANR.
unusedRoboDirective El problema es una directiva de robo no utilizada.
compatibleWithOrchestrator El problema es una sugerencia para usar orquestador.
launcherActivityNotFound Problema al encontrar una actividad de lanzador
startActivityNotFound Problema con la resolución de una intención proporcionada por el usuario para iniciar una actividad
incompleteRoboScriptExecution Un script de Robo no se ejecutó por completo.
completeRoboScriptExecution Un script de Robo se ejecutó por completo y con éxito.
failedToInstall El APK no se pudo instalar.
nonSdkApiUsageViolation La aplicación accedió a una API que no es SDK.
nonSdkApiUsageReport La aplicación accedió a una Api que no es SDK (nuevo informe detallado)
encounteredNonAndroidUiWidgetScreen Robo crawl encontró al menos una pantalla con elementos que no son widgets de la interfaz de usuario de Android.
encounteredLoginScreen Robo crawl encontró al menos una probable pantalla de inicio de sesión.
performedGoogleLogin Robo inició sesión con Google.
iosException La aplicación iOS se bloqueó con una excepción.
iosCrash La aplicación iOS se estrelló sin excepción (por ejemplo, se eliminó).
performedMonkeyActions Robo crawl implicó realizar algunas acciones de mono.
usedRoboDirective Robo crawl usó una directiva Robo.
usedRoboIgnoreDirective El rastreo de Robo usó una directiva de Robo para ignorar un elemento de la interfaz de usuario.
insufficientCoverage Robo no rastreó algunas partes potencialmente importantes de la aplicación.
inAppPurchases Robo crawl involucró algunas compras dentro de la aplicación.
crashDialogError Se detectó un cuadro de diálogo de bloqueo durante la ejecución de la prueba
uiElementsTooDeep La profundidad del elemento de la interfaz de usuario es mayor que el umbral
blankScreen Se encuentra una pantalla en blanco en el rastreo de Robo
overlappingUiElements Los elementos de la interfaz de usuario superpuestos se encuentran en el rastreo de Robo
unityException Se detectó una excepción de Unity no detectada (estas aplicaciones no fallan).
deviceOutOfMemory Se detectó un dispositivo que se está quedando sin memoria
logcatCollectionError Problemas detectados al recopilar logcat
detectedAppSplashScreen Robo detectó una pantalla de inicio proporcionada por la aplicación (frente a la pantalla de inicio del sistema operativo Android).

Categoría

Categorías de problemas.

Enumeraciones
unspecifiedCategory Categoría predeterminada no especificada. No utilice. Solo para versionado.
common El problema no es específico de un tipo de prueba en particular (por ejemplo, un bloqueo nativo).
robo El problema es específico de la ejecución de Robo.

tiempo de prueba

El tiempo de prueba se desglosa para conocer las fases.

Representación JSON
{
  "testProcessDuration": {
    object (Duration)
  }
}
Campos
testProcessDuration

object ( Duration )

Cuánto tiempo se tardó en ejecutar el proceso de prueba.

  • En respuesta: presente si se estableció previamente.
  • En solicitud de creación/actualización: opcional

HerramientaEjecuciónPaso

Paso de herramienta genérico que se usará para archivos binarios que no admitimos explícitamente. Por ejemplo: ejecutar cp para copiar artefactos de una ubicación a otra.

Representación JSON
{
  "toolExecution": {
    object (ToolExecution)
  }
}
Campos
toolExecution

object ( ToolExecution )

Una ejecución de herramienta.

  • En respuesta: presente si se establece mediante una solicitud de creación/actualización
  • En solicitud de creación/actualización: opcional

Varios pasos

Detalles cuando se ejecutan varios pasos con la misma configuración que un grupo.

Representación JSON
{
  "primaryStepId": string,
  "multistepNumber": integer,
  "primaryStep": {
    object (PrimaryStep)
  }
}
Campos
primaryStepId

string

Id. de paso del paso principal (original), que podría ser este paso.

multistepNumber

integer

Int único dado a cada paso. Va desde 0 (inclusive) hasta el número total de pasos (exclusivo). El paso principal es 0.

primaryStep

object ( PrimaryStep )

Presente si es un paso primario (original).

Paso primario

Almacena el estado de la prueba acumulada de varios pasos que se ejecutaron como grupo y el resultado de cada paso individual.

Representación JSON
{
  "rollUp": enum (OutcomeSummary),
  "individualOutcome": [
    {
      object (IndividualOutcome)
    }
  ]
}
Campos
rollUp

enum ( OutcomeSummary )

Estado de prueba acumulativa de varios pasos que se ejecutaron con la misma configuración que un grupo.

individualOutcome[]

object ( IndividualOutcome )

ID de paso y resultado de cada paso individual.

Resultado individual

Id. de paso y resultado de cada paso individual que se ejecutó como un grupo con otros pasos con la misma configuración.

Representación JSON
{
  "stepId": string,
  "outcomeSummary": enum (OutcomeSummary),
  "multistepNumber": integer,
  "runDuration": {
    object (Duration)
  }
}
Campos
stepId

string

outcomeSummary

enum ( OutcomeSummary )

multistepNumber

integer

Int único dado a cada paso. Va desde 0 (inclusive) hasta el número total de pasos (exclusivo). El paso principal es 0.

runDuration

object ( Duration )

El tiempo que tardó en ejecutarse este paso.

Métodos

accessibilityClusters

Enumera los clústeres de accesibilidad para un paso determinado

Puede devolver cualquiera de los siguientes códigos de error canónicos:

  • PERMISSION_DENIED: si el usuario no está autorizado para leer el proyecto
  • INVALID_ARGUMENT: si la solicitud tiene un formato incorrecto
  • FAILED_PRECONDITION: si un argumento en la solicitud no es válido; p.ej

create

 Crea un paso.

get

 Obtiene un Paso.

getPerfMetricsSummary

 Recupera un PerfMetricsSummary.

list

 Enumera los pasos para una ejecución determinada.

patch

 Actualiza un paso existente con la entidad parcial suministrada.

publishXunitXmlFiles

 Publique archivos xml en un paso existente.