Add script for pub buildbots.

tools/bots/compiler.py

Index: tools/bots/compiler.py
diff --git a/utils/compiler/buildbot.py b/tools/bots/compiler.py
similarity index 54%
rename from utils/compiler/buildbot.py
rename to tools/bots/compiler.py
index bf17f149bd60e76b7e5d4750165c3aa66d4aa227..a86c0a1151277628a05fd5c92d6d5d383f89fb6b 100644
--- a/utils/compiler/buildbot.py
+++ b/tools/bots/compiler.py
@@ -4,133 +4,72 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-"""Dart2js buildbot steps
+"""
+Dart2js buildbot steps
 
 Runs tests for the  dart2js compiler.
 """
 
 import platform
-import optparse
 import os
 import re
 import shutil
 import subprocess
 import sys
 
-BUILDER_NAME = 'BUILDBOT_BUILDERNAME'
-BUILDER_CLOBBER = 'BUILDBOT_CLOBBER'
-
-
-DART_PATH = os.path.dirname(
-    os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+import bot
 
 DART2JS_BUILDER = (
     r'dart2js-(linux|mac|windows)(-(jsshell))?-(debug|release)(-(checked|host-checked))?(-(host-checked))?-?(\d*)-?(\d*)')
 WEB_BUILDER = (
     r'dart2js-(ie9|ie10|ff|safari|chrome|opera)-(win7|win8|mac|linux)(-(all|html))?')
 
-NO_COLOR_ENV = dict(os.environ)
-NO_COLOR_ENV['TERM'] = 'nocolor'
-
-class BuildInfo(object):
-  """ Encapsulation of build information.
-    - compiler: 'dart2js' or None when the builder has an incorrect name
-    - runtime: 'd8', 'ie', 'ff', 'safari', 'chrome', 'opera'
-    - mode: 'debug' or 'release'
-    - system: 'linux', 'mac', or 'win7'
-    - checked: True if we should run in checked mode, otherwise False
-    - host_checked: True if we should run in host checked mode, otherwise False
-    - shard_index: The shard we are running, None when not specified.
-    - total_shards: The total number of shards, None when not specified.
-    - is_buildbot: True if we are on a buildbot (or emulating it).
-    - test_set: Specification of a non standard test set, default None
-  """
-  def __init__(self, compiler, runtime, mode, system, checked=False,
-               host_checked=False, shard_index=None, total_shards=None,
-               is_buildbot=False, test_set=None):
-    self.compiler = compiler
-    self.runtime = runtime
-    self.mode = mode
-    self.system = system
-    self.checked = checked
-    self.host_checked = host_checked
-    self.shard_index = shard_index
-    self.total_shards = total_shards
-    self.is_buildbot = is_buildbot
-    self.test_set = test_set
-
-  def PrintBuildInfo(self):
-    shard_description = ""
-    if self.shard_index:
-      shard_description = " shard %s of %s" % (self.shard_index,
-                                               self.total_shards)
-    print ("compiler: %s, runtime: %s mode: %s, system: %s,"
-           " checked: %s, host-checked: %s, test-set: %s%s"
-           ) % (self.compiler, self.runtime, self.mode, self.system,
-                self.checked, self.host_checked, self.test_set,
-                shard_description)
-
-
-def GetBuildInfo():
+
+def GetBuildInfo(builder_name, is_buildbot):
   """Returns a BuildInfo object for the current buildbot based on the
      name of the builder.
   """
-  parser = optparse.OptionParser()
-  parser.add_option('-n', '--name', dest='name', help='The name of the build'
-      'bot you would like to emulate (ex: web-chrome-win7)', default=None)
-  args, _ = parser.parse_args()
-
   compiler = None
   runtime = None
   mode = None
   system = None
-  builder_name = os.environ.get(BUILDER_NAME)
   checked = False
   host_checked = False
   shard_index = None
   total_shards = None
-  is_buildbot = True
   test_set = None
 
-  if not builder_name:
-    # We are not running on a buildbot.
-    is_buildbot = False
-    if args.name:
-      builder_name = args.name
-    else:
-      print 'Use -n $BUILDBOT_NAME for the bot you would like to emulate.'
-      sys.exit(1)
-
-  if builder_name:
-    dart2js_pattern = re.match(DART2JS_BUILDER, builder_name)
-    web_pattern = re.match(WEB_BUILDER, builder_name)
-
-    if web_pattern:
-      compiler = 'dart2js'
-      runtime = web_pattern.group(1)
-      system = web_pattern.group(2)
-      mode = 'release'
-      test_set = web_pattern.group(4)
-    elif dart2js_pattern:
-      compiler = 'dart2js'
-      system = dart2js_pattern.group(1)
-      runtime = 'd8'
-      if dart2js_pattern.group(3) == 'jsshell':
-        runtime = 'jsshell'
-      mode = dart2js_pattern.group(4)
-      # The valid naming parts for checked and host-checked are:
-      # Empty: checked=False, host_checked=False
-      # -checked: checked=True, host_checked=False
-      # -host-checked: checked=False, host_checked=True
-      # -checked-host-checked: checked=True, host_checked=True
-      if dart2js_pattern.group(6) == 'checked':
-        checked = True
-      if dart2js_pattern.group(6) == 'host-checked':
-        host_checked = True
-      if dart2js_pattern.group(8) == 'host-checked':
-        host_checked = True
-      shard_index = dart2js_pattern.group(9)
-      total_shards = dart2js_pattern.group(10)
+  dart2js_pattern = re.match(DART2JS_BUILDER, builder_name)
+  web_pattern = re.match(WEB_BUILDER, builder_name)
+
+  if web_pattern:
+    compiler = 'dart2js'
+    runtime = web_pattern.group(1)
+    system = web_pattern.group(2)
+    mode = 'release'
+    test_set = web_pattern.group(4)
+  elif dart2js_pattern:
+    compiler = 'dart2js'
+    system = dart2js_pattern.group(1)
+    runtime = 'd8'
+    if dart2js_pattern.group(3) == 'jsshell':
+      runtime = 'jsshell'
+    mode = dart2js_pattern.group(4)
+    # The valid naming parts for checked and host-checked are:
+    # Empty: checked=False, host_checked=False
+    # -checked: checked=True, host_checked=False
+    # -host-checked: checked=False, host_checked=True
+    # -checked-host-checked: checked=True, host_checked=True
+    if dart2js_pattern.group(6) == 'checked':
+      checked = True
+    if dart2js_pattern.group(6) == 'host-checked':
+      host_checked = True
+    if dart2js_pattern.group(8) == 'host-checked':
+      host_checked = True
+    shard_index = dart2js_pattern.group(9)
+    total_shards = dart2js_pattern.group(10)
+  else :
+    return None
 
   if system == 'windows':
     system = 'win7'
@@ -140,8 +79,9 @@ def GetBuildInfo():
       system == 'linux' and platform.system() != 'Linux'):
     print ('Error: You cannot emulate a buildbot with a platform different '
         'from your own.')
-    sys.exit(1)
-  return BuildInfo(compiler, runtime, mode, system, checked, host_checked,
+    return None
+
+  return bot.BuildInfo(compiler, runtime, mode, system, checked, host_checked,
                    shard_index, total_shards, is_buildbot, test_set)
 
 
@@ -158,52 +98,36 @@ def TestStepName(name, flags):
 
 def TestStep(name, mode, system, compiler, runtime, targets, flags):
   step_name = TestStepName(name, flags)
-  print '@@@BUILD_STEP %s@@@' % step_name
-  sys.stdout.flush()
-  if NeedsXterm(compiler, runtime) and system == 'linux':
-    cmd = ['xvfb-run', '-a']
-  else:
-    cmd = []
-
-  user_test = os.environ.get('USER_TEST', 'no')
-
-  cmd.extend([sys.executable,
-              os.path.join(os.curdir, 'tools', 'test.py'),
-              '--step_name=' + step_name,
-              '--mode=' + mode,
-              '--compiler=' + compiler,
-              '--runtime=' + runtime,
-              '--time',
-              '--use-sdk',
-              '--report'])
-
-  if user_test == 'yes':
-    cmd.append('--progress=color')
-  else:
-    cmd.extend(['--progress=buildbot', '-v'])
-
-  if flags:
-    cmd.extend(flags)
-  cmd.extend(targets)
-
-  print 'running %s' % (' '.join(cmd))
-  exit_code = subprocess.call(cmd, env=NO_COLOR_ENV)
-  if exit_code != 0:

[Emily Fortuna, 2012/10/24 03:00:04]

My concern is we check the exit code from running test.dart is here, but with
__exit__ only an exception is checked for.

[Bob Nystrom, 2012/10/24 16:22:28]

Exactly right. If you look at bot.RunProcess(), though, it should translate a
non-zero exit code to an exception, so that this gets hit.

The previous code was doing tons of "if exit_code != 0: return exit_code" to
early out and to me that looked like hand-implemented exception unwinding. So I
just made it use exceptions directly. :)

[Emily Fortuna, 2012/10/24 17:06:03]

Gotcha. Carry on then! 

-    print '@@@STEP_FAILURE@@@'
-  return exit_code
-
+  with bot.BuildStep(step_name, swallow_error=True):

[Emily Fortuna, 2012/10/23 23:09:49]

Fancy! (I had to look up  how to use this) 
BUT, I'm not 100% certain that this is maintaining the original semantics. The
script returns failure if the exit code is nonzero, whereas the new code only
reports failure if an exception is thrown (and test.dart can return a nonzero
exit code with no additional information, I believe)

[Bob Nystrom, 2012/10/24 00:46:45]

I had to look it up to create it! I wanted a nice automatic way of printing the
fail steps when a process borked.
I believe it is, but please do double check. In the original code, TestStep()
returns the status code but TestCompiler(), which calls it, always just ignores
it and then returns zero. As far as I can tell, in the original code, the exit
status from running test.dart is never used. I guess it relies on the test
output messages?

With my change, what *should* happen is that bot.RunProcess() will see a
non-zero exit status, and raise an OSError. with bot.BuildStep() will catch
that, print the failure and (because swallow_error is True), eat the error and
continue.

Does that sound right?

+    sys.stdout.flush()
+    if NeedsXterm(compiler, runtime) and system == 'linux':
+      cmd = ['xvfb-run', '-a']
+    else:
+      cmd = []
+
+    user_test = os.environ.get('USER_TEST', 'no')
+
+    cmd.extend([sys.executable,
+                os.path.join(os.curdir, 'tools', 'test.py'),
+                '--step_name=' + step_name,
+                '--mode=' + mode,
+                '--compiler=' + compiler,
+                '--runtime=' + runtime,
+                '--time',
+                '--use-sdk',
+                '--report'])
+
+    if user_test == 'yes':
+      cmd.append('--progress=color')
+    else:
+      cmd.extend(['--progress=buildbot', '-v'])
 
-def BuildSDK(mode, system):
-  """ build the SDK.
-   Args:
-     - mode: either 'debug' or 'release'
-     - system: either 'linux', 'mac', or 'win7'
-  """
-  os.chdir(DART_PATH)
+    if flags:
+      cmd.extend(flags)
+    cmd.extend(targets)
 
-  args = [sys.executable, './tools/build.py', '--mode=' + mode, 'create_sdk']
-  print 'running %s' % (' '.join(args))
-  return subprocess.call(args, env=NO_COLOR_ENV)
+    print 'running %s' % (' '.join(cmd))
+    bot.RunProcess(cmd)
 
 
 def TestCompiler(runtime, mode, system, flags, is_buildbot, test_set):
@@ -218,9 +142,6 @@ def TestCompiler(runtime, mode, system, flags, is_buildbot, test_set):
      - test_set: Specification of a non standard test set, default None
   """
 
-  # Make sure we are in the dart directory
-  os.chdir(DART_PATH)
-
   if system.startswith('win') and runtime == 'ie':
     # There should not be more than one InternetExplorerDriver instance
     # running at a time. For details, see
@@ -294,7 +215,6 @@ def TestCompiler(runtime, mode, system, flags, is_buildbot, test_set):
       TestStep("dart2js_extra", mode, system, 'dart2js', runtime, extras,
                flags)
 
-  return 0
 
 def _DeleteTempWebdriverProfiles(directory):
   """Find all the firefox profiles in a particular directory and delete them."""
@@ -303,6 +223,7 @@ def _DeleteTempWebdriverProfiles(directory):
     if os.path.isdir(item) and (f.startswith('tmp') or f.startswith('opera')):
       subprocess.Popen('rm -rf %s' % item, shell=True)
 
+
 def CleanUpTemporaryFiles(system, browser):
   """For some browser (selenium) tests, the browser creates a temporary profile
   on each browser session start. On Windows, generally these files are
@@ -331,19 +252,6 @@ def CleanUpTemporaryFiles(system, browser):
     _DeleteTempWebdriverProfiles('/tmp')
     _DeleteTempWebdriverProfiles('/var/tmp')
 
-def ClobberBuilder(mode):
-  """ Clobber the builder before we do the build.
-  Args:
-     - mode: either 'debug' or 'release'
-  """
-  cmd = [sys.executable,
-         './tools/clean_output_directory.py',
-         '--mode=' + mode]
-  print 'Clobbering %s' % (' '.join(cmd))
-  return subprocess.call(cmd, env=NO_COLOR_ENV)
-
-def GetShouldClobber():
-  return os.environ.get(BUILDER_CLOBBER) == "1"
 
 def GetHasHardCodedCheckedMode(build_info):
   # TODO(ricow): We currently run checked mode tests on chrome on linux and
@@ -357,32 +265,8 @@ def GetHasHardCodedCheckedMode(build_info):
     return True
   return False
 
-def main():
-  if len(sys.argv) == 0:
-    print 'Script pathname not known, giving up.'
-    return 1
-
-  build_info = GetBuildInfo()
-
-  # Print out the buildinfo for easy debugging.
-  build_info.PrintBuildInfo()
-
-  if build_info.compiler is None:
-    return 1
-
-  if GetShouldClobber():
-    print '@@@BUILD_STEP Clobber@@@'
-    status = ClobberBuilder(build_info.mode)
-    if status != 0:
-      print '@@@STEP_FAILURE@@@'
-      return status
-
-  print '@@@BUILD_STEP build sdk@@@'
-  status = BuildSDK(build_info.mode, build_info.system)
-  if status != 0:
-    print '@@@STEP_FAILURE@@@'
-    return status
 
+def RunCompilerTests(build_info):
   test_flags = []
   if build_info.shard_index:
     test_flags = ['--shards=%s' % build_info.total_shards,
@@ -392,22 +276,18 @@ def main():
 
   if build_info.host_checked: test_flags += ['--host-checked']
 
-  status = TestCompiler(build_info.runtime, build_info.mode,
-                        build_info.system, list(test_flags),
-                        build_info.is_buildbot, build_info.test_set)
+  TestCompiler(build_info.runtime, build_info.mode, build_info.system,
+               list(test_flags), build_info.is_buildbot, build_info.test_set)
 
   # See comment in GetHasHardCodedCheckedMode, this is a hack.
-  if (status == 0 and GetHasHardCodedCheckedMode(build_info)):
-    status = TestCompiler(build_info.runtime, build_info.mode,
-                          build_info.system,
-                          test_flags  + ['--checked'],
-                          build_info.is_buildbot,
-                          build_info.test_set)
-
-  if build_info.runtime != 'd8': CleanUpTemporaryFiles(build_info.system,
-                                                       build_info.runtime)
-  if status != 0: print '@@@STEP_FAILURE@@@'
-  return status
+  if (GetHasHardCodedCheckedMode(build_info)):
+    TestCompiler(build_info.runtime, build_info.mode, build_info.system,
+                 test_flags + ['--checked'], build_info.is_buildbot,
+                 build_info.test_set)
+
+  if build_info.runtime != 'd8':
+    CleanUpTemporaryFiles(build_info.system, build_info.runtime)
+
 
 if __name__ == '__main__':
-  sys.exit(main())
+  bot.RunBot(GetBuildInfo, RunCompilerTests)