Add a method to override the network conditions of the ChromeDriver session.

chrome/test/chromedriver/window_commands.cc

 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/test/chromedriver/window_commands.h"
 
 #include <stddef.h>
 
 #include <list>
 #include <string>
 
+#include "base/json/json_reader.h"

[samuong, 2016/06/14 17:46:00]

is this needed?

[roisinmcl, 2016/06/17 18:13:33]

I have removed this.

+
 #include "base/callback.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/stringprintf.h"
 #include "base/threading/platform_thread.h"
 #include "base/time/time.h"
 #include "base/values.h"
 #include "chrome/test/chromedriver/basic_types.h"
 #include "chrome/test/chromedriver/chrome/automation_extension.h"
 #include "chrome/test/chromedriver/chrome/browser_info.h"
 #include "chrome/test/chromedriver/chrome/chrome.h"
 #include "chrome/test/chromedriver/chrome/chrome_desktop_impl.h"
 #include "chrome/test/chromedriver/chrome/devtools_client.h"
 #include "chrome/test/chromedriver/chrome/geoposition.h"
 #include "chrome/test/chromedriver/chrome/javascript_dialog_manager.h"
 #include "chrome/test/chromedriver/chrome/js.h"
 #include "chrome/test/chromedriver/chrome/network_conditions.h"
+#include "chrome/test/chromedriver/chrome/network_list.h"

[samuong, 2016/06/14 17:46:00]

is this for the bitmasks?

[roisinmcl, 2016/06/17 18:13:33]

I removed this and declared the bitmasks within the function.

 #include "chrome/test/chromedriver/chrome/status.h"
 #include "chrome/test/chromedriver/chrome/ui_events.h"
 #include "chrome/test/chromedriver/chrome/web_view.h"
 #include "chrome/test/chromedriver/element_util.h"
 #include "chrome/test/chromedriver/net/timeout.h"
 #include "chrome/test/chromedriver/session.h"
 #include "chrome/test/chromedriver/util.h"
 
 namespace {
 
@@ skipping 946 matching lines @@
   std::string network_name;
   const base::DictionaryValue* conditions = NULL;
   std::unique_ptr<NetworkConditions> network_conditions(
       new NetworkConditions());
   if (params.GetString("network_name", &network_name)) {
     // Get conditions from preset list.
     Status status = FindPresetNetwork(network_name, network_conditions.get());
     if (status.IsError())
       return status;
   } else if (params.GetDictionary("network_conditions", &conditions)) {
+

[samuong, 2016/06/14 17:46:00]

nitpick: delete this blank line

[roisinmcl, 2016/06/17 18:13:33]

Done.

     // |latency| is required.
     if (!conditions->GetDouble("latency", &network_conditions->latency))
       return Status(kUnknownError,
                     "invalid 'network_conditions' is missing 'latency'");
 
     // Either |throughput| or the pair |download_throughput| and
     // |upload_throughput| is required.
     if (conditions->HasKey("throughput")) {
       if (!conditions->GetDouble("throughput",
                                  &network_conditions->download_throughput))
@@ skipping 26 matching lines @@
                   "either 'network_conditions' or 'network_name' must be "
                   "supplied");
   }
 
   session->overridden_network_conditions.reset(
       network_conditions.release());
   return web_view->OverrideNetworkConditions(
       *session->overridden_network_conditions);
 }
 
+Status ExecuteSetEmulatedNetworkConditions(Session* session,

[samuong, 2016/06/14 17:46:00]

i took a closer look into this and although you're right that it does get
applied to all tabs, i still think this should be a session command. the reason
is that it won't get applied to all tabs at the same time, and certain network
accesses (XHRs) won't get emulated correctly.

we might have this go through all of the WebViews for the session, and call
OverrideNetworkConditions on each one.

[roisinmcl, 2016/06/17 18:13:33]

Moved this function to session_commands and iterated through the WebViews and
called OverrideNetworkConditions on each one.

+                                          WebView* web_view,
+                                          const base::DictionaryValue& params,
+                                          std::unique_ptr<base::Value>* value,
+                                          Timeout* timeout) {

[samuong, 2016/06/14 17:46:00]

style nitpick: keep all parameters indented to the same level

[roisinmcl, 2016/06/17 18:13:33]

Done.

+  const int kOfflineMask = 0x0;

[samuong, 2016/06/14 17:46:00]

is this supposed to be 0x1?

[roisinmcl, 2016/06/17 18:13:33]

Changed this to 0x1.

+  const int kWifiMask = 0x2;
+  const int k4GMask = 0x8;
+  const int k3GMask = 0x10;
+  const int k2GMask = 0x20;
+
+  int connection_type;
+
+  if(!params.GetInteger("connection_type", &connection_type)) {

[samuong, 2016/06/14 17:46:00]

i think this is called "parameters.type" in the spec

[roisinmcl, 2016/06/17 18:13:33]

Done.

+    return Status(kUnknownError,
+                  "invalid network_connections is missing 'connection_type'");
+  }
+
+  std::unique_ptr<NetworkConditions> network_conditions(
+      new NetworkConditions());
+
+  if (connection_type == kOfflineMask) {

[samuong, 2016/06/14 17:46:00]

use the bitwise and operator (&) instead of == to test for bits. in many cases,
multiple bits will be set (e.g. airplane mode + wifi) so you'll also need to be
careful about the order of these if statements. in the airplane mode + wifi
example, wifi should take precedence.

[roisinmcl, 2016/06/17 18:13:33]

Done.

+    network_conditions->latency = 0;
+    network_conditions->upload_throughput = 0;
+    network_conditions->download_throughput = 0;
+    network_conditions->offline = true;
+  } else if (connection_type == kWifiMask) {
+    network_conditions->latency = 2;
+    network_conditions->upload_throughput = 30720 * 1024;
+    network_conditions->download_throughput = 30720 * 1024;
+    network_conditions->offline = false;
+  } else if (connection_type == k4GMask) {
+    network_conditions->latency = 20;
+    network_conditions->upload_throughput = 4096 * 1024;
+    network_conditions->download_throughput = 4096 * 1024;
+    network_conditions->offline = false;
+  } else if (connection_type == k3GMask) {
+    network_conditions->latency = 100;
+    network_conditions->upload_throughput = 750 * 1024;
+    network_conditions->download_throughput = 750 * 1024;
+    network_conditions->offline = false;
+  } else if (connection_type == k2GMask) {
+    network_conditions->latency = 300;
+    network_conditions->upload_throughput = 250 * 1024;
+    network_conditions->download_throughput = 250 * 1024;
+    network_conditions->offline = false;
+  } else {
+    return Status(kUnknownError,
+                  "invalid 'connection_type'");

[samuong, 2016/06/14 17:46:00]

style nitpick: join the two lines above

[roisinmcl, 2016/06/17 18:13:33]

Done.

+  }
+
+  session->overridden_network_conditions.reset(
+      network_conditions.release());
+  return web_view->OverrideNetworkConditions(
+      *session->overridden_network_conditions);
+}
+
 Status ExecuteDeleteNetworkConditions(Session* session,
                                       WebView* web_view,
                                       const base::DictionaryValue& params,
                                       std::unique_ptr<base::Value>* value,
                                       Timeout* timeout) {
   // Chrome does not have any command to stop overriding network conditions, so
   // we just override the network conditions with the "No throttling" preset.
   NetworkConditions network_conditions;
   // Get conditions from preset list.
   Status status = FindPresetNetwork("No throttling", &network_conditions);
@@ skipping 10 matching lines @@
   return status;
 }
 
 Status ExecuteTakeHeapSnapshot(Session* session,
                                WebView* web_view,
                                const base::DictionaryValue& params,
                                std::unique_ptr<base::Value>* value,
                                Timeout* timeout) {
   return web_view->TakeHeapSnapshot(value);
 }