DO NOT MERGE releasetools: allow for multiple OEM property values.

This CL changes the --oem_settings flag to allow a comma seperated list of
property files. All property values will be used when asserting properties such
as ro.product.name.

For example, if two property files are provided with ro.product.name values of
"sprout" and "sprout_a", the resulting otapackage will check that the device's
ro.product.name property matches at least one of them.

Bug: 34191373
Test: manual

(cherry-picked and adapted from AOSP commit 7f804ba71f)

Change-Id: I954673511be8f0929982235cc9cbfbd85a9ee1f4
This commit is contained in:
Alain Vongsouvanh 2017-02-16 13:06:55 -08:00
parent e64f52ebcd
commit 1c50b8154d
2 changed files with 86 additions and 79 deletions

View File

@ -77,26 +77,28 @@ class EdifyGenerator(object):
with temporary=True) to this one.""" with temporary=True) to this one."""
self.script.extend(other.script) self.script.extend(other.script)
def AssertOemProperty(self, name, value): def AssertOemProperty(self, name, values):
"""Assert that a property on the OEM paritition matches a value.""" """Assert that a property on the OEM paritition matches allowed values."""
if not name: if not name:
raise ValueError("must specify an OEM property") raise ValueError("must specify an OEM property")
if not value: if not values:
raise ValueError("must specify the OEM value") raise ValueError("must specify the OEM value")
get_prop_command = None
if common.OPTIONS.oem_no_mount: if common.OPTIONS.oem_no_mount:
cmd = ('getprop("{name}") == "{value}" || ' get_prop_command = 'getprop("%s")' % name
'abort("E{code}: This package expects the value \\"{value}\\" for '
'\\"{name}\\"; this has value \\"" + '
'getprop("{name}") + "\\".");').format(
code=common.ErrorCode.OEM_PROP_MISMATCH,
name=name, value=value)
else: else:
cmd = ('file_getprop("/oem/oem.prop", "{name}") == "{value}" || ' get_prop_command = 'file_getprop("/oem/oem.prop", "%s")' % name
'abort("E{code}: This package expects the value \\"{value}\\" for '
'\\"{name}\\" on the OEM partition; this has value \\"" + ' cmd = ''
'file_getprop("/oem/oem.prop", "{name}") + "\\".");').format( for value in values:
code=common.ErrorCode.OEM_PROP_MISMATCH, cmd += '%s == "%s" || ' % (get_prop_command, value)
name=name, value=value) cmd += (
'abort("E{code}: This package expects the value \\"{values}\\" for '
'\\"{name}\\"; this has value \\"" + '
'{get_prop_command} + "\\".");').format(
code=common.ErrorCode.OEM_PROP_MISMATCH,
get_prop_command=get_prop_command, name=name,
values='\\" or \\"'.join(values))
self.script.append(cmd) self.script.append(cmd)
def AssertSomeFingerprint(self, *fp): def AssertSomeFingerprint(self, *fp):

View File

@ -50,9 +50,11 @@ Usage: ota_from_target_files [flags] input_target_files output_ota_package
Remount and verify the checksums of the files written to the Remount and verify the checksums of the files written to the
system and vendor (if used) partitions. Incremental builds only. system and vendor (if used) partitions. Incremental builds only.
-o (--oem_settings) <file> -o (--oem_settings) <main_file[,additional_files...]>
Use the file to specify the expected OEM-specific properties Comma seperated list of files used to specify the expected OEM-specific
on the OEM partition of the intended device. properties on the OEM partition of the intended device.
Multiple expected values can be used by providing multiple files.
--oem_no_mount --oem_no_mount
For devices with OEM-specific properties but without an OEM partition, For devices with OEM-specific properties but without an OEM partition,
@ -451,20 +453,38 @@ def SignOutput(temp_zip_name, output_zip_name):
whole_file=True) whole_file=True)
def AppendAssertions(script, info_dict, oem_dict=None): def AppendAssertions(script, info_dict, oem_dicts=None):
oem_props = info_dict.get("oem_fingerprint_properties") oem_props = info_dict.get("oem_fingerprint_properties")
if oem_props is None or len(oem_props) == 0: if oem_props is None or len(oem_props) == 0:
device = GetBuildProp("ro.product.device", info_dict) device = GetBuildProp("ro.product.device", info_dict)
script.AssertDevice(device) script.AssertDevice(device)
else: else:
if oem_dict is None: if not oem_dicts:
raise common.ExternalError( raise common.ExternalError(
"No OEM file provided to answer expected assertions") "No OEM file provided to answer expected assertions")
for prop in oem_props.split(): for prop in oem_props.split():
if oem_dict.get(prop) is None: values = []
for oem_dict in oem_dicts:
if oem_dict.get(prop):
values.append(oem_dict[prop])
if not values:
raise common.ExternalError( raise common.ExternalError(
"The OEM file is missing the property %s" % prop) "The OEM file is missing the property %s" % prop)
script.AssertOemProperty(prop, oem_dict.get(prop)) script.AssertOemProperty(prop, values)
def _LoadOemDicts(script, recovery_mount_options):
"""Returns the list of loaded OEM properties dict."""
oem_dicts = None
if OPTIONS.oem_source is None:
raise common.ExternalError("OEM source required for this build")
if not OPTIONS.oem_no_mount:
script.Mount("/oem", recovery_mount_options)
oem_dicts = []
for oem_file in OPTIONS.oem_source:
oem_dicts.append(common.LoadDictionaryFromLines(
open(oem_file).readlines()))
return oem_dicts
def _WriteRecoveryImageToBoot(script, output_zip): def _WriteRecoveryImageToBoot(script, output_zip):
@ -577,19 +597,15 @@ def WriteFullOTAPackage(input_zip, output_zip):
oem_props = OPTIONS.info_dict.get("oem_fingerprint_properties") oem_props = OPTIONS.info_dict.get("oem_fingerprint_properties")
recovery_mount_options = OPTIONS.info_dict.get("recovery_mount_options") recovery_mount_options = OPTIONS.info_dict.get("recovery_mount_options")
oem_dict = None oem_dicts = None
if oem_props is not None and len(oem_props) > 0: if oem_props:
if OPTIONS.oem_source is None: oem_dicts = _LoadOemDicts(script, recovery_mount_options)
raise common.ExternalError("OEM source required for this build")
if not OPTIONS.oem_no_mount:
script.Mount("/oem", recovery_mount_options)
oem_dict = common.LoadDictionaryFromLines(
open(OPTIONS.oem_source).readlines())
metadata = { metadata = {
"post-build": CalculateFingerprint(oem_props, oem_dict, "post-build": CalculateFingerprint(oem_props, oem_dicts and oem_dicts[0],
OPTIONS.info_dict), OPTIONS.info_dict),
"pre-device": GetOemProperty("ro.product.device", oem_props, oem_dict, "pre-device": GetOemProperty("ro.product.device", oem_props,
oem_dicts and oem_dicts[0],
OPTIONS.info_dict), OPTIONS.info_dict),
"post-timestamp": GetBuildProp("ro.build.date.utc", OPTIONS.info_dict), "post-timestamp": GetBuildProp("ro.build.date.utc", OPTIONS.info_dict),
} }
@ -613,7 +629,7 @@ def WriteFullOTAPackage(input_zip, output_zip):
ts_text = GetBuildProp("ro.build.date", OPTIONS.info_dict) ts_text = GetBuildProp("ro.build.date", OPTIONS.info_dict)
script.AssertOlderBuild(ts, ts_text) script.AssertOlderBuild(ts, ts_text)
AppendAssertions(script, OPTIONS.info_dict, oem_dict) AppendAssertions(script, OPTIONS.info_dict, oem_dicts)
device_specific.FullOTA_Assertions() device_specific.FullOTA_Assertions()
# Two-step package strategy (in chronological order, which is *not* # Two-step package strategy (in chronological order, which is *not*
@ -664,7 +680,7 @@ else if get_stage("%(bcb_dev)s") == "3/3" then
# Dump fingerprints # Dump fingerprints
script.Print("Target: %s" % CalculateFingerprint( script.Print("Target: %s" % CalculateFingerprint(
oem_props, oem_dict, OPTIONS.info_dict)) oem_props, oem_dicts and oem_dicts[0], OPTIONS.info_dict))
device_specific.FullOTA_InstallBegin() device_specific.FullOTA_InstallBegin()
@ -839,17 +855,13 @@ def WriteBlockIncrementalOTAPackage(target_zip, source_zip, output_zip):
oem_props = OPTIONS.info_dict.get("oem_fingerprint_properties") oem_props = OPTIONS.info_dict.get("oem_fingerprint_properties")
recovery_mount_options = OPTIONS.source_info_dict.get( recovery_mount_options = OPTIONS.source_info_dict.get(
"recovery_mount_options") "recovery_mount_options")
oem_dict = None oem_dicts = None
if oem_props is not None and len(oem_props) > 0: if oem_props:
if OPTIONS.oem_source is None: oem_dicts = _LoadOemDicts(script, recovery_mount_options)
raise common.ExternalError("OEM source required for this build")
if not OPTIONS.oem_no_mount:
script.Mount("/oem", recovery_mount_options)
oem_dict = common.LoadDictionaryFromLines(
open(OPTIONS.oem_source).readlines())
metadata = { metadata = {
"pre-device": GetOemProperty("ro.product.device", oem_props, oem_dict, "pre-device": GetOemProperty("ro.product.device", oem_props,
oem_dicts and oem_dicts[0],
OPTIONS.source_info_dict), OPTIONS.source_info_dict),
"ota-type": "BLOCK", "ota-type": "BLOCK",
} }
@ -885,9 +897,9 @@ def WriteBlockIncrementalOTAPackage(target_zip, source_zip, output_zip):
metadata=metadata, metadata=metadata,
info_dict=OPTIONS.source_info_dict) info_dict=OPTIONS.source_info_dict)
source_fp = CalculateFingerprint(oem_props, oem_dict, source_fp = CalculateFingerprint(oem_props, oem_dicts and oem_dicts[0],
OPTIONS.source_info_dict) OPTIONS.source_info_dict)
target_fp = CalculateFingerprint(oem_props, oem_dict, target_fp = CalculateFingerprint(oem_props, oem_dicts and oem_dicts[0],
OPTIONS.target_info_dict) OPTIONS.target_info_dict)
metadata["pre-build"] = source_fp metadata["pre-build"] = source_fp
metadata["post-build"] = target_fp metadata["post-build"] = target_fp
@ -952,7 +964,7 @@ def WriteBlockIncrementalOTAPackage(target_zip, source_zip, output_zip):
else: else:
vendor_diff = None vendor_diff = None
AppendAssertions(script, OPTIONS.target_info_dict, oem_dict) AppendAssertions(script, OPTIONS.target_info_dict, oem_dicts)
device_specific.IncrementalOTA_Assertions() device_specific.IncrementalOTA_Assertions()
# Two-step incremental package strategy (in chronological order, # Two-step incremental package strategy (in chronological order,
@ -1004,9 +1016,9 @@ else if get_stage("%(bcb_dev)s") != "3/3" then
# Dump fingerprints # Dump fingerprints
script.Print("Source: %s" % CalculateFingerprint( script.Print("Source: %s" % CalculateFingerprint(
oem_props, oem_dict, OPTIONS.source_info_dict)) oem_props, oem_dicts and oem_dicts[0], OPTIONS.source_info_dict))
script.Print("Target: %s" % CalculateFingerprint( script.Print("Target: %s" % CalculateFingerprint(
oem_props, oem_dict, OPTIONS.target_info_dict)) oem_props, oem_dicts and oem_dicts[0], OPTIONS.target_info_dict))
script.Print("Verifying current system...") script.Print("Verifying current system...")
@ -1155,18 +1167,16 @@ def WriteVerifyPackage(input_zip, output_zip):
oem_props = OPTIONS.info_dict.get("oem_fingerprint_properties") oem_props = OPTIONS.info_dict.get("oem_fingerprint_properties")
recovery_mount_options = OPTIONS.info_dict.get( recovery_mount_options = OPTIONS.info_dict.get(
"recovery_mount_options") "recovery_mount_options")
oem_dict = None oem_dicts = None
if oem_props is not None and len(oem_props) > 0: if oem_props:
if OPTIONS.oem_source is None: oem_dicts = _LoadOemDicts(script, recovery_mount_options)
raise common.ExternalError("OEM source required for this build")
script.Mount("/oem", recovery_mount_options)
oem_dict = common.LoadDictionaryFromLines(
open(OPTIONS.oem_source).readlines())
target_fp = CalculateFingerprint(oem_props, oem_dict, OPTIONS.info_dict) target_fp = CalculateFingerprint(oem_props, oem_dicts and oem_dicts[0],
OPTIONS.info_dict)
metadata = { metadata = {
"post-build": target_fp, "post-build": target_fp,
"pre-device": GetOemProperty("ro.product.device", oem_props, oem_dict, "pre-device": GetOemProperty("ro.product.device", oem_props,
oem_dicts and oem_dicts[0],
OPTIONS.info_dict), OPTIONS.info_dict),
"post-timestamp": GetBuildProp("ro.build.date.utc", OPTIONS.info_dict), "post-timestamp": GetBuildProp("ro.build.date.utc", OPTIONS.info_dict),
} }
@ -1180,7 +1190,7 @@ def WriteVerifyPackage(input_zip, output_zip):
metadata=metadata, metadata=metadata,
info_dict=OPTIONS.info_dict) info_dict=OPTIONS.info_dict)
AppendAssertions(script, OPTIONS.info_dict, oem_dict) AppendAssertions(script, OPTIONS.info_dict, oem_dicts)
script.Print("Verifying device images against %s..." % target_fp) script.Print("Verifying device images against %s..." % target_fp)
script.AppendExtra("") script.AppendExtra("")
@ -1252,19 +1262,17 @@ def WriteABOTAPackageWithBrilloScript(target_file, output_file,
# Metadata to comply with Android OTA package format. # Metadata to comply with Android OTA package format.
oem_props = OPTIONS.info_dict.get("oem_fingerprint_properties", None) oem_props = OPTIONS.info_dict.get("oem_fingerprint_properties", None)
oem_dict = None oem_dicts = None
if oem_props: if oem_props:
if OPTIONS.oem_source is None: oem_dicts = _LoadOemDicts(script, None)
raise common.ExternalError("OEM source required for this build")
oem_dict = common.LoadDictionaryFromLines(
open(OPTIONS.oem_source).readlines())
metadata = { metadata = {
"post-build": CalculateFingerprint(oem_props, oem_dict, "post-build": CalculateFingerprint(oem_props, oem_dicts and oem_dicts[0],
OPTIONS.info_dict), OPTIONS.info_dict),
"post-build-incremental" : GetBuildProp("ro.build.version.incremental", "post-build-incremental" : GetBuildProp("ro.build.version.incremental",
OPTIONS.info_dict), OPTIONS.info_dict),
"pre-device": GetOemProperty("ro.product.device", oem_props, oem_dict, "pre-device": GetOemProperty("ro.product.device", oem_props,
oem_dicts and oem_dicts[0],
OPTIONS.info_dict), OPTIONS.info_dict),
"post-timestamp": GetBuildProp("ro.build.date.utc", OPTIONS.info_dict), "post-timestamp": GetBuildProp("ro.build.date.utc", OPTIONS.info_dict),
"ota-required-cache": "0", "ota-required-cache": "0",
@ -1272,7 +1280,8 @@ def WriteABOTAPackageWithBrilloScript(target_file, output_file,
} }
if source_file is not None: if source_file is not None:
metadata["pre-build"] = CalculateFingerprint(oem_props, oem_dict, metadata["pre-build"] = CalculateFingerprint(oem_props,
oem_dicts and oem_dicts[0],
OPTIONS.source_info_dict) OPTIONS.source_info_dict)
metadata["pre-build-incremental"] = GetBuildProp( metadata["pre-build-incremental"] = GetBuildProp(
"ro.build.version.incremental", OPTIONS.source_info_dict) "ro.build.version.incremental", OPTIONS.source_info_dict)
@ -1540,17 +1549,13 @@ def WriteIncrementalOTAPackage(target_zip, source_zip, output_zip):
oem_props = OPTIONS.info_dict.get("oem_fingerprint_properties") oem_props = OPTIONS.info_dict.get("oem_fingerprint_properties")
recovery_mount_options = OPTIONS.source_info_dict.get( recovery_mount_options = OPTIONS.source_info_dict.get(
"recovery_mount_options") "recovery_mount_options")
oem_dict = None oem_dicts = None
if oem_props is not None and len(oem_props) > 0: if oem_props:
if OPTIONS.oem_source is None: oem_dicts = _LoadOemDicts(script, recovery_mount_options)
raise common.ExternalError("OEM source required for this build")
if not OPTIONS.oem_no_mount:
script.Mount("/oem", recovery_mount_options)
oem_dict = common.LoadDictionaryFromLines(
open(OPTIONS.oem_source).readlines())
metadata = { metadata = {
"pre-device": GetOemProperty("ro.product.device", oem_props, oem_dict, "pre-device": GetOemProperty("ro.product.device", oem_props,
oem_dicts and oem_dicts[0],
OPTIONS.source_info_dict), OPTIONS.source_info_dict),
"ota-type": "FILE", "ota-type": "FILE",
} }
@ -1594,9 +1599,9 @@ def WriteIncrementalOTAPackage(target_zip, source_zip, output_zip):
else: else:
vendor_diff = None vendor_diff = None
target_fp = CalculateFingerprint(oem_props, oem_dict, target_fp = CalculateFingerprint(oem_props, oem_dicts and oem_dicts[0],
OPTIONS.target_info_dict) OPTIONS.target_info_dict)
source_fp = CalculateFingerprint(oem_props, oem_dict, source_fp = CalculateFingerprint(oem_props, oem_dicts and oem_dicts[0],
OPTIONS.source_info_dict) OPTIONS.source_info_dict)
if oem_props is None: if oem_props is None:
@ -1634,7 +1639,7 @@ def WriteIncrementalOTAPackage(target_zip, source_zip, output_zip):
# 0.1 for unpacking verbatim files, symlinking, and doing the # 0.1 for unpacking verbatim files, symlinking, and doing the
# device-specific commands. # device-specific commands.
AppendAssertions(script, OPTIONS.target_info_dict, oem_dict) AppendAssertions(script, OPTIONS.target_info_dict, oem_dicts)
device_specific.IncrementalOTA_Assertions() device_specific.IncrementalOTA_Assertions()
# Two-step incremental package strategy (in chronological order, # Two-step incremental package strategy (in chronological order,
@ -1972,7 +1977,7 @@ def main(argv):
OPTIONS.downgrade = True OPTIONS.downgrade = True
OPTIONS.wipe_user_data = True OPTIONS.wipe_user_data = True
elif o in ("-o", "--oem_settings"): elif o in ("-o", "--oem_settings"):
OPTIONS.oem_source = a OPTIONS.oem_source = a.split(',')
elif o == "--oem_no_mount": elif o == "--oem_no_mount":
OPTIONS.oem_no_mount = True OPTIONS.oem_no_mount = True
elif o in ("-e", "--extra_script"): elif o in ("-e", "--extra_script"):