adb_profile_chrome: Refactor into multiple modules and add tests

build/android/chrome_profiler/main.py

Index: build/android/chrome_profiler/main.py
diff --git a/build/android/chrome_profiler/main.py b/build/android/chrome_profiler/main.py
new file mode 100755
index 0000000000000000000000000000000000000000..262f366bee9edebdc977ba6f4b2bad088b8261df
--- /dev/null
+++ b/build/android/chrome_profiler/main.py
@@ -0,0 +1,201 @@
+#!/usr/bin/env python
+#
+# Copyright 2014 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 logging
+import optparse
+import os
+import sys
+import webbrowser
+
+from chrome_profiler import controllers
+from chrome_profiler import profiler
+from chrome_profiler import ui
+
+from pylib import android_commands
+from pylib.device import device_utils
+
+
+_DEFAULT_CHROME_CATEGORIES = '_DEFAULT_CHROME_CATEGORIES'
+
+
+def _ComputeChromeCategories(options):
+  categories = []
+  if options.trace_frame_viewer:
+    categories.append('disabled-by-default-cc.debug')
+  if options.trace_ubercompositor:
+    categories.append('disabled-by-default-cc.debug*')
+  if options.trace_gpu:
+    categories.append('disabled-by-default-gpu.debug*')
+  if options.trace_flow:
+    categories.append('disabled-by-default-toplevel.flow')
+  if options.chrome_categories:
+    categories += options.chrome_categories.split(',')
+  return categories
+
+
+def _ComputeSystraceCategories(options):
+  if not options.systrace_categories:
+    return []
+  return options.systrace_categories.split(',')
+
+
+def main():
+  parser = optparse.OptionParser(description='Record about://tracing profiles '
+                                 'from Android browsers. See http://dev.'
+                                 'chromium.org/developers/how-tos/trace-event-'
+                                 'profiling-tool for detailed instructions for '
+                                 'profiling.')
+
+  timed_options = optparse.OptionGroup(parser, 'Timed tracing')
+  timed_options.add_option('-t', '--time', help='Profile for N seconds and '
+                          'download the resulting trace.', metavar='N',
+                           type='float')
+  parser.add_option_group(timed_options)
+
+  cont_options = optparse.OptionGroup(parser, 'Continuous tracing')
+  cont_options.add_option('--continuous', help='Profile continuously until '
+                          'stopped.', action='store_true')
+  cont_options.add_option('--ring-buffer', help='Use the trace buffer as a '
+                          'ring buffer and save its contents when stopping '
+                          'instead of appending events into one long trace.',
+                          action='store_true')
+  parser.add_option_group(cont_options)
+
+  categories = optparse.OptionGroup(parser, 'Trace categories')
+  categories.add_option('-c', '--categories', help='Select Chrome tracing '
+                        'categories with comma-delimited wildcards, '
+                        'e.g., "*", "cat1*,-cat1a". Omit this option to trace '
+                        'Chrome\'s default categories. Chrome tracing can be '
+                        'disabled with "--categories=\'\'". Use "list" to see '
+                        'the available categories.',
+                        metavar='CHROME_CATEGORIES', dest='chrome_categories',
+                        default=_DEFAULT_CHROME_CATEGORIES)
+  categories.add_option('-s', '--systrace', help='Capture a systrace with the '
+                        'chosen comma-delimited systrace categories. You can '
+                        'also capture a combined Chrome + systrace by enabling '
+                        'both types of categories. Use "list" to see the '
+                        'available categories. Systrace is disabled by '
+                        'default.', metavar='SYS_CATEGORIES',
+                        dest='systrace_categories', default='')
+  categories.add_option('--trace-cc',
+                        help='Deprecated, use --trace-frame-viewer.',
+                        action='store_true')
+  categories.add_option('--trace-frame-viewer',
+                        help='Enable enough trace categories for '
+                        'compositor frame viewing.', action='store_true')
+  categories.add_option('--trace-ubercompositor',
+                        help='Enable enough trace categories for '
+                        'ubercompositor frame data.', action='store_true')
+  categories.add_option('--trace-gpu', help='Enable extra trace categories for '
+                        'GPU data.', action='store_true')
+  categories.add_option('--trace-flow', help='Enable extra trace categories '
+                        'for IPC message flows.', action='store_true')
+  parser.add_option_group(categories)
+
+  output_options = optparse.OptionGroup(parser, 'Output options')
+  output_options.add_option('-o', '--output', help='Save trace output to file.')
+  output_options.add_option('--json', help='Save trace as raw JSON instead of '
+                            'HTML.', action='store_true')
+  output_options.add_option('--view', help='Open resulting trace file in a '
+                            'browser.', action='store_true')
+  parser.add_option_group(output_options)
+
+  browsers = sorted(profiler.GetSupportedBrowsers().keys())
+  parser.add_option('-b', '--browser', help='Select among installed browsers. '
+                    'One of ' + ', '.join(browsers) + ', "stable" is used by '
+                    'default.', type='choice', choices=browsers,
+                    default='stable')
+  parser.add_option('-v', '--verbose', help='Verbose logging.',
+                    action='store_true')
+  parser.add_option('-z', '--compress', help='Compress the resulting trace '
+                    'with gzip. ', action='store_true')
+  options, _args = parser.parse_args()

[Dominik Grewe, 2014/05/22 18:07:10]

How about moving the setup of options in its own method? The main method is
quite long.

[Sami, 2014/05/27 11:03:54]

Good idea, done. Eventually we might move the options to the individual
controllers but for now I think we should keep things simple.

+  if options.trace_cc:
+    parser.parse_error("""--trace-cc is deprecated.
+
+For basic jank busting uses, use  --trace-frame-viewer
+For detailed study of ubercompositor, pass --trace-ubercompositor.
+
+When in doubt, just try out --trace-frame-viewer.
+""")
+
+  if options.verbose:
+    logging.getLogger().setLevel(logging.DEBUG)
+
+  devices = android_commands.GetAttachedDevices()
+  if len(devices) != 1:
+    parser.error('Exactly 1 device much be attached.')

[Dominik Grewe, 2014/05/22 18:07:10]

much -> must

[Sami, 2014/05/27 11:03:54]

Done.

+  device = device_utils.DeviceUtils(devices[0])
+  package_info = profiler.GetSupportedBrowsers()[options.browser]
+
+  if options.chrome_categories in ['list', 'help']:
+    ui.PrintMessage('Collecting record categories list...', eol='')
+    record_categories = []
+    disabled_by_default_categories = []
+    record_categories, disabled_by_default_categories = \
+        controllers.ChromeTracingController.GetCategories(device, package_info)
+
+    ui.PrintMessage('done')
+    ui.PrintMessage('Record Categories:')
+    ui.PrintMessage('\n'.join('\t%s' % item \
+        for item in sorted(record_categories)))
+
+    ui.PrintMessage('\nDisabled by Default Categories:')
+    ui.PrintMessage('\n'.join('\t%s' % item \
+        for item in sorted(disabled_by_default_categories)))
+
+    return 0
+
+  if options.systrace_categories in ['list', 'help']:
+    ui.PrintMessage('\n'.join(
+        controllers.SystraceController.GetCategories(device)))
+    return 0
+
+  if not options.time and not options.continuous:
+    ui.PrintMessage('Time interval or continuous tracing should be specified.')
+    return 1
+
+  chrome_categories = _ComputeChromeCategories(options)
+  systrace_categories = _ComputeSystraceCategories(options)
+
+  if chrome_categories and 'webview' in systrace_categories:
+    logging.warning('Using the "webview" category in systrace together with '
+                    'Chrome tracing results in duplicate trace events.')
+
+  enabled_controllers = []
+  if chrome_categories:
+    enabled_controllers.append(
+        controllers.ChromeTracingController(device,
+                                            package_info,
+                                            chrome_categories,
+                                            options.ring_buffer))
+  if systrace_categories:
+    enabled_controllers.append(
+        controllers.SystraceController(device,
+                                       systrace_categories,
+                                       options.ring_buffer))
+
+  if not controllers:
+    ui.PrintMessage('No trace categories enabled.')
+    return 1
+
+  if options.output:
+    options.output = os.path.expanduser(options.output)
+  result = profiler.CaptureProfile(
+      enabled_controllers,
+      options.time if not options.continuous else 0,
+      output=options.output,
+      compress=options.compress,
+      write_json=options.json)
+  if options.view:
+    if sys.platform == 'darwin':
+      os.system('/usr/bin/open %s' % os.path.abspath(result))
+    else:
+      webbrowser.open(result)
+
+
+if __name__ == '__main__':
+  sys.exit(main())