1#!/usr/bin/env python3 2 3# Copyright 2017 The Chromium Authors 4# Use of this source code is governed by a BSD-style license that can be 5# found in the LICENSE file. 6 7"""Merges dependency Android manifests into a root manifest.""" 8 9import argparse 10import collections 11import contextlib 12import os 13import sys 14import tempfile 15import xml.etree.ElementTree as ElementTree 16 17from util import build_utils 18from util import manifest_utils 19import action_helpers # build_utils adds //build to sys.path. 20 21_MANIFEST_MERGER_MAIN_CLASS = 'com.android.manifmerger.Merger' 22 23 24@contextlib.contextmanager 25def _ProcessMainManifest(manifest_path, min_sdk_version, target_sdk_version, 26 max_sdk_version, manifest_package): 27 """Patches the main Android manifest""" 28 doc, manifest, _ = manifest_utils.ParseManifest(manifest_path) 29 manifest_utils.SetUsesSdk(manifest, target_sdk_version, min_sdk_version, 30 max_sdk_version) 31 assert manifest_utils.GetPackage(manifest) or manifest_package, \ 32 'Must set manifest package in GN or in AndroidManifest.xml' 33 if manifest_package: 34 manifest.set('package', manifest_package) 35 tmp_prefix = manifest_path.replace(os.path.sep, '-') 36 with tempfile.NamedTemporaryFile(prefix=tmp_prefix) as patched_manifest: 37 manifest_utils.SaveManifest(doc, patched_manifest.name) 38 yield patched_manifest.name, manifest_utils.GetPackage(manifest) 39 40 41@contextlib.contextmanager 42def _ProcessOtherManifest(manifest_path, target_sdk_version, 43 seen_package_names): 44 """Patches non-main AndroidManifest.xml if necessary.""" 45 # 1. Ensure targetSdkVersion is set to the expected value to avoid 46 # spurious permissions being added (b/222331337). 47 # 2. Ensure all manifests have a unique package name so that the merger 48 # does not fail when this happens. 49 doc, manifest, _ = manifest_utils.ParseManifest(manifest_path) 50 51 changed_api = manifest_utils.SetTargetApiIfUnset(manifest, target_sdk_version) 52 53 package_name = manifest_utils.GetPackage(manifest) 54 package_count = seen_package_names[package_name] 55 seen_package_names[package_name] += 1 56 if package_count > 0: 57 manifest.set('package', f'{package_name}_{package_count}') 58 59 if package_count > 0 or changed_api: 60 tmp_prefix = manifest_path.replace(os.path.sep, '-') 61 with tempfile.NamedTemporaryFile(prefix=tmp_prefix) as patched_manifest: 62 manifest_utils.SaveManifest(doc, patched_manifest.name) 63 yield patched_manifest.name 64 else: 65 yield manifest_path 66 67 68def main(argv): 69 argv = build_utils.ExpandFileArgs(argv) 70 parser = argparse.ArgumentParser(description=__doc__) 71 action_helpers.add_depfile_arg(parser) 72 parser.add_argument('--manifest-merger-jar', 73 help='Path to SDK\'s manifest merger jar.', 74 required=True) 75 parser.add_argument('--root-manifest', 76 help='Root manifest which to merge into', 77 required=True) 78 parser.add_argument('--output', help='Output manifest path', required=True) 79 parser.add_argument('--extras', 80 help='GN list of additional manifest to merge') 81 parser.add_argument( 82 '--min-sdk-version', 83 required=True, 84 help='android:minSdkVersion for merging.') 85 parser.add_argument( 86 '--target-sdk-version', 87 required=True, 88 help='android:targetSdkVersion for merging.') 89 parser.add_argument( 90 '--max-sdk-version', help='android:maxSdkVersion for merging.') 91 parser.add_argument( 92 '--manifest-package', 93 help='Package name of the merged AndroidManifest.xml.') 94 parser.add_argument('--warnings-as-errors', 95 action='store_true', 96 help='Treat all warnings as errors.') 97 args = parser.parse_args(argv) 98 99 with action_helpers.atomic_output(args.output) as output: 100 cmd = build_utils.JavaCmd() + [ 101 '-cp', 102 args.manifest_merger_jar, 103 _MANIFEST_MERGER_MAIN_CLASS, 104 '--out', 105 output.name, 106 '--property', 107 'MIN_SDK_VERSION=' + args.min_sdk_version, 108 '--property', 109 'TARGET_SDK_VERSION=' + args.target_sdk_version, 110 ] 111 112 if args.max_sdk_version: 113 cmd += [ 114 '--property', 115 'MAX_SDK_VERSION=' + args.max_sdk_version, 116 ] 117 118 extras = action_helpers.parse_gn_list(args.extras) 119 120 with contextlib.ExitStack() as stack: 121 root_manifest, package = stack.enter_context( 122 _ProcessMainManifest(args.root_manifest, args.min_sdk_version, 123 args.target_sdk_version, args.max_sdk_version, 124 args.manifest_package)) 125 if extras: 126 seen_package_names = collections.Counter() 127 extras_processed = [ 128 stack.enter_context( 129 _ProcessOtherManifest(e, args.target_sdk_version, 130 seen_package_names)) for e in extras 131 ] 132 cmd += ['--libs', ':'.join(extras_processed)] 133 cmd += [ 134 '--main', 135 root_manifest, 136 '--property', 137 'PACKAGE=' + package, 138 '--remove-tools-declarations', 139 ] 140 build_utils.CheckOutput( 141 cmd, 142 # https://issuetracker.google.com/issues/63514300: 143 # The merger doesn't set a nonzero exit code for failures. 144 fail_func=lambda returncode, stderr: returncode != 0 or build_utils. 145 IsTimeStale(output.name, [root_manifest] + extras), 146 fail_on_output=args.warnings_as_errors) 147 148 if args.depfile: 149 action_helpers.write_depfile(args.depfile, args.output, inputs=extras) 150 151 152if __name__ == '__main__': 153 main(sys.argv[1:]) 154