tequilaOS/platform_hardware_interfaces
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add generate_vehicle_property_enums repo hook.

Browse source 
This repo hook will check whether the generated enum definition files
require update if VehicleProperty.aidl is updated and prompt user
to run generate_annotation_enums.py if requires update.

The repo hook will do nothing if the preupload files does not contain
VehicleProperty.aidl file.

Test: Manual test
Bug: 286286188
Change-Id: Iea1fdb26d8a76c5aff346ca5cb38ed145fe957d7
This commit is contained in:
Yu Shan 2023-06-07 13:25:43 -07:00
parent 109d7c52fe
commit 41dd7f18fc
2 changed files with 110 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
PREUPLOAD.cfg
View file

@ -10,3 +10,4 @@ aidl_format = true
aosp_hook_confirmationui = ${REPO_ROOT}/frameworks/base/tools/aosp/aosp_sha.sh ${PREUPLOAD_COMMIT} confirmationui aosp_hook_confirmationui = ${REPO_ROOT}/frameworks/base/tools/aosp/aosp_sha.sh ${PREUPLOAD_COMMIT} confirmationui
aosp_hook_gatekeeper = ${REPO_ROOT}/frameworks/base/tools/aosp/aosp_sha.sh ${PREUPLOAD_COMMIT} gatekeeper aosp_hook_gatekeeper = ${REPO_ROOT}/frameworks/base/tools/aosp/aosp_sha.sh ${PREUPLOAD_COMMIT} gatekeeper
aosp_hook_keymaster = ${REPO_ROOT}/frameworks/base/tools/aosp/aosp_sha.sh ${PREUPLOAD_COMMIT} keymaster aosp_hook_keymaster = ${REPO_ROOT}/frameworks/base/tools/aosp/aosp_sha.sh ${PREUPLOAD_COMMIT} keymaster
generate_vehicle_property_enums = ${REPO_ROOT}/hardware/interfaces/automotive/vehicle/tools/generate_annotation_enums.py --android_build_top ${REPO_ROOT} --preupload_files ${PREUPLOAD_FILES} --check_only

151
automotive/vehicle/tools/generate_annotation_enums.py Normal file → Executable file
View file

@ -23,29 +23,33 @@
Usage: Usage:
$ python generate_annotation_enums.py $ python generate_annotation_enums.py
""" """
import argparse
import filecmp
import os import os
import re import re
import sys import sys
import tempfile
PROP_AIDL_FILE_PATH = ("hardware/interfaces/automotive/vehicle/aidl_property/android/hardware/" + PROP_AIDL_FILE_PATH = ('hardware/interfaces/automotive/vehicle/aidl_property/android/hardware/' +
"automotive/vehicle/VehicleProperty.aidl") 'automotive/vehicle/VehicleProperty.aidl')
CHANGE_MODE_CPP_FILE_PATH = ("hardware/interfaces/automotive/vehicle/aidl/generated_lib/cpp/" + CHANGE_MODE_CPP_FILE_PATH = ('hardware/interfaces/automotive/vehicle/aidl/generated_lib/cpp/' +
"ChangeModeForVehicleProperty.h") 'ChangeModeForVehicleProperty.h')
ACCESS_CPP_FILE_PATH = ("hardware/interfaces/automotive/vehicle/aidl/generated_lib/cpp/" + ACCESS_CPP_FILE_PATH = ('hardware/interfaces/automotive/vehicle/aidl/generated_lib/cpp/' +
"AccessForVehicleProperty.h") 'AccessForVehicleProperty.h')
CHANGE_MODE_JAVA_FILE_PATH = ("hardware/interfaces/automotive/vehicle/aidl/generated_lib/java/" + CHANGE_MODE_JAVA_FILE_PATH = ('hardware/interfaces/automotive/vehicle/aidl/generated_lib/java/' +
"ChangeModeForVehicleProperty.java") 'ChangeModeForVehicleProperty.java')
ACCESS_JAVA_FILE_PATH = ("hardware/interfaces/automotive/vehicle/aidl/generated_lib/java/" + ACCESS_JAVA_FILE_PATH = ('hardware/interfaces/automotive/vehicle/aidl/generated_lib/java/' +
"AccessForVehicleProperty.java") 'AccessForVehicleProperty.java')
SCRIPT_PATH = 'hardware/interfaces/automotive/vehicle/tools/generate_annotation_enums.py'
TAB = " " TAB = ' '
RE_ENUM_START = re.compile("\s*enum VehicleProperty \{") RE_ENUM_START = re.compile('\s*enum VehicleProperty \{')
RE_ENUM_END = re.compile("\s*\}\;") RE_ENUM_END = re.compile('\s*\}\;')
RE_COMMENT_BEGIN = re.compile("\s*\/\*\*?") RE_COMMENT_BEGIN = re.compile('\s*\/\*\*?')
RE_COMMENT_END = re.compile("\s*\*\/") RE_COMMENT_END = re.compile('\s*\*\/')
RE_CHANGE_MODE = re.compile("\s*\* @change_mode (\S+)\s*") RE_CHANGE_MODE = re.compile('\s*\* @change_mode (\S+)\s*')
RE_ACCESS = re.compile("\s*\* @access (\S+)\s*") RE_ACCESS = re.compile('\s*\* @access (\S+)\s*')
RE_VALUE = re.compile("\s*(\w+)\s*=(.*)") RE_VALUE = re.compile('\s*(\w+)\s*=(.*)')
LICENSE = """/* LICENSE = """/*
* Copyright (C) 2022 The Android Open Source Project * Copyright (C) 2022 The Android Open Source Project
@ -195,23 +199,23 @@ class Converter:
match = RE_VALUE.match(line) match = RE_VALUE.match(line)
if match: if match:
prop_name = match.group(1) prop_name = match.group(1)
if prop_name == "INVALID": if prop_name == 'INVALID':
continue continue
if not annotation: if not annotation:
print("No @" + self.name + " annotation for property: " + prop_name) raise Exception(
sys.exit(1) 'No @' + self.name + ' annotation for property: ' + prop_name)
if id != 0: if id != 0:
content += "\n" content += '\n'
if cpp: if cpp:
annotation = annotation.replace(".", "::") annotation = annotation.replace('.', '::')
content += (TAB + TAB + "{VehicleProperty::" + prop_name + ", " + content += (TAB + TAB + '{VehicleProperty::' + prop_name + ', ' +
annotation + "},") annotation + '},')
else: else:
content += (TAB + TAB + "Map.entry(VehicleProperty." + prop_name + ", " + content += (TAB + TAB + 'Map.entry(VehicleProperty.' + prop_name + ', ' +
annotation + "),") annotation + '),')
id += 1 id += 1
# Remove the additional "," at the end for the Java file. # Remove the additional ',' at the end for the Java file.
if not cpp: if not cpp:
content = content[:-1] content = content[:-1]
@ -221,25 +225,88 @@ class Converter:
f.write(content) f.write(content)
def createTempFile():
f = tempfile.NamedTemporaryFile(delete=False);
f.close();
return f.name
def main(): def main():
android_top = os.environ['ANDROID_BUILD_TOP'] parser = argparse.ArgumentParser(
description='Generate Java and C++ enums based on annotations in VehicleProperty.aidl')
parser.add_argument('--android_build_top', required=False, help='Path to ANDROID_BUILD_TOP')
parser.add_argument('--preupload_files', nargs='+', required=False, help='modified files')
parser.add_argument('--check_only', required=False, action='store_true',
help='only check whether the generated files need update')
args = parser.parse_args();
android_top = None
output_folder = None
if args.android_build_top:
android_top = args.android_build_top
vehiclePropertyUpdated = False
for preuload_file in args.preupload_files:
if preuload_file.endswith('VehicleProperty.aidl'):
vehiclePropertyUpdated = True
break
if not vehiclePropertyUpdated:
return
else:
android_top = os.environ['ANDROID_BUILD_TOP']
if not android_top: if not android_top:
print("ANDROID_BUILD_TOP is not in envorinmental variable, please run source and lunch " + print('ANDROID_BUILD_TOP is not in envorinmental variable, please run source and lunch ' +
"at the android root") 'at the android root')
aidl_file = os.path.join(android_top, PROP_AIDL_FILE_PATH) aidl_file = os.path.join(android_top, PROP_AIDL_FILE_PATH)
change_mode_cpp_output = os.path.join(android_top, CHANGE_MODE_CPP_FILE_PATH);
access_cpp_output = os.path.join(android_top, ACCESS_CPP_FILE_PATH);
change_mode_java_output = os.path.join(android_top, CHANGE_MODE_JAVA_FILE_PATH);
access_java_output = os.path.join(android_top, ACCESS_JAVA_FILE_PATH);
c = Converter("change_mode", RE_CHANGE_MODE); change_mode_cpp_file = os.path.join(android_top, CHANGE_MODE_CPP_FILE_PATH);
c.convert(aidl_file, change_mode_cpp_output, CHANGE_MODE_CPP_HEADER, CHANGE_MODE_CPP_FOOTER, True) access_cpp_file = os.path.join(android_top, ACCESS_CPP_FILE_PATH);
c.convert(aidl_file, change_mode_java_output, CHANGE_MODE_JAVA_HEADER, CHANGE_MODE_JAVA_FOOTER, False) change_mode_java_file = os.path.join(android_top, CHANGE_MODE_JAVA_FILE_PATH);
c = Converter("access", RE_ACCESS) access_java_file = os.path.join(android_top, ACCESS_JAVA_FILE_PATH);
c.convert(aidl_file, access_cpp_output, ACCESS_CPP_HEADER, ACCESS_CPP_FOOTER, True) temp_files = []
c.convert(aidl_file, access_java_output, ACCESS_JAVA_HEADER, ACCESS_JAVA_FOOTER, False)
if not args.check_only:
change_mode_cpp_output = change_mode_cpp_file
access_cpp_output = access_cpp_file
change_mode_java_output = change_mode_java_file
access_java_output = access_java_file
else:
change_mode_cpp_output = createTempFile()
temp_files.append(change_mode_cpp_output)
access_cpp_output = createTempFile()
temp_files.append(access_cpp_output)
change_mode_java_output = createTempFile()
temp_files.append(change_mode_java_output)
access_java_output = createTempFile()
temp_files.append(access_java_output)
try:
c = Converter('change_mode', RE_CHANGE_MODE);
c.convert(aidl_file, change_mode_cpp_output, CHANGE_MODE_CPP_HEADER, CHANGE_MODE_CPP_FOOTER,
True)
c.convert(aidl_file, change_mode_java_output, CHANGE_MODE_JAVA_HEADER,
CHANGE_MODE_JAVA_FOOTER, False)
c = Converter('access', RE_ACCESS)
c.convert(aidl_file, access_cpp_output, ACCESS_CPP_HEADER, ACCESS_CPP_FOOTER, True)
c.convert(aidl_file, access_java_output, ACCESS_JAVA_HEADER, ACCESS_JAVA_FOOTER, False)
if not args.check_only:
return
if ((not filecmp.cmp(change_mode_cpp_output, change_mode_cpp_file)) or
(not filecmp.cmp(change_mode_java_output, change_mode_java_file)) or
(not filecmp.cmp(access_cpp_output, access_cpp_file)) or
(not filecmp.cmp(access_java_output, access_java_file))):
print('The generated enum files for VehicleProperty.aidl requires update, ')
print('Run \npython ' + android_top + '/' + SCRIPT_PATH)
sys.exit(1)
except Exception as e:
print('Error parsing VehicleProperty.aidl')
print(e)
sys.exit(1)
finally:
for file in temp_files:
os.remove(file)
if __name__ == "__main__": if __name__ == '__main__':
main() main()