cenário-perf do uip tm

Sintaxe e opções para "uip tm perf-scenario", que cria e executa cenários de desempenho do Test Manager, inspeciona dados de execução e gera relatórios.

uip tm perf-scenario gerencia cenários de desempenho do Test Manager: crie um cenário, associe casos de teste a ele como grupos de carga com um perfil de carga (usuários virtuais, tempo de aceleração/pico/ramificação de redução, limites de SLO), execute-o como uma simulação rápida ou um teste de carga completa, em seguida, inspecione os dados de execução resultantes e renderize relatórios.

Importante:

Esta página documenta um grupo de comando real e totalmente fornecido — ele é registrado incondicionalmente ao lado de todos os outros comandos uip tm, não atrás de um sinalizador de funcionalidade. Se você foi informado de que esta superfície não existe ou é pré-lançamento, verifique diretamente com uip tm perf-scenario --help.

Esse recurso abrange quatro páginas:

• Esta página — conceitos e o ciclo de vida do cenário: create, get, list, execute, stop, list-dry-run-reports.
• Grupos de carga — load-groups add/update/remove/list, a associação de caso de teste a cenário e seu perfil de carga.
• Dados de execução — executions list, results get, http-errors list, automation-errors list, transaction-metrics list.
• Relatórios — report generate, report compare.

Conceitos

• Cenário — a definição do teste de desempenho de nível superior (--scenario-key, por exemplo SP1:7). Criado com create, inspecionado com get, executado com execute.
• Grupo de carga — um caso de teste vinculado a um cenário com um perfil de carga (usuários virtuais, tempo, limites de SLO, tipo de robô). Um cenário pode ter vários grupos de carga. Consulte Carregar grupos.
• Execução — uma execução de um cenário, seja uma dryRun (execução rápida de validação) ou performanceTesting (execução de carga completa honrando o perfil de carga de cada grupo de carga). Iniciado com execute, inspecionado por meio de Dados de execução e interrompido mais cedo com stop.
• Relatório de simulação — o Serviço de desempenho registra um relatório após uma simulação de aprovação. Uma execução performanceTesting completa requer pelo menos um relatório de simulação de passagem para já existir; verifique com list-dry-run-reports antes de executar um teste de carga completa.

A maioria dos verbos lidos em todas as quatro páginas aceita --query <expr>, um filtro estilo jq aplicado do lado do cliente à saída Data antes de ser impresso — use-o para restringir uma grande carga (consulte o exemplo list abaixo).

Resumo

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

Todos os verbos honram as opções globais e os códigos de saída padrão. Cada verbo em todas as quatro páginas perf-scenario aceita --log-level <level> (padrão Information).

Observação:

--project-key é apenas um .requiredOption() em create e stop nesta página (e em load-groups update/remove/list — consulte Carregar grupos). Em get, execute e list-dry-run-reports é opcional — o projeto é derivados do prefixo de --scenario-key (por exemplo, SP1:7 → projeto SP1) quando omitido, e --project-key substitui essa ramificação se aprovado. Os verbos nas páginas Dados de execução e Relatórios não aceitam --project-key (exceto, opcionalmente, nos dois verbos report , onde afeta apenas se o link retornado abre a página do relatório no aplicativo) — esses verbos chamam o Performance Service diretamente em vez de resolver um projeto do Test Manager.

Criação de cenário-perf do uip tm

Crie um cenário de desempenho em um projeto do Test Manager.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Proprietário do projeto.
--name <name>	Obrigatório. Nome do cenário.
--description <text>	Descrição do cenário. O padrão é vazio. Limitado a 5120 caracteres.
--version <version>	String de versão do cenário. O padrão é 1.0. Limitado a 255 caracteres.
--app-type <type>	Tipo de aplicativo: web, apiService, ecommerce, gaming, financial, healthcare, saaS, streaming, messaging, enterprise. O padrão é web.
--perf-test-type <type>	Tipo de teste de desempenho: loadTesting, stressTesting, enduranceTesting, spikeTesting. O padrão é loadTesting.
--responsiveness <level>	Capacidade de resposta esperada: instant, fast, moderate, slow, verySlow. O padrão é fast.

Exemplo

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

Formato dos dados

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

uip tm perf-cenario obter

Obtenha os metadados de um cenário e os grupos de carga associados a ele.

Opções

Bandeira	Description
--scenario-key <key>	Obrigatório. Chave do objeto do cenário (por exemplo, SP1:7).
--project-key <key>	Proprietário do projeto. Opcional — derivados do prefixo --scenario-key quando omitido.

Exemplo

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

Formato dos dados

{
  "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 é o ID do grupo de carga do cenário — o identificador load-groups update e load-groups remove esperado (consulte Grupos de carga). Este é um ID diferente das linhas por execução retornadas por load-groups list.

lista de perf-scenario do uip tm

Listar os cenários de desempenho em um projeto.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Proprietário do projeto.
--search <text>	Filtre cenários por nome ou chave.
--limit <n>	Máximo de resultados a serem retornados. O padrão é o tamanho da página do próprio serviço quando omitido.
--offset <n>	Resultados a ignorar para paginação. O padrão é 0.
--query <expr>	filtro no estilo jq aplicado aos dados de saída.

Exemplos

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

Formato dos dados

{
  "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 é a contagem total de correspondências relatada pelo servidor, que pode exceder Count (o número de linhas realmente retornadas) quando --limit trunca a página.

Execução do cenário-perf do uip tm

Executar um cenário e retornar o ID de execução. O modo padrão é dryRun (execução rápida de tests); passe --execution-type performanceTesting para uma execução com carga completa honrando os sinalizadores de perfil de carga em cada grupo de carga. Uma execução completa requer pelo menos um relatório de simulação de passagem para já existir — verifique com list-dry-run-reports primeiro.

Opções

Bandeira	Description
--scenario-key <key>	Obrigatório. Chave do objeto do cenário (por exemplo, SP1:7).
--project-key <key>	Proprietário do projeto. Opcional — derivados do prefixo --scenario-key quando omitido.
--execution-type <type>	dryRun ou performanceTesting. O padrão é dryRun.
--wait	Pesquise até que a execução atinja um estado terminal (Finished ou Cancelled) e, em seguida, emita o mesmo formato que results get (consulte Dados de execução). Sairá diferente de zero se a execução for Cancelled, uma configuração de automação falhar ou um SLO tiver sido violado.
--full	Com --wait, inclua a série temporal por segundo (AggregatedData + AggregatedDataWithTransaction) na saída. Erros se passado sem --wait.
--poll-interval-sec <n>	Com --wait, segundos entre verificações de status. O padrão é 12. Erros se passado sem --wait.
--timeout-sec <n>	Com --wait, máximo de segundos para esperar (0 = sem tempo limite). O padrão é 1800. Erros se passado sem --wait. Saídas decorridos 4 — a execução continua, portanto, verifique novamente com results get.

Exemplos

# 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

Formato dos dados — sem --wait

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

Formato dos dados — com --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 pesquisa results get internamente, então essa é a mesma forma de carga que results get retorna para uma execução finalizada — execute --wait salva apenas um segundo comando. Uma matriz SloViolationReasons não vazia em qualquer grupo de carga ou um log de aplicativo correspondente a "execução da configuração terminou com o status "falha" faz com que o comando saia diferente de zero mesmo que a execução tenha atingido um estado terminal.

parada de perf-scenario do uip tm

Cancele a execução de um cenário em execução.

Opções

Bandeira	Description
--execution-id <uuid>	Obrigatório. UUID de execução do cenário (o ExecutionId de execute).
--project-key <key>	Obrigatório. Proprietário do projeto.

Exemplo

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

Formato dos dados

{
  "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" reflete que o servidor aceita a solicitação de cancelamento, não que a execução ainda tenha sido interrompida — o cancelamento é assíncrono.

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

Listar relatórios de simulação bem-sucedidos de um cenário. Execute isso antes de enviar uma execução performanceTesting completa — uma execução completa requer que um relatório de simulação de passagem já exista para a automação de cada grupo de carga.

Opções

Bandeira	Description
--scenario-key <key>	Obrigatório. Chave do objeto do cenário (por exemplo, SP1:7).
--project-key <key>	Proprietário do projeto. Opcional — derivados do prefixo --scenario-key quando omitido.

Exemplo

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

Formato dos dados

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

Uma array Reports vazia (e HasPassingDryRun: false) significa que nenhum grupo de carga tem ainda uma simulação — execute execute (modo padrão dryRun) primeiro. Esse comando falha em vez de retornar um resultado vazio se o cenário não tiver grupos de carga ou se nenhum dos casos de teste dos seus grupos de carga carregar uma automação vinculada.

Relacionado

• Grupos de carga — associe casos de teste a um cenário e ajuste seu perfil de carga.
• Dados de execução — inspecione uma execução finalizada ou em andamento.
• Relatórios — renderize relatórios criados para uma execução ou uma comparação.
• casos de teste — link-automation é o que dá a um caso de teste o automationId do qual load-groups add e list-dry-run-reports dependem.
• projeto — escopo que possui cada cenário.

Veja também

• Visão geral do Test Manager