73dd4f45f3
stdout and stderr will default to subprocess.PIPE and subprocess.STDOUT
respectively (which is the expected behavior from most of the existing
callers), unless caller specifies any of them.
Test: `m dist`
Test: python -m unittest \
test_common \
test_add_img_to_target_files \
test_ota_from_target_files \
test_validate_target_files
Change-Id: I43b3f08edfa8a9bcfe54baf9848dc705c048e327
391 lines
14 KiB
Python
391 lines
14 KiB
Python
#
|
|
# Copyright (C) 2018 The Android Open Source Project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
import os
|
|
import os.path
|
|
import unittest
|
|
import zipfile
|
|
|
|
import common
|
|
import test_utils
|
|
from add_img_to_target_files import (
|
|
AddCareMapForAbOta, AddPackRadioImages, AppendVBMetaArgsForPartition,
|
|
CheckAbOtaImages, GetCareMap)
|
|
from rangelib import RangeSet
|
|
|
|
|
|
OPTIONS = common.OPTIONS
|
|
|
|
|
|
class AddImagesToTargetFilesTest(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
OPTIONS.input_tmp = common.MakeTempDir()
|
|
|
|
def tearDown(self):
|
|
common.Cleanup()
|
|
|
|
def _verifyCareMap(self, expected, file_name):
|
|
"""Parses the care_map.pb; and checks the content in plain text."""
|
|
text_file = common.MakeTempFile(prefix="caremap-", suffix=".txt")
|
|
|
|
# Calls an external binary to convert the proto message.
|
|
cmd = ["care_map_generator", "--parse_proto", file_name, text_file]
|
|
proc = common.Run(cmd)
|
|
output, _ = proc.communicate()
|
|
self.assertEqual(
|
|
0, proc.returncode,
|
|
"Failed to run care_map_generator:\n{}".format(output))
|
|
|
|
with open(text_file, 'r') as verify_fp:
|
|
plain_text = verify_fp.read()
|
|
self.assertEqual('\n'.join(expected), plain_text)
|
|
|
|
@staticmethod
|
|
def _create_images(images, prefix):
|
|
"""Creates images under OPTIONS.input_tmp/prefix."""
|
|
path = os.path.join(OPTIONS.input_tmp, prefix)
|
|
if not os.path.exists(path):
|
|
os.mkdir(path)
|
|
|
|
for image in images:
|
|
image_path = os.path.join(path, image + '.img')
|
|
with open(image_path, 'wb') as image_fp:
|
|
image_fp.write(image.encode())
|
|
|
|
images_path = os.path.join(OPTIONS.input_tmp, 'IMAGES')
|
|
if not os.path.exists(images_path):
|
|
os.mkdir(images_path)
|
|
return images, images_path
|
|
|
|
def test_CheckAbOtaImages_imageExistsUnderImages(self):
|
|
"""Tests the case with existing images under IMAGES/."""
|
|
images, _ = self._create_images(['aboot', 'xbl'], 'IMAGES')
|
|
CheckAbOtaImages(None, images)
|
|
|
|
def test_CheckAbOtaImages_imageExistsUnderRadio(self):
|
|
"""Tests the case with some image under RADIO/."""
|
|
images, _ = self._create_images(['system', 'vendor'], 'IMAGES')
|
|
radio_path = os.path.join(OPTIONS.input_tmp, 'RADIO')
|
|
if not os.path.exists(radio_path):
|
|
os.mkdir(radio_path)
|
|
with open(os.path.join(radio_path, 'modem.img'), 'wb') as image_fp:
|
|
image_fp.write('modem'.encode())
|
|
CheckAbOtaImages(None, images + ['modem'])
|
|
|
|
def test_CheckAbOtaImages_missingImages(self):
|
|
images, _ = self._create_images(['aboot', 'xbl'], 'RADIO')
|
|
self.assertRaises(
|
|
AssertionError, CheckAbOtaImages, None, images + ['baz'])
|
|
|
|
def test_AddPackRadioImages(self):
|
|
images, images_path = self._create_images(['foo', 'bar'], 'RADIO')
|
|
AddPackRadioImages(None, images)
|
|
|
|
for image in images:
|
|
self.assertTrue(
|
|
os.path.exists(os.path.join(images_path, image + '.img')))
|
|
|
|
def test_AddPackRadioImages_with_suffix(self):
|
|
images, images_path = self._create_images(['foo', 'bar'], 'RADIO')
|
|
images_with_suffix = [image + '.img' for image in images]
|
|
AddPackRadioImages(None, images_with_suffix)
|
|
|
|
for image in images:
|
|
self.assertTrue(
|
|
os.path.exists(os.path.join(images_path, image + '.img')))
|
|
|
|
def test_AddPackRadioImages_zipOutput(self):
|
|
images, _ = self._create_images(['foo', 'bar'], 'RADIO')
|
|
|
|
# Set up the output zip.
|
|
output_file = common.MakeTempFile(suffix='.zip')
|
|
with zipfile.ZipFile(output_file, 'w') as output_zip:
|
|
AddPackRadioImages(output_zip, images)
|
|
|
|
with zipfile.ZipFile(output_file, 'r') as verify_zip:
|
|
for image in images:
|
|
self.assertIn('IMAGES/' + image + '.img', verify_zip.namelist())
|
|
|
|
def test_AddPackRadioImages_imageExists(self):
|
|
images, images_path = self._create_images(['foo', 'bar'], 'RADIO')
|
|
|
|
# Additionally create images under IMAGES/ so that they should be skipped.
|
|
images, images_path = self._create_images(['foo', 'bar'], 'IMAGES')
|
|
|
|
AddPackRadioImages(None, images)
|
|
|
|
for image in images:
|
|
self.assertTrue(
|
|
os.path.exists(os.path.join(images_path, image + '.img')))
|
|
|
|
def test_AddPackRadioImages_missingImages(self):
|
|
images, _ = self._create_images(['foo', 'bar'], 'RADIO')
|
|
AddPackRadioImages(None, images)
|
|
|
|
self.assertRaises(AssertionError, AddPackRadioImages, None,
|
|
images + ['baz'])
|
|
|
|
@staticmethod
|
|
def _test_AddCareMapForAbOta():
|
|
"""Helper function to set up the test for test_AddCareMapForAbOta()."""
|
|
OPTIONS.info_dict = {
|
|
'system_verity_block_device': '/dev/block/system',
|
|
'vendor_verity_block_device': '/dev/block/vendor',
|
|
'system.build.prop': {
|
|
'ro.system.build.fingerprint':
|
|
'google/sailfish/12345:user/dev-keys',
|
|
},
|
|
'vendor.build.prop': {
|
|
'ro.vendor.build.fingerprint': 'google/sailfish/678:user/dev-keys',
|
|
}
|
|
}
|
|
|
|
# Prepare the META/ folder.
|
|
meta_path = os.path.join(OPTIONS.input_tmp, 'META')
|
|
if not os.path.exists(meta_path):
|
|
os.mkdir(meta_path)
|
|
|
|
system_image = test_utils.construct_sparse_image([
|
|
(0xCAC1, 6),
|
|
(0xCAC3, 4),
|
|
(0xCAC1, 6)])
|
|
vendor_image = test_utils.construct_sparse_image([
|
|
(0xCAC2, 10)])
|
|
|
|
image_paths = {
|
|
'system' : system_image,
|
|
'vendor' : vendor_image,
|
|
}
|
|
return image_paths
|
|
|
|
def test_AddCareMapForAbOta(self):
|
|
image_paths = self._test_AddCareMapForAbOta()
|
|
|
|
AddCareMapForAbOta(None, ['system', 'vendor'], image_paths)
|
|
|
|
care_map_file = os.path.join(OPTIONS.input_tmp, 'META', 'care_map.pb')
|
|
expected = ['system', RangeSet("0-5 10-15").to_string_raw(),
|
|
"ro.system.build.fingerprint",
|
|
"google/sailfish/12345:user/dev-keys",
|
|
'vendor', RangeSet("0-9").to_string_raw(),
|
|
"ro.vendor.build.fingerprint",
|
|
"google/sailfish/678:user/dev-keys"]
|
|
|
|
self._verifyCareMap(expected, care_map_file)
|
|
|
|
def test_AddCareMapForAbOta_withNonCareMapPartitions(self):
|
|
"""Partitions without care_map should be ignored."""
|
|
image_paths = self._test_AddCareMapForAbOta()
|
|
|
|
AddCareMapForAbOta(
|
|
None, ['boot', 'system', 'vendor', 'vbmeta'], image_paths)
|
|
|
|
care_map_file = os.path.join(OPTIONS.input_tmp, 'META', 'care_map.pb')
|
|
expected = ['system', RangeSet("0-5 10-15").to_string_raw(),
|
|
"ro.system.build.fingerprint",
|
|
"google/sailfish/12345:user/dev-keys",
|
|
'vendor', RangeSet("0-9").to_string_raw(),
|
|
"ro.vendor.build.fingerprint",
|
|
"google/sailfish/678:user/dev-keys"]
|
|
|
|
self._verifyCareMap(expected, care_map_file)
|
|
|
|
def test_AddCareMapForAbOta_withAvb(self):
|
|
"""Tests the case for device using AVB."""
|
|
image_paths = self._test_AddCareMapForAbOta()
|
|
OPTIONS.info_dict = {
|
|
'avb_system_hashtree_enable' : 'true',
|
|
'avb_vendor_hashtree_enable' : 'true',
|
|
'system.build.prop': {
|
|
'ro.system.build.fingerprint':
|
|
'google/sailfish/12345:user/dev-keys',
|
|
},
|
|
'vendor.build.prop': {
|
|
'ro.vendor.build.fingerprint': 'google/sailfish/678:user/dev-keys',
|
|
}
|
|
}
|
|
|
|
AddCareMapForAbOta(None, ['system', 'vendor'], image_paths)
|
|
|
|
care_map_file = os.path.join(OPTIONS.input_tmp, 'META', 'care_map.pb')
|
|
expected = ['system', RangeSet("0-5 10-15").to_string_raw(),
|
|
"ro.system.build.fingerprint",
|
|
"google/sailfish/12345:user/dev-keys",
|
|
'vendor', RangeSet("0-9").to_string_raw(),
|
|
"ro.vendor.build.fingerprint",
|
|
"google/sailfish/678:user/dev-keys"]
|
|
|
|
self._verifyCareMap(expected, care_map_file)
|
|
|
|
def test_AddCareMapForAbOta_noFingerprint(self):
|
|
"""Tests the case for partitions without fingerprint."""
|
|
image_paths = self._test_AddCareMapForAbOta()
|
|
OPTIONS.info_dict = {
|
|
'system_verity_block_device': '/dev/block/system',
|
|
'vendor_verity_block_device': '/dev/block/vendor',
|
|
}
|
|
|
|
AddCareMapForAbOta(None, ['system', 'vendor'], image_paths)
|
|
|
|
care_map_file = os.path.join(OPTIONS.input_tmp, 'META', 'care_map.pb')
|
|
expected = ['system', RangeSet("0-5 10-15").to_string_raw(), "unknown",
|
|
"unknown", 'vendor', RangeSet("0-9").to_string_raw(), "unknown",
|
|
"unknown"]
|
|
|
|
self._verifyCareMap(expected, care_map_file)
|
|
|
|
def test_AddCareMapForAbOta_withThumbprint(self):
|
|
"""Tests the case for partitions with thumbprint."""
|
|
image_paths = self._test_AddCareMapForAbOta()
|
|
OPTIONS.info_dict = {
|
|
'system_verity_block_device': '/dev/block/system',
|
|
'vendor_verity_block_device': '/dev/block/vendor',
|
|
'system.build.prop': {
|
|
'ro.system.build.thumbprint': 'google/sailfish/123:user/dev-keys',
|
|
},
|
|
'vendor.build.prop' : {
|
|
'ro.vendor.build.thumbprint': 'google/sailfish/456:user/dev-keys',
|
|
}
|
|
}
|
|
|
|
AddCareMapForAbOta(None, ['system', 'vendor'], image_paths)
|
|
|
|
care_map_file = os.path.join(OPTIONS.input_tmp, 'META', 'care_map.pb')
|
|
expected = ['system', RangeSet("0-5 10-15").to_string_raw(),
|
|
"ro.system.build.thumbprint",
|
|
"google/sailfish/123:user/dev-keys",
|
|
'vendor', RangeSet("0-9").to_string_raw(),
|
|
"ro.vendor.build.thumbprint",
|
|
"google/sailfish/456:user/dev-keys"]
|
|
|
|
self._verifyCareMap(expected, care_map_file)
|
|
|
|
def test_AddCareMapForAbOta_verityNotEnabled(self):
|
|
"""No care_map.pb should be generated if verity not enabled."""
|
|
image_paths = self._test_AddCareMapForAbOta()
|
|
OPTIONS.info_dict = {}
|
|
AddCareMapForAbOta(None, ['system', 'vendor'], image_paths)
|
|
|
|
care_map_file = os.path.join(OPTIONS.input_tmp, 'META', 'care_map.pb')
|
|
self.assertFalse(os.path.exists(care_map_file))
|
|
|
|
def test_AddCareMapForAbOta_missingImageFile(self):
|
|
"""Missing image file should be considered fatal."""
|
|
image_paths = self._test_AddCareMapForAbOta()
|
|
image_paths['vendor'] = ''
|
|
self.assertRaises(AssertionError, AddCareMapForAbOta, None,
|
|
['system', 'vendor'], image_paths)
|
|
|
|
def test_AddCareMapForAbOta_zipOutput(self):
|
|
"""Tests the case with ZIP output."""
|
|
image_paths = self._test_AddCareMapForAbOta()
|
|
|
|
output_file = common.MakeTempFile(suffix='.zip')
|
|
with zipfile.ZipFile(output_file, 'w') as output_zip:
|
|
AddCareMapForAbOta(output_zip, ['system', 'vendor'], image_paths)
|
|
|
|
care_map_name = "META/care_map.pb"
|
|
temp_dir = common.MakeTempDir()
|
|
with zipfile.ZipFile(output_file, 'r') as verify_zip:
|
|
self.assertTrue(care_map_name in verify_zip.namelist())
|
|
verify_zip.extract(care_map_name, path=temp_dir)
|
|
|
|
expected = ['system', RangeSet("0-5 10-15").to_string_raw(),
|
|
"ro.system.build.fingerprint",
|
|
"google/sailfish/12345:user/dev-keys",
|
|
'vendor', RangeSet("0-9").to_string_raw(),
|
|
"ro.vendor.build.fingerprint",
|
|
"google/sailfish/678:user/dev-keys"]
|
|
self._verifyCareMap(expected, os.path.join(temp_dir, care_map_name))
|
|
|
|
def test_AddCareMapForAbOta_zipOutput_careMapEntryExists(self):
|
|
"""Tests the case with ZIP output which already has care_map entry."""
|
|
image_paths = self._test_AddCareMapForAbOta()
|
|
|
|
output_file = common.MakeTempFile(suffix='.zip')
|
|
with zipfile.ZipFile(output_file, 'w') as output_zip:
|
|
# Create an existing META/care_map.pb entry.
|
|
common.ZipWriteStr(output_zip, 'META/care_map.pb',
|
|
'dummy care_map.pb')
|
|
|
|
# Request to add META/care_map.pb again.
|
|
AddCareMapForAbOta(output_zip, ['system', 'vendor'], image_paths)
|
|
|
|
# The one under OPTIONS.input_tmp must have been replaced.
|
|
care_map_file = os.path.join(OPTIONS.input_tmp, 'META', 'care_map.pb')
|
|
expected = ['system', RangeSet("0-5 10-15").to_string_raw(),
|
|
"ro.system.build.fingerprint",
|
|
"google/sailfish/12345:user/dev-keys",
|
|
'vendor', RangeSet("0-9").to_string_raw(),
|
|
"ro.vendor.build.fingerprint",
|
|
"google/sailfish/678:user/dev-keys"]
|
|
|
|
self._verifyCareMap(expected, care_map_file)
|
|
|
|
# The existing entry should be scheduled to be replaced.
|
|
self.assertIn('META/care_map.pb', OPTIONS.replace_updated_files_list)
|
|
|
|
def test_AppendVBMetaArgsForPartition(self):
|
|
OPTIONS.info_dict = {}
|
|
cmd = []
|
|
AppendVBMetaArgsForPartition(cmd, 'system', '/path/to/system.img')
|
|
self.assertEqual(
|
|
['--include_descriptors_from_image', '/path/to/system.img'], cmd)
|
|
|
|
def test_AppendVBMetaArgsForPartition_vendorAsChainedPartition(self):
|
|
testdata_dir = test_utils.get_testdata_dir()
|
|
pubkey = os.path.join(testdata_dir, 'testkey.pubkey.pem')
|
|
OPTIONS.info_dict = {
|
|
'avb_avbtool': 'avbtool',
|
|
'avb_vendor_key_path': pubkey,
|
|
'avb_vendor_rollback_index_location': 5,
|
|
}
|
|
cmd = []
|
|
AppendVBMetaArgsForPartition(cmd, 'vendor', '/path/to/vendor.img')
|
|
self.assertEqual(2, len(cmd))
|
|
self.assertEqual('--chain_partition', cmd[0])
|
|
chained_partition_args = cmd[1].split(':')
|
|
self.assertEqual(3, len(chained_partition_args))
|
|
self.assertEqual('vendor', chained_partition_args[0])
|
|
self.assertEqual('5', chained_partition_args[1])
|
|
self.assertTrue(os.path.exists(chained_partition_args[2]))
|
|
|
|
def test_GetCareMap(self):
|
|
sparse_image = test_utils.construct_sparse_image([
|
|
(0xCAC1, 6),
|
|
(0xCAC3, 4),
|
|
(0xCAC1, 6)])
|
|
OPTIONS.info_dict = {
|
|
'system_image_blocks' : 12,
|
|
}
|
|
name, care_map = GetCareMap('system', sparse_image)
|
|
self.assertEqual('system', name)
|
|
self.assertEqual(RangeSet("0-5 10-12").to_string_raw(), care_map)
|
|
|
|
def test_GetCareMap_invalidPartition(self):
|
|
self.assertRaises(AssertionError, GetCareMap, 'oem', None)
|
|
|
|
def test_GetCareMap_invalidAdjustedPartitionSize(self):
|
|
sparse_image = test_utils.construct_sparse_image([
|
|
(0xCAC1, 6),
|
|
(0xCAC3, 4),
|
|
(0xCAC1, 6)])
|
|
OPTIONS.info_dict = {
|
|
'system_image_blocks' : -12,
|
|
}
|
|
self.assertRaises(AssertionError, GetCareMap, 'system', sparse_image)
|