Cloud Runner TestGenerationApi - com escopo, global

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 4 min. de leitura
  • Gerencia a geração de trabalhos de teste a ser executada em um executor de nuvem para Automated Test Framework (ATF). Esta API faz parte da inclusão de script CloudRunnerApi.

    Você pode usar esta API para as seguintes tarefas:
    • Inicie o trabalho de geração de teste.
    • Verifique o andamento do trabalho de geração de teste.
    • Cancele o trabalho de geração de teste.

    No escopo global, esta API é executada no namespace sn_atf_tg. . Você deve ter ATF Test Generator and Cloud Runner Plug-in (sn_atf_tg) ativado para usar esta API.

    TestGenerationApi – cancelJob(cadeia de caracteres snboqId)

    Define o trabalho de geração de teste e seu registro de conjunto de atualizações associado para o status Concluído. Cancela os rastreadores raiz de todos os testes gerados que estão em execução. Se algum trabalho de teste estiver em andamento no cancelamento, este método definirá qualquer um dos registros de teste em andamento gerados como ignorado.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    SnboqId Cadeia de caracteres Obrigatório. O sys_id do registro BOQ na tabela Fila de Orquestração do Navegador [sn_atf_tg_sn_boq].
    Tabela 2. Retornos
    Tipo Descrição
    nulo Nulo se bem-sucedido, mensagem de erro caso contrário.

    O exemplo a seguir mostra como começar a gerar testes para a tabela de incidentes e cancelar a geração de testes. No escopo global, use o namespace sn_atf_tg.

    var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
      tableEncodedQuery: "nameISincident",
      catalogEncodedQuery: "sysIdISEMPTY",
      maxTestCount: 10
    });
    
    CloudRunnerAPI.TestGenerationAPI.cancelJob({snboqId: insertedSnboqId});

    TestGenerationApi – andamento (cadeia de caracteres snboqId)

    Fornece o status de cada teste gerado para um registro BOQ (Fila de Orquestração do Navegador) fornecido.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    SnboqId Cadeia de caracteres Obrigatório. O sys_id do registro BOQ na tabela Fila de Orquestração do Navegador [sn_atf_tg_sn_boq].
    Tabela 4. Retornos
    Tipo Descrição
    Objeto Informações sobre o trabalho de teste. Você pode encontrar detalhes de teste avançados na tabela Testes gerados [sn_atf_tg_generated_test].
    {
      "testsFailed": Number,
      "testsInProgress": Number,
      "testsPending": Number,
      "testsSkipped": Number,
      "testsSucceeded": Number
    }
    TestsFailed O número de testes com falha gerados. Os motivos da falha são listados na tabela Testes gerados [sn_atf_tg_generated_test].

    Tipo de dados: Número

    TestsEm andamento O número de casos de uso que estão sendo criados.

    Tipo de dados: Número

    TestesPendentes O número de casos de uso restantes a serem gerados.

    Tipo de dados: Número

    Testesignorado O número de testes ignorados devido ao cancelamento do trabalho.

    Tipo de dados: Número

    Testesbem-sucedidos O número de testes gerados com sucesso.

    Tipo de dados: Número

    O exemplo a seguir mostra como começar a gerar testes para a tabela de incidentes, obter o andamento e cancelar a geração de testes. No escopo global, use o namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
      "tableEncodedQuery": "nameISincident",
      "catalogEncodedQuery": "sysIdISEMPTY",
      "maxTestCount": 10
    });
    
    gs.info(JSON.stringify(CloudRunnerAPI.TestGenerationAPI.progress({snboqId: snboqId})));
    
    CloudRunnerAPI.TestGenerationAPI.cancelJob({"snboqId": snboqId});

    Saída:

    {
      "testsSucceeded": 4,
      "testsFailed": 2,
      "testsPending": 2,
      "testsInProgress": 8,
      "testsSkipped": 0
    }

    TestGenerationApi – startJob(cadeia de caracteres tableEncodedQuery, cadeia de caracteres userEncodedQuery, catálogo de cadeias de caracteres EncodedQuery, número maxTestCount, número maxTestCountPerTable, Número maxTestCountPerItem, Cadeia de caracteres e-mail, Boolian separateUpdateSetPerScope, Cadeia de caracteres scopeForGeneratingTests, Cadeia de caracteres SuiteName )

    Insere um registro na tabela Fila de Orquestração do Navegador (BOQ) [sn_atf_tg_sn_boq] para iniciar um trabalho de teste.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Catálogo EncodedQuery Cadeia de caracteres Opcional. Consulta codificada que especifica os itens do catálogo (ICs) nos quais gerar testes.

    Padrão: Todos os ICs (cadeia de caracteres vazia)

    e-mail Cadeia de caracteres Opcional. Endereço de e-mail para o qual enviar uma notificação quando a geração de teste for concluída.

    Padrão: Sem e-mail (cadeia de caracteres vazia)

    MaxTestCount Número Opcional. Número máximo de testes a serem gerados.

    Valores possíveis: 1-9999

    Padrão: 9999 (valor máximo)

    MaxTestCountPerItem Número Opcional. Número máximo de testes a serem gerados por IC.

    Valores possíveis: 1-10

    Padrão: 10 (valor máximo)

    MaxTestCountPerTable Número Opcional. Número máximo de testes a serem gerados por tabela.

    Valores possíveis: 1-10

    Padrão: 10 (valor máximo)

    ScopeForGeneratingTests Cadeia de caracteres Necessário quando separateUpdateSetPerScopedefinido como falso. Sys_id do escopo no qual colocar todos os testes gerados.

    Padrão: Sem sys_id (cadeia de caracteres vazia)

    SeparateUpdateSetPerScope Booliano Opcional. Sinalizador que indica se os testes gerados devem ser separados em respectivos pacotes, conjuntos de atualizações e escopos ou se os testes devem ser colocados em um pacote, conjunto de atualizações e escopo.
    Valores válidos:
    • Verdadeiro: Os testes são colocados em seu respectivo pacote e conjunto de atualizações de acordo com o escopo de cada tabela ou item do catálogo.
    • Falso: Todos os testes gerados são colocados no mesmo pacote, conjunto de atualizações e escopo. Se falso, scopeForGeneratingTestsé obrigatório na solicitação.

    Padrão: verdadeiro

    TestSuite Cadeia de caracteres Opcional. Define o nome do pacote de testes a ser criado por meio da geração de testes.

    Tipo de dados: Cadeia de caracteres

    Pacote gerado por ATF - <time_stamp>

    TableEncodedQuery Cadeia de caracteres Opcional. Consulta codificada que especifica as tabelas nas quais gerar testes. Consulte Encoded query strings.

    Padrão: Todas as tabelas (cadeia de caracteres vazia)

    UserEncodedQuery Cadeia de caracteres Opcional. Consulta codificada que especifica os usuários para os quais gerar testes.

    Padrão: Todos os usuários (cadeia de caracteres vazia)

    Tabela 6. Retornos
    Tipo Descrição
    Cadeia de caracteres O sys_id do registro BOQ na tabela Fila de Orquestração do Navegador [sn_atf_tg_sn_boq].

    O exemplo a seguir mostra como começar a gerar testes para a tabela de incidentes. No escopo global, use o namespace sn_atf_tg.

    var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
      tableEncodedQuery: "nameISincident",
      catalogEncodedQuery: "sysIdISEMPTY",
      suiteName: "Suite123",
      maxTestCount: 10
    });
    
    gs.info(insertedSnboqId);

    Saída:

    <sys_id of inserted BOQ record>