add --uses-library option to manifest_fixer.py

`--uses-library foo` adds <uses-library android:name="foo"
android:required="true"/> element to the manifest.

When there is already a uses-library element with the same
name, then the hand-written element is respected.

Test: m -j
Test: build/soong/scripts/manifest_fixer_test.py

Change-Id: Ia5e989d3c3c3fba7cc9015a6d16dac70464282a8
This commit is contained in:
Jiyong Park
2018-06-18 11:01:00 +09:00
parent 87e50a0d14
commit c08f46fdfc
2 changed files with 163 additions and 9 deletions

View File

@@ -34,14 +34,25 @@ def get_children_with_tag(parent, tag_name):
return children
def find_child_with_attribute(element, tag_name, namespace_uri,
attr_name, value):
for child in get_children_with_tag(element, tag_name):
attr = child.getAttributeNodeNS(namespace_uri, attr_name)
if attr is not None and attr.value == value:
return child
return None
def parse_args():
"""Parse commandline arguments."""
parser = argparse.ArgumentParser()
parser.add_argument('--minSdkVersion', default='', dest='min_sdk_version',
help='specify minSdkVersion used by the build system')
parser.add_argument('--uses-library', dest='uses_libraries', action='append',
help='specify additional <uses-library> tag to add')
parser.add_argument('input', help='input AndroidManifest.xml file')
parser.add_argument('output', help='input AndroidManifest.xml file')
parser.add_argument('output', help='output AndroidManifest.xml file')
return parser.parse_args()
@@ -104,6 +115,17 @@ def compare_version_gt(a, b):
return b_is_int
def get_indent(element, default_level):
indent = ''
if element is not None and element.nodeType == minidom.Node.TEXT_NODE:
text = element.nodeValue
indent = text[:len(text)-len(text.lstrip())]
if not indent or indent == '\n':
# 1 indent = 4 space
indent = '\n' + (' ' * default_level * 4)
return indent
def raise_min_sdk_version(doc, requested):
"""Ensure the manifest contains a <uses-sdk> tag with a minSdkVersion.
@@ -124,14 +146,7 @@ def raise_min_sdk_version(doc, requested):
element = uses_sdk[0]
else:
element = doc.createElement('uses-sdk')
indent = ''
first = manifest.firstChild
if first is not None and first.nodeType == minidom.Node.TEXT_NODE:
text = first.nodeValue
indent = text[:len(text)-len(text.lstrip())]
if not indent or indent == '\n':
indent = '\n '
indent = get_indent(manifest.firstChild, 1)
manifest.insertBefore(element, manifest.firstChild)
# Insert an indent before uses-sdk to line it up with the indentation of the
@@ -150,6 +165,55 @@ def raise_min_sdk_version(doc, requested):
min_attr.value = requested
def add_uses_libraries(doc, new_uses_libraries):
"""Add additional <uses-library> tags with android:required=true.
Args:
doc: The XML document. May be modified by this function.
new_uses_libraries: The names of libraries to be added by this function.
Raises:
RuntimeError: Invalid manifest
"""
manifest = parse_manifest(doc)
elems = get_children_with_tag(manifest, 'application')
application = elems[0] if len(elems) == 1 else None
if len(elems) > 1:
raise RuntimeError('found multiple <application> tags')
elif not elems:
application = doc.createElement('application')
indent = get_indent(manifest.firstChild, 1)
first = manifest.firstChild
manifest.insertBefore(doc.createTextNode(indent), first)
manifest.insertBefore(application, first)
indent = get_indent(application.firstChild, 2)
last = application.lastChild
if last is not None and last.nodeType != minidom.Node.TEXT_NODE:
last = None
for name in new_uses_libraries:
if find_child_with_attribute(application, 'uses-library', android_ns,
'name', name) is not None:
# If the uses-library tag of the same 'name' attribute value exists,
# respect it.
continue
ul = doc.createElement('uses-library')
ul.setAttributeNS(android_ns, 'android:name', name)
ul.setAttributeNS(android_ns, 'android:required', 'true')
application.insertBefore(doc.createTextNode(indent), last)
application.insertBefore(ul, last)
# align the closing tag with the opening tag if it's not
# indented
if application.lastChild.nodeType != minidom.Node.TEXT_NODE:
indent = get_indent(application.previousSibling, 1)
application.appendChild(doc.createTextNode(indent))
def write_xml(f, doc):
f.write('<?xml version="1.0" encoding="utf-8"?>\n')
for node in doc.childNodes:
@@ -168,6 +232,9 @@ def main():
if args.min_sdk_version:
raise_min_sdk_version(doc, args.min_sdk_version)
if args.uses_libraries:
add_uses_libraries(doc, args.uses_libraries)
with open(args.output, 'wb') as f:
write_xml(f, doc)