uip tm - scénario de performances

Syntaxe et options de `uip tm perf-scenario`, qui crée et exécute des scénarios de performances Test Manager, inspecte les données d'exécution et génère des rapports.

uip tm perf-scenario gère les scénarios de performances de Test Manager: créez un scénario, liez-lui les cas de test en tant que groupes de charge avec un profil de charge (utilisateurs virtuels, synchronisation des montées en puissance/pics/down, seuils SLO), exécutez-le en tant que test rapide ou un test de charge complète, puis inspecter les données d'exécution qui en résultent et générer les rapports.

Important :

Cette page documente un groupe de commandes réel et entièrement livré — il est enregistré inconditionnellement avec toutes les autres commandes uip tm et non derrière un indicateur de fonctionnalité. Si vous avez été informé que cette surface n’existe pas ou est en version préliminaire, vérifiez directement avec uip tm perf-scenario --help.

Cette ressource s’étend sur quatre pages:

• Cette page — les concepts et le cycle de vie du scénario: create, get, list, execute, stop, list-dry-run-reports.
• Groupes de charge - load-groups add/update/remove/list, la liaison cas de test-scénario et son profil de charge.
• Données d'exécution — executions list, results get, http-errors list, automation-errors list, transaction-metrics list.
• Rapports — report generate, report compare.

Concepts

• Scénario — la définition de test de performance de haut niveau (--scenario-key, par exemple SP1:7). Créé avec create, inspecté avec get, exécuté avec execute.
• Groupe de charge : un cas de test lié à un scénario avec un profil de charge (utilisateurs virtuels, synchronisation, seuils SLO, type de robot). Un scénario peut avoir plusieurs groupes de charge. Voir Groupes de charge.
• Exécution — l'exécution d'un scénario, soit une dryRun (exécution rapide), soit performanceTesting (exécution à charge complète respectant le profil de charge de chaque groupe de charge). Démarré avec execute, inspecté via Données d'exécution et arrêté tôt avec stop.
• Rapport de test — le Service de performance enregistre un rapport après un test de réussite. Une exécution performanceTesting complète nécessite qu'au moins un rapport d'exécution du test soit déjà transmis; vérifiez avec list-dry-run-reports avant d'exécuter un test de charge complète.

La plupart des verbes lus sur les quatre pages acceptent --query <expr>, un filtre de style jq appliqué côté client à la sortie Data avant qu'il ne soit imprimé — utilisez-le pour affiner une charge utile importante (voir l'exemple list ci-dessous).

Synthèse

uip tm perf-scenario create --project-key <key> --name <name> [--description <text>] [--version <version>] [--app-type <type>] [--perf-test-type <type>] [--responsiveness <level>]
uip tm perf-scenario get --scenario-key <key> [--project-key <key>]
uip tm perf-scenario list --project-key <key> [--search <text>] [--limit <n>] [--offset <n>] [--query <expr>]
uip tm perf-scenario execute --scenario-key <key> [--project-key <key>] [--execution-type <dryRun|performanceTesting>] [--wait [--full] [--poll-interval-sec <n>] [--timeout-sec <n>]]
uip tm perf-scenario stop --execution-id <uuid> --project-key <key>
uip tm perf-scenario list-dry-run-reports --scenario-key <key> [--project-key <key>]

Tous les verbes respectent les options globales et les codes de sortie standard. Chaque verbe sur les quatre pages du perf-scenario accepte --log-level <level> (par défaut Information).

Remarque :

--project-key est uniquement un .requiredOption() sur create et stop sur cette page (et sur load-groups update/remove/list — voir Groupes de charge). Sur get, execute et list-dry-run-reports, c'est facultatif: le projet est dérivé du préfixe de --scenario-key (par exemple, SP1:7 → projet SP1) lorsqu'il est omis, et --project-key remplace cette dérive si réussi. Les verbes des pages Données d'exécution et Rapports ne prennent pas du tout --project-key (sauf en option sur les deux verbes report , où cela affecte uniquement si le lien renvoyé ouvre la page du rapport dans l'application) — ces verbes appellent le Performance Service directement plutôt que de résoudre un projet Test Manager.

Création de scénarios de performances uip tm

Créez un scénario de performances dans un projet Test Manager.

Options

Drapeau	Description
--project-key <key>	Requis. Propriétaire du projet.
--name <name>	Requis. Nom du scénario.
--description <text>	Description du scénario. La valeur par défaut est vide. Limité à 5 120 caractères.
--version <version>	Chaîne de version du scénario. La valeur par défaut est 1.0. Limité à 255 caractères.
--app-type <type>	Type d’application: web, apiService, ecommerce, gaming, financial, healthcare, saaS, streaming, messaging, enterprise. La valeur par défaut est web.
--perf-test-type <type>	Type de test de performance: loadTesting, stressTesting, enduranceTesting, spikeTesting. La valeur par défaut est loadTesting.
--responsiveness <level>	Réactivité attendue: instant, fast, moderate, slow, verySlow. La valeur par défaut est fast.

Exemple

uip tm perf-scenario create \
  --project-key SP1 \
  --name "Checkout load" \
  --app-type web \
  --perf-test-type loadTesting \
  --responsiveness fast

Format des données

{
  "Code": "ScenarioCreate",
  "Data": {
    "ScenarioKey": "SP1:7",
    "Name": "Checkout load",
    "Version": "1.0",
    "AppType": "web",
    "PerfTestType": "loadTesting",
    "Responsiveness": "fast"
  }
}

uip tm perf-scenario obtenir

Récupérez les métadonnées d'un scénario et les groupes de charge qui y sont liés.

Options

Drapeau	Description
--scenario-key <key>	Requis. Clé d’objet de scénario (par exemple, SP1:7).
--project-key <key>	Propriétaire du projet. Facultatif — dérivé du préfixe --scenario-key lorsqu'il est omis.

Exemple

uip tm perf-scenario get --scenario-key SP1:7

Format des données

{
  "Code": "ScenarioGet",
  "Data": {
    "ScenarioKey": "SP1:7",
    "Name": "Checkout load",
    "Version": "1.0",
    "Description": "",
    "AppType": "web",
    "PerfTestType": "loadTesting",
    "Responsiveness": "fast",
    "LoadGroups": [
      {
        "LoadGroupId": "8e322581-0a25-0000-738b-0b49fd936ca1",
        "TestCaseKey": "SP1:602",
        "Name": "Checkout flow",
        "PackageName": "Checkout_Tests",
        "PackageVersion": "1.0.2",
        "FolderKey": "94821c49-ab85-49cb-94e1-f82c6d8973be",
        "VirtualUsers": 20,
        "Enabled": true
      }
    ]
  }
}

LoadGroupId voici l'ID de groupe de charge du scénario — l'identifiant load-groups update et load-groups remove attendu (voir Groupes de charge). Il s'agit d'un ID différent des lignes par exécution renvoyées par load-groups list.

liste de scénarios de performances uip tm

Répertoriez les scénarios de performances dans un projet.

Options

Drapeau	Description
--project-key <key>	Requis. Propriétaire du projet.
--search <text>	Filtrez les scénarios par nom ou par clé.
--limit <n>	Nombre maximal de résultats à renvoyer. Par défaut, la taille de page du service lorsqu'elle est omise.
--offset <n>	Résultats à ignorer pour la pagination. La valeur par défaut est 0.
--query <expr>	un filtre de style jq appliqué aux données de sortie.

Exemples

uip tm perf-scenario list --project-key DEMO

# search by name, narrowing the output to just the scenario rows
uip tm perf-scenario list --project-key DEMO --search checkout --query .Scenarios

Format des données

{
  "Code": "PerfScenariosList",
  "Data": {
    "Total": 2,
    "Count": 2,
    "Scenarios": [
      {
        "ScenarioKey": "DEMO:7",
        "Name": "Checkout load",
        "Version": "1.0",
        "AppType": "web",
        "PerfTestType": "loadTesting",
        "Responsiveness": "fast",
        "VirtualUsers": 20,
        "DurationMinutes": 0,
        "Updated": "2025-04-15T10:30:00Z",
        "UpdatedBy": "[e-mail]"
      },
      {
        "ScenarioKey": "DEMO:9",
        "Name": "Search stress",
        "Version": "1.0",
        "AppType": "web",
        "PerfTestType": "stressTesting",
        "Responsiveness": "fast",
        "VirtualUsers": 100,
        "DurationMinutes": 0,
        "Updated": "2025-04-15T10:30:00Z",
        "UpdatedBy": "[e-mail]"
      }
    ]
  }
}

Total est le nombre total de correspondances indiqué par le serveur, qui peut dépasser Count (le nombre de lignes réellement renvoyées) lorsque --limit tronque la page.

uip tm perf-scenario - Exécuter

Exécutez un scénario et renvoyez son ID d'exécution. Le mode par défaut est dryRun (exécution rapide); transmettez --execution-type performanceTesting pour une exécution complète de la charge en respectant les indicateurs de profil de charge sur chaque groupe de charge. Une exécution complète nécessite qu'au moins un rapport de test soit déjà transmis; vérifiez d'abord avec list-dry-run-reports.

Options

Drapeau	Description
--scenario-key <key>	Requis. Clé d’objet de scénario (par exemple, SP1:7).
--project-key <key>	Propriétaire du projet. Facultatif — dérivé du préfixe --scenario-key lorsqu'il est omis.
--execution-type <type>	dryRun ou performanceTesting. La valeur par défaut est dryRun.
--wait	Interrogez jusqu'à ce que l'exécution atteigne un état terminal (Finished ou Cancelled), puis émettez la même forme que results get (voir Données d'exécution). Quitte la valeur non zéro si l'exécution est Cancelled, si une configuration d'automatisation a échoué ou si un SLO n'a pas été respecté.
--full	Avec --wait, incluez la série temporelle par seconde (AggregatedData + AggregatedDataWithTransaction) dans la sortie. Erreurs si transmis sans --wait.
--poll-interval-sec <n>	Avec --wait, secondes entre les vérifications de statut. La valeur par défaut est 12. Erreurs si transmis sans --wait.
--timeout-sec <n>	Avec --wait, secondes maximum à attendre (0 = aucun délai d'attente). La valeur par défaut est 1800. Erreurs si transmis sans --wait. L'expiration quitte 4 — l'exécution se poursuit, alors vérifiez-la avec results get.

Exemples

# start a dry run and return immediately
uip tm perf-scenario execute --scenario-key SP1:7

# run a full performance test and wait for the results bundle
uip tm perf-scenario execute \
  --scenario-key SP1:7 \
  --execution-type performanceTesting \
  --wait

Format de données — sans --wait

{
  "Code": "ScenarioExecute",
  "Data": {
    "ScenarioKey": "SP1:7",
    "ExecutionId": "80694766-5a44-0000-0985-0b49fd93832d",
    "ExecutionType": "dryRun",
    "Status": "Pending"
  }
}

Format de données — avec --wait

{
  "Code": "ScenarioExecutionResults",
  "Data": {
    "ExecutionId": "80694766-5a44-0000-0985-0b49fd93832d",
    "LoadGroupCount": 1,
    "LoadGroups": [
      {
        "LoadGroupId": "8e322581-0a25-0000-738b-0b49fd936ca1",
        "StartedAt": "2025-04-15T10:30:00Z",
        "CumulativeResponseTimeMs": 120,
        "MaxResponseTimeMs": 450,
        "SuccessfulWorkflowCount": 98,
        "FailedWorkflowCount": 2,
        "HttpErrorCount": 0,
        "HttpErrorRate": 0,
        "AutomationErrorCount": 2,
        "AutomationErrorRate": 0.02,
        "SloViolationReasons": []
      }
    ],
    "LogCount": 12,
    "ApplicationLogs": [
      {
        "CreatedAt": "2025-04-15T10:31:00Z",
        "LogLevel": "Information",
        "ExecutionId": "80694766-5a44-0000-0985-0b49fd93832d",
        "Message": "Execution finished"
      }
    ]
  }
}

--wait interroge results get en interne, il s'agit donc de la même forme de charge utile que results get renvoie pour une exécution terminée - execute --wait enregistre simplement une deuxième commande. Un tableau SloViolationReasons non vide sur un groupe de charge, ou une exécution de configuration du journal d’application se termine avec le statut « échoué»;, ce qui rend la sortie de la commande non nulle, même si l’exécution a atteint un état terminal.

arrêt du scénario de performances uip tm

Annulez l’exécution d’un scénario en cours.

Options

Drapeau	Description
--execution-id <uuid>	Requis. UUID d’exécution de scénario (le ExecutionId de execute).
--project-key <key>	Requis. Propriétaire du projet.

Exemple

uip tm perf-scenario stop --execution-id 80694766-5a44-0000-0985-0b49fd93832d --project-key SP1

Format des données

{
  "Code": "ScenarioStop",
  "Data": {
    "ExecutionId": "80694766-5a44-0000-0985-0b49fd93832d",
    "Result": "Stopping",
    "Note": "Server has accepted the cancel request. Run 'perf-scenario results get --execution-id <ID>' to confirm terminal status (will be 'Cancelled')."
  }
}

Result: "Stopping" indique que le serveur a accepté la demande d'annulation, et non que l'exécution s'est encore arrêtée — l'annulation est asynchrone.

uip tm perf-scenario list-Dry-run-reports

Répertoriez des rapports de test réussis pour un scénario. Exécutez cette option avant de soumettre une performanceTesting exécution complète — une exécution complète nécessite qu'un rapport de test disponible existe déjà pour l'automatisation de chaque groupe de charge.

Options

Drapeau	Description
--scenario-key <key>	Requis. Clé d’objet de scénario (par exemple, SP1:7).
--project-key <key>	Propriétaire du projet. Facultatif — dérivé du préfixe --scenario-key lorsqu'il est omis.

Exemple

uip tm perf-scenario list-dry-run-reports --scenario-key SP1:7

Format des données

{
  "Code": "ScenarioDryRunReports",
  "Data": {
    "ScenarioKey": "SP1:7",
    "ScenarioId": "756e8ebf-c227-0000-8a9f-0b49fd934bef",
    "HasPassingDryRun": true,
    "ReportCount": 1,
    "Reports": [
      {
        "AutomationId": "auto-1",
        "RuntimeType": 4,
        "RecommendedMultiplexingFactor": 3,
        "ApplicationType": null
      }
    ]
  }
}

Un tableau Reports vide (et HasPassingDryRun: false) signifie qu'aucun groupe de charge n'a encore fait l'objet d'un test de test. Exécutez d'abord execute (mode dryRun par défaut). Cette commande génère une erreur au lieu de renvoyer un résultat vide si le scénario n’a pas de groupes de charge, ou si aucun cas de test de ses groupes de charge ne comporte une automatisation liée.

Associé

• Groupes de charge : liez les cas de test à un scénario et ajustez leur profil de charge.
• Données d’exécution : inspectez une exécution terminée ou en cours.
• Rapports : rendent les rapports créés à des fins d’exécution ou de comparaison.
• testcases — link-automation est ce qui donne à un cas de test le automationId duquel dépendent load-groups add et list-dry-run-reports .
• project — étendue qui possède chaque scénario.

Voir également

• Vue d’ensemble de Test Manager