Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 0ff15de3 authored by Tao Bao's avatar Tao Bao
Browse files

releasetools: common.UnzipTemp() filters out non-matching patterns. 

common.UnzipTemp() calls `unzip` to do the unzipping, which will
complain if there's non-existent names in the given list. Prior to this
CL, callers had to do the work to remove non-existent entries. This CL
filters out the given patterns in common.UnzipTemp()/common.UnzipToDir()
to make callers' works easier.

Bug: 128848294
Test: `m dist` with aosp_taimen-userdebug (which calls
      ota_from_target_files.py on a target_files.zip that doesn't
      contain RADIO/*).
Test: `python -m unittest test_common.CommonZipTest`
Change-Id: I5e741c27ea8d0b8126c398a7e1b56a8deb4a3d7f
parent bec4aa86

tools/releasetools/common.py

+17 −8
Original line number Diff line number Diff line
@@ -17,6 +17,7 @@ from __future__ import print_function 
import collections

import copy

import errno

import fnmatch

import getopt

import getpass

import gzip
@@ -771,21 +772,29 @@ def Gunzip(in_filename, out_filename): 
    shutil.copyfileobj(in_file, out_file)





def UnzipToDir(filename, dirname, pattern=None):

def UnzipToDir(filename, dirname, patterns=None):

  """Unzips the archive to the given directory.



  Args:

    filename: The name of the zip file to unzip.



    dirname: Where the unziped files will land.



    pattern: Files to unzip from the archive. If omitted, will unzip the entire

    archvie.

    patterns: Files to unzip from the archive. If omitted, will unzip the entire

        archvie. Non-matching patterns will be filtered out. If there's no match

        after the filtering, no file will be unzipped.

  """



  cmd = ["unzip", "-o", "-q", filename, "-d", dirname]

  if pattern is not None:

    cmd.extend(pattern)

  if patterns is not None:

    # Filter out non-matching patterns. unzip will complain otherwise.

    with zipfile.ZipFile(filename) as input_zip:

      names = input_zip.namelist()

    filtered = [

        pattern for pattern in patterns if fnmatch.filter(names, pattern)]



    # There isn't any matching files. Don't unzip anything.

    if not filtered:

      return

    cmd.extend(filtered)



  RunAndCheckOutput(cmd)

tools/releasetools/ota_from_target_files.py

+2 −7
Original line number Diff line number Diff line
@@ -236,7 +236,7 @@ METADATA_NAME = 'META-INF/com/android/metadata' 
POSTINSTALL_CONFIG = 'META/postinstall_config.txt'

DYNAMIC_PARTITION_INFO = 'META/dynamic_partitions_info.txt'

AB_PARTITIONS = 'META/ab_partitions.txt'

UNZIP_PATTERN = ['IMAGES/*', 'META/*']

UNZIP_PATTERN = ['IMAGES/*', 'META/*', 'RADIO/*']

RETROFIT_DAP_UNZIP_PATTERN = ['OTA/super_*.img', AB_PARTITIONS]
@@ -1802,12 +1802,7 @@ def GetTargetFilesZipForSecondaryImages(input_file, skip_postinstall=False): 
    infolist = input_zip.infolist()

    namelist = input_zip.namelist()



  # Additionally unzip 'RADIO/*' if exists.

  unzip_pattern = UNZIP_PATTERN[:]

  if any([entry.startswith('RADIO/') for entry in namelist]):

    unzip_pattern.append('RADIO/*')

  input_tmp = common.UnzipTemp(input_file, unzip_pattern)



  input_tmp = common.UnzipTemp(input_file, UNZIP_PATTERN)

  for info in infolist:

    unzipped_file = os.path.join(input_tmp, *info.filename.split('/'))

    if info.filename == 'IMAGES/system_other.img':

tools/releasetools/test_common.py

+84 −0
Original line number Diff line number Diff line
@@ -359,6 +359,90 @@ class CommonZipTest(test_utils.ReleaseToolsTestCase): 
    finally:

      os.remove(zip_file.name)



  @staticmethod

  def _test_UnzipTemp_createZipFile():

    zip_file = common.MakeTempFile(suffix='.zip')

    output_zip = zipfile.ZipFile(

        zip_file, 'w', compression=zipfile.ZIP_DEFLATED)

    contents = os.urandom(1024)

    with tempfile.NamedTemporaryFile() as entry_file:

      entry_file.write(contents)

      common.ZipWrite(output_zip, entry_file.name, arcname='Test1')

      common.ZipWrite(output_zip, entry_file.name, arcname='Test2')

      common.ZipWrite(output_zip, entry_file.name, arcname='Foo3')

      common.ZipWrite(output_zip, entry_file.name, arcname='Bar4')

      common.ZipWrite(output_zip, entry_file.name, arcname='Dir5/Baz5')

      common.ZipClose(output_zip)

    common.ZipClose(output_zip)

    return zip_file



  def test_UnzipTemp(self):

    zip_file = self._test_UnzipTemp_createZipFile()

    unzipped_dir = common.UnzipTemp(zip_file)

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Test1')))

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Test2')))

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Foo3')))

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Bar4')))

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Dir5/Baz5')))



  def test_UnzipTemp_withPatterns(self):

    zip_file = self._test_UnzipTemp_createZipFile()



    unzipped_dir = common.UnzipTemp(zip_file, ['Test1'])

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Test1')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Test2')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Foo3')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Bar4')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Dir5/Baz5')))



    unzipped_dir = common.UnzipTemp(zip_file, ['Test1', 'Foo3'])

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Test1')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Test2')))

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Foo3')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Bar4')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Dir5/Baz5')))



    unzipped_dir = common.UnzipTemp(zip_file, ['Test*', 'Foo3*'])

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Test1')))

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Test2')))

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Foo3')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Bar4')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Dir5/Baz5')))



    unzipped_dir = common.UnzipTemp(zip_file, ['*Test1', '*Baz*'])

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Test1')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Test2')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Foo3')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Bar4')))

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Dir5/Baz5')))



  def test_UnzipTemp_withEmptyPatterns(self):

    zip_file = self._test_UnzipTemp_createZipFile()

    unzipped_dir = common.UnzipTemp(zip_file, [])

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Test1')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Test2')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Foo3')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Bar4')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Dir5/Baz5')))



  def test_UnzipTemp_withPartiallyMatchingPatterns(self):

    zip_file = self._test_UnzipTemp_createZipFile()

    unzipped_dir = common.UnzipTemp(zip_file, ['Test*', 'Nonexistent*'])

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Test1')))

    self.assertTrue(os.path.exists(os.path.join(unzipped_dir, 'Test2')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Foo3')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Bar4')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Dir5/Baz5')))



  def test_UnzipTemp_withNoMatchingPatterns(self):

    zip_file = self._test_UnzipTemp_createZipFile()

    unzipped_dir = common.UnzipTemp(zip_file, ['Foo4', 'Nonexistent*'])

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Test1')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Test2')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Foo3')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Bar4')))

    self.assertFalse(os.path.exists(os.path.join(unzipped_dir, 'Dir5/Baz5')))





class CommonApkUtilsTest(test_utils.ReleaseToolsTestCase):

  """Tests the APK utils related functions."""