Home | History | Annotate | Download | only in gyp
      1 #!/usr/bin/env python
      2 #
      3 # Copyright 2014 The Chromium Authors. All rights reserved.
      4 # Use of this source code is governed by a BSD-style license that can be
      5 # found in the LICENSE file.
      6 
      7 """Generates the obfuscated jar and test jar for an apk.
      8 
      9 If proguard is not enabled or 'Release' is not in the configuration name,
     10 obfuscation will be a no-op.
     11 """
     12 
     13 import fnmatch
     14 import optparse
     15 import os
     16 import sys
     17 import zipfile
     18 
     19 from util import build_utils
     20 
     21 def ParseArgs(argv):
     22   parser = optparse.OptionParser()
     23   parser.add_option('--android-sdk', help='path to the Android SDK folder')
     24   parser.add_option('--android-sdk-tools',
     25                     help='path to the Android SDK build tools folder')
     26   parser.add_option('--android-sdk-jar',
     27                     help='path to Android SDK\'s android.jar')
     28   parser.add_option('--proguard-jar-path',
     29                     help='Path to proguard.jar in the sdk')
     30   parser.add_option('--input-jars-paths',
     31                     help='Path to jars to include in obfuscated jar')
     32 
     33   parser.add_option('--proguard-configs',
     34                     help='Paths to proguard config files')
     35 
     36   parser.add_option('--configuration-name',
     37                     help='Gyp configuration name (i.e. Debug, Release)')
     38   parser.add_option('--proguard-enabled', action='store_true',
     39                     help='Set if proguard is enabled for this target.')
     40 
     41   parser.add_option('--obfuscated-jar-path',
     42                     help='Output path for obfuscated jar.')
     43 
     44   parser.add_option('--testapp', action='store_true',
     45                     help='Set this if building an instrumentation test apk')
     46   parser.add_option('--tested-apk-obfuscated-jar-path',
     47                     help='Path to obfusctated jar of the tested apk')
     48   parser.add_option('--test-jar-path',
     49                     help='Output path for jar containing all the test apk\'s '
     50                     'code.')
     51 
     52   parser.add_option('--stamp', help='File to touch on success')
     53 
     54   (options, args) = parser.parse_args(argv)
     55 
     56   if args:
     57     parser.error('No positional arguments should be given. ' + str(args))
     58 
     59   # Check that required options have been provided.
     60   required_options = (
     61       'android_sdk',
     62       'android_sdk_tools',
     63       'android_sdk_jar',
     64       'proguard_jar_path',
     65       'input_jars_paths',
     66       'configuration_name',
     67       'obfuscated_jar_path',
     68       )
     69 
     70   if options.testapp:
     71     required_options += (
     72         'test_jar_path',
     73         )
     74 
     75   build_utils.CheckOptions(options, parser, required=required_options)
     76 
     77   return options, args
     78 
     79 
     80 def main(argv):
     81   options, _ = ParseArgs(argv)
     82 
     83   library_classpath = [options.android_sdk_jar]
     84   input_jars = build_utils.ParseGypList(options.input_jars_paths)
     85 
     86   dependency_class_filters = [
     87       '*R.class', '*R$*.class', '*Manifest.class', '*BuildConfig.class']
     88 
     89   def DependencyClassFilter(name):
     90     for name_filter in dependency_class_filters:
     91       if fnmatch.fnmatch(name, name_filter):
     92         return False
     93     return True
     94 
     95   if options.testapp:
     96     with zipfile.ZipFile(options.test_jar_path, 'w') as test_jar:
     97       for jar in input_jars:
     98         with zipfile.ZipFile(jar, 'r') as jar_zip:
     99           for name in filter(DependencyClassFilter, jar_zip.namelist()):
    100             with jar_zip.open(name) as zip_entry:
    101               test_jar.writestr(name, zip_entry.read())
    102 
    103   if options.configuration_name == 'Release' and options.proguard_enabled:
    104     proguard_cmd = [
    105         'java', '-jar', options.proguard_jar_path,
    106         '-forceprocessing',
    107         '-libraryjars', ':'.join(library_classpath),
    108         '-dump', options.obfuscated_jar_path + '.dump',
    109         '-printseeds', options.obfuscated_jar_path + '.seeds',
    110         '-printusage', options.obfuscated_jar_path + '.usage',
    111         '-printmapping', options.obfuscated_jar_path + '.mapping',
    112         ]
    113 
    114     exclude_paths = []
    115     configs = build_utils.ParseGypList(options.proguard_configs)
    116     if (options.tested_apk_obfuscated_jar_path and
    117         options.tested_apk_obfuscated_jar_path != '/'):
    118       # configs should only contain the process_resources.py generated config.
    119       assert len(configs) == 1, (
    120           'test apks should not have custom proguard configs: ' + str(configs))
    121       tested_jar_info = build_utils.ReadJson(
    122           options.tested_apk_obfuscated_jar_path + '.info')
    123       exclude_paths = tested_jar_info['inputs']
    124       configs = tested_jar_info['configs']
    125       proguard_cmd += [
    126           '-dontobfuscate',
    127           '-dontoptimize',
    128           '-dontskipnonpubliclibraryclassmembers',
    129           '-libraryjars', options.tested_apk_obfuscated_jar_path,
    130           '-applymapping', options.tested_apk_obfuscated_jar_path + '.mapping',
    131           ]
    132 
    133     proguard_injars = [p for p in input_jars if p not in exclude_paths]
    134     proguard_cmd += ['-injars', ':'.join(proguard_injars)]
    135 
    136     for config_file in configs:
    137       proguard_cmd += ['-include', config_file]
    138 
    139     # The output jar must be specified after inputs.
    140     proguard_cmd += ['-outjars', options.obfuscated_jar_path]
    141 
    142     build_utils.CheckOutput(proguard_cmd)
    143 
    144     this_info = {
    145       'inputs': proguard_injars,
    146       'configs': configs
    147     }
    148 
    149     build_utils.WriteJson(
    150         this_info, options.obfuscated_jar_path + '.info')
    151   else:
    152     output_files = [
    153         options.obfuscated_jar_path,
    154         options.obfuscated_jar_path + '.info',
    155         options.obfuscated_jar_path + '.dump',
    156         options.obfuscated_jar_path + '.seeds',
    157         options.obfuscated_jar_path + '.usage',
    158         options.obfuscated_jar_path + '.mapping']
    159     for f in output_files:
    160       if os.path.exists(f):
    161         os.remove(f)
    162       build_utils.Touch(f)
    163 
    164   if options.stamp:
    165     build_utils.Touch(options.stamp)
    166 
    167 if __name__ == '__main__':
    168   sys.exit(main(sys.argv[1:]))
    169