O que é?

A atividade de SOAP no TOTVS Automação de Testes é uma ferramenta que permite testar e automatizar chamadas a WebServices SOAP, facilitando a integração e validação de processos.

WebServices são usados para disponibilizar serviços interativos na WEB, podendo ser acessados por outras aplicações. O SOAP (Simple Object Access Protocol) está se tornando padrão para a troca de mensagens entre aplicações e Web Services, já que é uma tecnologia construída com base em XML e HTTP. Como o RM possui seus web services podemos utilizar o TOTVS Automação de Testes para testá-los.

Para que serve?

Serve para automatizar o teste e a execução de WebServices SOAP, incluindo registros, processos e outros serviços oferecidos pelo sistema RM.

Links Úteis

  1. Documentação e Download Soap Ui: https://www.soapui.org/docs/
  2. O que são WebServices: https://pt.wikipedia.org/wiki/Web_service

Exemplo de Uso 

  1. Navegue no menu do TOTVS Automação de Testes e clique em: Atividades → ServiçosSoap.
  2. Na tabela que será mostrada, clique no botão verde em destaque para criar Atividade de Soap.


Especifica a versão da atividade em questão. O objetivo de versionar uma atividade é para quando necessitamos ter mais de uma atividade em versões diferentes. Isso irá nos auxiliar a ter um histórico de atualizações e assegurar que as mudanças feitas sejam rastreáveis e reversíveis, se necessário.

Se for necessário utilizar mais de uma versão do RM no seu ambiente, é recomendado que a versão da atividade seja compatível com o sistema RM em uso. Caso contrário, pode-se optar por uma versão padrão de sua preferência.

Exemplo utilizando a versão do RM

Exemplo utilizando a versão padrão

Fornece uma descrição detalhada da atividade, explicando seu propósito e operações, facilitando a compreensão e manutenção futura.

Se ocorrer um erro durante a execução de alguma das requisições, o TOTVS Automação de Testes deve tomar medidas específicas para lidar com esse erro. As ações variam conforme o tipo e a gravidade do erro.

Logar o Erro: Caso ocorra um erro em alguma das requisições SOAP, o TOTVS Automação de Testes deverá registrar todas as informações relevantes sobre o erro no log de execuções.

      • Exemplo: Se uma requisição SOAP falhar com um erro 500, o TOTVS Automação de Testes deverá registrar essas informações nos logs para análise posterior. A execução do processo não será finalizada

Gerar Erro de Execução: Caso ocorra um erro em alguma das requisições SOAP, o TOTVS Automação de Testes deverá lançar uma exceção que interrompa a execução do processo atual.

      • Exemplo:  Se uma requisição SOAP falhar com um erro 500, o TOTVS Automação de Testes deverá registrar essas informações nos logs para análise posterior e a execução do processo será finalizada.  

Gerar Alerta e Continuar: Caso ocorra um erro alguma das requisições SOAP, o TOTVS Automação de Testes deverá registrar um alerta e continuar a execução das operações subsequentes. Isso permite que outros processos continuem sendo executados.

      • Exemplo: Se uma requisição SOAP falhar com um erro 500, o TOTVS Automação de Testes deverá registrar um alerta sobre a execução da atividade e continuar processando outras operações relacionadas sem interrupção.


Neste cadastro, é possível realizar as seguintes operações:

Permite que o TOTVS Automação de Testes recupere e liste todas as operações disponíveis no serviço web configurado. Esta funcionalidade é essencial para identificar e selecionar as operações específicas que podem ser executadas pelo serviço web.

Atenção: O Agent e o Host do RM devem estar devidamente sendo executados no servidor em questão.

Saiba mais: Agent e Servidor.

Funcionamento:

  • Inicialização: Deve-se informar o servidor e a URI correspondente. O TOTVS Automação de Testes enviará uma requisição ao serviço web para listar todas as operações disponíveis.
  • Listagem: As operações recuperadas são exibidas em uma interface onde os usuários podem visualizar e selecionar as operações desejadas.

Permite a atualização ou modificação de múltiplos campos de múltiplas requisições em uma única operação. Este recurso é utilizado para aplicar mudanças consistentes em vários elementos ao mesmo tempo, economizando tempo e reduzindo o risco de erros manuais.

Funcionamento:

  • Configuração: O usuário define os parâmetros e os registros que serão alterados em massa. É possível realizar a alteração dos seguintes campos:
    • Uri da Coleção;
    • Soap Endpoint;
    • Timeout XML;
    • Usuário;
    • Senha;
    • Domínio;

Permite executar todas as requisições definidas em uma sequência ou lote. Esta funcionalidade é útil para automatizar a execução de múltiplas operações de forma ordenada e eficiente. Para isso, escolha o servidor em que deve ser executado às requisições.

Atenção: O Agent e o Host do RM devem estar devidamente sendo executados no servidor em questão.

Saiba mais: Agent e Servidor.


Funcionamento:

  • Definição: O usuário configura uma série de requisições que devem ser executadas em sequência.
  • Execução: O TOTVS Automação de Testes processa cada requisição na ordem definida, garantindo que todas as operações sejam executadas conforme especificado.
  • Log: Será logado o resultado de cada requisição executada, assim como o seu status code.
    • Verde: A requisição foi executada com sucesso.
    • Vermelho: Houve um erro para processar a requisição.

URI (WSDL): É o endereço onde está localizado o arquivo WSDL que descreve o WebService. Este arquivo define os métodos disponíveis, os tipos de dados, e as operações que podem ser executadas pelo WebService.

SOAP Endpoint: O SOAP Endpoint é o endereço onde o serviço SOAP está disponível para receber as requisições. Este é o URL que os clientes utilizam para enviar as mensagens SOAP ao servidor

Timeout (Segundos) O Timeout define o tempo máximo (em segundos) que o TOTVS Automação de Testes deve esperar por uma resposta do WebService antes de considerar a requisição como falhada. Este campo é importante para garantir que a aplicação não fique indefinidamente esperando por uma resposta.

Descrição: Campo que permite adicionar uma descrição detalhada sobre a requisição SOAP. Pode incluir informações sobre o propósito da requisição, detalhes dos parâmetros e qualquer outra informação relevante

Status de Retorno HTTP Esperados: Lista dos códigos de status HTTP que são esperados como resposta válida do WebService em questão. Isso ajuda a identificar se a requisição foi bem-sucedida ou se encontrou algum tipo de erro.

A Mensagem é a estrutura principal de uma requisição SOAP, onde são definidos os dados a serem enviados e recebidos pelo serviço web.

Nesta aba são compostos pelos seguintes campos: 

SOAP Action: É um cabeçalho HTTP específico usado em requisições SOAP para indicar a operação ou método específico que deve ser executado pelo serviço web. Ele é essencial para o roteamento correto e processamento da solicitação pelo servidor. Sendo assim ele informa ao servidor SOAP qual operação deve ser executada, sendo útil em serviços web que expõem múltiplas operações. 

Exemplo de Soap Action:

Envelope: O envelope SOAP é o elemento raiz que define o início e o fim da mensagem SOAP.

Exemplo de Envelope:


A seção Autenticação é crucial para garantir a segurança das requisições SOAP. Nesta seção, são especificadas as credenciais necessárias (Login, senha e domínio) para acessar o serviço web.

Exemplo: 

É o processo de enviar uma mensagem SOAP a um serviço web para solicitar a execução de uma operação específica. Este processo envolve a criação e configuração de uma mensagem SOAP, incluindo a definição do envelope SOAP e a especificação do cabeçalho SOAP Action.

a. Sendo assim clique no botão em destaque para Executar a Requisição e coloque o servidor de uso.

Atenção: O Agent e o Host do RM devem estar devidamente sendo executados no servidor em questão.

Saiba mais: Agent e Servidor.

b. E para remover a requisição clique no botão em destaque Deletar requisição.



Saiba mais

As mensagens SOAP são baseadas em XML e possuem uma estrutura rígida que inclui um envelope, cabeçalhos opcionais e um corpo. Esta estrutura permite uma comunicação padronizada e extensível.

Pelo TOTVS Automação de Testes, é possível testar sua requisição SOAP antes de ser incluída em um projeto de teste.

É possível definir variáveis de ambiente para execução das atividades SOAP.

FAQ

P: O que é preciso para configurar meu ambiente para testar WebServices?

R: O Agent deve estar em execução como administrador, o Host do RM deve estar em execução e seu arquivo de configuração deve conter às keys necessárias para o seu uso.

P: Qual é o papel do SoapUI neste processo?

R: O SoapUI é utilizado para criar e testar requisições SOAP, ajudando a identificar métodos e a estruturar o XML necessário para incluir registros no sistema RM.

P: A minha atividade apresentou o seguinte erro: Erro na chamada do método ExecuteWithXmlParams. The remote server returned an error: (401) Unauthorized. O que fazer?

R: Usuário utilizado para login inválido ou vencido. 

P: A minha atividade apresentou o seguinte erro: There is an error in XML document (0, 0). O que fazer?

R: A chamada webservice aponta para uma máquina específica. Para isso, edite o campo Soap Endpoint e aponte a chamada para LOCALHOST.

  • Sem rótulos