StrixOS/build
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Convert common.RunAndWait method to raise an exception on subprocess failure.

Browse Source 
Then refactor the code in merge_target_files.py to adapt to this semantic
change. This makes the code more consistent with existing releasetools code,
and it's easier to follow.

Test: Failure cases (verify exception), success cases (merged target generated)
Bug: 124521133
Change-Id: I56f04e360d8ff8ffcd6245359cdeb79f4565a9c4
This commit is contained in:
Bill Peckham
2019-02-21 18:53:37 -08:00
parent f97ed91448
commit 889b0c6b09
2 changed files with 23 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
tools/releasetools/common.py
View File

@@ -191,7 +191,7 @@ def Run(args, verbose=None, **kwargs):
def RunAndWait(args, verbose=None, **kwargs): def RunAndWait(args, verbose=None, **kwargs):
"""Runs the given command and returns the exit code. """Runs the given command waiting for it to complete.
Args: Args:
args: The command represented as a list of strings. args: The command represented as a list of strings.
@@ -201,12 +201,16 @@ def RunAndWait(args, verbose=None, **kwargs):
stdin, etc. stdout and stderr will default to subprocess.PIPE and stdin, etc. stdout and stderr will default to subprocess.PIPE and
subprocess.STDOUT respectively unless caller specifies any of them. subprocess.STDOUT respectively unless caller specifies any of them.
Returns: Raises:
The process return code. ExternalError: On non-zero exit from the command.
""" """
proc = Run(args, verbose=verbose, **kwargs) proc = Run(args, verbose=verbose, **kwargs)
proc.wait() proc.wait()
return proc.returncode
if proc.returncode != 0:
raise ExternalError(
"Failed to run command '{}' (exit code {})".format(
args, proc.returncode))
def RunAndCheckOutput(args, verbose=None, **kwargs): def RunAndCheckOutput(args, verbose=None, **kwargs):

88
tools/releasetools/merge_target_files.py
View File

@@ -142,9 +142,6 @@ def extract_items(target_files, target_files_temp_dir, extract_item_list):
will land. will land.
extract_item_list: A list of items to extract. extract_item_list: A list of items to extract.
Returns:
On success, 0. Otherwise, a non-zero exit code from unzip.
""" """
logger.info('extracting from %s', target_files) logger.info('extracting from %s', target_files)
@@ -178,13 +175,7 @@ def extract_items(target_files, target_files_temp_dir, extract_item_list):
target_files target_files
] + filtered_extract_item_list ] + filtered_extract_item_list
result = common.RunAndWait(command, verbose=True) common.RunAndWait(command, verbose=True)
if result != 0:
logger.error('extract_items command %s failed %d', str(command), result)
return result
return 0
def process_ab_partitions_txt( def process_ab_partitions_txt(
@@ -305,9 +296,6 @@ def process_file_contexts_bin(temp_dir, output_target_files_temp_dir):
already contain plat_file_contexts and vendor_file_contexts (in the already contain plat_file_contexts and vendor_file_contexts (in the
appropriate sub directories), and to which META/file_contexts.bin will be appropriate sub directories), and to which META/file_contexts.bin will be
written. written.
Returns:
On success, 0. Otherwise, a non-zero exit code.
""" """
# To create a merged file_contexts.bin file, we use the system and vendor # To create a merged file_contexts.bin file, we use the system and vendor
@@ -352,12 +340,7 @@ def process_file_contexts_bin(temp_dir, output_target_files_temp_dir):
sorted_file_contexts_txt = os.path.join(temp_dir, 'sorted_file_contexts.txt') sorted_file_contexts_txt = os.path.join(temp_dir, 'sorted_file_contexts.txt')
command = ['fc_sort', merged_file_contexts_txt, sorted_file_contexts_txt] command = ['fc_sort', merged_file_contexts_txt, sorted_file_contexts_txt]
common.RunAndWait(command, verbose=True)
# TODO(b/124521133): Refector RunAndWait to raise exception on failure.
result = common.RunAndWait(command, verbose=True)
if result != 0:
return result
# Finally, the compile step creates the final META/file_contexts.bin. # Finally, the compile step creates the final META/file_contexts.bin.
@@ -371,12 +354,7 @@ def process_file_contexts_bin(temp_dir, output_target_files_temp_dir):
sorted_file_contexts_txt, sorted_file_contexts_txt,
] ]
result = common.RunAndWait(command, verbose=True) common.RunAndWait(command, verbose=True)
if result != 0:
return result
return 0
def process_special_cases( def process_special_cases(
@@ -402,9 +380,6 @@ def process_special_cases(
output_target_files_temp_dir: The name of a directory that will be used output_target_files_temp_dir: The name of a directory that will be used
to create the output target files package after all the special cases to create the output target files package after all the special cases
are processed. are processed.
Returns:
On success, 0. Otherwise, a non-zero exit code.
""" """
process_ab_partitions_txt( process_ab_partitions_txt(
@@ -417,15 +392,10 @@ def process_special_cases(
other_target_files_temp_dir=other_target_files_temp_dir, other_target_files_temp_dir=other_target_files_temp_dir,
output_target_files_temp_dir=output_target_files_temp_dir) output_target_files_temp_dir=output_target_files_temp_dir)
result = process_file_contexts_bin( process_file_contexts_bin(
temp_dir=temp_dir, temp_dir=temp_dir,
output_target_files_temp_dir=output_target_files_temp_dir) output_target_files_temp_dir=output_target_files_temp_dir)
if result != 0:
return result
return 0
def merge_target_files( def merge_target_files(
temp_dir, temp_dir,
@@ -451,9 +421,6 @@ def merge_target_files(
output_target_files: The name of the output zip archive target files output_target_files: The name of the output zip archive target files
package created by merging system and other. package created by merging system and other.
Returns:
On success, 0. Otherwise, a non-zero exit code.
""" """
# Create directory names that we'll use when we extract files from system, # Create directory names that we'll use when we extract files from system,
@@ -467,64 +434,49 @@ def merge_target_files(
# We extract them directly into the output temporary directory since the # We extract them directly into the output temporary directory since the
# items do not need special case processing. # items do not need special case processing.
result = extract_items( extract_items(
target_files=system_target_files, target_files=system_target_files,
target_files_temp_dir=output_target_files_temp_dir, target_files_temp_dir=output_target_files_temp_dir,
extract_item_list=system_extract_as_is_item_list) extract_item_list=system_extract_as_is_item_list)
if result != 0:
return result
# Extract "as is" items from the input other partial target files package. We # Extract "as is" items from the input other partial target files package. We
# extract them directly into the output temporary directory since the items # extract them directly into the output temporary directory since the items
# do not need special case processing. # do not need special case processing.
result = extract_items( extract_items(
target_files=other_target_files, target_files=other_target_files,
target_files_temp_dir=output_target_files_temp_dir, target_files_temp_dir=output_target_files_temp_dir,
extract_item_list=other_extract_as_is_item_list) extract_item_list=other_extract_as_is_item_list)
if result != 0:
return result
# Extract "special" items from the input system partial target files package. # Extract "special" items from the input system partial target files package.
# We extract these items to different directory since they require special # We extract these items to different directory since they require special
# processing before they will end up in the output directory. # processing before they will end up in the output directory.
result = extract_items( extract_items(
target_files=system_target_files, target_files=system_target_files,
target_files_temp_dir=system_target_files_temp_dir, target_files_temp_dir=system_target_files_temp_dir,
extract_item_list=system_extract_special_item_list) extract_item_list=system_extract_special_item_list)
if result != 0:
return result
# Extract "special" items from the input other partial target files package. # Extract "special" items from the input other partial target files package.
# We extract these items to different directory since they require special # We extract these items to different directory since they require special
# processing before they will end up in the output directory. # processing before they will end up in the output directory.
result = extract_items( extract_items(
target_files=other_target_files, target_files=other_target_files,
target_files_temp_dir=other_target_files_temp_dir, target_files_temp_dir=other_target_files_temp_dir,
extract_item_list=other_extract_special_item_list) extract_item_list=other_extract_special_item_list)
if result != 0:
return result
# Now that the temporary directories contain all the extracted files, perform # Now that the temporary directories contain all the extracted files, perform
# special case processing on any items that need it. After this function # special case processing on any items that need it. After this function
# completes successfully, all the files we need to create the output target # completes successfully, all the files we need to create the output target
# files package are in place. # files package are in place.
result = process_special_cases( process_special_cases(
temp_dir=temp_dir, temp_dir=temp_dir,
system_target_files_temp_dir=system_target_files_temp_dir, system_target_files_temp_dir=system_target_files_temp_dir,
other_target_files_temp_dir=other_target_files_temp_dir, other_target_files_temp_dir=other_target_files_temp_dir,
output_target_files_temp_dir=output_target_files_temp_dir) output_target_files_temp_dir=output_target_files_temp_dir)
if result != 0:
return result
# Regenerate IMAGES in the temporary directory. # Regenerate IMAGES in the temporary directory.
add_img_args = [ add_img_args = [
@@ -571,13 +523,7 @@ def merge_target_files(
'-l', output_target_files_list, '-l', output_target_files_list,
] ]
logger.info('creating %s', output_target_files) logger.info('creating %s', output_target_files)
result = common.RunAndWait(command, verbose=True) common.RunAndWait(command, verbose=True)
if result != 0:
logger.error('zip command %s failed %d', str(command), result)
return result
return 0
def merge_target_files_with_temp_dir( def merge_target_files_with_temp_dir(
@@ -601,9 +547,6 @@ def merge_target_files_with_temp_dir(
package created by merging system and other. package created by merging system and other.
keep_tmp: Keep the temporary directory after processing is complete. keep_tmp: Keep the temporary directory after processing is complete.
Returns:
On success, 0. Otherwise, a non-zero exit code.
""" """
# Create a temporary directory. This will serve as the parent of directories # Create a temporary directory. This will serve as the parent of directories
@@ -619,7 +562,7 @@ def merge_target_files_with_temp_dir(
temp_dir = common.MakeTempDir(prefix='merge_target_files_') temp_dir = common.MakeTempDir(prefix='merge_target_files_')
try: try:
return merge_target_files( merge_target_files(
temp_dir=temp_dir, temp_dir=temp_dir,
system_target_files=system_target_files, system_target_files=system_target_files,
other_target_files=other_target_files, other_target_files=other_target_files,
@@ -638,9 +581,6 @@ def main():
Process command line arguments, then call merge_target_files_with_temp_dir to Process command line arguments, then call merge_target_files_with_temp_dir to
perform the heavy lifting. perform the heavy lifting.
Returns:
On success, 0. Otherwise, a non-zero exit code.
""" """
common.InitLogging() common.InitLogging()
@@ -673,9 +613,9 @@ def main():
OPTIONS.other_target_files is None or OPTIONS.other_target_files is None or
OPTIONS.output_target_files is None): OPTIONS.output_target_files is None):
common.Usage(__doc__) common.Usage(__doc__)
return 1 sys.exit(1)
return merge_target_files_with_temp_dir( merge_target_files_with_temp_dir(
system_target_files=OPTIONS.system_target_files, system_target_files=OPTIONS.system_target_files,
other_target_files=OPTIONS.other_target_files, other_target_files=OPTIONS.other_target_files,
output_target_files=OPTIONS.output_target_files, output_target_files=OPTIONS.output_target_files,
@@ -683,4 +623,4 @@ def main():
if __name__ == '__main__': if __name__ == '__main__':
sys.exit(main()) main()