Android: Add APK patch size estimates to resource_sizes.py.

build/android/resource_sizes.py

 #!/usr/bin/python
 # Copyright (c) 2011 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.
 
 """Prints the size of each given file and optionally computes the size of
    libchrome.so without the dependencies added for building with android NDK.
    Also breaks down the contents of the APK to determine the installed size
    and assign size contributions to different classes of file.
 """
 
 import argparse
 import collections
 from contextlib import contextmanager
 import json
 import logging
 import operator
 import os
 import re
 import struct
 import sys
 import tempfile
 import zipfile
 import zlib
 
+from binary_size import apk_downloader
 import devil_chromium
 from devil.android.sdk import build_tools
 from devil.utils import cmd_helper
 from devil.utils import lazy
 import method_count
 from pylib import constants
 from pylib.constants import host_paths
 
 _AAPT_PATH = lazy.WeakConstant(lambda: build_tools.GetPath('aapt'))
 _GRIT_PATH = os.path.join(host_paths.DIR_SOURCE_ROOT, 'tools', 'grit')
 _BUILD_UTILS_PATH = os.path.join(
     host_paths.DIR_SOURCE_ROOT, 'build', 'android', 'gyp')
+_APK_PATCH_SIZE_ESTIMATOR_PATH = os.path.join(
+    host_paths.DIR_SOURCE_ROOT, 'third_party', 'apk-patch-size-estimator')
 
 # Prepend the grit module from the source tree so it takes precedence over other
 # grit versions that might present in the search path.
 with host_paths.SysPath(_GRIT_PATH, 1):
   from grit.format import data_pack # pylint: disable=import-error
 
 with host_paths.SysPath(host_paths.BUILD_COMMON_PATH):
   import perf_tests_results_helper # pylint: disable=import-error
 
 with host_paths.SysPath(_BUILD_UTILS_PATH, 1):
   from util import build_utils # pylint: disable=import-error
 
+with host_paths.SysPath(_APK_PATCH_SIZE_ESTIMATOR_PATH):
+  import apk_patch_size_estimator  as patch_size # pylint: disable=import-error

[agrieve, 2017/03/20 17:53:40]

nit: you have a double space in here, although even better would be to not alias
it (I believe style guide discourages this)

[estevenson, 2017/03/20 18:02:37]

Done.

+
 
 # Python had a bug in zipinfo parsing that triggers on ChromeModern.apk
 # https://bugs.python.org/issue14315
 def _PatchedDecodeExtra(self):
   # Try to decode the extra field.
   extra = self.extra
   unpack = struct.unpack
   while len(extra) >= 4:
     tp, ln = unpack('<HH', extra[:4])
     if tp == 1:
@@ skipping 607 matching lines @@
   graph_title = os.path.basename(apk_filename) + '_Dex'
   dex_metrics = method_count.CONTRIBUTORS_TO_DEX_CACHE
   for key, label in dex_metrics.iteritems():
     ReportPerfResult(chartjson, graph_title, label, sizes[key], 'entries')
 
   graph_title = '%sCache' % graph_title
   ReportPerfResult(chartjson, graph_title, 'DexCache', sizes['dex_cache_size'],
                    'bytes')
 
 
+def _PrintPatchSizeEstimate(new_apk, builder, bucket, chartjson=None):
+  apk_name = os.path.basename(new_apk)
+  title = apk_name + '_PatchSizeEstimate'
+  # Reference APK paths have spaces replaced by underscores.
+  builder = builder.replace(' ', '_')
+  old_apk = apk_downloader.MaybeDownloadApk(
+      builder, apk_downloader.CURRENT_MILESTONE, apk_name,
+      apk_downloader.DEFAULT_DOWNLOAD_PATH, bucket)
+  if old_apk:
+    # Use a temp dir in case patch size functions fail to clean up temp files.
+    with build_utils.TempDir() as tmp:
+      tmp_name = os.path.join(tmp, 'patch.tmp')
+      bsdiff = patch_size.calculate_bsdiff(old_apk, new_apk, None, tmp_name)
+      ReportPerfResult(chartjson, title, 'BSDiff (gzipped)', bsdiff, 'bytes')
+      fbf = patch_size.calculate_filebyfile(old_apk, new_apk, None, tmp_name)
+      ReportPerfResult(chartjson, title, 'FileByFile (gzipped)', fbf, 'bytes')
+
+
 @contextmanager
 def Unzip(zip_file, filename=None):
   """Utility for temporary use of a single file in a zip archive."""
   with build_utils.TempDir() as unzipped_dir:
     unzipped_files = build_utils.ExtractAll(
         zip_file, unzipped_dir, True, pattern=filename)
     if len(unzipped_files) == 0:
       raise Exception(
           '%s not found in %s' % (filename, zip_file))
     yield unzipped_files[0]
@@ skipping 18 matching lines @@
                          help='Location of the build artifacts.')
   argparser.add_argument('--chartjson', action='store_true',
                          help='Sets output mode to chartjson.')
   argparser.add_argument('--output-dir', default='.',
                          help='Directory to save chartjson to.')
   argparser.add_argument('--no-output-dir', action='store_true',
                          help='Skip all measurements that rely on having '
                          'output-dir')
   argparser.add_argument('-d', '--device',
                          help='Dummy option for perf runner.')
+  argparser.add_argument('--estimate-patch-size', action='store_true',
+                         help='Include patch size estimates. Useful for perf '
+                         'builders where a reference APK is available but adds '
+                         '~3 mins to run time.')
+  argparser.add_argument('--builder', default=apk_downloader.DEFAULT_BUILDER,
+                         help='Builder name to use for reference APK for patch '
+                         'size estimates.')
+  argparser.add_argument('--bucket', default=apk_downloader.DEFAULT_BUCKET,

[agrieve, 2017/03/20 17:53:40]

name bikeshed: how about --reference-apk-bucket and --reference-apk-builder

[estevenson, 2017/03/20 18:02:36]

Done.

+                         help='Storage bucket holding reference APKs.')
   argparser.add_argument('apk', help='APK file path.')
   args = argparser.parse_args()
 
   chartjson = _BASE_CHART.copy() if args.chartjson else None
 
   if args.chromium_output_directory:
     constants.SetOutputDirectory(args.chromium_output_directory)
   if not args.no_output_dir:
     constants.CheckOutputDirectory()
     devil_chromium.Initialize()
     build_vars = _ReadBuildVars(constants.GetOutDirectory())
     tools_prefix = build_vars['android_tool_prefix']
   else:
     tools_prefix = ''
 
   PrintApkAnalysis(args.apk, tools_prefix, chartjson=chartjson)
   _PrintDexAnalysis(args.apk, chartjson=chartjson)
+  if args.estimate_patch_size:
+    _PrintPatchSizeEstimate(
+        args.apk, args.builder, args.bucket, chartjson=chartjson)
   if not args.no_output_dir:
     PrintPakAnalysis(args.apk, args.min_pak_resource_size)
     _PrintStaticInitializersCountFromApk(
         args.apk, tools_prefix, chartjson=chartjson)
   if chartjson:
     results_path = os.path.join(args.output_dir, 'results-chart.json')
     logging.critical('Dumping json to %s', results_path)
     with open(results_path, 'w') as json_file:
       json.dump(chartjson, json_file)
 
 
 if __name__ == '__main__':
   sys.exit(main())