Moved RunMonkeyTests out of android_commands.py

build/android/run_monkey_test.py

 #!/usr/bin/env python
 # Copyright (c) 2012 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.
 
 """Runs the Monkey tests on one or more devices."""
 import logging
 import optparse
 import time
+import random

[frankf, 2012/09/11 17:36:51]

not alphabetical. Please run gpylint.

 
 from pylib import android_commands
 from pylib import python_test_base
 from pylib import python_test_caller
 from pylib import python_test_sharder
 from pylib import test_options_parser
 from pylib import test_result
 
 
 class MonkeyTest(python_test_base.PythonTestBase):
   def __init__(self, test_name, options):
     self.options = options
     super(MonkeyTest, self).__init__(test_name)
 
   def testMonkey(self):
     start_ms = int(time.time()) * 1000
 
     # Launch and wait for Chrome to launch.
-    self.adb.StartActivity(self.options['package_name'],
-                           self.options.pop('activity_name'),
+    self.adb.StartActivity(self.options.package_name,
+                           self.options.activity_name,
                            wait_for_completion=True,
                            action='android.intent.action.MAIN')
 
     # Chrome crashes are not always caught by Monkey test runner.
     # Verify Chrome has the same PID before and after the test.
-    before_pids = self.adb.ExtractPid(self.options['package_name'])
+    before_pids = self.adb.ExtractPid(self.options.package_name)
 
     # Run the test.
     output = ''
     duration_ms = 0
     if before_pids:
-      output = '\n'.join(self.adb.RunMonkey(**self.options))
+      output = '\n'.join(RunMonkey(self.adb, self.options))
       duration_ms = int(time.time()) * 1000 - start_ms
-      after_pids = self.adb.ExtractPid(self.options['package_name'])
+      after_pids = self.adb.ExtractPid(self.options.package_name)
 
     crashed = (not before_pids or not after_pids
                or after_pids[0] != before_pids[0])
     result = test_result.SingleTestResult(self.qualified_name, start_ms,
                                           duration_ms, log=output)
     results = test_result.TestResults()
 
     if 'Monkey finished' in output and not crashed:
       results.ok = [result]
     else:
       results.crashed = [result]
 
     return results
 
 
 def DispatchPythonTests(options):
   """Dispatches the Monkey tests, sharding it if there multiple devices."""
   logger = logging.getLogger()
   logger.setLevel(logging.DEBUG)
 
-  build_type = options.pop('build_type')
   available_tests = [MonkeyTest('testMonkey', options)]
   attached_devices = android_commands.GetAttachedDevices()
   if not attached_devices:
     raise Exception('You have no devices attached or visible!')
 
   # Actually run the tests.
   logging.debug('Running monkey tests.')
   available_tests *= len(attached_devices)
   sharder = python_test_sharder.PythonTestSharder(
       attached_devices, 1, available_tests)
   result = sharder.RunShardedTests()
-  result.LogFull('Monkey', 'Monkey', build_type)
+  result.LogFull('Monkey', 'Monkey', options.build_type)
   result.PrintAnnotation()
 
 
+def RunMonkey(adb, options):

[bulach, 2012/09/11 11:08:49]

nit: if nothing else will use this, please make it a member of MonkeyTest, and
add a "_" prefix.. maybe also rename to "_LaunchDeviceMonkey", to separate from
the other Run methods we have..

[frankf, 2012/09/11 17:36:51]

I prefer to have explicit parameters with default arguments instead of bundling
everything into options. It's more transparent and also allows other modules to
import and use this method.

[Isaac (away), 2012/09/13 03:06:18]

This style of defaults is consistent with the rest of our code base.  I'm not
sure what pylint says but gpylint complains about functions with default values.

[Isaac (away), 2012/09/13 03:06:18]

Done.

+  """Runs monkey test for a given package.
+
+  Args:
+    package_name: Allowed package.
+    category: A list of allowed categories.
+    throttle: Delay between events (ms).
+    seed: Seed value for pseduo-random generator. Same seed value
+      generates the same sequence of events. Seed is randomized by
+      default.
+    event_count: Number of events to generate.
+    verbosity: Verbosity level [0-3].
+    extra_args: A string of other args to pass to the command verbatim.

[bulach, 2012/09/11 11:08:49]

if this is becomes a method, please remove this Args: section and just use
self.adb and self.options directly...

[Isaac (away), 2012/09/13 03:06:18]

Done.

+
+  Returns:
+    Output of the test run.
+  """
+  category = options.category or []
+  seed = options.seed or random.randint(1, 100)
+  throttle = options.throttle or 100
+  event_count = options.event_count or 10000
+  verbosity = options.verbosity or 1
+  extra_args = options.extra_args or ''
+
+  cmd = ['monkey',
+         '-p %s' % options.package_name,
+         ' '.join(['-c %s' % c for c in category]),
+         '--throttle %d' % throttle,
+         '-s %d' % seed,
+         '-v ' * verbosity,
+         '--monitor-native-crashes',
+         '--kill-process-after-error',
+         extra_args,
+         '%d' % event_count]
+  return adb.RunShellCommand(' '.join(cmd),
+                             timeout_time=event_count*throttle*1.5)
+
 def main():
   desc = 'Run the Monkey tests on 1 or more devices.'
   parser = optparse.OptionParser(description=desc)
   test_options_parser.AddBuildTypeOption(parser)
-  parser.add_option('--package-name',
-                    help='Allowed package.')
+  parser.add_option('--package-name', help='Allowed package.')
   parser.add_option('--activity-name',
                     default='com.google.android.apps.chrome.Main',
                     help='Name of the activity to start [default: %default].')
   parser.add_option('--category',
                     help='A list of allowed categories [default: ""].')
   parser.add_option('--throttle', default=100, type='int',
                     help='Delay between events (ms) [default: %default]. ')
   parser.add_option('--seed', type='int',
                     help='Seed value for pseduo-random generator. Same seed'
                          ' value generates the same sequence of events. Seed is'
                          ' randomized by default.')
   parser.add_option('--event-count', default=10000, type='int',
                     help='Number of events to generate [default: %default].')
   parser.add_option('--verbosity', default=1, type='int',
                     help='Verbosity level [0-3] [default: %default].')
   parser.add_option('--extra-args', default='',
                     help='String of other args to pass to the command verbatim'
                          ' [default: "%default"].')
   (options, args) = parser.parse_args()
 
   if args:
     parser.error('Unknown arguments: %s' % args)
 
   if not options.package_name:
     parser.error('Missing package name')
 
   if options.category:
     options.category = options.category.split(',')
 
-  DispatchPythonTests(vars(options))
+  DispatchPythonTests(options)
 
 
 if __name__ == '__main__':
   main()