UiPath Documentation
uipath-cli
latest
false
UiPath-CLI-Benutzerhandbuch
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

uip-tm-ausführung

Syntax und Optionen für „uip tm run“, das jeden Test in einem Paket ausführt, das bereits in den Orchestrator hochgeladen wurde, auf die Ergebnisse wartet, einen Bericht schreibt und einen anderen Wert beendet, wenn ein Test fehlschlägt.

uip tm run führt Tests im Test Manager aus, wartet auf die Ergebnisse und schreibt einen Bericht in einem Befehl, der für CI erstellt wurde. Mit --type package wird jeder Test in einem Paket ausgeführt, das bereits in den Orchestrator hochgeladen wurde. Der Exitcode enthält das Urteil, sodass ein Pipelineschritt keine zusätzliche Analyse erfordert.

Der Befehl wartet bis zu 5 Minuten, bis der Test Manager das hochgeladene Paket indiziert, und führt dann seine Tests über einen ausgeblendeten Testsatz durch. Der Test Manager erstellt und verknüpft einen Testfall für jeden Test im Paket, der noch keinen hat. Fehlgeschlagene Testfälle werden bis zu --max-retries Mal innerhalb derselben Ausführung erneut ausgeführt, sodass der Bericht das letzte Ergebnis jedes Testfalls enthält.

Without --project-key or --project-id, the tests run in the tenant default project, the one project get-default returns. Test Manager creates that project if the tenant has none. Every result names the project the tests ran in under ProjectKey.

Zusammenfassung​

uip tm run --type package [--project-key <key> | --project-id <id>] --package-name <name> --package-version <version> (--folder-path <path> | --folder-key <uuid>) [--input-path <file>] [--max-retries <count>] [--format <format>] [--result-path <path>] [--include-passed-assertions] [--timeout <seconds>] [--poll-interval <seconds>]
uip tm run --type package [--project-key <key> | --project-id <id>] --package-name <name> --package-version <version> (--folder-path <path> | --folder-key <uuid>) [--input-path <file>] [--max-retries <count>] [--format <format>] [--result-path <path>] [--include-passed-assertions] [--timeout <seconds>] [--poll-interval <seconds>]

Beachten Sie die globalen Optionen. Die von diesem Befehl verwendeten Codes finden Sie unter Exit-Codes .

uip-tm-ausführung​

Führen Sie jeden Test in einem hochgeladenen Paket aus, warten Sie, bis die Ausführung abgeschlossen ist, und schreiben Sie einen JUnit-XML- oder UiPath-JSON-Bericht.

Argumente​

Keine.

Optionen​

MarkierenBeschreibung
--type <type>Erforderlich. Was ausgeführt werden soll. Nur package (ein Paket, das bereits in den Orchestrator hochgeladen wurde) wird akzeptiert.
--project-key <key>Test Manager project key. Ignored if --project-id is also given. Without --project-key or --project-id, the tests run in the tenant default project; when the tenant has none, Test Manager creates it, which needs the tenant Project.Create permission.
--project-id <id>Test Manager-Projekt-ID. Anstelle von --project-key verwenden; gewinnt, wenn beide angegeben sind.
--package-name <name>Erforderlich. Paket-ID, wie sie in den Orchestrator hochgeladen wurde (z. B. MyTests).
--package-version <version>Erforderlich. Eine App-Version (z. B. 1.0) führt den neuesten hochgeladenen Patch aus. Eine genaue Version (z. B. 1.0.244878764) muss bereits hochgeladen wurden und der neueste Patch der App-Version sein; ältere Patches werden abgelehnt. Der Befehl wartet bis zu 5 Minuten, bis der Test Manager eine Version indiziert, die der Orchestrator bereits hat.
--folder-path <path>Orchestrator-Ordner, in dem die Tests ausgeführt werden sollen (z. B. Shared oder Shared/CI). Es ist genau eines von --folder-path oder --folder-key erforderlich.
--folder-key <uuid>Orchestrator-Ordnerschlüssel anstelle von --folder-path.
--input-path <file>JSON-Datei mit Parameterüberschreibungen, z. B. [{"name":"Param","type":"String","value":"v"}]. Die Datei wird gelesen, bevor etwas erstellt wird. Namen, für die keine Testdeklarationen angegeben sind, werden nicht angewendet; In der Ausgabe werden sie unter IgnoredInputs aufgeführt.
--max-retries <count>Führen Sie fehlgeschlagene Testfälle bis zu so oft aus, von 0 bis 100. Die Standardeinstellung ist 0.
--format <format>Berichtsformat: junit (XML) oder uipath (JSON). Die Standardeinstellung ist junit.
--result-path <path>Berichtsdatei oder -verzeichnis. Standardmäßig das aktuelle Arbeitsverzeichnis. Ein Verzeichnis oder ein neuer Pfad ohne Erweiterung erhält eine Datei, die nach dem Testsatz der Ausführung benannt ist.
--include-passed-assertionsLesen Sie auch die Assertionen bestandener Tests für den Bericht, eine weitere Anforderung pro bestandenem Test. Standardmäßig erhalten nur Tests, die nicht bestanden sind, ihre Assertionen.
--timeout <seconds>Maximale Sekunden für die gesamte Ausführung, einschließlich Wiederholungen; 0 bedeutet keine Zeitüberschreitung. Die Standardeinstellung ist 7200, höchstens 604800 (eine Woche).
--poll-interval <seconds>Sekunden zwischen den Ausführungsstatusprüfungen, von 1 bis 3600. Die Standardeinstellung ist 60.

Beispiele​

# run every test in MyTests 1.0.3 and write a JUnit report
uip tm run \
  --type package \
  --project-key DEMO \
  --package-name MyTests \
  --package-version 1.0.3 \
  --folder-path Shared \
  --result-path ./results/junit.xml

# run the same package in the tenant default project (no --project-key)
uip tm run \
  --type package \
  --package-name MyTests \
  --package-version 1.0.3 \
  --folder-path Shared \
  --result-path ./results/junit.xml

# run the latest 1.0.x patch with input overrides, retry failed tests twice, write the UiPath JSON report
uip tm run \
  --type package \
  --project-key DEMO \
  --package-name MyTests \
  --package-version 1.0 \
  --folder-path Shared \
  --input-path ./inputs.json \
  --max-retries 2 \
  --format uipath
# run every test in MyTests 1.0.3 and write a JUnit report
uip tm run \
  --type package \
  --project-key DEMO \
  --package-name MyTests \
  --package-version 1.0.3 \
  --folder-path Shared \
  --result-path ./results/junit.xml

# run the same package in the tenant default project (no --project-key)
uip tm run \
  --type package \
  --package-name MyTests \
  --package-version 1.0.3 \
  --folder-path Shared \
  --result-path ./results/junit.xml

# run the latest 1.0.x patch with input overrides, retry failed tests twice, write the UiPath JSON report
uip tm run \
  --type package \
  --project-key DEMO \
  --package-name MyTests \
  --package-version 1.0 \
  --folder-path Shared \
  --input-path ./inputs.json \
  --max-retries 2 \
  --format uipath

Datenform (jeder Test bestanden)​

{
  "Result": "Success",
  "Code": "RunPackage",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ExecutionUrl": "https://cloud.uipath.com/org/tenant/testmanager_/DEMO/testexecutions/a1b2c3d4-0000-0000-0000-000000000001",
    "PackageName": "MyTests",
    "PackageVersion": "1.0.3",
    "FolderPath": "Shared",
    "Status": "Finished",
    "TotalTests": 12,
    "Passed": 12,
    "Failed": 0,
    "Cancelled": 0,
    "Format": "junit",
    "OutputPath": "./results/junit.xml",
    "Retries": 0,
    "ProjectKey": "DEMO"
  }
}
{
  "Result": "Success",
  "Code": "RunPackage",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ExecutionUrl": "https://cloud.uipath.com/org/tenant/testmanager_/DEMO/testexecutions/a1b2c3d4-0000-0000-0000-000000000001",
    "PackageName": "MyTests",
    "PackageVersion": "1.0.3",
    "FolderPath": "Shared",
    "Status": "Finished",
    "TotalTests": 12,
    "Passed": 12,
    "Failed": 0,
    "Cancelled": 0,
    "Format": "junit",
    "OutputPath": "./results/junit.xml",
    "Retries": 0,
    "ProjectKey": "DEMO"
  }
}
FeldBedeutung
PackageVersionDie genaue ausgeführte Version, aufgelöst von --package-version.
ProjectKeyThe project the tests ran in: the one you passed, or the tenant default project. It is the last field, so with --output plain it is the last column.
RetriesWie viele erneute Ausführungen fehlgeschlagener Testfälle stattgefunden haben.
OutputPathWo der Bericht geschrieben wurde.
IgnoredInputs, DeclaredInputsNur vorhanden, wenn --input-path Eingaben benennen, die kein Test deklariert: die ignorierten Namen und die Namen, die die Tests deklarieren.
MissingResultsNur vorhanden, wenn der Test Manager mehr Tests zählt, als ein Ergebnis gemeldet hat.
AssertionsNotReadNur vorhanden, wenn die Assertionen einiger Tests nicht gelesen werden konnten; der Bericht enthält keine Fehlerdetails dazu.

Wenn die Tests erfolgreich sind, aber Eingaben ignoriert wurden oder Assertionen nicht gelesen werden konnten, enthält der Erfolgsumschlag auch ein Warning.

Datenform (ein Test fehlgeschlagen)​

{
  "Result": "Failure",
  "Code": "RunPackageTestsFailed",
  "ErrorCode": "execution_failed",
  "Message": "2 of 12 tests did not pass (2 failed).",
  "Instructions": "See the report at ./results/junit.xml or open https://cloud.uipath.com/org/tenant/testmanager_/DEMO/testexecutions/a1b2c3d4-0000-0000-0000-000000000001.",
  "Retry": "RetryWillNotFix",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Status": "Finished",
    "TotalTests": 12,
    "Passed": 10,
    "Failed": 2,
    "Cancelled": 0,
    "Format": "junit",
    "OutputPath": "./results/junit.xml",
    "Retries": 0,
    "ProjectKey": "DEMO"
  }
}
{
  "Result": "Failure",
  "Code": "RunPackageTestsFailed",
  "ErrorCode": "execution_failed",
  "Message": "2 of 12 tests did not pass (2 failed).",
  "Instructions": "See the report at ./results/junit.xml or open https://cloud.uipath.com/org/tenant/testmanager_/DEMO/testexecutions/a1b2c3d4-0000-0000-0000-000000000001.",
  "Retry": "RetryWillNotFix",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Status": "Finished",
    "TotalTests": 12,
    "Passed": 10,
    "Failed": 2,
    "Cancelled": 0,
    "Format": "junit",
    "OutputPath": "./results/junit.xml",
    "Retries": 0,
    "ProjectKey": "DEMO"
  }
}

Data holds the full run summary, the same fields as on success, including ProjectKey; the example shows a subset. A cancelled execution returns Code: "RunPackageCancelled" instead. The report is written in both cases.

Datenform (Timeout)​

{
  "Result": "TimeoutError",
  "ErrorCode": "timeout",
  "Message": "Timed out while waiting for the tests.",
  "Instructions": "The tests may still be running. Check execution a1b2c3d4-0000-0000-0000-000000000001 in Test Manager, or run again with a larger --timeout. A report of the tests that finished is at ./results/junit.xml.",
  "Retry": "RetryLater",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Retries": 0,
    "OutputPath": "./results/junit.xml",
    "ProjectKey": "DEMO",
    "ExecutionUrl": "https://cloud.uipath.com/org/tenant/testmanager_/DEMO/testexecutions/a1b2c3d4-0000-0000-0000-000000000001"
  }
}
{
  "Result": "TimeoutError",
  "ErrorCode": "timeout",
  "Message": "Timed out while waiting for the tests.",
  "Instructions": "The tests may still be running. Check execution a1b2c3d4-0000-0000-0000-000000000001 in Test Manager, or run again with a larger --timeout. A report of the tests that finished is at ./results/junit.xml.",
  "Retry": "RetryLater",
  "Data": {
    "ExecutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Retries": 0,
    "OutputPath": "./results/junit.xml",
    "ProjectKey": "DEMO",
    "ExecutionUrl": "https://cloud.uipath.com/org/tenant/testmanager_/DEMO/testexecutions/a1b2c3d4-0000-0000-0000-000000000001"
  }
}

Data is present only when the execution had started before the time ran out. OutputPath is present only when a partial report of the tests that finished could be written. ProjectKey and ExecutionUrl locate the started execution. Any other failure after the execution starts carries the same Data fields.

Exitcodes​

Code beendenBedeutung
0Jeder Test bestanden.
1Ein Test ist fehlgeschlagen oder hat kein Ergebnis gemeldet, die Ausführung wurde abgebrochen, es wurde kein Test durchgeführt oder ein Serviceaufruf ist fehlgeschlagen.
2Login or permission problem after the run starts, or no permission to open or create the tenant default project. A missing login or no access to a project you passed exits 1 before the run starts.
3Bad option or input, for example no folder or both folder flags, an invalid --package-version, or a malformed --input-path file.
4--timeout abgelaufen.

Der Exitcode 1 deckt mehrere Ergebnisse ab. Um sie unterscheiden zu können, lesen Sie den Umschlag: Code ist RunPackageCancelled für eine abgebrochene Ausführung und RunPackageTestsFailed andernfalls ist Data.TotalTests 0 , wenn kein Test durchgeführt wurde (z. B. ein leeres oder falsch angegebenes Paket). und Data.MissingResults zählt Tests, die kein Ergebnis gemeldet haben. Der Fall der fehlenden Anmeldung unterscheidet sich von der CLI-weiten Regel, dass Authentifizierungsfehler 2 beenden; Siehe Beendigungscodes.

Im Gegensatz zu uip tm wait, bei dem 0 beendet wird, sobald eine Ausführung das Ergebnis abgeschlossen hat, schlägt uip tm run den Schritt selbst fehl, wenn ein Test nicht besteht.

  • uip or package – packages upload veröffentlicht das Paket, das von diesem Befehl ausgeführt wird.
  • project get-default — the tenant default project this command runs in when you pass no project.
  • Pack – erstellen Sie ein .nupkg aus einem externen Playwright-Testprojekt.
  • testsets run – starten Sie stattdessen die Ausführung eines vorhandenen Testsatzes.
  • Ausführungen – überprüfen, wiederholen oder brechen Sie die Ausführung ab, die dieser Befehl startet.
  • Ergebnis – Laden Sie JUnit-XML für jede Ausführung herunter.

Siehe auch​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support(opens in new window)

Möchten Sie lernen? UiPath Academy(opens in new window)

Haben Sie Fragen? UiPath-Forum(opens in new window)

Auf dem neuesten Stand bleiben