Cloud Runner TestUserApi – Com escopo, global

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 6 min. de leitura

    • 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.

    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 o plug-in ATF Test Generator and Cloud Runner (sn_atf_tg) ativado para usar esta API.

    Consulte também:

    TestUserApi – cancelJob(cadeia de caracteres snboqId)

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

    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.
    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 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 da nuvem válido, o código define o usuário da 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(cadeia de caracteres nome de usuário)

    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 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, {username: "abel.tuter"}.
    Tabela 4. Retorna
    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 fornecido é um usuário de nuvem válido.
    • falso: o usuário fornecido é 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 da nuvem válido, o código define o usuário da 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 (cadeia de caracteres snboqId)

    Fornece o status de cada teste de usuário para um registro de Fila de Orquestração de Navegador (BOQ) 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. 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 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 da nuvem válido, o código define o usuário da 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(cadeia de caracteres nome de usuário)

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

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    nome do usuário Objeto Obrigatório. ID 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, {username: "abel.tuter"}.
    Tabela 8. Retorna
    Tipo Descrição
    Nulo Nulo se for bem-sucedido. Caso contrário, mensagem de erro.
    Não é possível definir o usuário da nuvem como usuário da nuvem inválido – Este erro indica que o usuário fornecido é 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 da nuvem válido, o código define o usuário da 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 nome de usuário)

    Inicia um trabalho de usuário de teste de ponta a ponta no executor na 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 na nuvem.
    Tabela 10. 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 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 da nuvem válido, o código define o usuário da 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