Cloud Runner TestRunnerApi – Com escopo, global

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 3 min. de leitura
  • Gerencia testes a serem executados 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 um teste ATF ou pacote de testes no navegador do 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 o plug-in ATF Test Generator and Cloud Runner (sn_atf_tg) ativado para usar esta API.

    TestRunnerApi – cancelJob(cadeia de caracteres snboqId)

    Define o trabalho do executor de teste com o status concluído e cancela os rastreadores raiz de todos os testes gerados que estão 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. Retorna
    Tipo Descrição
    nulo Nulo se for bem-sucedido, mensagem de erro caso contrário.

    O exemplo a seguir mostra como iniciar uma simulação de um teste ATF, exibir o andamento e interromper a simulação. 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 (cadeia de caracteres snboqId)

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

    Tipo: número

    Objeto.estado Estado do registro de BOQ.
    Valores possíveis:
    • Pendente - a atividade de teste solicitada foi criada e está aguardando a execução.
    • 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 à infraestrutura em nuvem para iniciar navegadores para geração de teste ou execução de teste.
    • Em execução – Os navegadores de infraestrutura em nuvem localizam e executam testes pendentes.
    • Concluído – A tarefa de teste está concluída.
    • Estado de falha – A tarefa de teste falhou.

    Tipo: cadeia de caracteres

    Erro Se malsucedido, mensagens de erro possíveis:
    • 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 de BOQ inválido passado - o ID fornecido deve ser para um registro de BOQ na tabela Fila de Orquestração do navegador [sn_atf_tg_sn_boq].

    O exemplo a seguir mostra como iniciar uma simulação de um teste ATF, exibir o andamento e interromper a simulação. 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 teste ATF ou pacote de testes a ser executado no navegador do Cloud Runner. Localizado em uma das seguintes tabelas:
    • Teste [sys_atf_test]
    • Pacotes de testes [sys_atf_test_suite]
    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 iniciar uma simulação de um teste ATF, exibir o andamento e interromper a simulação. 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}