--- sourceDocument: Referência de API do Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference Release : - xanadu ft:locale : - pt-BR ft:publication_title : - Referência de API do Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Cloud Runner TestRunnerApi -- Com escopo, global # Cloud Runner TestRunnerApi -- Com escopo, global {#ariaid-title1} * Versão de lançamento: Xanadu * * Atualizado 1 de ago. de 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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. {#cloudrnr-TestRunnerAPI-scoped__cloudrnr-TestRunnerAPI-scoped_ul_vwb_wvn_31c} No escopo global, esta API é executada no namespace sn_atf_tg. Você deve ter o plug-in [ATF Test Generator and Cloud Runner](https://www.servicenow.com/docs/access?context=atf-tg-cr-intro&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) (sn_atf_tg) ativado para usar esta API. Consulte também: * [Cloud Runner TestGenerationApi -- Com escopo, global](https://servicenow-prod.fluidtopics.net/zt~Oln47K8guNs44Pk~gIw#cloudrnr-TestGenerationAPI-scoped "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.") * [Cloud Runner TestUserApi -- Com escopo, global](https://servicenow-prod.fluidtopics.net/SkEEyPdhfDtWRgdLG~w3sg#cloudrnr-TestUserAPI-scoped "Gerencia trabalhos de usuário de teste a serem executados em um executor na nuvem para Automated Test Framework (ATF). Esta API faz parte da inclusão de script CloudRunnerApi.") * [API REST do usuário de teste do executor na nuvem](https://servicenow-prod.fluidtopics.net/1ZWNf0zT2r2LCZa49bpDdw#cloudrunner-testuser-api "Gerencia trabalhos de usuário de teste a serem executados em um executor na nuvem para Automated Test Framework (ATF).") {#cloudrnr-TestRunnerAPI-scoped__ul_gd4_zsn_31c} ## TestRunnerApi -- cancelJob(cadeia de caracteres snboqId) {#ariaid-title2} 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. {#cr-TestRunnerAPI-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestRunnerAPI-cancelJob_S__cr-snboqId-ph-desc} | 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 1. Parâmetros] {#cr-TestRunnerAPI-cancelJob_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-cancelJob_S__table_fpx_lv4_g1c__entry__2} | Tipo | Descrição | |-|-| | nulo | Nulo se for bem-sucedido, mensagem de erro caso contrário. | [Tabela 2. Retorna] {#cr-TestRunnerAPI-cancelJob_S__table_fpx_lv4_g1c} 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": "" }); 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) {#ariaid-title3} Fornece o status de cada teste executado para um registro de Fila de Orquestração de Navegador (BOQ) fornecido. {#cr-TestRunnerAPI-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestRunnerAPI-progress_S__cr-snboqId-ph-desc} | 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 3. Parâmetros] {#cr-TestRunnerAPI-progress_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-progress_S__table_fpx_lv4_g1c__entry__2}{#cr-TestRunnerAPI-progress_S__cr-prog-state-ph-desc} | 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.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-pending} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-pending} * 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.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-brsreq} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-brsreq} * Em execução -- Os navegadores de infraestrutura em nuvem localizam e executam testes pendentes. * Concluído -- A tarefa de teste está concluída.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-complete} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-complete} * Estado de falha -- A tarefa de teste falhou.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-failed} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-failed} {#cr-TestRunnerAPI-progress_S__ul_rvl_vsg_l1c} 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 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\]. {#cr-TestRunnerAPI-progress_S__ul_wqr_slb_j1c} | [Tabela 4. Retorna] {#cr-TestRunnerAPI-progress_S__table_fpx_lv4_g1c} 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": "" }); 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) {#ariaid-title4} Inicia um teste ATF ou um pacote de testes no navegador Cloud Runner. {#cr-TestRunnerAPI-startJob_S__table_epx_lv4_g1c__entry__3} | 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\] {#cr-TestRunnerAPI-startJob_S__ul_gqc_yj4_l1c} | [Tabela 5. Parâmetros] {#cr-TestRunnerAPI-startJob_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-startJob_S__table_fpx_lv4_g1c__entry__2} | 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\]. | [Tabela 6. Retorna] {#cr-TestRunnerAPI-startJob_S__table_fpx_lv4_g1c} 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": "" }); gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId}))); CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId}); Saída: {progress: 64, state: running}