Make use of md5_check within package_resources.py

build/android/gyp/package_resources.py

 #!/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.
 
 # pylint: disable=C0301
 """Package resources into an apk.
 
 See https://android.googlesource.com/platform/tools/base/+/master/legacy/ant-tasks/src/main/java/com/android/ant/AaptExecTask.java
 and
 https://android.googlesource.com/platform/sdk/+/master/files/ant/build.xml
 """
 # pylint: enable=C0301
 
 import optparse
 import os
 import re
 import shutil
+import sys
 import zipfile
 
 from util import build_utils
 
 
 # List is generated from the chrome_apk.apk_intermediates.ap_ via:
 #     unzip -l $FILE_AP_ | cut -c31- | grep res/draw | cut -d'/' -f 2 | sort \
 #     | uniq | grep -- -tvdpi- | cut -c10-
 # and then manually sorted.
 # Note that we can't just do a cross-product of dimentions because the filenames
@@ skipping 34 matching lines @@
         'xxxhdpi-v21',
     ),
     'tvdpi': (
         'tvdpi-v4',
         'sw600dp-tvdpi-v13',
         'ldrtl-sw600dp-tvdpi-v17',
     ),
 }
 
 
-def ParseArgs():
+def _ParseArgs(args):
   """Parses command line options.
 
   Returns:
     An options object as from optparse.OptionsParser.parse_args()
   """
   parser = optparse.OptionParser()
   build_utils.AddDepfileOption(parser)
   parser.add_option('--android-sdk', help='path to the Android SDK folder')
   parser.add_option('--aapt-path',
                     help='path to the Android aapt tool')
 
   parser.add_option('--configuration-name',
                     help='Gyp\'s configuration name (Debug or Release).')
 
   parser.add_option('--android-manifest', help='AndroidManifest.xml path')
   parser.add_option('--version-code', help='Version code for apk.')
   parser.add_option('--version-name', help='Version name for apk.')
   parser.add_option(
       '--shared-resources',
       action='store_true',
       help='Make a resource package that can be loaded by a different'
       'application at runtime to access the package\'s resources.')
   parser.add_option(
       '--app-as-shared-lib',
       action='store_true',
       help='Make a resource package that can be loaded as shared library')
   parser.add_option('--resource-zips',
+                    default='[]',
                     help='zip files containing resources to be packaged')
   parser.add_option('--asset-dir',
                     help='directories containing assets to be packaged')
   parser.add_option('--no-compress', help='disables compression for the '
                     'given comma separated list of extensions')
   parser.add_option(
       '--create-density-splits',
       action='store_true',
       help='Enables density splits')
   parser.add_option('--language-splits',
+                    default='[]',
                     help='GYP list of languages to create splits for')
 
   parser.add_option('--apk-path',
                     help='Path to output (partial) apk.')
 
-  (options, args) = parser.parse_args()
+  options, positional_args = parser.parse_args(args)
 
-  if args:
+  if positional_args:
     parser.error('No positional arguments should be given.')
 
   # Check that required options have been provided.
   required_options = ('android_sdk', 'aapt_path', 'configuration_name',
                       'android_manifest', 'version_code', 'version_name',
                       'apk_path')
 
   build_utils.CheckOptions(options, parser, required=required_options)
 
+  options.resource_zips = build_utils.ParseGypList(options.resource_zips)
+  options.language_splits = build_utils.ParseGypList(options.language_splits)
   return options
 
 
 def MoveImagesToNonMdpiFolders(res_root):
   """Move images from drawable-*-mdpi-* folders to drawable-* folders.
 
   Why? http://crbug.com/289843
   """
   for src_dir_name in os.listdir(res_root):
     src_components = src_dir_name.split('-')
@@ skipping 30 matching lines @@
     res_dirs = sorted(subdirs, key=lambda p : int(os.path.basename(p)))
   else:
     res_dirs = [d]
   package_command = []
   for d in res_dirs:
     MoveImagesToNonMdpiFolders(d)
     package_command += ['-S', d]
   return package_command
 
 
+def _GenerateDensitySplitPaths(apk_path):
+  for density, config in DENSITY_SPLITS.iteritems():
+    src_path = '%s_%s' % (apk_path, '_'.join(config))
+    dst_path = '%s_%s' % (apk_path, density)
+    yield src_path, dst_path
+
+
+def _GenerateLanguageSplitOutputPaths(apk_path, languages):
+  for lang in languages:
+    yield '%s_%s' % (apk_path, lang)
+
+
 def RenameDensitySplits(apk_path):
   """Renames all density splits to have shorter / predictable names."""
-  for density, config in DENSITY_SPLITS.iteritems():
-    src_path = '%s_%s' % (apk_path, '_'.join(config))
-    dst_path = '%s_%s' % (apk_path, density)
-    if src_path != dst_path:
-      if os.path.exists(dst_path):
-        os.unlink(dst_path)
-      os.rename(src_path, dst_path)
+  for src_path, dst_path in _GenerateDensitySplitPaths(apk_path):
+    shutil.move(src_path, dst_path)
 
 
 def CheckForMissedConfigs(apk_path, check_density, languages):
   """Raises an exception if apk_path contains any unexpected configs."""
   triggers = []
   if check_density:
     triggers.extend(re.compile('-%s' % density) for density in DENSITY_SPLITS)
   if languages:
     triggers.extend(re.compile(r'-%s\b' % lang) for lang in languages)
   with zipfile.ZipFile(apk_path) as main_apk_zip:
     for name in main_apk_zip.namelist():
       for trigger in triggers:
         if trigger.search(name) and not 'mipmap-' in name:
           raise Exception(('Found config in main apk that should have been ' +
                            'put into a split: %s\nYou need to update ' +
                            'package_resources.py to include this new ' +
                            'config (trigger=%s)') % (name, trigger.pattern))
 
 
-def main():
-  options = ParseArgs()
-  android_jar = os.path.join(options.android_sdk, 'android.jar')
-  aapt = options.aapt_path
+def _ConstructMostAaptArgs(options):
+  package_command = [
+      options.aapt_path,
+      'package',
+      '--version-code', options.version_code,
+      '--version-name', options.version_name,
+      '-M', options.android_manifest,
+      '--no-crunch',
+      '-f',
+      '--auto-add-overlay',
+      '-I', os.path.join(options.android_sdk, 'android.jar'),
+      '-F', options.apk_path,
+      '--ignore-assets', build_utils.AAPT_IGNORE_PATTERN,
+      ]

[pkotwicz, 2015/09/24 19:21:36]

Nit: I think that ']' should have the same indent as 'package_command'

The examples in the style guide seem to do this.
https://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Indentation
(Though they do not explicitly say that this should be done)

[agrieve, 2015/09/25 02:14:35]

Done.

+  if options.no_compress:

[pkotwicz, 2015/09/24 19:21:36]

Nit: A blank line between lines 232 and 233?

[agrieve, 2015/09/25 02:14:35]

Done.

+    for ext in options.no_compress.split(','):
+      package_command += ['-0', ext]
 
+  if options.shared_resources:
+    package_command.append('--shared-lib')
+
+  if options.app_as_shared_lib:
+    package_command.append('--app-as-shared-lib')
+
+  if options.asset_dir and os.path.exists(options.asset_dir):
+    package_command += ['-A', options.asset_dir]
+
+  if options.create_density_splits:
+    for config in DENSITY_SPLITS.itervalues():
+      package_command.extend(('--split', ','.join(config)))
+
+  if options.language_splits:
+    for lang in options.language_splits:
+      package_command.extend(('--split', lang))
+
+  if 'Debug' in options.configuration_name:
+    package_command += ['--debug-mode']
+
+  return package_command
+

[pkotwicz, 2015/09/24 19:21:36]

Nit: Remove one of the blank line?

[agrieve, 2015/09/25 02:14:36]

Style guide says 2 lines between top-level definitions

+
+def _OnStaleMd5(package_command, options):
   with build_utils.TempDir() as temp_dir:
-    package_command = [aapt,
-                       'package',
-                       '--version-code', options.version_code,
-                       '--version-name', options.version_name,
-                       '-M', options.android_manifest,
-                       '--no-crunch',
-                       '-f',
-                       '--auto-add-overlay',
-                       '-I', android_jar,
-                       '-F', options.apk_path,
-                       '--ignore-assets', build_utils.AAPT_IGNORE_PATTERN,
-                       ]
-
-    if options.no_compress:
-      for ext in options.no_compress.split(','):
-        package_command += ['-0', ext]
-    if options.shared_resources:
-      package_command.append('--shared-lib')
-    if options.app_as_shared_lib:
-      package_command.append('--app-as-shared-lib')
-
-    if options.asset_dir and os.path.exists(options.asset_dir):
-      package_command += ['-A', options.asset_dir]
-
     if options.resource_zips:
-      dep_zips = build_utils.ParseGypList(options.resource_zips)
+      dep_zips = options.resource_zips
       for z in dep_zips:
         subdir = os.path.join(temp_dir, os.path.basename(z))
         if os.path.exists(subdir):
           raise Exception('Resource zip name conflict: ' + os.path.basename(z))
         build_utils.ExtractAll(z, path=subdir)
         package_command += PackageArgsForExtractedZip(subdir)
 
-    if options.create_density_splits:
-      for config in DENSITY_SPLITS.itervalues():
-        package_command.extend(('--split', ','.join(config)))
-
-    language_splits = None
-    if options.language_splits:
-      language_splits = build_utils.ParseGypList(options.language_splits)
-      for lang in language_splits:
-        package_command.extend(('--split', lang))
-
-    if 'Debug' in options.configuration_name:
-      package_command += ['--debug-mode']
-
     build_utils.CheckOutput(
         package_command, print_stdout=False, print_stderr=False)
 
-    if options.create_density_splits or language_splits:
-      CheckForMissedConfigs(
-          options.apk_path, options.create_density_splits, language_splits)
+    if options.create_density_splits or options.language_splits:
+      CheckForMissedConfigs(options.apk_path, options.create_density_splits,
+                            options.language_splits)
 
     if options.create_density_splits:
       RenameDensitySplits(options.apk_path)
 
-    if options.depfile:
-      build_utils.WriteDepfile(
-          options.depfile,
-          build_utils.GetPythonDependencies())
+
+def main(args):
+  args = build_utils.ExpandFileArgs(args)
+  options = _ParseArgs(args)
+
+  package_command = _ConstructMostAaptArgs(options)
+
+  output_paths = [ options.apk_path ]
+
+  if options.create_density_splits:
+    for _, dst_path in _GenerateDensitySplitPaths(options.apk_path):
+      output_paths.append(dst_path)
+  output_paths.extend(
+      _GenerateLanguageSplitOutputPaths(options.apk_path,
+                                        options.language_splits))
+
+  input_paths = [ options.android_manifest ] + options.resource_zips
+  if options.asset_dir and os.path.exists(options.asset_dir):
+    for root, _, filenames in os.walk(options.asset_dir):
+      input_paths.extend(os.path.join(root, f) for f in filenames)
+
+  build_utils.CallAndWriteDepfileIfStale(
+      lambda: _OnStaleMd5(package_command, options),
+      options,
+      input_paths=input_paths,
+      input_strings=package_command,
+      output_paths=output_paths)
 
 
 if __name__ == '__main__':
-  main()
+  main(sys.argv[1:])