Filter out ANSI escape sequences when building with clang.

scripts/slave/compile.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.
 
 """A tool to build chrome, executed by buildbot.
 
   When this is run, the current directory (cwd) should be the outer build
   directory (e.g., chrome-release/build/).
 
@@ skipping 97 matching lines @@
 
   if cc:
     print 'Forcing CC = %s' % cc
     env['CC'] = cc
 
   if ldplusplus:
     print 'Forcing LDPLUSPLUS = %s' % ldplusplus
     env['LDPLUSPLUS'] = ldplusplus
 
 
+class CombineFilter(chromium_utils.RunCommandFilter):
+  """A RunCommandFilter that runs several RunCommandFilters in a sequence."""
+  def __init__(self, *filters):
+    chromium_utils.RunCommandFilter.__init__(self)
+    self.filters = filter(None, filters)
+
+  def FilterLine(self, a_line):
+    """Called by RunCommand for each line of output."""
+    for f in self.filters: a_line = f.FilterLine(a_line)
+    return a_line
+
+  def FilterDone(self, last_bits):
+    """Called by RunCommand when the command is done."""
+    for f in self.filters: last_bits = f.FilterDone(last_bits)
+    return last_bits
+
+
+# clang uses ANSII escape codes for colored diagnostics. Sadly, they get
+# disabled when ninja is used (https://github.com/martine/ninja/issues/174),
+# so we force clang's colors on. This filters the escape codes out so that
+# they don't show up on the buildbot output.
+# TODO(thakis): Pass escape sequences on to the master, and strip them there.
+# Then they can be converted to html on the side.
+class AnsiiEscapeSequenceStripper(chromium_utils.RunCommandFilter):
+  # http://en.wikipedia.org/wiki/ANSI_escape_code#Sequence_elements
+  # Only strip CSIs.
+  # This regex was taken from colorama.
+  ANSI_RE = re.compile('\033\[(?:\d|;)*[a-zA-Z]')
+
+  def FilterLine(self, a_line):
+    """Called by RunCommand for each line of output."""
+    return AnsiiEscapeSequenceStripper.ANSI_RE.sub('', a_line)
+
+  def FilterDone(self, last_bits):
+    """Called by RunCommand when the command is done."""
+    return AnsiiEscapeSequenceStripper.ANSI_RE.sub('', last_bits)
+
+
 # RunCommandFilter for xcodebuild
 class XcodebuildFilter(chromium_utils.RunCommandFilter):
   """xcodebuild filter"""
 
   # This isn't a full on state machine because there are some builds that
   # invoke xcodebuild as part of a target action.  Instead it relies on
   # the consistent format that Xcode uses for its steps.  The output follows
   # the pattern of:
   #   1. a section line for the target
   #   2. a "header" for each thing done (Compile, PhaseScriptExecution, etc.)
@@ skipping 228 matching lines @@
 
   env = EchoDict(os.environ)
   common_xcode_settings(command, options, env, options.compiler)
 
   # Add on any remaining args
   command.extend(args)
 
   # Set up the filter before changing directories so the raw build log can
   # be recorded.
   # Support a local file blocking filters (for debugging).  Also check the
-  # darwin version to make sure this is not 10.5 (easier then checking the
+  # darwin version to make sure this is not 10.5 (easier than checking the
   # Xcode version), as Xcode 3.1.x has slightly different output.
   xcodebuild_filter = None
   no_filter_path = os.path.join(os.getcwd(), 'no_xcodebuild_filter')
   if os.path.exists(no_filter_path):
     print 'NOTE: "%s" exists, output is unfiltered' % no_filter_path
   elif os.uname()[3].startswith('Darwin Kernel Version 9.'):
     print 'NOTE: Filtering output not supported on Mac OS X 10.5'
   else:
     full_log_path = os.path.join(os.getcwd(), 'full_xcodebuild_log.txt')
     full_log = open(full_log_path, 'w')
@@ skipping 13 matching lines @@
     env['GOMA_COMPILER_PROXY_DAEMON_MODE'] = 'true'
     if os.path.exists(goma_key):
       env['GOMA_API_KEY_FILE'] = goma_key
     if options.clobber:
       chromium_utils.RunCommand(goma_ctl_cmd + ['restart'], env=env)
     else:
       chromium_utils.RunCommand(goma_ctl_cmd + ['ensure_start'], env=env)
 
   # Run the build.
   env.print_overrides()
+
+  filter_obj = AnsiiEscapeSequenceStripper()
+  if xcodebuild_filter:
+    filter_obj = CombineFilter(filter_obj, xcodebuild_filter)
   result = chromium_utils.RunCommand(command, env=env,
-                                     filter_obj=xcodebuild_filter)
+                                     filter_obj=filter_obj)
 
   if options.compiler in ('goma', 'goma-clang', 'gomaclang'):
     # Always stop the proxy for now to allow in-place update.
     chromium_utils.RunCommand(goma_ctl_cmd + ['stop'], env=env)
 
   return result
 
 
 DISTRIBUTION_FILE = '/etc/lsb-release'
 def get_ubuntu_codename():
@@ skipping 224 matching lines @@
     goma_key = os.path.join(options.goma_dir, 'goma.key')
     env['GOMA_COMPILER_PROXY_DAEMON_MODE'] = 'true'
     if os.path.exists(goma_key):
       env['GOMA_API_KEY_FILE'] = goma_key
     if options.clobber:
       chromium_utils.RunCommand(goma_ctl_cmd + ['restart'], env=env)
     else:
       chromium_utils.RunCommand(goma_ctl_cmd + ['ensure_start'], env=env)
 
   # Run the build.
+  filter_obj = None
+  if options.compiler in ('clang', 'goma-clang'):
+    filter_obj = AnsiiEscapeSequenceStripper()
   env.print_overrides()
-  result = chromium_utils.RunCommand(command, env=env)
+  result = chromium_utils.RunCommand(command, env=env,
+                                     filter_obj=filter_obj)
 
   if options.compiler in ('goma', 'goma-clang'):
     # Always stop the proxy for now to allow in-place update.
     chromium_utils.RunCommand(goma_ctl_cmd + ['stop'], env=env)
 
   return result
 
 
 def main_scons(options, args):
   """Interprets options, clobbers object files, and calls scons.
@@ skipping 308 matching lines @@
     main = build_tool_map.get(options.build_tool)
     if not main:
       sys.stderr.write('Unknown build tool %s.\n' % repr(options.build_tool))
       return 2
 
   return main(options, args)
 
 
 if '__main__' == __name__:
   sys.exit(real_main())