[Chromedriver] Add Device Metrics override support to ChromeDriver via Capabilities

chrome/test/chromedriver/test/run_py_tests.py

 #!/usr/bin/env python
 # Copyright 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.
 
 """End to end tests for ChromeDriver."""
 
 import base64
 import json
 import math
@@ skipping 82 matching lines @@
   return filter
 
 _ANDROID_NEGATIVE_FILTER = {}
 _ANDROID_NEGATIVE_FILTER['chrome'] = (
     _NEGATIVE_FILTER + [
         # TODO(chrisgao): fix hang of tab crash test on android.
         'ChromeDriverTest.testTabCrash',
         # Android doesn't support switches and extensions.
         'ChromeSwitchesCapabilityTest.*',
         'ChromeExtensionsCapabilityTest.*',
+        'MobileEmulationCapabilityTest.*',
         # https://crbug.com/274650
         'ChromeDriverTest.testCloseWindow',
         # https://code.google.com/p/chromedriver/issues/detail?id=270
         'ChromeDriverTest.testPopups',
         # https://code.google.com/p/chromedriver/issues/detail?id=298
         'ChromeDriverTest.testWindowPosition',
         'ChromeDriverTest.testWindowSize',
         'ChromeDriverTest.testWindowMaximize',
         'ChromeLogPathCapabilityTest.testChromeLogPath',
         'ExistingBrowserTest.*',
@@ skipping 588 matching lines @@
     # When 31 is released, will reload the tab instead.
     # https://code.google.com/p/chromedriver/issues/detail?id=547
     self.assertRaises(chromedriver.UnknownError,
                       self._driver.Load, 'chrome://crash')
     self.assertRaises(chromedriver.NoSuchSession,
                       self._driver.GetCurrentUrl)
 
   def testDoesntHangOnDebugger(self):
     self._driver.ExecuteScript('debugger;')
 
+  def testMobileEmulationDisabledByDefault(self):
+    self.assertFalse(self._driver.capabilities['mobileEmulationEnabled'])
+
 
 class ChromeDriverAndroidTest(ChromeDriverBaseTest):
   """End to end tests for Android-specific tests."""
 
   def testLatestAndroidAppInstalled(self):
     if ('stable' not in _ANDROID_PACKAGE_KEY and
         'beta' not in _ANDROID_PACKAGE_KEY):
       return
 
     self._driver = self.CreateDriver()
@@ skipping 81 matching lines @@
 
     Verifies that a log message is written into the specified log file.
     """
     tmp_log_path = tempfile.NamedTemporaryFile()
     driver = self.CreateDriver(chrome_log_path=tmp_log_path.name)
     driver.ExecuteScript('console.info("%s")' % self.LOG_MESSAGE)
     driver.Quit()
     self.assertTrue(self.LOG_MESSAGE in open(tmp_log_path.name).read())
 
 
+class MobileEmulationCapabilityTest(ChromeDriverBaseTest):
+  """Tests that ChromeDriver processes chromeOptions.mobileEmulation.
+
+  Makes sure the device metrics are overridden in DevTools and user agent is
+  overridden in Chrome.
+  """
+
+  @staticmethod
+  def GlobalSetUp():
+    def respondWithUserAgentString(request):
+      return request.GetHeader('User-Agent')
+
+    MobileEmulationCapabilityTest._http_server = webserver.WebServer(
+        chrome_paths.GetTestData())
+    MobileEmulationCapabilityTest._http_server.SetCallbackForPath(
+        '/userAgent', respondWithUserAgentString)
+
+  @staticmethod
+  def GlobalTearDown():
+    MobileEmulationCapabilityTest._http_server.Shutdown()
+
+  def testDeviceMetrics(self):
+    driver = self.CreateDriver(
+        mobile_emulation = {
+            'deviceMetrics': {'width': 360, 'height': 640, 'pixelRatio': 3}})
+    self.assertTrue(driver.capabilities['mobileEmulationEnabled'])
+    self.assertEqual(360, driver.ExecuteScript('return window.innerWidth'))
+    self.assertEqual(640, driver.ExecuteScript('return window.innerHeight'))
+
+  def testUserAgent(self):
+    driver = self.CreateDriver(
+        mobile_emulation = {'userAgent': 'Agent Smith'})
+    driver.Load(self._http_server.GetUrl() + '/userAgent')
+    body_tag = driver.FindElement('tag name', 'body')
+    self.assertEqual("Agent Smith", body_tag.GetText())
+
+  def testDeviceName(self):

[stgao, 2014/05/22 05:02:22]

It seems this testcase keeps failing on Chrome 33, but passes on Chrome 34, 35,
and trunk.
Although we are going to deprecate support on Chrome 33 as 35 is promoted to
stable, it is still good to know why it fails.

http://build.chromium.org/p/chromium.chromedriver/builders/Linux/builds/6016/...

http://build.chromium.org/p/chromium.chromedriver/waterfall

Would you mind taking a look?
Chrome 33 could be downloaded from
https://commondatastorage.googleapis.com/chromium-browser-continuous/index.ht...

+    driver = self.CreateDriver(
+        mobile_emulation = {'deviceName': 'Google Nexus 5'})
+    driver.Load(self._http_server.GetUrl() + '/userAgent')
+    self.assertEqual(360, driver.ExecuteScript('return window.innerWidth'))
+    self.assertEqual(640, driver.ExecuteScript('return window.innerHeight'))
+    body_tag = driver.FindElement('tag name', 'body')
+    self.assertEqual(
+        'Mozilla/5.0 (Linux; Android 4.2.1; en-us; Nexus 5 Build/JOP40D) AppleW'
+        'ebKit/535.19 (KHTML, like Gecko) Chrome/18.0.1025.166 Mobile Safari/53'
+        '5.19',
+        body_tag.GetText())
+
+
 class ChromeDriverLogTest(unittest.TestCase):
   """Tests that chromedriver produces the expected log file."""
 
   UNEXPECTED_CHROMEOPTION_CAP = 'unexpected_chromeoption_capability'
   LOG_MESSAGE = 'unrecognized chrome option: %s' % UNEXPECTED_CHROMEOPTION_CAP
 
   def testChromeDriverLog(self):
     _, tmp_log_path = tempfile.mkstemp(prefix='chromedriver_log_')
     chromedriver_server = server.Server(
         _CHROMEDRIVER_BINARY, log_path=tmp_log_path)
@@ skipping 173 matching lines @@
     if _ANDROID_PACKAGE_KEY:
       negative_filter = _ANDROID_NEGATIVE_FILTER[_ANDROID_PACKAGE_KEY]
     else:
       negative_filter = _GetDesktopNegativeFilter(options.chrome_version)
     options.filter = '*-' + ':__main__.'.join([''] + negative_filter)
 
   all_tests_suite = unittest.defaultTestLoader.loadTestsFromModule(
       sys.modules[__name__])
   tests = unittest_util.FilterTestSuite(all_tests_suite, options.filter)
   ChromeDriverTest.GlobalSetUp()
+  MobileEmulationCapabilityTest.GlobalSetUp()
   result = unittest.TextTestRunner(stream=sys.stdout, verbosity=2).run(tests)
   ChromeDriverTest.GlobalTearDown()
+  MobileEmulationCapabilityTest.GlobalTearDown()
   sys.exit(len(result.failures) + len(result.errors))