TestUserApi do executor na nuvem - escopo, global

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

    • Gerencia trabalhos do usuário de teste 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 o trabalho de teste do usuário.
    • Defina o usuário da nuvem.
    • Verifique se o usuário especificado é válido.
    • Verifique o andamento do trabalho de teste do usuário.
    • 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.

    Consulte também:

    TestUserApi – cancelJob (cadeia de caracteres snboqId)

    Define o status do trabalho do usuário de teste na tabela Fila de Orquestração do Navegador [sn_atf_tg_sn_boq] como Concluído.

    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.
    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 usuário de teste para o usuário administrador, obter o andamento e cancelar o usuário de teste. Depois de confirmar o usuário bloqueado como um usuário de nuvem válido, o código define o usuário de nuvem como um administrador ITIL. No escopo global, use o namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    Saída:

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – isValidCloudUser(String username)

    Verifica se um usuário fornecido é um usuário de nuvem válido.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    nome do usuário Objeto Obrigatório. ID de usuário de um usuário válido listado na tabela Usuários [sys_user]. Este valor é fornecido como uma cadeia de caracteres em um objeto JSON. Por exemplo, "abel.tuter" .
    Tabela 4. Retornos
    Tipo Descrição
    Booliano

    Sinalizador que indica se o usuário fornecido é um usuário de nuvem válido.

    Valores válidos:
    • Verdadeiro: O usuário informado é um usuário de nuvem válido.
    • Falso: O usuário informado é inválido por um ou mais dos seguintes motivos:
      • O usuário não foi encontrado.
      • O usuário está inativo.
      • O usuário está bloqueado.
      • O usuário precisa de uma redefinição de senha.
      • O usuário não tem uma função de administrador.
      • O usuário tem acesso somente leitura.
      • O usuário tem acesso somente a serviços da Web.

    O exemplo a seguir mostra como iniciar um usuário de teste para o usuário administrador, obter o andamento e cancelar o usuário de teste. Depois de confirmar o usuário bloqueado como um usuário de nuvem válido, o código define o usuário de nuvem como um administrador ITIL. No escopo global, use o namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    Saída:

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – andamento (snboqId de cadeia de caracteres)

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

    Tabela 5. 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 6. 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 usuário de teste para o usuário administrador, obter o andamento e cancelar o usuário de teste. Depois de confirmar o usuário bloqueado como um usuário de nuvem válido, o código define o usuário de nuvem como um administrador ITIL. No escopo global, use o namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    Saída:

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – selectCloudUser(String username)

    Inicia um trabalho do usuário de teste de ponta a ponta no executor da nuvem. Se o usuário conseguir fazer login corretamente com a função de administrador, a propriedade do usuário na nuvem será definida como este usuário para execuções de testes futuras e gerações de testes na infraestrutura do executor na nuvem.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    nome do usuário Objeto Obrigatório. ID de usuário de um usuário válido listado na tabela Usuários [sys_user]. Este valor é fornecido como uma cadeia de caracteres em um objeto JSON. Por exemplo, "abel.tuter" .
    Tabela 8. Retornos
    Tipo Descrição
    Nulo Nulo se bem-sucedido. Caso contrário, mensagem de erro.
    Usuário de nuvem não é possível definir o usuário de nuvem como inválido - Este erro indica que o usuário informado é inválido por um ou mais dos seguintes motivos:
    • O usuário não foi encontrado.
    • O usuário está inativo.
    • O usuário está bloqueado.
    • O usuário precisa de uma redefinição de senha.
    • O usuário não tem uma função de administrador.
    • O usuário tem acesso somente leitura.
    • O usuário tem acesso somente a serviços da Web.

    O exemplo a seguir mostra como iniciar um usuário de teste para o usuário administrador, obter o andamento e cancelar o usuário de teste. Depois de confirmar o usuário bloqueado como um usuário de nuvem válido, o código define o usuário de nuvem como um administrador ITIL. No escopo global, use o namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    Saída:

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False

    TestUserApi – startJob (cadeia de caracteres de nome de usuário)

    Inicia um trabalho de usuário de teste de ponta a ponta no executor de nuvem.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    nome do usuário Cadeia de caracteres Obrigatório. Nome de usuário de sys_user para testar a infraestrutura de ponta a ponta do executor de nuvem.
    Tabela 10. 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 usuário de teste para o usuário administrador, obter o andamento e cancelar o usuário de teste. Depois de confirmar o usuário bloqueado como um usuário de nuvem válido, o código define o usuário de nuvem como um administrador ITIL. No escopo global, use o namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId})));

CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

    Saída:

    {progress: 64, state: running}
User is missing the following criteria: 
	User is locked out
False