REST Resource: projects.histories.executions.steps

{
  "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.
}

string

Eine eindeutige Kennung innerhalb einer Ausführung für diesen Schritt.

Gibt INVALID_ARGUMENT zurück, wenn dieses Feld vom Aufrufer festgelegt oder überschrieben wird.

• Als Antwort: immer gesetzt
• In der Erstellungs-/Aktualisierungsanforderung: nie festgelegt

object ( Timestamp )

Der Zeitpunkt, zu dem der Schritt erstellt wurde.

• Als Antwort: immer gesetzt
• In der Erstellungs-/Aktualisierungsanforderung: nie festgelegt

object ( Timestamp )

Der Zeitpunkt, zu dem der Schrittstatus auf „Abgeschlossen“ gesetzt wurde.

Dieser Wert wird automatisch festgelegt, wenn der Status in COMPLETE übergeht.

• Als Antwort: Wird gesetzt, wenn der Ausführungsstatus COMPLETE ist.
• In der Erstellungs-/Aktualisierungsanforderung: nie festgelegt

string

Ein kurzer, für Menschen lesbarer Name, der in der Benutzeroberfläche angezeigt wird. Maximal 100 Zeichen. Beispiel: Sauberer Build

Beim Erstellen eines neuen Schritts wird ein PRECONDITION_FAILED zurückgegeben, wenn dieser seinen Namen und Dimensionswert mit einem vorhandenen Schritt teilt. Wenn zwei Schritte eine ähnliche Aktion darstellen, aber unterschiedliche Dimensionswerte haben, sollten sie denselben Namen haben. Wenn beispielsweise derselbe Testsatz auf zwei verschiedenen Plattformen ausgeführt wird, sollten die beiden Schritte denselben Namen haben.

• Als Antwort: immer gesetzt
• In Anforderung erstellen: immer festlegen
• In Update-Anfrage: nie gesetzt

string

Eine Beschreibung dieses Tools. Beispiel: mvn clean package -D skipTests=true

• Als Antwort: vorhanden, wenn durch Erstellungs-/Aktualisierungsanforderung festgelegt
• In der Erstellungs-/Aktualisierungsanfrage: optional

enum ( State )

Der Ausgangszustand ist IN_PROGRESS. Die einzigen zulässigen Zustandsübergänge sind * IN_PROGRESS -> COMPLETE

Wenn ein ungültiger Übergang angefordert wird, wird ein PRECONDITION_FAILED zurückgegeben.

Es ist zulässig, einen Schritt mit dem Status „ABGESCHLOSSEN“ zu erstellen. Der Status kann nur einmal auf COMPLETE gesetzt werden. Eine PRECONDITION_FAILED wird zurückgegeben, wenn der Status mehrmals auf COMPLETE gesetzt wird.

• Als Antwort: immer gesetzt
• In der Erstellungs-/Aktualisierungsanfrage: optional

object ( Outcome )

Einstufung des Ergebnisses, beispielsweise in ERFOLGREICH oder FEHLER

• Als Antwort: vorhanden, wenn durch Erstellungs-/Aktualisierungsanforderung festgelegt
• In der Erstellungs-/Aktualisierungsanfrage: optional

boolean

Ob es sich bei den Ausgaben dieses Schritts um Bilder handelt, deren Miniaturansichten mit „thumbnails.list“ abgerufen werden können.

• Als Antwort: immer gesetzt
• In der Erstellungs-/Aktualisierungsanforderung: nie festgelegt

map (key: string, value: string)

Beliebige, vom Benutzer bereitgestellte Schlüssel/Wert-Paare, die dem Schritt zugeordnet sind.

Benutzer sind dafür verantwortlich, den Schlüssel-Namespace so zu verwalten, dass Schlüssel nicht versehentlich kollidieren.

Ein INVALID_ARGUMENT wird zurückgegeben, wenn die Anzahl der Beschriftungen 100 überschreitet oder wenn die Länge eines der Schlüssel oder Werte 100 Zeichen überschreitet.

• Als Antwort: immer gesetzt
• In der Erstellungsanfrage: optional
• In Update-Anfrage: optional; Jedes neue Schlüssel/Wert-Paar wird der Karte hinzugefügt und jeder neue Wert für einen vorhandenen Schlüssel aktualisiert den Wert dieses Schlüssels

Ein Objekt, das eine Liste von "key": value Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

map (key: string, value: string)

Wenn für die Ausführung, die diesen Schritt enthält, eine dimension_definition festgelegt ist, kann das Kind in diesem Feld die Werte der Dimensionen angeben.

Die Schlüssel müssen genau mit der dimension_definition der Ausführung übereinstimmen.

Wenn die Ausführung beispielsweise dimension_definition = ['attempt', 'device'] hat, muss ein Schritt Werte für diese Dimensionen definieren, z. dimensionValue = ['attempt': '1', 'device': 'Nexus 6']

Wenn ein Schritt nicht an einer Dimension der Matrix teilnimmt, sollte der Wert für diese Dimension eine leere Zeichenfolge sein. Wenn beispielsweise einer der Tests von einem Läufer ausgeführt wird, der keine Wiederholungsversuche unterstützt, könnte der Schritt dimensionValue = ['attempt': '', 'device': 'Nexus 6'] haben.

Wenn der Schritt an keiner Dimension der Matrix beteiligt ist, bleibt dimensionValue möglicherweise nicht festgelegt.

Eine PRECONDITION_FAILED wird zurückgegeben, wenn einer der Schlüssel in der Dimensionsdefinition der Ausführung nicht vorhanden ist.

Eine PRECONDITION_FAILED wird zurückgegeben, wenn ein anderer Schritt in dieser Ausführung bereits denselben Namen und denselben Dimensionswert hat, sich jedoch in anderen Datenfeldern unterscheidet, z. B. wenn das Schrittfeld unterschiedlich ist.

Eine PRECONDITION_FAILED wird zurückgegeben, wenn dimensionValue festgelegt ist und in der Ausführung eine dimension_definition vorhanden ist, die nicht als einer der Schlüssel angegeben ist.

• Als Antwort: vorhanden, wenn durch Erstellen festgelegt
• In der Erstellungsanfrage: optional
• In Update-Anfrage: nie gesetzt

Ein Objekt, das eine Liste von "key": value Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

object ( Duration )

Wie lange hat es gedauert, bis dieser Schritt ausgeführt wurde?

Wenn diese Option nicht festgelegt ist, wird sie auf die Differenz zwischen „creationTime“ und „CompletionTime“ festgelegt, wenn der Schritt auf den COMPLETE-Status gesetzt wird. In einigen Fällen ist es sinnvoll, diesen Wert separat festzulegen: Wenn beispielsweise ein Schritt erstellt wird, der Vorgang, den er darstellt, jedoch einige Minuten in der Warteschlange steht, bevor er ausgeführt wird, wäre es sinnvoll, die in der Warteschlange verbrachte Zeit nicht einzubeziehen Laufdauer.

PRECONDITION_FAILED wird zurückgegeben, wenn versucht wird, eine runDuration für einen Schritt festzulegen, für den dieses Feld bereits festgelegt ist.

• Als Antwort: vorhanden, falls zuvor festgelegt; immer im COMPLETE-Schritt vorhanden
• In der Erstellungsanfrage: optional
• In Update-Anfrage: optional

object ( Duration )

Wie viel Geräteressource zur Durchführung des Tests verwendet wird.

Dabei handelt es sich um die Gerätenutzung, die zu Abrechnungszwecken verwendet wird. Sie unterscheidet sich von runDuration. Beispielsweise wird bei einem Infrastrukturausfall die Gerätenutzung nicht in Rechnung gestellt.

PRECONDITION_FAILED wird zurückgegeben, wenn versucht wird, „device_usage“ für einen Schritt festzulegen, für den dieses Feld bereits festgelegt ist.

• Als Antwort: vorhanden, falls zuvor festgelegt.
• In der Erstellungsanfrage: optional
• In Update-Anfrage: optional

object ( MultiStep )

Details, wenn mehrere Schritte mit derselben Konfiguration als Gruppe ausgeführt werden. Anhand dieser Details kann identifiziert werden, zu welcher Gruppe dieser Schritt gehört. Außerdem wird der „primäre Schritt“ der Gruppe identifiziert, der alle Gruppenmitglieder indiziert.

• Als Antwort: vorhanden, falls zuvor festgelegt.
• In der Anforderung erstellen: optional, legen Sie fest, ob dieser Schritt mehr als einmal ausgeführt wurde.
• In Update-Anfrage: optional

object ( TestExecutionStep )

Eine Ausführung eines Testläufers.

object ( ToolExecutionStep )

Eine Ausführung eines Tools (wird für Schritte verwendet, die wir nicht explizit unterstützen).

{
  "testSuiteOverviews": [
    {
      object (TestSuiteOverview)
    }
  ],
  "toolExecution": {
    object (ToolExecution)
  },
  "testIssues": [
    {
      object (TestIssue)
    }
  ],
  "testTiming": {
    object (TestTiming)
  }
}

object ( TestSuiteOverview )

Liste der Inhalte der Testsuite-Übersicht. Dies kann vom Server aus dem xUnit-XML-Protokoll analysiert oder direkt vom Benutzer hochgeladen werden. Diese Referenzen sollten nur aufgerufen werden, wenn die Testsuiten vollständig analysiert oder hochgeladen wurden.

Die maximal zulässige Anzahl von Testsuite-Übersichten pro Schritt beträgt 1000.

• Als Antwort: immer gesetzt
• In der Erstellungsanfrage: optional
• In Aktualisierungsanforderung: niemals (verwenden Sie stattdessen die benutzerdefinierte Methode „publishXunitXmlFiles“)

object ( ToolExecution )

Stellt die Ausführung des Testläufers dar.

Der Exit-Code dieses Tools wird verwendet, um festzustellen, ob der Test bestanden wurde.

• Als Antwort: immer gesetzt
• In der Erstellungs-/Aktualisierungsanfrage: optional

object ( TestIssue )

Während der Testausführung beobachtete Probleme.

Wenn beispielsweise die zu testende mobile App während des Tests abstürzt, können die Fehlermeldung und der Stack-Trace-Inhalt hier aufgezeichnet werden, um das Debuggen zu unterstützen.

• Als Antwort: vorhanden, wenn durch Erstellen oder Aktualisieren festgelegt
• In der Erstellungs-/Aktualisierungsanfrage: optional

object ( TestTiming )

Der zeitliche Ablauf der Testausführung.

• Als Antwort: vorhanden, wenn durch Erstellen oder Aktualisieren festgelegt
• In der Erstellungs-/Aktualisierungsanfrage: optional

{
  "commandLineArguments": [
    string
  ],
  "toolLogs": [
    {
      object (FileReference)
    }
  ],
  "exitCode": {
    object (ToolExitCode)
  },
  "toolOutputs": [
    {
      object (ToolOutputReference)
    }
  ]
}

string

Die vollständige tokenisierte Befehlszeile einschließlich des Programmnamens (entspricht argv in einem C-Programm).

• Als Antwort: vorhanden, wenn durch die Erstellungsanforderung festgelegt
• In der Erstellungsanfrage: optional
• In Update-Anfrage: nie gesetzt

object ( FileReference )

Verweise auf beliebige Nur-Text-Protokolle geben die Ausführung des Tools aus.

Dieses Feld kann vor dem Beenden des Tools festgelegt werden, um während der Ausführung des Tools Zugriff auf eine Live-Ansicht der Protokolle zu haben.

Die maximal zulässige Anzahl von Werkzeugprotokollen pro Schritt beträgt 1000.

• Als Antwort: vorhanden, wenn durch Erstellungs-/Aktualisierungsanforderung festgelegt
• In der Erstellungsanfrage: optional
• In der Aktualisierungsanforderung: optional, jeder angegebene Wert wird an die vorhandene Liste angehängt

object ( ToolExitCode )

Exit-Code für die Toolausführung. Dieses Feld wird gesetzt, sobald das Tool beendet wurde.

• Als Antwort: vorhanden, wenn durch Erstellungs-/Aktualisierungsanforderung festgelegt
• In der Erstellungsanfrage: optional
• In der Aktualisierungsanforderung: optional wird ein FAILED_PRECONDITION-Fehler zurückgegeben, wenn bereits ein ExitCode festgelegt ist.

object ( ToolOutputReference )

Verweise auf undurchsichtige Dateien eines beliebigen Formats, die von der Tool-Ausführung ausgegeben werden.

Die maximal zulässige Anzahl von Werkzeugausgängen pro Schritt beträgt 1000.

• Als Antwort: vorhanden, wenn durch Erstellungs-/Aktualisierungsanforderung festgelegt
• In der Erstellungsanfrage: optional
• In der Aktualisierungsanforderung: optional, jeder angegebene Wert wird an die vorhandene Liste angehängt

{
  "number": integer
}

integer

Exit-Code für die Toolausführung. Ein Wert von 0 bedeutet, dass die Ausführung erfolgreich war.

• Als Antwort: immer gesetzt
• In der Erstellungs-/Aktualisierungsanfrage: immer festgelegt

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

string

Eine kurze, für Menschen lesbare Nachricht, die das Problem beschreibt. Erforderlich.

object ( StackTrace )

Veraltet zugunsten von Stack-Trace-Feldern innerhalb bestimmter Warnungen.

object ( Any )

Warnmeldung mit zusätzlichen Details zum Problem. Sollte immer eine Nachricht von com.google.devtools.toolresults.v1.warnings sein

enum ( Severity )

Schwere des Problems. Erforderlich.

enum ( Type )

Art der Ausgabe. Erforderlich.

enum ( Category )

Problemkategorie. Erforderlich.

{
  "typeUrl": string,
  "value": string
}

string

Ein URL/Ressourcenname, der den Typ der serialisierten Protokollpuffernachricht eindeutig identifiziert. Diese Zeichenfolge muss mindestens ein „/“-Zeichen enthalten. Das letzte Segment des URL-Pfads muss den vollständig qualifizierten Namen des Typs darstellen (wie in path/google.protobuf.Duration ). Der Name sollte in kanonischer Form vorliegen (z. B. wird das führende „.“ nicht akzeptiert).

In der Praxis kompilieren Teams in der Regel alle Typen in die Binärdatei vor, die sie voraussichtlich im Kontext von Any verwenden werden. Für URLs, die das Schema http , https oder kein Schema verwenden, kann man jedoch optional einen Typserver einrichten, der Typ-URLs wie folgt Nachrichtendefinitionen zuordnet:

• Wenn kein Schema angegeben ist, wird https angenommen.
• Ein HTTP-GET für die URL muss einen google.protobuf.Type Wert im Binärformat liefern oder einen Fehler erzeugen.
• Anwendungen dürfen Suchergebnisse basierend auf der URL zwischenspeichern oder sie in eine Binärdatei vorkompilieren lassen, um eine Suche zu vermeiden. Daher muss die Binärkompatibilität bei Änderungen an Typen gewahrt bleiben. (Verwenden Sie versionierte Typnamen, um wichtige Änderungen zu verwalten.)

Hinweis: Diese Funktionalität ist derzeit in der offiziellen Protobuf-Version nicht verfügbar und wird nicht für Typ-URLs verwendet, die mit type.googleapis.com beginnen.

Andere Schemata als http , https (oder das leere Schema) können mit implementierter spezifischer Semantik verwendet werden.

string ( bytes format)

Muss ein gültiger serialisierter Protokollpuffer des oben angegebenen Typs sein.

Eine Base64-codierte Zeichenfolge.

{
  "testProcessDuration": {
    object (Duration)
  }
}

object ( Duration )

Wie lange es gedauert hat, den Testvorgang auszuführen.

• Als Antwort: vorhanden, falls zuvor festgelegt.
• In der Erstellungs-/Aktualisierungsanfrage: optional

{
  "toolExecution": {
    object (ToolExecution)
  }
}

object ( ToolExecution )

Eine Tool-Ausführung.

• Als Antwort: vorhanden, wenn durch Erstellungs-/Aktualisierungsanforderung festgelegt
• In der Erstellungs-/Aktualisierungsanfrage: optional

{
  "primaryStepId": string,
  "multistepNumber": integer,
  "primaryStep": {
    object (PrimaryStep)
  }
}

string

Schritt-ID des primären (ursprünglichen) Schritts, bei dem es sich möglicherweise um diesen Schritt handelt.

integer

Eindeutiger int, der jedem Schritt zugewiesen wird. Der Bereich reicht von 0 (einschließlich) bis zur Gesamtzahl der Schritte (exklusiv). Der primäre Schritt ist 0.

object ( PrimaryStep )

Vorhanden, wenn es sich um einen primären (ursprünglichen) Schritt handelt.

{
  "rollUp": enum (OutcomeSummary),
  "individualOutcome": [
    {
      object (IndividualOutcome)
    }
  ]
}

enum ( OutcomeSummary )

Rollup-Teststatus mehrerer Schritte, die mit derselben Konfiguration als Gruppe ausgeführt wurden.

object ( IndividualOutcome )

Schritt-ID und Ergebnis jedes einzelnen Schritts.

{
  "stepId": string,
  "outcomeSummary": enum (OutcomeSummary),
  "multistepNumber": integer,
  "runDuration": {
    object (Duration)
  }
}

string

enum ( OutcomeSummary )

integer

Eindeutiger int, der jedem Schritt zugewiesen wird. Der Bereich reicht von 0 (einschließlich) bis zur Gesamtzahl der Schritte (exklusiv). Der primäre Schritt ist 0.

object ( Duration )

Wie lange hat es gedauert, bis dieser Schritt ausgeführt wurde?