REST API do executor de testes do Cloud Runner

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 8 min. de leitura

    • Gerencia testes a serem executados em um executor de nuvem para Automated Test Framework (ATF).

    . Executor de teste do Cloud Runner A API requer ATF Test Generator and Cloud Runner plug-in (sn_atf_tg). Os métodos disponíveis com esta API são executados no agora Namespace e pode ser chamado usando o Nome da API, Teste de regressão com um clique para ATF , No Explorador DA REST API. A função de administrador é necessária para acessar esta API.

    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.

    . Executor de teste do Cloud Runner A API pode ser usada em conjunto com REST API de geração de testes do Cloud Runner e. REST API do usuário de teste do executor na nuvem. Por exemplo, você pode gerar um teste (API de geração de testes do Cloud Runner) e obter o andamento do teste na fila de orquestração do navegador (API de geração de TESTES DO Cloud Runner) e verificar o número de testes aprovados ou reprovados.

    Para exibir a documentação de referência da API do Server desta API, consulte TestRunnerApi do executor na nuvem - escopo, global.

    Executor de teste do Cloud Runner - OBTENHA /now/sn_atf_tg/test_runner_progress

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

    Formato de URL

    URL padrão: GET /api/now/sn_atf_tg/test_runner_progress

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    SnboqId Obrigatório. O sys_id do registro BOQ do trabalho do executor de teste para obter o andamento.

    Tipo de dados: Cadeia de caracteres

    Tabela: BOQ [sn_atf_tg_sn_boq]
    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Andamento do trabalho BOQ recuperado com sucesso.
    400 Erro ao obter o status do registro BOQ. Retorna uma das seguintes mensagens:
    • Nenhum ID de BOQ passado - Nenhum ID de BOQ foi fornecido. Adicione o ID DO BOQ ao corpo da solicitação.
    • Registro BOQ - SYS ID inválido. Verifique se o sys_id do registro BOQ é válido e se o registro existe.
    403 Erro ao conceder acesso do usuário ao endpoint. Certifique-se de que o usuário tenha a função de administrador.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado Objeto que contém os resultados de andamento do trabalho executor de testes ou uma mensagem explicando por que a solicitação falhou.

    Tipo de dados: Objeto

    "result": { 
    "progress": 100, 
    "state": "completed" 
  }

    Ou:

    {
  "result": { 
    "message": "String" 
  } 
}
    resultado.mensagem Mensagem de erro detalhando por que o andamento do executor de teste não pode ser recuperado. O parâmetro de mensagem não é retornado em uma resposta bem-sucedida.

    Tipo de dados: Cadeia de caracteres
    result.progress Percentual que indica o quão próximo um teste está da conclusão de um teste enquanto estiver em um estado em execução.

    Tipo de dados: Número
    result.state Status atual do registro BOQ.
    Valores possíveis:
    • 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.
    • Concluída: A tarefa de teste está concluída.
    • Estado com falha: Falha na tarefa de teste.
    • Pendente: A atividade de teste solicitada foi criada e aguardando para ser executada.
    • Processamento: A instância está verificando registros para garantir que os rastreadores de execução sejam marcados para executor de nuvem antes que a solicitação seja enviada para a infraestrutura de nuvem.
    • Em execução: Os navegadores de infraestrutura em nuvem encontram e executam testes pendentes.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    A solicitação a seguir recupera o andamento do trabalho do executor de testes do registro BOQ.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress?snboqId=<sys_id of SNBOQ record>" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username:password"

    A resposta indica que o teste está 100% concluído.

    { 
  "result": { 
    "progress": 100, 
    "state": "completed" 
  } 
}

    O exemplo a seguir retorna uma mensagem de erro 400 quando nenhum ID de BOQ é aprovado.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress" \
--request GET \
--header "Accept:application/json" \
--user "username:password"

    Resposta:

    {
  "result": {
    "message": "No SNBOQ ID passed in, add snboqId to request body"
  }
}

    O exemplo a seguir retorna uma mensagem de erro 400 quando um ID de BOQ inválido é aprovado.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress?snboqId=invalid_sys_id" \
--request GET \
--header "Accept:application/json" \
--user "username:password"

    Resposta:

    {
  "result": {
    "message": "Invalid SNBOQ sys_id passed in"
  }
}

    Executor de teste do Cloud Runner - POST /now/sn_atf_tg/cancel_test_runner

    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.

    Formato de URL

    URL padrão: GET /now/sn_atf_tg/cancel_test_runner

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    SnboqId Sys_id do registro Fila de Orquestração do Navegador (BOQ) (sn_atf_tg_sn_boq) associado ao trabalho do executor de testes a ser cancelado.

    Tipo de dados: Cadeia de caracteres

    Tabela: BOQ [sn_atf_tg_sn_boq]

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Erro ao cancelar o trabalho. Retorna uma das seguintes mensagens:
    • Nenhum ID de BOQ passado - Nenhum ID de BOQ foi fornecido. Adicione o ID DO BOQ ao corpo da solicitação.
    • Registro BOQ - SYS ID inválido. Verifique se o sys_id do registro BOQ é válido e se o registro existe.
    403 Erro ao conceder acesso do usuário ao endpoint. Certifique-se de que o usuário tenha a função de administrador.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado Objeto que contém os resultados da solicitação.
    
  "result": { 
    "message": String
  }

    Tipo de dados: Objeto
    resultado.mensagem Mensagem detalhando se o cancelamento do teste foi bem-sucedido.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir mostra como formar uma solicitação de cancelamento do executor de teste de acordo com o sys_id do registro BOQ.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/cancel_test_runner" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"snboqId\":\"<sys_id of BOQ record>\"}" \ 
--user "username:password"

    A mensagem de resposta indicando que o executor do teste foi cancelado com sucesso.

    { 
  "result": { 
    "message": "success" 
  } 
}

    Executor de teste do Cloud Runner - POST /now/sn_atf_tg/test_runner

    Insere um trabalho de executor de testes na tabela BOQ [sn_atf_tg_sn_boq] para determinado teste ou pacote de testes, que é executado no executor de nuvem.

    Formato de URL

    URL padrão: PUBLICAÇÃO now/sn_atf_tg/test_runner

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    TestId Sys_id do teste [sys_atf_test] ou pacote de testes [sys_atf_test_suite] a ser executado no executor da nuvem.

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 18. Códigos de status
    Código do status Descrição
    200 Trabalho BOQ do executor de testes inserido com sucesso.
    400 Erro ao iniciar o trabalho do executor de testes. Retorna uma das seguintes mensagens:
    • Teste ou pacote de testes com SYS ID <testId> - ID de teste inválido. Certifique-se de que o sys_id do registro de teste (sys_atf_test) ou pacote de testes (sys_atf_test_suite) seja válido e o registro exista.
    • Nenhum ID de teste aprovado - Nenhum ID de teste foi aprovado. Adicione o ID de teste ao corpo da solicitação.
    403 Erro ao conceder acesso do usuário ao endpoint. Certifique-se de que o usuário tenha a função de administrador.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado Objeto que contém os resultados da solicitação.

    Tipo de dados: Objeto

    { 
  "result": { 
    "snboqId": "String" 
  } 
}

    Ou:

    
  "result": { 
    "message": "String"
  }
    SnboqId Sys_id do registro BOQ que é inserido quando o executor de testes é iniciado.

    Tipo de dados: Cadeia de caracteres

    Tabela: BOQ [sn_atf_tg_sn_boq]
    resultado.mensagem Mensagem de erro detalhando por que o executor de teste não pode ser iniciado.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    A solicitação a seguir insere um trabalho executor de testes na tabela BOQ [sn_atf_tg_sn_boq].

    curl "https://instance.service-now.com/api/now/sn_atf_tg/test_runner" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"testId\":\"<sys_id of ATF test or test suite>\"}" \ 
--user "username:password"

    O corpo da resposta retorna o sys_id do trabalho executor de testes que foi inserido com sucesso.

    { 
  "result": { 
    "snboqId": "<sys_id of newly inserted SNBOQ record>" 
  } 
}