blob: 1a9b8c55107e1dd0912f5a84a5cbb70567338013 [file] [log] [blame]
# Copyright (c) 2013 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.
"""Module containing utilities for apk packages."""
import itertools
import re
from devil import base_error
from import aapt
r'\s*A: ([^\(\)= ]*)(?:\([^\(\)= ]*\))?='
r'(?:"(.*)" \(Raw: .*\)|\(type.*?\)(.*))$')
_MANIFEST_ELEMENT_RE = re.compile(r'\s*(?:E|N): (\S*) .*$')
def GetPackageName(apk_path):
"""Returns the package name of the apk."""
return ApkHelper(apk_path).GetPackageName()
# TODO(jbudorick): Deprecate and remove this function once callers have been
# converted to ApkHelper.GetInstrumentationName
def GetInstrumentationName(apk_path):
"""Returns the name of the Instrumentation in the apk."""
return ApkHelper(apk_path).GetInstrumentationName()
def ToHelper(path_or_helper):
"""Creates an ApkHelper unless one is already given."""
if isinstance(path_or_helper, basestring):
return ApkHelper(path_or_helper)
return path_or_helper
def _ParseManifestFromApk(apk_path):
aapt_output = aapt.Dump('xmltree', apk_path, 'AndroidManifest.xml')
parsed_manifest = {}
node_stack = [parsed_manifest]
indent = ' '
for line in aapt_output[1:]:
if len(line) == 0:
indent_depth = 0
while line[(len(indent) * indent_depth):].startswith(indent):
indent_depth += 1
node_stack = node_stack[:indent_depth]
node = node_stack[-1]
m = _MANIFEST_ELEMENT_RE.match(line[len(indent) * indent_depth:])
if m:
manifest_key =
if manifest_key in node:
node[manifest_key] += [{}]
node[manifest_key] = [{}]
node_stack += [node[manifest_key][-1]]
m = _MANIFEST_ATTRIBUTE_RE.match(line[len(indent) * indent_depth:])
if m:
manifest_key =
if manifest_key in node:
raise base_error.BaseError(
"A single attribute should have one key and one value")
node[manifest_key] = or
return parsed_manifest
class ApkHelper(object):
def __init__(self, path):
self._apk_path = path
self._manifest = None
def path(self):
return self._apk_path
def GetActivityName(self):
"""Returns the name of the Activity in the apk."""
manifest_info = self._GetManifest()
activity = (
except KeyError:
return None
if '.' not in activity:
activity = '%s.%s' % (self.GetPackageName(), activity)
elif activity.startswith('.'):
activity = '%s%s' % (self.GetPackageName(), activity)
return activity
def GetInstrumentationName(
self, default='android.test.InstrumentationTestRunner'):
"""Returns the name of the Instrumentation in the apk."""
all_instrumentations = self.GetAllInstrumentations(default=default)
if len(all_instrumentations) != 1:
raise base_error.BaseError(
'There is more than one instrumentation. Expected one.')
return all_instrumentations[0]['android:name']
def GetAllInstrumentations(
self, default='android.test.InstrumentationTestRunner'):
"""Returns a list of all Instrumentations in the apk."""
return self._GetManifest()['manifest'][0]['instrumentation']
except KeyError:
return [{'android:name': default}]
def GetPackageName(self):
"""Returns the package name of the apk."""
manifest_info = self._GetManifest()
return manifest_info['manifest'][0]['package']
except KeyError:
raise Exception('Failed to determine package name of %s' % self._apk_path)
def GetPermissions(self):
manifest_info = self._GetManifest()
return [p['android:name'] for
p in manifest_info['manifest'][0]['uses-permission']]
except KeyError:
return []
def GetSplitName(self):
"""Returns the name of the split of the apk."""
manifest_info = self._GetManifest()
return manifest_info['manifest'][0]['split']
except KeyError:
return None
def HasIsolatedProcesses(self):
"""Returns whether any services exist that use isolatedProcess=true."""
manifest_info = self._GetManifest()
applications = manifest_info['manifest'][0].get('application', [])
services = itertools.chain(
*(application.get('service', []) for application in applications))
return any(
int(s.get('android:isolatedProcess', '0'), 0)
for s in services)
except KeyError:
return False
def _GetManifest(self):
if not self._manifest:
self._manifest = _ParseManifestFromApk(self._apk_path)
return self._manifest