diff --git a/scripts/manifest_fixer.py b/scripts/manifest_fixer.py index f34f6c313..6af0ca900 100755 --- a/scripts/manifest_fixer.py +++ b/scripts/manifest_fixer.py @@ -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 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 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 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 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('\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) diff --git a/scripts/manifest_fixer_test.py b/scripts/manifest_fixer_test.py index ccfa8fbe9..54a3784a9 100755 --- a/scripts/manifest_fixer_test.py +++ b/scripts/manifest_fixer_test.py @@ -158,5 +158,92 @@ class RaiseMinSdkVersionTest(unittest.TestCase): self.assertEqual(output, expected) + +class AddUsesLibrariesTest(unittest.TestCase): + """Unit tests for add_uses_libraries function.""" + + def run_test(self, input_manifest, new_uses_libraries): + doc = minidom.parseString(input_manifest) + manifest_fixer.add_uses_libraries(doc, new_uses_libraries) + output = StringIO.StringIO() + manifest_fixer.write_xml(output, doc) + return output.getvalue() + + manifest_tmpl = ( + '\n' + '\n' + ' \n' + '%s' + ' \n' + '\n') + + def uses_libraries(self, name_required_pairs): + ret = '' + for name, required in name_required_pairs: + ret += ( + ' \n' + ) % (name, required) + + return ret + + def test_empty(self): + """Empty new_uses_libraries must not touch the manifest.""" + manifest_input = self.manifest_tmpl % self.uses_libraries([ + ('foo', 'true'), + ('bar', 'false')]) + expected = manifest_input + output = self.run_test(manifest_input, []) + self.assertEqual(output, expected) + + def test_not_overwrite(self): + """new_uses_libraries must not overwrite existing tags.""" + manifest_input = self.manifest_tmpl % self.uses_libraries([ + ('foo', 'true'), + ('bar', 'false')]) + expected = manifest_input + output = self.run_test(manifest_input, ['foo', 'bar']) + self.assertEqual(output, expected) + + def test_add(self): + """New names are added with 'required:true'.""" + manifest_input = self.manifest_tmpl % self.uses_libraries([ + ('foo', 'true'), + ('bar', 'false')]) + expected = self.manifest_tmpl % self.uses_libraries([ + ('foo', 'true'), + ('bar', 'false'), + ('baz', 'true'), + ('qux', 'true')]) + output = self.run_test(manifest_input, ['bar', 'baz', 'qux']) + self.assertEqual(output, expected) + + def test_no_application(self): + """When there is no tag, the tag is added.""" + manifest_input = ( + '\n' + '\n' + '\n') + expected = self.manifest_tmpl % self.uses_libraries([ + ('foo', 'true'), + ('bar', 'true')]) + output = self.run_test(manifest_input, ['foo', 'bar']) + self.assertEqual(output, expected) + + def test_empty_application(self): + """Even when here is an empty tag, the libs are added.""" + manifest_input = ( + '\n' + '\n' + ' \n' + '\n') + expected = self.manifest_tmpl % self.uses_libraries([ + ('foo', 'true'), + ('bar', 'true')]) + output = self.run_test(manifest_input, ['foo', 'bar']) + self.assertEqual(output, expected) + + if __name__ == '__main__': unittest.main()