Cloud Runner TestGenerationApi – Com escopo, global

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 4 min. de leitura
  • Gerencia a geração de trabalho de teste a ser executada em um executor na 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 o plug-in ATF Test Generator and Cloud Runner (sn_atf_tg) ativado para usar esta API.

    TestGenerationApi – cancelJob(cadeia de caracteres snboqId)

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

    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. Retorna
    Tipo Descrição
    nulo Nulo se for 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 teste. 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 de Fila de Orquestração de Navegador (BOQ) 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. Retorna
    Tipo Descrição
    Objeto Informações sobre o trabalho de teste. Você pode encontrar detalhes de testes avançados na tabela Testes gerados [sn_atf_tg_generated_test].
    {
      "testsFailed": Number,
      "testsInProgress": Number,
      "testsPending": Number,
      "testsSkipped": Number,
      "testsSucceeded": Number
    }
    testesFalha 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

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

    Tipo de dados: número

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

    Tipo de dados: número

    testesIgnorados 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 teste. 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, cadeia de caracteres catalogEncodedQuery, número maxTestCount, número maxTestCountPerTable, número maxTestCountPerItem, cadeia de caracteres de e-mail)

    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
    catalogEncodedQuery Cadeia de caracteres Opcional. Consulta codificada que especifica os itens do catálogo (ICs) nos quais os testes serão gerados.

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

    e-mail Cadeia de caracteres Opcional. Endereço de e-mail para o qual uma notificação será enviada 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)

    maxTestContPerTable 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)

    maxTestContPerItem 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)

    SeparateUpdateSetPerScope Booliano

    Opcional. Sinalizador que indica se os testes gerados devem ser separados nos respectivos pacotes, conjuntos de atualizações e escopos ou colocar os testes 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 for falso, scopeForGeneratingTests será necessário na solicitação.

    Padrão: verdadeiro

    scopeForGeneratingTests Cadeia de caracteres Obrigatório quando separateUpdateSetPerScope está definido como falso. Sys_id do escopo no qual todos os testes gerados serão colocados.

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

    tableEncodedQuery Cadeia de caracteres Opcional. Consulta codificada que especifica as tabelas nas quais os testes serão gerados. 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 nos quais os testes serão gerados.

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

    Tabela 6. Retorna
    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",
      maxTestCount: 10
    });
    
    gs.info(insertedSnboqId);

    Saída:

    <sys_id of inserted BOQ record>