रेस्टिटो टूल का उपयोग करके REST क्लाइंट परीक्षण: रेस्ट क्लाइंट क्या है?

आरईएसटी क्या है?

बाकी इसका मतलब है "आरईप्रेजेंटेशनल स्टेट ट्रांसफर", जो किसी भी दो सिस्टम के बीच किसी निश्चित समय पर संचार का एक नया तरीका है। इनमें से एक सिस्टम को 'आरईएसटी क्लाइंट' और दूसरे को 'आरईएसटी सर्वर' कहा जाता है।

REST क्लाइंट परीक्षण के लिए रेस्टिटो फ्रेमवर्क के बारे में जानने से पहले, आइए पहले कुछ मूल बातें सीखें।

REST क्लाइंट क्या है?

REST क्लाइंट एक REST सेवा API को आमंत्रित करने का एक तरीका या उपकरण है जिसे किसी भी सिस्टम या सेवा प्रदाता द्वारा संचार के लिए उजागर किया जाता है। उदाहरण के लिए: यदि Google से किसी मार्ग के बारे में वास्तविक समय ट्रैफ़िक जानकारी प्राप्त करने के लिए कोई API उजागर किया जाता है, तो Google ट्रैफ़िक API को आमंत्रित करने वाले सॉफ़्टवेयर/टूल को REST क्लाइंट कहा जाता है।

REST सर्वर क्या है?

यह एक विधि या API है जो किसी भी सिस्टम या सेवा प्रदाता द्वारा संचार के लिए उपलब्ध है। उदाहरण के लिए, Google किसी दिए गए मार्ग पर वास्तविक समय ट्रैफ़िक जानकारी प्राप्त करने के लिए API उपलब्ध कराता है।

यहां, विभिन्न क्लाइंटों से प्रदर्शित API के लिए किसी भी अनुरोध को सुनने के लिए Google सर्वर को चालू रहना आवश्यक है।

उदाहरण:

अब समय आ गया है कि उपरोक्त परिभाषाओं से सम्पूर्ण एंड-टू-एंड परिदृश्य स्थापित किया जाए।

आइए उबर जैसे टैक्सी बुकिंग एप्लीकेशन पर विचार करें, क्योंकि कंपनी को वाहन के रूट के आसपास यातायात की स्थिति के बारे में वास्तविक समय की जानकारी की आवश्यकता होती है।

बाकी ग्राहक:

यहाँ क्लाइंट एक Uber मोबाइल एप्लीकेशन है जिस पर ड्राइवर ने लॉग इन किया है। यह ऐप वास्तविक समय डेटा प्राप्त करने के लिए Google मैप्स द्वारा प्रदर्शित REST API को अनुरोध भेजता है। उदाहरण के लिए, एक HTTP GET अनुरोध।

बाकी सर्वर:

इस उदाहरण में, गूगल सेवा प्रदाता है, और गूगल मैप्स एपीआई उबर ऐप के अनुरोध पर आवश्यक विवरण के साथ प्रतिक्रिया करता है।

REST संचार में क्लाइंट और सर्वर दोनों समान रूप से महत्वपूर्ण हैं।

यहाँ, हमने केवल REST क्लाइंट के ऑटोमेशन परीक्षण के लिए उदाहरण लागू किए हैं। REST सर्वर के परीक्षण के लिए, देखें https://www.guru99.com/top-6-api-testing-tool.html.

रेस्टिटो क्या है?

रेस्टिटो एक फ्रेमवर्क है जिसे Mkotsur द्वारा विकसित किया गया है। यह एक हल्का ऐप है जो आपको किसी भी तरह के HTTP अनुरोध को निष्पादित करने में मदद करता है। आप अपने REST API का परीक्षण करने और अपने एप्लिकेशन या अपने नेटवर्क में समस्याओं को खोजने के लिए रेस्टिटो का उपयोग कर सकते हैं।

रेस्टिटो का उपयोग करके REST क्लाइंट का परीक्षण कैसे करें?

आइये इस अभ्यास को निम्नलिखित 4 चरणों में विभाजित करें:

  1. किसी भी सर्वर एंडपॉइंट पर HTTP GET अनुरोध भेजने के लिए HTTP क्लाइंट और विधि बनाएँ। अभी के लिए, एंडपॉइंट को इस प्रकार मानें http://localhost:9092/getevents.
  1. लोकलहोस्ट में एंडपॉइंट 'getevents' पर भेजे गए अनुरोधों को सुनने और कैप्चर करने के लिए रेस्टिटो सर्वर शुरू करें http://localhost:9092/getevents.
  1. उपरोक्त क्लाइंट का परीक्षण करने के लिए एक परीक्षण क्लास बनाएँ। API 'getevents' को GET अनुरोध आरंभ करने के लिए HTTP क्लाइंट 'sendGETRequest' विधि को लागू करें।
  1. रेस्टिटो फ्रेमवर्क का उपयोग करके HTTP GET कॉल को मान्य करें।

आइये उपरोक्त प्रत्येक चरण पर गहराई से विचार करें।

चरण 1) किसी भी सर्वर एंडपॉइंट पर HTTP GET अनुरोध भेजने के लिए एक HTTP क्लाइंट और विधि बनाएं।

========== जावा कोड प्रारंभ ===========

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;
	}
}

========== जावा कोड समाप्त ===========

चरण 2) लोकलहोस्ट में एंडपॉइंट 'getevents' पर भेजे गए अनुरोधों को सुनने और कैप्चर करने के लिए रेस्टिटो सर्वर शुरू करें http://localhost:9092/getevents.

========== जावा कोड प्रारंभ ===========

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();
    }


}

========== जावा कोड समाप्त ===========

चरण 3) उपरोक्त क्लाइंट का परीक्षण करने के लिए एक परीक्षण क्लास बनाएँ। API 'getevents' को GET अनुरोध आरंभ करने के लिए HTTP क्लाइंट sendGETRequest विधि को लागू करें।

========== जावा कोड प्रारंभ ===========
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();
            }
		}	
	}

========== जावा कोड समाप्त ===========

चरण 4) रेस्टिटो फ्रेमवर्क का उपयोग करके हेडर के साथ GET अनुरोध और बॉडी के साथ POST अनुरोध को कैसे मान्य करें।

========== जावा कोड प्रारंभ ===========

/**
     * 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();
            }
		}
	}
}

========== जावा कोड समाप्त ===========

REST क्लाइंट परीक्षण के लिए रेस्टिटो फ्रेमवर्क का उपयोग करने के लाभ

ReST क्लाइंट परीक्षण के लिए रेस्टिटो फ्रेमवर्क के लाभ/सुविधाएँ यहाँ दी गई हैं

  • हमें REST क्लाइंट का परीक्षण करने के लिए वास्तविक REST सर्वर विकसित करने की आवश्यकता नहीं है।
  • रेस्टिटो सर्वर के विभिन्न व्यवहार का मॉक करने के लिए मजबूत और विविध उपयोगिताएँ और विधियाँ प्रदान करता है। उदाहरण के लिए: यह जाँचने के लिए कि जब सर्वर HTTP 404 त्रुटि या HTTP 503 त्रुटि के साथ प्रतिक्रिया करता है तो REST क्लाइंट कैसे व्यवहार करता है।
  • रेस्टिटो सर्वर को कुछ मिलीसेकंड में स्थापित किया जा सकता है और परीक्षण पूरा होने के बाद समाप्त किया जा सकता है।
  • रेस्टिटो सभी प्रकार की HTTP विधि सामग्री का समर्थन करता है, जैसे संपीड़ित, गैर-संपीड़ित, एकीकृत, अनुप्रयोग/पाठ, अनुप्रयोग/JSON, आदि।

REST क्लाइंट परीक्षण के लिए रेस्टिटो फ्रेमवर्क का उपयोग करने के नुकसान

ReST क्लाइंट परीक्षण के लिए रेस्टिटो फ्रेमवर्क के नुकसान/कमी यहां दी गई हैं

  • 'लोकलहोस्ट' को सर्वर मशीन मानने के लिए REST क्लाइंट स्रोत में बदलाव किया जाना चाहिए।
  • यदि हम सामान्यतः प्रयुक्त पोर्ट जैसे '8080' या '9443' आदि का उपयोग करते हैं तो किसी भी पोर्ट में सर्वर खोलने में समस्या हो सकती है।
  • 9092 या 9099 जैसे पोर्ट का उपयोग करने की सलाह दी जाती है, जो आमतौर पर अन्य उपकरणों द्वारा उपयोग नहीं किए जाते हैं।

सारांश

  • REST का तात्पर्य है "REpresentational State Transfer" जो किसी निश्चित समय पर किन्हीं दो प्रणालियों के बीच संचार का एक नया मानक तरीका है।
  • REST क्लाइंट एक REST सेवा API को लागू करने की एक विधि या उपकरण है जो किसी भी सिस्टम या सेवा प्रदाता द्वारा संचार के लिए उपलब्ध होता है।
  • रेस्टसर्वर विधि या एपीआई में जो किसी भी सिस्टम या सेवा प्रदाता द्वारा संचार के लिए उपलब्ध है।
  • रेस्टिटो एक हल्का ऐप है जो आपको किसी भी प्रकार के HTTP अनुरोध को निष्पादित करने में मदद करता है
  • किसी भी सर्वर एंडपॉइंट पर HTTP GET अनुरोध भेजने के लिए HTTP क्लाइंट और विधि बनाएं
  • समापन बिंदु 'getevents' पर भेजे गए अनुरोधों को सुनने और कैप्चर करने के लिए रेस्टिटो सर्वर प्रारंभ करें।
  • लोकलहोस्ट में एंडपॉइंट 'getevents' पर भेजे गए अनुरोधों को सुनने और कैप्चर करने के लिए रेस्टिटो सर्वर शुरू करें
  • यहां, हमने केवल REST क्लाइंट के स्वचालन परीक्षण के लिए उदाहरण क्रियान्वित किए हैं।
  • हमें REST क्लाइंट का परीक्षण करने के लिए वास्तविक REST सर्वर विकसित करने की आवश्यकता नहीं है।
  • 'लोकलहोस्ट' को सर्वर मशीन मानने के लिए REST क्लाइंट स्रोत में बदलाव किया जाना चाहिए।