Configure network throttling

There might be scenarios where you would have to check the functionality of your website on poor network conditions or even offline. Such networks have variable upload and download speeds which can alter how your website performs on different browsers.

With Network throttling feature, you can test the performance and behavior of your website under different network conditions by simulating different network profiles.

To configure network throttling with TestCloud, follow these steps:

1. Set the boolean enableNetworkThrottling=True desired capability for your project. See: Set desired capabilities for TestCloud environment.
2. Add the keyword to your project.
   Note:

   The keyword is also accessible through the Katalon TestCloud Keywords plugin on Katalon Store. You can install the plugin to automatically load all TestCloud keywords into your Katalon project, without having to manually define them. To install the plugin, visit: Katalon TestCloud keywords.

   Declare a custom keyword class with the name ThrottleNetworkExecutor under the com.katalon.testcloud package.

   public class ThrottleNetworkExecutor {
   	
   	/**
   	 * set the network profile for test network on web.
   	 *
   	 * @param condition A string or object representing browser network conditions. 
   	 *
   	 * 
   	 */
   	@Keyword
   	void setNetworkProfileForWeb(String condition) {
   	}
   	
   	/**
   	 * set the network profile for test network on Mobile.
   	 *
   	 * @param condition A string or object representing browser network conditions. 
   	 *
   	 * 
   	 */
   	@Keyword
   	void setNetworkProfileForMobile(String condition) {
   	}
   	
   	@Keyword
       void customNetworkProfileForWeb(int downloadSpeed, int uploadSpeed, int latency) {
       }
       
       @Keyword
       void customNetworkProfileForMobile(int downloadSpeed, int uploadSpeed, int latency) {
       }
   }

   The ThrottleNetworkExecutor contains 4 keywords for the following use cases:

   setNetworkProfileForWeb: throttle network for web browsers by profile.

   Profile Name	Download Speed	Upload Speed	Latency
   offline	0 Kbps	0 Kbps	0 ms
   GPRS	50 Kbps	20 Kbps	500 ms
   Regular 2G	250 Kbps	50 Kbps	300 ms
   Good 2G	450 Kbps	150 Kbps	150 ms
   Regular 3G	750 Kbps	250 Kbps	100 ms
   Good 3G	1 Mbps	750 Kbps	20 ms
   Regular 4G	4 Mbps	3 Mbps	20 ms
   DSL	2 Mbps	1 Mbps	5 ms

   setNetworkProfileForMobile: throttle network for mobile devices by profile.

   Profile Name	Download Speed	Upload Speed	Latency
   2g-gprs-poor	20 Kbps	6 Kbps	1000 ms
   2g-gprs-good	50 Kbps	16 Kbps	500 ms
   3g-umts-poor	200 Kbps	64 Kbps	400 ms
   4g-lte-poor	1 Mbps	500 Kbps	200 ms
   3g-umts-good	5 Mbps	2 Mbps	100 ms
   4g-lte-good	15 Mbps	7 Mbps	70 ms
   4g-lte-advanced-good	25 Mbps	12 Mbps	20 ms

   customNetworkProfileForWeb, customNetworkProfileForMobile: provide arbitrary values for network throttling.