Files
build/tools/auto_gen_test_config.py
Jingwen Chen f3406e64f7 Make auto_gen_test_config available to Bazel.
In the Bazel rule, the actual AndroidManifest.xml file isn't available
in the providers of the android_binary dependency. And for good reason,
we should also rely on aapt2 to dump the manifest contents from the
final packaged APK anyway, but this auto gen script doesn't support
reading the output of aapt2 dump.

This CL adds a simple reader of the output of `aapt2 dump xmltree`, and
enabled if the xmltree content is passed to this tool instead of
AndroidManifest.xml.

Also fixup auto_gen_test_config_test.py. The test was completely failing.

Test: atest auto_gen_test_config_test
Test: presubmits

Change-Id: I7fecd927d0ed7847b6463d964b3698f4164b0177
2023-09-18 12:34:29 +00:00

132 lines
4.9 KiB
Python
Executable File

#!/usr/bin/env python3
#
# Copyright (C) 2017 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""A tool to generate TradeFed test config file.
"""
import re
import os
import shutil
import sys
from xml.dom.minidom import parse
ATTRIBUTE_LABEL = 'android:label'
ATTRIBUTE_RUNNER = 'android:name'
ATTRIBUTE_PACKAGE = 'package'
PLACEHOLDER_LABEL = '{LABEL}'
PLACEHOLDER_EXTRA_CONFIGS = '{EXTRA_CONFIGS}'
PLACEHOLDER_MODULE = '{MODULE}'
PLACEHOLDER_PACKAGE = '{PACKAGE}'
PLACEHOLDER_RUNNER = '{RUNNER}'
PLACEHOLDER_TEST_TYPE = '{TEST_TYPE}'
def main(argv):
"""Entry point of auto_gen_test_config.
Args:
argv: A list of arguments.
Returns:
0 if no error, otherwise 1.
"""
if len(argv) != 4 and len(argv) != 6:
sys.stderr.write(
f'Invalid arguments: {argv}. The script requires 4 arguments for file paths: '
'target_config, android_manifest (or the xmltree dump), empty_config, '
'instrumentation_test_config_template, '
'and 2 optional arguments for extra configs: '
'--extra-configs \'EXTRA_CONFIGS\'.\n')
return 1
target_config = argv[0]
android_manifest = argv[1]
empty_config = argv[2]
instrumentation_test_config_template = argv[3]
extra_configs = '\n'.join(argv[5].split('\\n')) if len(argv) == 6 else ''
module = os.path.splitext(os.path.basename(target_config))[0]
# If the AndroidManifest.xml is not available, but the APK is, this tool also
# accepts the output of `aapt2 dump xmltree <apk> AndroidManifest.xml` written
# into a file. This is a custom structured aapt2 output - not raw XML!
if android_manifest.endswith(".xmltree"):
label = module
with open(android_manifest, encoding="utf-8") as manifest:
# e.g. A: package="android.test.example.helloworld" (Raw: "android.test.example.helloworld")
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
pattern = re.compile(r"\(Raw:\s\"(.*)\"\)$")
curr_element = None
for line in manifest.readlines():
curr_line = line.strip()
if curr_line.startswith("E:"):
# e.g. "E: instrumentation (line=9)"
# ^^^^^^^^^^^^^^^
curr_element = curr_line.split(" ")[1]
if curr_element == "instrumentation":
if ATTRIBUTE_RUNNER in curr_line:
runner = re.findall(pattern, curr_line)[0]
if ATTRIBUTE_LABEL in curr_line:
label = re.findall(pattern, curr_line)[0]
if curr_element == "manifest":
if ATTRIBUTE_PACKAGE in curr_line:
package = re.findall(pattern, curr_line)[0]
if not (runner and label and package):
# Failed to locate instrumentation or manifest element in AndroidManifest.
# file. Empty test config file will be created.
shutil.copyfile(empty_config, target_config)
return 0
else:
# If the AndroidManifest.xml file is directly available, read it as an XML file.
manifest = parse(android_manifest)
instrumentation_elements = manifest.getElementsByTagName('instrumentation')
manifest_elements = manifest.getElementsByTagName('manifest')
if len(instrumentation_elements) != 1 or len(manifest_elements) != 1:
# Failed to locate instrumentation or manifest element in AndroidManifest.
# file. Empty test config file will be created.
shutil.copyfile(empty_config, target_config)
return 0
instrumentation = instrumentation_elements[0]
manifest = manifest_elements[0]
if ATTRIBUTE_LABEL in instrumentation.attributes:
label = instrumentation.attributes[ATTRIBUTE_LABEL].value
else:
label = module
runner = instrumentation.attributes[ATTRIBUTE_RUNNER].value
package = manifest.attributes[ATTRIBUTE_PACKAGE].value
test_type = ('InstrumentationTest'
if runner.endswith('.InstrumentationTestRunner')
else 'AndroidJUnitTest')
with open(instrumentation_test_config_template) as template:
config = template.read()
config = config.replace(PLACEHOLDER_LABEL, label)
config = config.replace(PLACEHOLDER_MODULE, module)
config = config.replace(PLACEHOLDER_PACKAGE, package)
config = config.replace(PLACEHOLDER_TEST_TYPE, test_type)
config = config.replace(PLACEHOLDER_EXTRA_CONFIGS, extra_configs)
config = config.replace(PLACEHOLDER_RUNNER, runner)
with open(target_config, 'w') as config_file:
config_file.write(config)
return 0
if __name__ == '__main__':
sys.exit(main(sys.argv[1:]))