[Android] Add context manager to record logcat during step(s).

scripts/slave/recipe_modules/chromium_android/api.py

 # Copyright 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 contextlib
 import datetime
 import json
 import os
 import re
 import urllib
@@ skipping 231 matching lines @@
     # (or at least make the difference clear).
     self.m.archive.zip_and_upload_build(
         'zip_build',
         target=self.m.chromium.c.BUILD_CONFIG,
         # We send None as the path so that zip_build.py gets it from factory
         # properties.
         build_url=None,
         src_dir=self.m.path['slave_build'].join('src'),
         exclude_files='lib.target,gen,android_webview,jingle_unittests')
 
-  def spawn_logcat_monitor(self):
-    self.m.step(
-        'spawn_logcat_monitor',
-        [self.m.path['build'].join('scripts', 'slave', 'daemonizer.py'),
-         '--', self.c.cr_build_android.join('adb_logcat_monitor.py'),
-         self.m.chromium.c.build_dir.join('logcat')],
-        env=self.m.chromium.get_env(),
-        infra_step=True)
-
   def spawn_device_monitor(self):
     script = self.m.path['build'].join('scripts', 'slave', 'daemonizer.py')
     args = [
         '--action', 'restart',
         '--pid-file-path', '/tmp/device_monitor.pid',
         '--', self.resource('spawn_device_monitor.py'),
         self.m.adb.adb_path(),
         json.dumps(self._devices),
         self.m.properties['mastername'],
         self.m.properties['buildername'],
@@ skipping 397 matching lines @@
       args.extend(['--official-build'])
     if json_results_file:
       args.extend(['--json-results-file', json_results_file])
 
     return self.test_runner(
         'Instrumentation test %s%s' % (annotation or name,
                                        ' (%s)' % suffix if suffix else ''),
         args=['instrumentation'] + args,
         **kwargs)
 
-  def logcat_dump(self, gs_bucket=None):
+  def spawn_logcat_monitor(self, logcat_dir=None):
+    if not logcat_dir:
+      logcat_dir = self.m.chromium.c.build_dir.join('logcat')

[luqui, 2015/11/23 22:59:40]

Sure you don't want this to be a config item?

[mikecase (-- gone --), 2015/11/24 20:50:59]

Added default_logcat_dir to config.

+
+    self.m.step(
+        'spawn_logcat_monitor',
+        [self.m.path['build'].join('scripts', 'slave', 'daemonizer.py'),
+         '--', self.c.cr_build_android.join('adb_logcat_monitor.py'),
+         logcat_dir],
+        env=self.m.chromium.get_env(),
+        infra_step=True)
+
+  def logcat_dump(self, output_logcat_file, logcat_dir=None, gs_bucket=None):
+    if not logcat_dir:
+      logcat_dir = self.m.chromium.c.build_dir.join('logcat')
+
     if gs_bucket:
-      log_path = self.m.chromium.output_dir.join('full_log')
       self.m.python(
           'logcat_dump',
           self.m.path['checkout'].join('build', 'android',
                                        'adb_logcat_printer.py'),
-          [ '--output-path', log_path,
-            self.m.path['checkout'].join('out', 'logcat') ],
+          ['--output-path', output_logcat_file, logcat_dir],
           infra_step=True)
       self.m.gsutil.upload(
-          log_path,
+          output_logcat_file,
           gs_bucket,
           'logcat_dumps/%s/%s' % (self.m.properties['buildername'],
                                   self.m.properties['buildnumber']),
           link_name='logcat dump',
           version='4.7')
     else:
       self.m.python(
           'logcat_dump',
           self.m.path['build'].join('scripts', 'slave', 'tee.py'),
-          [self.m.chromium.output_dir.join('full_log'),
+          [output_logcat_file,
            '--',
            self.m.path['checkout'].join('build', 'android',
                                         'adb_logcat_printer.py'),
-           self.m.path['checkout'].join('out', 'logcat')],
-          infra_step=True,
-          )
+           logcat_dir],
+          infra_step=True)
 
-  def stack_tool_steps(self):
-    log_file = self.m.path['checkout'].join('out',
-                                            self.m.chromium.c.BUILD_CONFIG,
-                                            'full_log')
+  @contextlib.contextmanager
+  def logcat(self, step_name):
+    """Context manager for recording logcat.
+
+    Args:
+      step_name: Name of the outer step. Any steps ran inside this context
+          manager will be nested inside.
+    """
+    with self.m.step.nest(step_name):
+      logcat_dir = self.m.path.mkdtemp('test_logcat')
+      self.spawn_logcat_monitor(logcat_dir)
+      yield
+      self.logcat_dump(logcat_dir=logcat_dir,

[luqui, 2015/11/23 22:59:40]

Will this kill the logcat monitor..  or will the next spawn_logcat_monitor
reset, or... Just wondering what the flow is like when there are multiple of
these.

[mikecase (-- gone --), 2015/11/24 20:50:59]

So, I looked through the scripts, spawn_logcat_monitor will start a process that
records the logcats from all devices into a directory. It also stores its
process ID in a specially named file in the directory. When you call logcat_dump
on that same directory, it kills the process with the PID from the specially
named file. So yeah, logcat_dump will kill the associated logcat_monitor for a
given directory.

+                       output_logcat_file=self.m.raw_io.output('logcat'),
+                       gs_bucket=None)
+
+  def stack_tool_steps(self, logcat_file):
     target_arch = self.m.chromium.c.gyp_env.GYP_DEFINES['target_arch']
     # gyp converts ia32 to x86, bot needs to do the same
     target_arch = {'ia32': 'x86'}.get(target_arch) or target_arch
     self.m.step(
         'stack_tool_with_logcat_dump',
         [self.m.path['checkout'].join('third_party', 'android_platform',
                               'development', 'scripts', 'stack'),
-         '--arch', target_arch, '--more-info', log_file],
+         '--arch', target_arch, '--more-info', logcat_file],
         env=self.m.chromium.get_env(),
         infra_step=True)
     self.m.step(
         'stack_tool_for_tombstones',
         [self.m.path['checkout'].join('build', 'android', 'tombstones.py'),
          '-a', '-s', '-w'], env=self.get_env(),
         infra_step=True)
     if self.c.asan_symbolize:
       self.m.step(
           'stack_tool_for_asan',
           [self.m.path['checkout'].join('build',
                                         'android',
                                         'asan_symbolize.py'),
-           '-l', log_file], env=self.m.chromium.get_env(),
+           '-l', logcat_file], env=self.m.chromium.get_env(),
           infra_step=True)
 
   def test_report(self):
     self.m.python.inline(
         'test_report',
          """
             import glob, os, sys
             for report in glob.glob(sys.argv[1]):
               with open(report, 'r') as f:
                 for l in f.readlines():
@@ skipping 19 matching lines @@
     else:
       kwargs = {}
     self.provision_devices(**kwargs)
     if self.m.chromium.c.gyp_env.GYP_DEFINES.get('asan', 0) == 1:
       self.asan_device_setup()
 
     self.spawn_device_monitor()
 
   def common_tests_final_steps(self, logcat_gs_bucket=None):
     self.shutdown_device_monitor()
-    self.logcat_dump(gs_bucket=logcat_gs_bucket)
-    self.stack_tool_steps()
+    logcat_file = self.m.chromium.output_dir.join('full_log')
+    self.logcat_dump(output_logcat_file=logcat_file,
+                     gs_bucket=logcat_gs_bucket)
+    self.stack_tool_steps(logcat_file=logcat_file)
     self.test_report()
 
   def run_bisect_script(self, extra_src='', path_to_config='', **kwargs):
     self.m.step('prepare bisect perf regression',
         [self.m.path['checkout'].join('tools',
                                       'prepare-bisect-perf-regression.py'),
          '-w', self.m.path['slave_build']])
 
     args = []
     if extra_src:
@@ skipping 256 matching lines @@
   def test_runner(self, step_name, args=None, **kwargs):
     """Wrapper for the python testrunner script.
 
     Args:
       step_name: Name of the step.
       args: Testrunner arguments.
     """
     with self.handle_exit_codes():
       return self.m.python(
           step_name, self.c.test_runner, args, **kwargs)