Teste de cliente REST usando a ferramenta Restito: O que é Rest Client?

O que é RESTO?

DESCANSO significa “Transferência de Estado Representacional”, que é uma nova forma de comunicação entre quaisquer dois sistemas em um determinado momento. Um dos sistemas é denominado 'REST Client' e o outro é denominado 'REST Server'.

Antes de aprender sobre o Restito Framework para testes de cliente REST, vamos primeiro aprender alguns princípios básicos.

O que é cliente REST?

Cliente REST é um método ou ferramenta para invocar uma API de serviço REST que é exposta para comunicação por qualquer sistema ou provedor de serviços. Por exemplo: se uma API for exposta para obter informações de tráfego em tempo real sobre uma rota do Google, o software/ferramenta que invoca a API de tráfego do Google é chamado de cliente REST.

O que é servidor REST?

É um método ou API exposto à comunicação por qualquer sistema ou provedor de serviços. Por exemplo, o Google expõe uma API para obter informações de tráfego em tempo real em uma determinada rota.

Aqui, o servidor do Google precisa estar instalado e funcionando para ouvir quaisquer solicitações à API exposta de diferentes clientes.

Exemplo:

É hora de estabelecer um cenário completo de ponta a ponta a partir das definições acima.

Consideremos um aplicativo de reserva de táxi como o Uber, pois uma empresa precisa de informações em tempo real sobre a situação do trânsito nas rotas em que um determinado veículo está localizado.

Cliente de descanso:

Aqui, o cliente é um aplicativo móvel da Uber no qual o motorista está conectado. Este aplicativo envia uma solicitação à API REST exposta pelo Google Maps para obter os dados em tempo real. Por exemplo, uma solicitação HTTP GET.

Servidor de descanso:

Neste exemplo, o Google é o provedor de serviços e a API do Google Maps responde com os detalhes necessários à solicitação do aplicativo Uber.

Tanto o cliente quanto o servidor são igualmente importantes na comunicação REST.

Aqui, implementamos exemplos para testes de automação apenas do cliente REST. Para testar o servidor REST, consulte https://www.guru99.com/top-6-api-testing-tool.html.

O que é Restito?

Restito é um framework desenvolvido pela Mkotsur. É um aplicativo leve para ajudá-lo a executar qualquer tipo de solicitação HTTP. Você pode usar Restito para testar suas APIs REST e pesquisar problemas em sua aplicação ou rede.

Como testar o cliente REST usando Restito?

Vamos dividir o exercício nas seguintes 4 etapas:

Crie um cliente HTTP e um método para enviar uma solicitação HTTP GET para qualquer endpoint do servidor. Por enquanto, considere o ponto final como http://localhost:9092/getevents.

Inicie um servidor Restito para escutar e capturar as solicitações enviadas ao endpoint 'getevents' em localhost http://localhost:9092/getevents.

Crie uma classe de teste para testar o cliente acima. Invoque o método 'sendGETRequest' do cliente HTTP para iniciar uma solicitação GET para a API 'getevents'.

Valide a chamada HTTP GET usando o framework Restito.

Vamos nos aprofundar em cada uma das etapas acima.

Passo 1) Crie um cliente HTTP e um método para enviar uma solicitação HTTP GET para qualquer endpoint do servidor.

========== CÓDIGO JAVA começa ===========

package com.chamlabs.restfulservices.client;

import java.util.HashMap;
import java.util.Map;

import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.HttpClientBuilder;
import org.json.JSONObject;

/**
 * This class creates a HTTP Client and has a method to send HTTP GET request: 
 * 		sendGETRequest(..)
 */
public class RestClient {
	/**
	 * Constructor for the  class RestClient	
	 */
	public RestClient() {
		System.out.println("Creating RestClient constructor");
	}

	/**
	 * Method to Send GET request to http://localhost:<<port>>/getevents
	 * @param port
	 * @return true if GET request is successfully sent. False, otherwise.
	 */
	public static boolean sendGETRequest(int port) {
		try {
			HttpClient client = HttpClientBuilder.create().build();
			HttpGet getRequest = new HttpGet("http://localhost:" + port + "/getevents");
			//HttpResponse response = client.execute(request);
			client.execute(getRequest);
			System.out.println("HTTP request is sent successfully."
					+ "Returning True");
			return true;
		} 
		
		catch (Exception e) {
			e.printStackTrace();
		}
		System.out.println("Some exception has occurred during the HTTP Client creation."
				+ "Returning false");
		return false;
	}
}

========== CÓDIGO JAVA termina ===========

Passo 2) Inicie um servidor Restito para escutar e capturar as solicitações enviadas ao endpoint 'getevents' em localhost http://localhost:9092/getevents.

========== CÓDIGO JAVA começa ===========

package com.chamlabs.restfultesting.util;

import static com.xebialabs.restito.builder.stub.StubHttp.whenHttp;
import static com.xebialabs.restito.semantics.Action.status;
import static com.xebialabs.restito.semantics.Condition.get;
import static com.xebialabs.restito.semantics.Condition.post;
import java.util.List;
import org.glassfish.grizzly.http.util.HttpStatus;
import com.xebialabs.restito.semantics.Call;
import com.xebialabs.restito.server.StubServer;

/**
 * This utility class contains several utility methods like : 
 * 		restartRestitoServerForGETRequests(..)
 * 		restartRestitoServerForPOSTRequests(..) 
 * 		waitAndGetCallList(..)
 * 
 * @author cham6
 * @email: paperplanes.chandra@gmail.com
 * @fork: https://github.com/cham6/restfultesting.git
 *
 */
public class TestUtil {
	
	/**
	 * Utility method to start restito stub server to accept GET requests
	 * @param server
	 * @param port
	 * @param status
	 */
	public static void restartRestitoServerForGETRequests (StubServer server, int port, HttpStatus status)
    {
        // Kill the restito server
        if (server != null) {
            server.stop();
        }
        // Initialize and configure a newer instance of the stub server
        server = new StubServer(port).run();
        whenHttp(server).match(get("/getevents")).then(status(status));
    }
	
	/**
	 * Utility method to start restito stub server to accept POST requests
	 * @param server
	 * @param port
	 * @param status
	 */
	public static void restartRestitoServerForPOSTRequests (StubServer server, int port, HttpStatus status)
    {
        // Kill the restito server
        if (server != null) {
            server.stop();
        }
        // Initialize and configure a newer instance of the stub server
        server = new StubServer(port).run();
        whenHttp(server).match(post("/postevents")).then(status(status));
    }
	
	/**
     * For a given restito stub server, loop for the given amount of seconds and
     * break and return the call list from server.
     * 
     * @param server
     * @param waitTimeInSeconds
     * @return
     * @throws InterruptedException
     */
	public static List<Call> waitAndGetCallList (StubServer server, int waitTimeInSeconds)
        throws InterruptedException
    {
        int timeoutCount = 0;
        List<Call> callList = server.getCalls();
        while (callList.isEmpty()) {
            Thread.sleep(1000);
            timeoutCount++;
            if (timeoutCount >= waitTimeInSeconds) {
                break;
            }
            callList = server.getCalls();
        }
        // Wait for 2 seconds to get all the calls into callList to Eliminate any falkyness.
        Thread.sleep(2000);
        return server.getCalls();
    }


}

========== CÓDIGO JAVA termina ===========

Passo 3) Crie uma classe de teste para testar o cliente acima. Invoque o método sendGETRequest do cliente HTTP para iniciar uma solicitação GET para a API 'getevents'.

========== CÓDIGO JAVA começa ===========

import junit.framework.TestCase;

import com.chamlabs.restfulservices.client.RestClient;
import com.chamlabs.restfultesting.util.TestUtil;
import com.xebialabs.restito.semantics.Call;
import com.xebialabs.restito.server.StubServer;
import static org.glassfish.grizzly.http.util.HttpStatus.ACCEPTED_202;
import org.json.JSONObject;
import java.util.List;
import java.util.Map;

/**
 * This class contains several junit tests to validate the RestClient operations like: 
 * 		sendRequest(..)
 * 		sendRequestWithCustomHeaders(..) 
 * 		sendPOSTRequestWithJSONBody(..)
 *
 */

public class RestClientTester extends TestCase {
	
    private static final Integer PORT = 9098;
    private static final Integer PORT2 = 9099;
    private static final Integer PORT3 = 9097;
	
    public RestClientTester() {
    	System.out.println("Starting the test RestClientTester");
    }
    /**
     * Junit test to validate the GET request from RestClient
     * Steps:
     * 		1) Create a stub server using Restito framework and configure it to listen on given port
     * 		2) Invoke the sendGETRequest(..) method of RestClient
     * 		3) Restito captures the matching GET requests sent, if any.
     * 		4) Validate if Restito has captured any GET requests on given endpoint
     * Expected Behavior:
     * 		> Restito should have captured GET request and it should have captured only one GET request.
     * Finally:
     * 		> Stop the stub server started using restito.
     */
	public void testGETRequestFromClient() {
		
		StubServer server = null;
		try {
		//This will start the stub server on 'PORT' and responds with HTTP 202 'ACCEPTED_202'
		TestUtil.restartRestitoServerForGETRequests(server, PORT, ACCEPTED_202);
		
		RestClient.sendGETRequest(PORT);
		
		List<Call> callList = TestUtil.waitAndGetCallList(server, 30);
		assertTrue("GET request is not received from the RestClient. Test failed.", 
				(callList != null) && (callList.size() == 1));
		}
		catch(Exception e) {
			e.printStackTrace();
			fail("Test Failed due to exception : " + e);
		}
		finally {
			if(server != null) {
				server.stop();
            }
		}	
	}

========== CÓDIGO JAVA termina ===========

Passo 4) Como validar a solicitação GET com Headers e a solicitação POST com o corpo usando o framework Restito.

========== CÓDIGO JAVA começa ===========

/**
     * Junit test to validate the GET request with headers from RestClient
     * Steps:
     * 		1) Create a stub server using Restito framework and configure it to listen on given port
     * 		2) Invoke the sendGETRequestWithCustomHeaders(..) method of RestClient
     * 		3) Restito captures the matching GET requests sent, if any. 
     * 		4) Validate if Restito has captured any GET requests on a given endpoint
     * Expected Behavior:
     * 		> Restito should have captured GET request, and it should have captured only one GET request.
     * 		> Get the headers of the captured GET request 
     * 		  and make sure the headers match to the ones configured.
     * Finally:
     * 		> Stop the stub server started using restito.
     */

public void testGETRequestWithHeadersFromClient() {
		StubServer server = null;
		
		try {
		//This will start the stub server on 'PORT' and responds with HTTP 202 'ACCEPTED_202'
			TestUtil.restartRestitoServerForGETRequests(server, PORT2, ACCEPTED_202);
		
		RestClient.sendGETRequestWithCustomHeaders(PORT2);
		
		List<Call> callList = TestUtil.waitAndGetCallList(server, 30);
		assertTrue("GET request is not received from the RestClient. Test failed.", 
				(callList != null) && (callList.size() == 1));
		
		//Validate the headers of the GET request from REST Client
		Map<String, List<String>> headersFromRequest = callList.get(0).getHeaders();
		assertTrue("GET request contains header Accept and its value ",
				headersFromRequest.get("Accept").contains("text/html"));
		assertTrue("GET request contains header Authorization and its value ",
				headersFromRequest.get("Authorization").contains("Bearer 1234567890qwertyuiop"));
		assertTrue("GET request contains header Cache-Control and its value ",
				headersFromRequest.get("Cache-Control").contains("no-cache"));
		assertTrue("GET request contains header Connection and its value ",
				headersFromRequest.get("Connection").contains("keep-alive"));
		assertTrue("GET request contains header Content-Type and its value ",
				headersFromRequest.get("Content-Type").contains("application/json"));
		}
		catch(Exception e) {
			e.printStackTrace();
			fail("Test Failed due to exception : " + e);
		}
		finally {
			if(server != null) {
				server.stop();
            }
		}
	}

/**
     * Junit test to validate the POST request with body and headers from RestClient
     * Steps:
     * 		1) Create a stub server using Restito framework and configure it to listen on given port
     * 		2) Invoke the sendPOSTRequestWithJSONBody(..) method of RestClient
     * 		3) Restito captures the matching POST requests sent, if any.
     * 		4) Validate if Restito has captured any POST requests on given endpoint
     * Expected Behavior:
     * 		> Restito should have captured POST request and it should have captured only one POST request.
     * 		> Get the body of the captured POST request and validate the JSON values
     * Finally:
     * 		> Stop the stub server started using restito.
	 */

public void testPOSTRequestWithJSONBody() {
		StubServer server = null;
		
		try {
		//This will start the stub server on 'PORT' and responds with HTTP 202 'ACCEPTED_202'
			TestUtil.restartRestitoServerForPOSTRequests(server, PORT3, ACCEPTED_202);
		
		RestClient.sendPOSTRequestWithJSONBody(PORT3);
		
		List<Call> callList = TestUtil.waitAndGetCallList(server, 30);
		assertTrue("POST request is not received from the RestClient. Test failed.", 
				(callList != null) && (callList.size() == 1));
		
		//Validate the headers of the GET request from REST Client
		
		String requestBody = callList.get(0).getPostBody();
		JSONObject postRequestJSON = new JSONObject(requestBody);
		assertTrue("The timeUpdated in json is incorrect",
				postRequestJSON.get("timeUpdated").toString().equalsIgnoreCase("1535703838478"));
		assertTrue("The access_token in json is incorrect",
				postRequestJSON.get("access_token").toString().
				equalsIgnoreCase("abf8714d-73a3-42ab-9df8-d13fcb92a1d8"));
		assertTrue("The refresh_token in json is incorrect",
				postRequestJSON.get("refresh_token").toString().
				equalsIgnoreCase("d5a5ab08-c200-421d-ad46-2e89c2f566f5"));
		assertTrue("The token_type in json is incorrect",
				postRequestJSON.get("token_type").toString().equalsIgnoreCase("bearer"));
		assertTrue("The expires_in in json is incorrect",
				postRequestJSON.get("expires_in").toString().equalsIgnoreCase("1024"));
		assertTrue("The scope in json is incorrect",
				postRequestJSON.get("scope").toString().equalsIgnoreCase(""));
		}
		catch(Exception e) {
			e.printStackTrace();
			fail("Test Failed due to exception : " + e);
		}
		finally {
			if(server != null) {
				server.stop();
            }
		}
	}
}

========== CÓDIGO JAVA termina ===========

Vantagens de usar Restito Framework para testes de cliente REST

Aqui estão os prós/benefícios do Restito Framework para testes de cliente ReST

Não precisamos que o servidor REST real seja desenvolvido para testar o cliente REST.
Restito fornece utilitários e métodos fortes e variados para simular diferentes comportamentos de um servidor. Por exemplo: Para testar como o cliente REST se comporta quando o servidor responde com erro HTTP 404 ou erro HTTP 503.
Os servidores Restito podem ser configurados em poucos milissegundos e podem ser encerrados após a conclusão dos testes.
Restito suporta todos os tipos de conteúdo de método HTTP, como compactado, não compactado, unificado, aplicativo/texto, aplicativo/JSON, etc.

Desvantagens de usar Restito Framework para testes de cliente REST

Aqui estão os contras/desvantagens do Restito Framework para testes de cliente ReST

A fonte do cliente REST deve ser ajustada para considerar 'localhost' como uma máquina servidora.
Abrir o servidor em qualquer porta pode entrar em conflito se usarmos alguma porta comumente usada como '8080' ou '9443' etc.
É aconselhável usar portas como 9092 ou 9099, que não são comumente utilizadas por outras ferramentas.

Resumo

REST significa “REpresentational State Transfer”, que é uma nova forma padrão de comunicação entre quaisquer dois sistemas em um determinado momento.
Cliente REST é um método ou ferramenta para invocar uma API de serviço REST que é exposta à comunicação por qualquer sistema ou provedor de serviços.
No método RestServer ou em uma API exposta para comunicação por qualquer sistema ou provedor de serviços.
Restito é um aplicativo leve para ajudá-lo a executar qualquer tipo de solicitação HTTP
Crie um cliente HTTP e um método para enviar uma solicitação HTTP GET para qualquer endpoint do servidor
Inicie um servidor Restito para escutar e capturar as solicitações enviadas ao endpoint 'getevents'.
Inicie um servidor Restito para escutar e capturar as solicitações enviadas ao endpoint 'getevents' em localhost
Aqui, implementamos exemplos para testes de automação apenas do cliente REST.
Não precisamos que o servidor REST real seja desenvolvido para testar o cliente REST.
A fonte do cliente REST deve ser ajustada para considerar 'localhost' como uma máquina servidora.

O que é RESTO?

O que é cliente REST?

O que é servidor REST?

Exemplo:

Cliente de descanso:

Servidor de descanso:

O que é Restito?

Como testar o cliente REST usando Restito?

Vantagens de usar Restito Framework para testes de cliente REST

Desvantagens de usar Restito Framework para testes de cliente REST

Resumo

Assine a newsletter