Callouts REST do Apex

Pré-requisitos

Antes de preparar seus testes, vamos criar uma classe com os exemplos de solicitações GET e POST que executamos de forma anônima na unidade “Envio de dados para um serviço”. Esses exemplos foram um pouco modificados para as solicitações ficarem em valores de métodos e retornos, mas eles são praticamente iguais aos exemplos anteriores.

Testar um callout com o StaticResourceCalloutMock

Para testar seus callouts, use callouts simulados implementando uma interface ou usando recursos estáticos. No exemplo em questão, usamos recursos estáticos e posteriormente uma interface de simulação. O recurso estático contém o corpo de resposta que será devolvido. E lembre-se: se usar um callout simulado, a solicitação não será enviada para o ponto de extremidade. Em vez disso, o tempo de execução do Apex sabe como procurar a resposta especificada no recurso estático e apresentar exatamente essa informação. O método Test.setMock informa ao tempo de execução que callouts simulados estão sendo usados no método de teste. Vejamos os callouts simulados na prática. Em primeiro lugar, criaremos um recurso estático com uma sequência de caracteres em formato JSON que será usada para a solicitação GET.

1. No Developer Console, selecione File (Arquivo) | New (Novo) | Static Resource (Recurso estático).
2. Para o nome, insira GetAnimalResource.
3. Para o tipo MIME, selecione text/plain (texto/simples) (apesar de estarmos usando JSON).
4. Clique em Submit (Enviar).
5. Na guia que abre para o recurso, insira o conteúdo a seguir. Confira se está tudo na mesma linha, sem gerar uma quebra para a próxima. Esse é o conteúdo devolvido pelo callout simulado. Um conjunto de três criaturas da floresta.

   {"animals": ["pesky porcupine", "hungry hippo", "squeaky squirrel"]}

6. Pressione Ctrl+S para salvar.

Pronto, você criou um recurso estático! Agora, vamos adicionar um teste para o callout que use esse recurso.

1. No Developer Console, selecione File (Arquivo) | New (Novo) | Apex Class (Classe do Apex).
2. Para o nome da classe, insira AnimalsCalloutsTest e clique em OK.
3. Substitua o código gerado automaticamente pela seguinte definição de classe de teste.

   @isTest
   private class AnimalsCalloutsTest {
   
       @isTest static  void testGetCallout() {
           // Create the mock response based on a static resource
           StaticResourceCalloutMock mock = new StaticResourceCalloutMock();
           mock.setStaticResource('GetAnimalResource');
           mock.setStatusCode(200);
           mock.setHeader('Content-Type', 'application/json;charset=UTF-8');
           // Associate the callout with a mock response
           Test.setMock(HttpCalloutMock.class, mock);
           // Call method to test
           HttpResponse result = AnimalsCallouts.makeGetCallout();
           // Verify mock response is not null
           System.assertNotEquals(null,result,
               'The callout returned a null response.');
           // Verify status code
           System.assertEquals(200,result.getStatusCode(),
             'The status code is not 200.');
           // Verify content type   
           System.assertEquals('application/json;charset=UTF-8',
             result.getHeader('Content-Type'),
             'The content type value is not expected.');  
           // Verify the array contains 3 items     
           Map<String, Object> results = (Map<String, Object>) 
               JSON.deserializeUntyped(result.getBody());
           List<Object> animals = (List<Object>) results.get('animals');
           System.assertEquals(3, animals.size(),
             'The array should only contain 3 items.');          
       }   
   
   }

4. Pressione Ctrl+S para salvar.
5. Selecione Test (Teste) | Always Run Asynchronously (Sempre executar de forma assíncrona). Se não selecionar a opção Sempre executar de forma assíncrona, as execuções de teste com apenas uma classe serão feitas em sincronia. É possível abrir registros a partir da guia Testes apenas para execuções de testes síncronas.
6. Para executar o teste, selecione Test (Teste) | New Run (Nova execução).
7. Na lista Classes de teste, selecione AnimalsCalloutsTest.
8. Clique em Add Selected (Adicionar itens selecionados) | Run (Executar).

O resultado do teste será exibido na guia Testes com uma ID de execução de teste. Quando a execução do teste terminar, expanda a execução de teste para ver os detalhes. Agora, clique duas vezes em AnimalCallouts no painel Cobertura de código geral para ver que linhas foram incluídas nos seus testes.

Testar um callout com HttpCalloutMock

Oferecemos uma implementação da interface HttpCalloutMock para testar seus callouts de POST. Essa interface possibilita que você especifique a resposta enviada para o método respond. Sua classe de teste fará o tempo de execução do Apex enviar uma resposta falsa chamando o Test.setMock de novo. Para o primeiro argumento, passe HttpCalloutMock.class. Para o segundo argumento, passe uma nova instância de AnimalsHttpCalloutMock, que é sua interface de implementação do HttpCalloutMock. (Escreveremos AnimalsHttpCalloutMock no próximo exemplo.)

Test.setMock(HttpCalloutMock.class, new AnimalsHttpCalloutMock());

Agora, adicione a classe que implementa a interface do HttpCalloutMock para interceptar o callout. Se um callout HTTP for invocado em um contexto de teste, o callout não é realizado. Em vez disso, você receberá a resposta da simulação especificada na implementação do método respond em AnimalsHttpCalloutMock.

1. No Developer Console, selecione File (Arquivo) | New (Novo) | Apex Class (Classe do Apex).
2. Para o nome da classe, insira AnimalsHttpCalloutMock e clique em OK.
3. Substitua o código gerado automaticamente pela seguinte definição de classe.

   @isTest
   global class AnimalsHttpCalloutMock implements HttpCalloutMock {
       // Implement this interface method
       global HTTPResponse respond(HTTPRequest request) {
           // Create a fake response
           HttpResponse response = new HttpResponse();
           response.setHeader('Content-Type', 'application/json');
           response.setBody('{"animals": ["majestic badger", "fluffy bunny", "scary bear", "chicken", "mighty moose"]}');
           response.setStatusCode(200);
           return response; 
       }
   }

4. Pressione Ctrl+S para salvar.

Na sua classe de teste, crie o método testPostCallout para configurar o callout simulado, conforme veremos no exemplo a seguir. O método testPostCallout chama Test.setMock que, por sua vez, chama o método makePostCallout na classe AnimalsCallouts. Depois, ele verifica se a resposta devolvida é o que você especificou no método de resposta da implementação simulada.

1. Altere a classe de teste AnimalsCalloutsTest para adicionar um segundo método de teste. Clique na guia de classe e acrescente o seguinte método antes de fechar o parênteses.

   @isTest static void testPostCallout() {
       // Set mock callout class 
       Test.setMock(HttpCalloutMock.class, new AnimalsHttpCalloutMock()); 
       // This causes a fake response to be sent
       // from the class that implements HttpCalloutMock. 
       HttpResponse response = AnimalsCallouts.makePostCallout();
       // Verify that the response received contains fake values
       String contentType = response.getHeader('Content-Type');
       System.assert(contentType == 'application/json');
       String actualValue = response.getBody();
       System.debug(response.getBody());
       String expectedValue = '{"animals": ["majestic badger", "fluffy bunny", "scary bear", "chicken", "mighty moose"]}';
       System.assertEquals(actualValue, expectedValue);
       System.assertEquals(200, response.getStatusCode());
   }

2. Pressione Ctrl+S para salvar.
3. Selecione Test (Teste) | New Run (Nova execução).
4. Na lista Classes de teste, selecione AnimalsCalloutsTest.
5. Clique em Add Selected (Adicionar itens selecionados) | Run (Executar).

   O resultado do teste será exibido na guia Testes com uma nova ID de execução de teste. Quando a execução do teste terminar, expanda a execução de teste para ver os detalhes de ambos.