From 603655f5b57005f01f05d440d12deafc03b9b732 Mon Sep 17 00:00:00 2001 From: Zhomart Mukhamejanov Date: Fri, 4 May 2018 12:35:09 -0700 Subject: [PATCH] releasetools: Make _GetPropertyFilesString public ota_from_target_files.py: Rename PropertyFiles._GetPropertyFilesString to PropertyFiles.GetPropertyFilesString. Currently only PropertyFiles.Compute and PropertyFiles.Finalize gives access to _GetPropertyFilesString. But Compute force sets reserve_space=True, and Finalize requires reserved_length. _GetPropertyFilesString is useful method that can be used outside releasetools. One of the usage is in bootable/recovery/updater_sample/. Test: python -m unittest test_ota_from_target_files Change-Id: I2cc44ec46a0e68ba071531b003af8cdbfe90e588 Signed-off-by: Zhomart Mukhamejanov --- tools/releasetools/ota_from_target_files.py | 20 ++++++++++---- .../test_ota_from_target_files.py | 27 +++++++------------ 2 files changed, 24 insertions(+), 23 deletions(-) diff --git a/tools/releasetools/ota_from_target_files.py b/tools/releasetools/ota_from_target_files.py index b6c26bfaf..e8ec50e1b 100755 --- a/tools/releasetools/ota_from_target_files.py +++ b/tools/releasetools/ota_from_target_files.py @@ -1026,7 +1026,7 @@ class PropertyFiles(object): A string with placeholders for the metadata offset/size info, e.g. "payload.bin:679:343,payload_properties.txt:378:45,metadata: ". """ - return self._GetPropertyFilesString(input_zip, reserve_space=True) + return self.GetPropertyFilesString(input_zip, reserve_space=True) class InsufficientSpaceException(Exception): pass @@ -1055,7 +1055,7 @@ class PropertyFiles(object): InsufficientSpaceException: If the reserved length is insufficient to hold the final string. """ - result = self._GetPropertyFilesString(input_zip, reserve_space=False) + result = self.GetPropertyFilesString(input_zip, reserve_space=False) if len(result) > reserved_length: raise self.InsufficientSpaceException( 'Insufficient reserved space: reserved={}, actual={}'.format( @@ -1074,12 +1074,22 @@ class PropertyFiles(object): Raises: AssertionError: On finding a mismatch. """ - actual = self._GetPropertyFilesString(input_zip) + actual = self.GetPropertyFilesString(input_zip) assert actual == expected, \ "Mismatching streaming metadata: {} vs {}.".format(actual, expected) - def _GetPropertyFilesString(self, zip_file, reserve_space=False): - """Constructs the property-files string per request.""" + def GetPropertyFilesString(self, zip_file, reserve_space=False): + """ + Constructs the property-files string per request. + + Args: + zip_file: The input ZIP file. + reserved_length: The reserved length of the property-files string. + + Returns: + A property-files string including the metadata offset/size info, e.g. + "payload.bin:679:343,payload_properties.txt:378:45,metadata: ". + """ def ComputeEntryOffsetSize(name): """Computes the zip entry offset and size.""" diff --git a/tools/releasetools/test_ota_from_target_files.py b/tools/releasetools/test_ota_from_target_files.py index 0eb24b5f4..213e830e5 100644 --- a/tools/releasetools/test_ota_from_target_files.py +++ b/tools/releasetools/test_ota_from_target_files.py @@ -774,8 +774,7 @@ class PropertyFilesTest(unittest.TestCase): zip_file = self.construct_zip_package(entries) property_files = TestPropertyFiles() with zipfile.ZipFile(zip_file, 'r') as zip_fp: - # pylint: disable=protected-access - raw_metadata = property_files._GetPropertyFilesString( + raw_metadata = property_files.GetPropertyFilesString( zip_fp, reserve_space=False) streaming_metadata = property_files.Finalize(zip_fp, len(raw_metadata)) tokens = self._parse_property_files_string(streaming_metadata) @@ -798,8 +797,7 @@ class PropertyFilesTest(unittest.TestCase): property_files = TestPropertyFiles() with zipfile.ZipFile(zip_file, 'r') as zip_fp: # First get the raw metadata string (i.e. without padding space). - # pylint: disable=protected-access - raw_metadata = property_files._GetPropertyFilesString( + raw_metadata = property_files.GetPropertyFilesString( zip_fp, reserve_space=False) raw_length = len(raw_metadata) @@ -833,8 +831,7 @@ class PropertyFilesTest(unittest.TestCase): property_files = TestPropertyFiles() with zipfile.ZipFile(zip_file, 'r') as zip_fp: # First get the raw metadata string (i.e. without padding space). - # pylint: disable=protected-access - raw_metadata = property_files._GetPropertyFilesString( + raw_metadata = property_files.GetPropertyFilesString( zip_fp, reserve_space=False) # Should pass the test if verification passes. @@ -891,8 +888,7 @@ class StreamingPropertyFilesTest(PropertyFilesTest): zip_file = self.construct_zip_package(entries) property_files = StreamingPropertyFiles() with zipfile.ZipFile(zip_file, 'r') as zip_fp: - # pylint: disable=protected-access - raw_metadata = property_files._GetPropertyFilesString( + raw_metadata = property_files.GetPropertyFilesString( zip_fp, reserve_space=False) streaming_metadata = property_files.Finalize(zip_fp, len(raw_metadata)) tokens = self._parse_property_files_string(streaming_metadata) @@ -915,8 +911,7 @@ class StreamingPropertyFilesTest(PropertyFilesTest): property_files = StreamingPropertyFiles() with zipfile.ZipFile(zip_file, 'r') as zip_fp: # First get the raw metadata string (i.e. without padding space). - # pylint: disable=protected-access - raw_metadata = property_files._GetPropertyFilesString( + raw_metadata = property_files.GetPropertyFilesString( zip_fp, reserve_space=False) # Should pass the test if verification passes. @@ -1051,8 +1046,7 @@ class AbOtaPropertyFilesTest(PropertyFilesTest): zip_file = self.construct_zip_package_withValidPayload(with_metadata=True) property_files = AbOtaPropertyFiles() with zipfile.ZipFile(zip_file, 'r') as zip_fp: - # pylint: disable=protected-access - raw_metadata = property_files._GetPropertyFilesString( + raw_metadata = property_files.GetPropertyFilesString( zip_fp, reserve_space=False) property_files_string = property_files.Finalize(zip_fp, len(raw_metadata)) @@ -1067,8 +1061,7 @@ class AbOtaPropertyFilesTest(PropertyFilesTest): zip_file = self.construct_zip_package_withValidPayload(with_metadata=True) property_files = AbOtaPropertyFiles() with zipfile.ZipFile(zip_file, 'r') as zip_fp: - # pylint: disable=protected-access - raw_metadata = property_files._GetPropertyFilesString( + raw_metadata = property_files.GetPropertyFilesString( zip_fp, reserve_space=False) property_files.Verify(zip_fp, raw_metadata) @@ -1101,8 +1094,7 @@ class NonAbOtaPropertyFilesTest(PropertyFilesTest): zip_file = self.construct_zip_package(entries) property_files = NonAbOtaPropertyFiles() with zipfile.ZipFile(zip_file) as zip_fp: - # pylint: disable=protected-access - raw_metadata = property_files._GetPropertyFilesString( + raw_metadata = property_files.GetPropertyFilesString( zip_fp, reserve_space=False) property_files_string = property_files.Finalize(zip_fp, len(raw_metadata)) tokens = self._parse_property_files_string(property_files_string) @@ -1119,8 +1111,7 @@ class NonAbOtaPropertyFilesTest(PropertyFilesTest): zip_file = self.construct_zip_package(entries) property_files = NonAbOtaPropertyFiles() with zipfile.ZipFile(zip_file) as zip_fp: - # pylint: disable=protected-access - raw_metadata = property_files._GetPropertyFilesString( + raw_metadata = property_files.GetPropertyFilesString( zip_fp, reserve_space=False) property_files.Verify(zip_fp, raw_metadata)