TestRunnerApi do executor na nuvem - escopo, global

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 3 min. de leitura
  • Gerencia testes a serem executados 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 um teste ATF ou pacote de testes no navegador Cloud Runner.
    • Verifique o andamento do trabalho de teste.
    • Cancele o trabalho 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.

    TestRunnerApi – cancelJob (cadeia de caracteres snboqId)

    Define o trabalho do executor de testes para o status Concluído e cancela os rastreadores raiz de todos os testes gerados em execução.

    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 iniciar um teste, executar um teste ATF, exibir o andamento e interromper a execução do teste. No escopo global, use o namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
    	"testId": "<sys_id>"
    });
    
    gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));
    
    CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

    Saída:

    {progress: 64, state: running}

    TestRunnerApi – andamento (snboqId de cadeia de caracteres)

    Fornece o status de cada teste executado 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 Objeto JSON que indica o andamento do teste.
    {
      "progress": Number,
      "state": "String"
    }
    Object.progress Indica a porcentagem de andamento do teste concluída.

    Tipo: Número

    Object.state Estado do registro BOQ.
    Valores possíveis:
    • Pendente - A atividade de teste solicitada foi criada e está aguardando para ser executada.
    • Processamento - A instância está verificando registros para garantir que os rastreadores de execução sejam marcados para executor na nuvem antes que a solicitação seja enviada para a infraestrutura em nuvem.
    • Navegadores solicitados - Uma solicitação foi enviada para a infraestrutura de nuvem para iniciar os navegadores para geração de teste ou execução de teste.
    • Em execução - Os navegadores de infraestrutura em nuvem encontram e executam testes pendentes.
    • Concluída - A tarefa de teste foi concluída.
    • Estado com falha - Falha na tarefa de teste.

    Tipo: cadeia de caracteres

    Erro Possíveis mensagens de erro:
    • Nenhum ID de BOQ passado - o objeto JSON fornecido não tem uma entrada de ID de BOQ. Verifique se o objeto JSON está estruturado como SnboqId: "<sys_id>" .
    • Sys_id DO BOQ inválido passado - O ID fornecido deve ser para um registro do BOQ na tabela Fila de Orquestração do Navegador [sn_atf_tg_sn_boq].

    O exemplo a seguir mostra como iniciar um teste, executar um teste ATF, exibir o andamento e interromper a execução do teste. No escopo global, use o namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
    	"testId": "<sys_id>"
    });
    
    gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));
    
    CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

    Saída:

    {progress: 64, state: running}

    TestRunnerApi – startJob (cadeia de caracteres testId)

    Inicia um teste ATF ou um pacote de testes no navegador Cloud Runner.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    TestId Cadeia de caracteres Obrigatório. O sys_id do pacote de testes ATF ou do pacote de testes a ser executado no navegador Cloud Runner. Localizado em uma das seguintes tabelas:
    • Teste [sys_atf_test]
    • Pacotes de testes [sys_atf_test_suite]
    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 iniciar um teste, executar um teste ATF, exibir o andamento e interromper a execução do teste. No escopo global, use o namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
    	"testId": "<sys_id>"
    });
    
    gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));
    
    CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

    Saída:

    {progress: 64, state: running}