Enable running cros_tab_switching on Chrome OS DUT

The first version of cros_tab_switching can only run by specifying the
argument --remote=DUT_IP. Enable running cros_tab_switching locally when
--remote is not specified so it can be used on test_that.

Bug: 852231
Change-Id: Ia92dc4913a039e7b4ae7488c1b8d0523451d4645
Reviewed-on: https://chromium-review.googlesource.com/1098872
Commit-Queue: Vovo Yang <vovoy@chromium.org>
Reviewed-by: Cheng-Yu Lee <cylee@chromium.org>
Reviewed-by: Achuith Bhandarkar <achuith@chromium.org>
Cr-Commit-Position: refs/heads/master@{#568739}

tools/perf/contrib/cros_benchmarks/cros_utils.py

@@ -6,6 +6,7 @@ import json
 import logging
 import os
 import subprocess
+import time
 
 import py_utils
 
@@ -13,8 +14,34 @@ from telemetry.core import exceptions
 from telemetry.value import histogram_util
 
 
-def _RunRemoteCommand(dut_ip, cmd):
-  return os.system('ssh root@%s %s' % (dut_ip, cmd))
+def _RunCommand(dut_ip, cmd):
+  """Runs command on the DUT.
+
+  Args:
+    dut_ip: IP of the DUT. If it's None, runs command locally.
+    cmd: The command to run.
+  """
+  if dut_ip:
+    # Commands via ssh shall be double-quoted to escape special characters.
+    cmd = '"%s"' % cmd
+    return os.system('ssh root@%s %s' % (dut_ip, cmd))
+  else:
+    return os.system(cmd)
+
+
+def _Popen(dut_ip, cmd_list):
+  """Popen to run a command on DUT."""
+  if dut_ip:
+    cmd_list = ['ssh', 'root@' + dut_ip] + cmd_list
+  return subprocess.Popen(cmd_list, stdout=subprocess.PIPE)
+
+
+def _CopyToDUT(dut_ip, local_path, dut_path):
+  """Copies file to the DUT path."""
+  if dut_ip:
+    os.system('scp -q %s root@%s:%s' % (local_path, dut_ip, dut_path))
+  else:
+    os.system('cp %s %s' % (local_path, dut_path))
 
 
 def _GetTabSwitchHistogram(browser):
@@ -108,7 +135,6 @@ class KeyboardEmulator(object):
       dut_ip: DUT IP or hostname.
     """
     self._dut_ip = dut_ip
-    self._root_dut_ip = 'root@' + dut_ip
     self._key_device_name = None
 
   def _StartRemoteKeyboardEmulator(self):
@@ -122,18 +148,23 @@ class KeyboardEmulator(object):
     """
     kbd_prop_filename = '/usr/local/autotest/cros/input_playback/keyboard.prop'
 
-    ret = _RunRemoteCommand(self._dut_ip, 'test -e %s' % kbd_prop_filename)
+    ret = _RunCommand(self._dut_ip, 'test -e %s' % kbd_prop_filename)
     if ret != 0:
       raise RuntimeError('Keyboard property file does not exist.')
 
-    cmd = ['ssh', self._root_dut_ip, 'evemu-device', kbd_prop_filename]
-    ssh_process = subprocess.Popen(cmd, stdout=subprocess.PIPE)
+    process = _Popen(self._dut_ip, ['evemu-device', kbd_prop_filename])
 
     # The evemu-device output format:
     # Emulated Keyboard: /dev/input/event10
-    output = ssh_process.stdout.readline()
-    # The remote process would live when the ssh process was terminated.
-    ssh_process.kill()
+    output = process.stdout.readline()
+    if self._dut_ip:
+      # The remote process would live when the ssh process was terminated.
+      process.kill()
+    else:
+      # Needs extra sleep when running locally, otherwise the first key may not
+      # dispatch.
+      # TODO(cywang): crbug.com/852702
+      time.sleep(1)
     if not output.startswith('Emulated Keyboard:'):
       raise RuntimeError('Keyboard emulation failed.')
     key_device_name = output.split()[2]
@@ -143,9 +174,8 @@ class KeyboardEmulator(object):
     """Uploads the script to send key to switch tabs."""
     cur_dir = os.path.dirname(os.path.abspath(__file__))
     log_key_filename = os.path.join(cur_dir, 'data', 'log_key_tab_switch')
-    os.system('scp -q %s %s:%s' %
-              (log_key_filename, self._root_dut_ip,
-               KeyboardEmulator.REMOTE_LOG_KEY_FILENAME))
+    _CopyToDUT(self._dut_ip, log_key_filename,
+               KeyboardEmulator.REMOTE_LOG_KEY_FILENAME)
 
   def __enter__(self):
     self._key_device_name = self._StartRemoteKeyboardEmulator()
@@ -154,14 +184,14 @@ class KeyboardEmulator(object):
 
   def SwitchTab(self):
     """Sending Ctrl-tab key to trigger tab switching."""
-    cmd = ('"evemu-play --insert-slot0 %s < %s"' %
+    cmd = ('evemu-play --insert-slot0 %s < %s' %
            (self._key_device_name,
             KeyboardEmulator.REMOTE_LOG_KEY_FILENAME))
-    _RunRemoteCommand(self._dut_ip, cmd)
+    _RunCommand(self._dut_ip, cmd)
 
   def __exit__(self, exc_type, exc_value, traceback):
-    # Kills the remote emulator process explicitly.
-    _RunRemoteCommand(self._dut_ip, 'pkill evemu-device')
+    # Kills the emulator process explicitly.
+    _RunCommand(self._dut_ip, 'pkill evemu-device')
 
 
 def NoScreenOff(dut_ip):
@@ -170,5 +200,5 @@ def NoScreenOff(dut_ip):
   Args:
     dut_ip: DUT IP or hostname.
   """
-  _RunRemoteCommand(dut_ip, 'set_power_policy --ac_screen_off_delay=3600')
-  _RunRemoteCommand(dut_ip, 'set_power_policy --ac_screen_dim_delay=3600')
+  _RunCommand(dut_ip, 'set_power_policy --ac_screen_off_delay=3600')
+  _RunCommand(dut_ip, 'set_power_policy --ac_screen_dim_delay=3600')

tools/perf/contrib/cros_benchmarks/tab_switching_bench.py

@@ -3,7 +3,6 @@
 # found in the LICENSE file.
 
 import os
-import logging
 
 from core import perf_benchmark
 
@@ -42,9 +41,10 @@ class CrosTabSwitchingTypical24(perf_benchmark.PerfBenchmark):
                       help='pause between tab creation and tab switch')
 
   def CreateStorySet(self, options):
-    if not options.cros_remote:
-      # Raise exception here would fail the presubmit check.
-      logging.error('Must specify --remote=DUT_IP to run this test.')
+    # When running this test with test_that, fetch_benchmark_deps.py would
+    # invoke this method. Options doesn't have attribute cros_remote in this
+    # case.
+    cros_remote = getattr(options, 'cros_remote', None)
     story_set = story.StorySet(
         archive_data_file='data/tab_switching.json',
         base_dir=os.path.dirname(os.path.abspath(__file__)),
@@ -52,7 +52,7 @@ class CrosTabSwitchingTypical24(perf_benchmark.PerfBenchmark):
     # May not have pause_after_creation attribute in presubmit check.
     pause_after_creation = getattr(options, 'pause_after_creation', 0)
     story_set.AddStory(tab_switching_stories.CrosMultiTabTypical24Story(
-        story_set, options.cros_remote, options.tabset_repeat,
+        story_set, cros_remote, options.tabset_repeat,
         pause_after_creation))
     return story_set
 

tools/perf/contrib/cros_benchmarks/tab_switching_stories.py

@@ -22,14 +22,16 @@ class CrosMultiTabStory(page_module.Page):
     super(CrosMultiTabStory, self).__init__(
         shared_page_state_class=shared_page_state.SharedPageState,
         page_set=story_set, name=self.NAME, url=self.URL)
+    # cros_remote is the DUT IP or None if running locally.
     self._cros_remote = cros_remote
     self._tabset_repeat = tabset_repeat
     self._pause_after_creation = pause_after_creation
 
   def RunNavigateSteps(self, action_runner):
     """Opening tabs and waiting for them to load."""
-    if not self._cros_remote:
-      raise ValueError('Must specify --remote=DUT_IP to run this test.')
+    if not self._cros_remote and not py_utils.IsRunningOnCrosDevice():
+      raise ValueError('Must specify --remote=DUT_IP to run this test, '
+                       'or run it on CrOS locally.')
 
     # As this story may run for a long time, adjusting screen off time to
     # avoid screen off.