[Android] Refactor the buildbot scripts to prepare for downstream usage.

build/android/buildbot/bb_run_bot.py

 #!/usr/bin/env python
 #
 # 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.
 
 import collections
 import copy
 import json
 import os
 import pipes
 import re
 import subprocess
 import sys
 
 import bb_utils
 
 BotConfig = collections.namedtuple(

[Isaac (away), 2013/06/28 01:39:12]

Rename these to start with _

[Siva Chandra, 2013/06/28 21:34:10]

Done.

     'BotConfig', ['bot_id', 'host_obj', 'test_obj'])
 
 HostConfig = collections.namedtuple(
     'HostConfig',
     ['host_steps', 'extra_args', 'extra_gyp_defines', 'target_arch'])
 
 TestConfig = collections.namedtuple('Tests', ['tests', 'extra_args'])
 
 
+def CreateBotConfig(bot_id, host_object, test_object=None):

[Isaac (away), 2013/06/28 01:39:12]

Just call these BotConfig, HostConfig and TestConfig

[Siva Chandra, 2013/06/28 21:34:10]

Done.

+  return BotConfig(bot_id, host_object, test_object)
+
+def CreateTestConfig(tests, extra_args=None):
+  return TestConfig(tests, extra_args)
+
+def CreateHostConfig(host_steps, extra_args=None, extra_gyp=None,
+                     target_arch=None):
+  return HostConfig(host_steps, extra_args, extra_gyp, target_arch)
+
+
 def DictDiff(d1, d2):
   diff = []
   for key in sorted(set(d1.keys() + d2.keys())):
     if key in d1 and d1[key] != d2.get(key):
       diff.append('- %s=%s' % (key, pipes.quote(d1[key])))
     if key in d2 and d2[key] != d1.get(key):
       diff.append('+ %s=%s' % (key, pipes.quote(d2[key])))
   return '\n'.join(diff)
 
 
@@ skipping 29 matching lines @@
 
   # Bots checkout chrome in /b/build/slave/<name>/build/src
   build_internal_android = os.path.abspath(os.path.join(
       bb_utils.CHROME_SRC, '..', '..', '..', '..', '..', 'build_internal',
       'scripts', 'slave', 'android'))
   if os.path.exists(build_internal_android):
     env['PATH'] = os.pathsep.join([build_internal_android, env['PATH']])
   return env
 
 
-def GetCommands(options, bot_config):
+def GetCommands(options, bot_config, host_step_script, device_step_script):

[Isaac (away), 2013/06/28 01:39:12]

These args are fragile, I'd prefer overrides to the scripts be part of
bot_config object.

[Siva Chandra, 2013/06/28 21:34:10]

Done.

   """Get a formatted list of commands.
 
   Args:
     options: Options object.
     bot_config: A BotConfig named tuple.
+    host_step_script: Host step script.
+    device_step_script: Device step script.
   Returns:
     list of Command objects.
   """
   property_args = bb_utils.EncodeProperties(options)
-  commands = [['build/android/buildbot/bb_host_steps.py'] +
-              ['--steps=%s' % ','.join(bot_config.host_obj.host_steps)] +
+  commands = [[host_step_script,
+               '--steps=%s' % ','.join(bot_config.host_obj.host_steps)] +
               property_args + (bot_config.host_obj.extra_args or [])]
 
   test_obj = bot_config.test_obj
   if test_obj:
-    run_test_cmd = [
-        'build/android/buildbot/bb_device_steps.py', '--reboot'] + property_args
+    run_test_cmd = [device_step_script, '--reboot'] + property_args
     for test in test_obj.tests:
       run_test_cmd.extend(['-f', test])
     if test_obj.extra_args:
       run_test_cmd.extend(test_obj.extra_args)
     commands.append(run_test_cmd)
   return commands
 
 
 def GetBotStepMap():
   compile_step = ['compile']
   std_host_tests = ['check_webview_licenses', 'findbugs']
   std_build_steps = ['compile', 'zip_build']
   std_test_steps = ['extract_build']
   std_tests = ['ui', 'unit']
   flakiness_server = '--upload-to-flakiness-server'
 
-  def B(bot_id, host_object, test_object=None):
-    return BotConfig(bot_id, host_object, test_object)
-
-  def T(tests, extra_args=None):
-    return TestConfig(tests, extra_args)
-
-  def H(host_steps, extra_args=None, extra_gyp=None, target_arch=None):
-    return HostConfig(host_steps, extra_args, extra_gyp, target_arch)
+  B = CreateBotConfig
+  H = CreateHostConfig
+  T = CreateTestConfig
 
   bot_configs = [
       # Main builders
       B('main-builder-dbg', H(std_build_steps + std_host_tests)),
       B('main-builder-rel', H(std_build_steps)),
       B('main-clang-builder',
         H(compile_step, extra_gyp='clang=1 component=shared_library')),
       B('main-clobber', H(compile_step)),
       B('main-tests', H(std_test_steps), T(std_tests, [flakiness_server])),
 
@@ skipping 44 matching lines @@
     # Trybots do not upload to flakiness dashboard. They should be otherwise
     # identical in configuration to their trunk building counterparts.
     test_obj = bot_map[to_id].test_obj
     if to_id.startswith('try') and test_obj:
       extra_args = test_obj.extra_args
       if extra_args and flakiness_server in extra_args:
         extra_args.remove(flakiness_server)
   return bot_map
 
 
-def main(argv):
+def GetBotConfig(bot_step_map, bot_id):

[Isaac (away), 2013/06/28 01:39:12]

Please name this something more generic, such as 'GetBestMatch' and remove
references to 'bot'.

[Siva Chandra, 2013/06/28 21:34:10]

Done.

+  bot_config = bot_step_map.get(bot_id)
+  if not bot_config:
+    substring_matches = filter(lambda x: x in bot_id, bot_step_map.iterkeys())
+    if substring_matches:
+      max_id = max(substring_matches, key=len)
+      print 'Using config from id="%s" (substring match).' % max_id
+      bot_config = bot_step_map[max_id]
+  return bot_config
+
+
+def GetRunBotOptParser():
   parser = bb_utils.GetParser()
   parser.add_option('--bot-id', help='Specify bot id directly.')
   parser.add_option('--testing', action='store_true',
                     help='For testing: print, but do not run commands')
+
+  return parser
+
+
+def main(argv):
+  parser = GetRunBotOptParser()
   options, args = parser.parse_args(argv[1:])
   if args:
     parser.error('Unused args: %s' % args)
 
   bot_id = options.bot_id or options.factory_properties.get('android_bot_id')
   if not bot_id:
     parser.error('A bot id must be specified through option or factory_props.')
 
   # Get a BotConfig object looking first for an exact bot-id match. If no exact
   # match, look for a bot-id which is a substring of the specified id.
   # This allows similar bots to have unique IDs, but to share config.
   # If multiple substring matches exist, pick the longest one.
-  bot_map = GetBotStepMap()
-  bot_config = bot_map.get(bot_id)
-  if not bot_config:
-    substring_matches = filter(lambda x: x in bot_id, bot_map.iterkeys())
-    if substring_matches:
-      max_id = max(substring_matches, key=len)
-      print 'Using config from id="%s" (substring match).' % max_id
-      bot_config = bot_map[max_id]
+  bot_config = GetBotConfig(GetBotStepMap(), bot_id)
   if not bot_config:
     print 'Error: config for id="%s" cannot be inferred.' % bot_id
     return 1
 
   print 'Using config:', bot_config
 
-  commands = GetCommands(options, bot_config)
+  commands = GetCommands(
+      options, bot_config,
+      'build/android/buildbot/bb_host_steps.py',
+      'build/android/buildbot/bb_device_steps.py')
   for command in commands:
     print 'Will run: ', bb_utils.CommandToString(command)
   print
 
   env = GetEnvironment(bot_config.host_obj, options.testing)
   print 'Environment changes:'
   print DictDiff(dict(os.environ), env)
 
   for command in commands:
     print bb_utils.CommandToString(command)
     sys.stdout.flush()
     if options.testing:
       env['BUILDBOT_TESTING'] = '1'
     return_code = subprocess.call(command, cwd=bb_utils.CHROME_SRC, env=env)
     if return_code != 0:
       return return_code
 
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv))