Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 1 | #!/usr/bin/env python |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 2 | # |
Amin Hassani | f94b643 | 2018-01-26 17:39:47 -0800 | [diff] [blame] | 3 | # Copyright (C) 2013 The Android Open Source Project |
| 4 | # |
| 5 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | # you may not use this file except in compliance with the License. |
| 7 | # You may obtain a copy of the License at |
| 8 | # |
| 9 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | # |
| 11 | # Unless required by applicable law or agreed to in writing, software |
| 12 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | # See the License for the specific language governing permissions and |
| 15 | # limitations under the License. |
| 16 | # |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 17 | |
| 18 | """Unit testing checker.py.""" |
| 19 | |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 20 | # Disable check for function names to avoid errors based on old code |
| 21 | # pylint: disable-msg=invalid-name |
| 22 | |
| 23 | from __future__ import absolute_import |
Gilad Arnold | f583a7d | 2015-02-05 13:23:55 -0800 | [diff] [blame] | 24 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 25 | import array |
| 26 | import collections |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 27 | import hashlib |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 28 | import io |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 29 | import itertools |
| 30 | import os |
| 31 | import unittest |
| 32 | |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 33 | from six.moves import zip |
| 34 | |
| 35 | import mock # pylint: disable=import-error |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 36 | |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 37 | from update_payload import checker |
| 38 | from update_payload import common |
| 39 | from update_payload import test_utils |
Kelvin Zhang | 73202a9 | 2022-06-02 10:19:54 -0700 | [diff] [blame^] | 40 | import update_metadata_pb2 |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 41 | from update_payload.error import PayloadError |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 42 | from update_payload.payload import Payload # Avoid name conflicts later. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 43 | |
| 44 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 45 | def _OpTypeByName(op_name): |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 46 | """Returns the type of an operation from its name.""" |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 47 | op_name_to_type = { |
| 48 | 'REPLACE': common.OpType.REPLACE, |
| 49 | 'REPLACE_BZ': common.OpType.REPLACE_BZ, |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 50 | 'SOURCE_COPY': common.OpType.SOURCE_COPY, |
| 51 | 'SOURCE_BSDIFF': common.OpType.SOURCE_BSDIFF, |
Alex Deymo | 2846677 | 2015-09-11 17:16:44 -0700 | [diff] [blame] | 52 | 'ZERO': common.OpType.ZERO, |
| 53 | 'DISCARD': common.OpType.DISCARD, |
| 54 | 'REPLACE_XZ': common.OpType.REPLACE_XZ, |
Amin Hassani | 5ef5d45 | 2017-08-04 13:10:59 -0700 | [diff] [blame] | 55 | 'PUFFDIFF': common.OpType.PUFFDIFF, |
Amin Hassani | efa62d9 | 2017-11-09 13:46:56 -0800 | [diff] [blame] | 56 | 'BROTLI_BSDIFF': common.OpType.BROTLI_BSDIFF, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 57 | } |
| 58 | return op_name_to_type[op_name] |
| 59 | |
| 60 | |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 61 | def _GetPayloadChecker(payload_gen_write_to_file_func, payload_gen_dargs=None, |
| 62 | checker_init_dargs=None): |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 63 | """Returns a payload checker from a given payload generator.""" |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 64 | if payload_gen_dargs is None: |
| 65 | payload_gen_dargs = {} |
| 66 | if checker_init_dargs is None: |
| 67 | checker_init_dargs = {} |
| 68 | |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 69 | payload_file = io.BytesIO() |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 70 | payload_gen_write_to_file_func(payload_file, **payload_gen_dargs) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 71 | payload_file.seek(0) |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 72 | payload = Payload(payload_file) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 73 | payload.Init() |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 74 | return checker.PayloadChecker(payload, **checker_init_dargs) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 75 | |
| 76 | |
| 77 | def _GetPayloadCheckerWithData(payload_gen): |
| 78 | """Returns a payload checker from a given payload generator.""" |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 79 | payload_file = io.BytesIO() |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 80 | payload_gen.WriteToFile(payload_file) |
| 81 | payload_file.seek(0) |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 82 | payload = Payload(payload_file) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 83 | payload.Init() |
| 84 | return checker.PayloadChecker(payload) |
| 85 | |
| 86 | |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 87 | # This class doesn't need an __init__(). |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 88 | # pylint: disable=W0232 |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 89 | # Unit testing is all about running protected methods. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 90 | # pylint: disable=W0212 |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 91 | # Don't bark about missing members of classes you cannot import. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 92 | # pylint: disable=E1101 |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 93 | class PayloadCheckerTest(unittest.TestCase): |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 94 | """Tests the PayloadChecker class. |
| 95 | |
| 96 | In addition to ordinary testFoo() methods, which are automatically invoked by |
| 97 | the unittest framework, in this class we make use of DoBarTest() calls that |
| 98 | implement parametric tests of certain features. In order to invoke each test, |
| 99 | which embodies a unique combination of parameter values, as a complete unit |
| 100 | test, we perform explicit enumeration of the parameter space and create |
| 101 | individual invocation contexts for each, which are then bound as |
| 102 | testBar__param1=val1__param2=val2(). The enumeration of parameter spaces for |
| 103 | all such tests is done in AddAllParametricTests(). |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 104 | """ |
| 105 | |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 106 | def setUp(self): |
| 107 | """setUp function for unittest testcase""" |
| 108 | self.mock_checks = [] |
| 109 | |
| 110 | def tearDown(self): |
| 111 | """tearDown function for unittest testcase""" |
| 112 | # Verify that all mock functions were called. |
| 113 | for check in self.mock_checks: |
| 114 | check.mock_fn.assert_called_once_with(*check.exp_args, **check.exp_kwargs) |
| 115 | |
| 116 | class MockChecksAtTearDown(object): |
| 117 | """Mock data storage. |
| 118 | |
| 119 | This class stores the mock functions and its arguments to be checked at a |
| 120 | later point. |
| 121 | """ |
| 122 | def __init__(self, mock_fn, *args, **kwargs): |
| 123 | self.mock_fn = mock_fn |
| 124 | self.exp_args = args |
| 125 | self.exp_kwargs = kwargs |
| 126 | |
| 127 | def addPostCheckForMockFunction(self, mock_fn, *args, **kwargs): |
| 128 | """Store a mock function and its arguments to self.mock_checks |
| 129 | |
| 130 | Args: |
| 131 | mock_fn: mock function object |
| 132 | args: expected positional arguments for the mock_fn |
| 133 | kwargs: expected named arguments for the mock_fn |
| 134 | """ |
| 135 | self.mock_checks.append(self.MockChecksAtTearDown(mock_fn, *args, **kwargs)) |
| 136 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 137 | def MockPayload(self): |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 138 | """Create a mock payload object, complete with a mock manifest.""" |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 139 | payload = mock.create_autospec(Payload) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 140 | payload.is_init = True |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 141 | payload.manifest = mock.create_autospec( |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 142 | update_metadata_pb2.DeltaArchiveManifest) |
| 143 | return payload |
| 144 | |
| 145 | @staticmethod |
| 146 | def NewExtent(start_block, num_blocks): |
| 147 | """Returns an Extent message. |
| 148 | |
| 149 | Each of the provided fields is set iff it is >= 0; otherwise, it's left at |
| 150 | its default state. |
| 151 | |
| 152 | Args: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 153 | start_block: The starting block of the extent. |
| 154 | num_blocks: The number of blocks in the extent. |
Gilad Arnold | f583a7d | 2015-02-05 13:23:55 -0800 | [diff] [blame] | 155 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 156 | Returns: |
| 157 | An Extent message. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 158 | """ |
| 159 | ex = update_metadata_pb2.Extent() |
| 160 | if start_block >= 0: |
| 161 | ex.start_block = start_block |
| 162 | if num_blocks >= 0: |
| 163 | ex.num_blocks = num_blocks |
| 164 | return ex |
| 165 | |
| 166 | @staticmethod |
| 167 | def NewExtentList(*args): |
| 168 | """Returns an list of extents. |
| 169 | |
| 170 | Args: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 171 | *args: (start_block, num_blocks) pairs defining the extents. |
Gilad Arnold | f583a7d | 2015-02-05 13:23:55 -0800 | [diff] [blame] | 172 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 173 | Returns: |
| 174 | A list of Extent objects. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 175 | """ |
| 176 | ex_list = [] |
| 177 | for start_block, num_blocks in args: |
| 178 | ex_list.append(PayloadCheckerTest.NewExtent(start_block, num_blocks)) |
| 179 | return ex_list |
| 180 | |
| 181 | @staticmethod |
| 182 | def AddToMessage(repeated_field, field_vals): |
| 183 | for field_val in field_vals: |
| 184 | new_field = repeated_field.add() |
| 185 | new_field.CopyFrom(field_val) |
| 186 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 187 | def SetupAddElemTest(self, is_present, is_submsg, convert=str, |
| 188 | linebreak=False, indent=0): |
| 189 | """Setup for testing of _CheckElem() and its derivatives. |
| 190 | |
| 191 | Args: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 192 | is_present: Whether or not the element is found in the message. |
| 193 | is_submsg: Whether the element is a sub-message itself. |
| 194 | convert: A representation conversion function. |
| 195 | linebreak: Whether or not a linebreak is to be used in the report. |
| 196 | indent: Indentation used for the report. |
Gilad Arnold | f583a7d | 2015-02-05 13:23:55 -0800 | [diff] [blame] | 197 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 198 | Returns: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 199 | msg: A mock message object. |
| 200 | report: A mock report object. |
| 201 | subreport: A mock sub-report object. |
| 202 | name: An element name to check. |
| 203 | val: Expected element value. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 204 | """ |
| 205 | name = 'foo' |
| 206 | val = 'fake submsg' if is_submsg else 'fake field' |
| 207 | subreport = 'fake subreport' |
| 208 | |
| 209 | # Create a mock message. |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 210 | msg = mock.create_autospec(update_metadata_pb2._message.Message) |
| 211 | self.addPostCheckForMockFunction(msg.HasField, name) |
| 212 | msg.HasField.return_value = is_present |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 213 | setattr(msg, name, val) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 214 | # Create a mock report. |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 215 | report = mock.create_autospec(checker._PayloadReport) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 216 | if is_present: |
| 217 | if is_submsg: |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 218 | self.addPostCheckForMockFunction(report.AddSubReport, name) |
| 219 | report.AddSubReport.return_value = subreport |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 220 | else: |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 221 | self.addPostCheckForMockFunction(report.AddField, name, convert(val), |
| 222 | linebreak=linebreak, indent=indent) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 223 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 224 | return (msg, report, subreport, name, val) |
| 225 | |
| 226 | def DoAddElemTest(self, is_present, is_mandatory, is_submsg, convert, |
| 227 | linebreak, indent): |
| 228 | """Parametric testing of _CheckElem(). |
| 229 | |
| 230 | Args: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 231 | is_present: Whether or not the element is found in the message. |
| 232 | is_mandatory: Whether or not it's a mandatory element. |
| 233 | is_submsg: Whether the element is a sub-message itself. |
| 234 | convert: A representation conversion function. |
| 235 | linebreak: Whether or not a linebreak is to be used in the report. |
| 236 | indent: Indentation used for the report. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 237 | """ |
| 238 | msg, report, subreport, name, val = self.SetupAddElemTest( |
| 239 | is_present, is_submsg, convert, linebreak, indent) |
| 240 | |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 241 | args = (msg, name, report, is_mandatory, is_submsg) |
| 242 | kwargs = {'convert': convert, 'linebreak': linebreak, 'indent': indent} |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 243 | if is_mandatory and not is_present: |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 244 | self.assertRaises(PayloadError, |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 245 | checker.PayloadChecker._CheckElem, *args, **kwargs) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 246 | else: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 247 | ret_val, ret_subreport = checker.PayloadChecker._CheckElem(*args, |
| 248 | **kwargs) |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 249 | self.assertEqual(val if is_present else None, ret_val) |
| 250 | self.assertEqual(subreport if is_present and is_submsg else None, |
| 251 | ret_subreport) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 252 | |
| 253 | def DoAddFieldTest(self, is_mandatory, is_present, convert, linebreak, |
| 254 | indent): |
| 255 | """Parametric testing of _Check{Mandatory,Optional}Field(). |
| 256 | |
| 257 | Args: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 258 | is_mandatory: Whether we're testing a mandatory call. |
| 259 | is_present: Whether or not the element is found in the message. |
| 260 | convert: A representation conversion function. |
| 261 | linebreak: Whether or not a linebreak is to be used in the report. |
| 262 | indent: Indentation used for the report. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 263 | """ |
| 264 | msg, report, _, name, val = self.SetupAddElemTest( |
| 265 | is_present, False, convert, linebreak, indent) |
| 266 | |
| 267 | # Prepare for invocation of the tested method. |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 268 | args = [msg, name, report] |
| 269 | kwargs = {'convert': convert, 'linebreak': linebreak, 'indent': indent} |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 270 | if is_mandatory: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 271 | args.append('bar') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 272 | tested_func = checker.PayloadChecker._CheckMandatoryField |
| 273 | else: |
| 274 | tested_func = checker.PayloadChecker._CheckOptionalField |
| 275 | |
| 276 | # Test the method call. |
| 277 | if is_mandatory and not is_present: |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 278 | self.assertRaises(PayloadError, tested_func, *args, **kwargs) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 279 | else: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 280 | ret_val = tested_func(*args, **kwargs) |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 281 | self.assertEqual(val if is_present else None, ret_val) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 282 | |
| 283 | def DoAddSubMsgTest(self, is_mandatory, is_present): |
| 284 | """Parametrized testing of _Check{Mandatory,Optional}SubMsg(). |
| 285 | |
| 286 | Args: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 287 | is_mandatory: Whether we're testing a mandatory call. |
| 288 | is_present: Whether or not the element is found in the message. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 289 | """ |
| 290 | msg, report, subreport, name, val = self.SetupAddElemTest(is_present, True) |
| 291 | |
| 292 | # Prepare for invocation of the tested method. |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 293 | args = [msg, name, report] |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 294 | if is_mandatory: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 295 | args.append('bar') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 296 | tested_func = checker.PayloadChecker._CheckMandatorySubMsg |
| 297 | else: |
| 298 | tested_func = checker.PayloadChecker._CheckOptionalSubMsg |
| 299 | |
| 300 | # Test the method call. |
| 301 | if is_mandatory and not is_present: |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 302 | self.assertRaises(PayloadError, tested_func, *args) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 303 | else: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 304 | ret_val, ret_subreport = tested_func(*args) |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 305 | self.assertEqual(val if is_present else None, ret_val) |
| 306 | self.assertEqual(subreport if is_present else None, ret_subreport) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 307 | |
| 308 | def testCheckPresentIff(self): |
| 309 | """Tests _CheckPresentIff().""" |
| 310 | self.assertIsNone(checker.PayloadChecker._CheckPresentIff( |
| 311 | None, None, 'foo', 'bar', 'baz')) |
| 312 | self.assertIsNone(checker.PayloadChecker._CheckPresentIff( |
| 313 | 'a', 'b', 'foo', 'bar', 'baz')) |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 314 | self.assertRaises(PayloadError, checker.PayloadChecker._CheckPresentIff, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 315 | 'a', None, 'foo', 'bar', 'baz') |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 316 | self.assertRaises(PayloadError, checker.PayloadChecker._CheckPresentIff, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 317 | None, 'b', 'foo', 'bar', 'baz') |
| 318 | |
| 319 | def DoCheckSha256SignatureTest(self, expect_pass, expect_subprocess_call, |
| 320 | sig_data, sig_asn1_header, |
| 321 | returned_signed_hash, expected_signed_hash): |
| 322 | """Parametric testing of _CheckSha256SignatureTest(). |
| 323 | |
| 324 | Args: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 325 | expect_pass: Whether or not it should pass. |
| 326 | expect_subprocess_call: Whether to expect the openssl call to happen. |
| 327 | sig_data: The signature raw data. |
| 328 | sig_asn1_header: The ASN1 header. |
| 329 | returned_signed_hash: The signed hash data retuned by openssl. |
| 330 | expected_signed_hash: The signed hash data to compare against. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 331 | """ |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 332 | # Stub out the subprocess invocation. |
| 333 | with mock.patch.object(checker.PayloadChecker, '_Run') \ |
| 334 | as mock_payload_checker: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 335 | if expect_subprocess_call: |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 336 | mock_payload_checker([], send_data=sig_data) |
| 337 | mock_payload_checker.return_value = ( |
| 338 | sig_asn1_header + returned_signed_hash, None) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 339 | |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 340 | if expect_pass: |
| 341 | self.assertIsNone(checker.PayloadChecker._CheckSha256Signature( |
| 342 | sig_data, 'foo', expected_signed_hash, 'bar')) |
| 343 | else: |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 344 | self.assertRaises(PayloadError, |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 345 | checker.PayloadChecker._CheckSha256Signature, |
| 346 | sig_data, 'foo', expected_signed_hash, 'bar') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 347 | |
| 348 | def testCheckSha256Signature_Pass(self): |
| 349 | """Tests _CheckSha256Signature(); pass case.""" |
| 350 | sig_data = 'fake-signature'.ljust(256) |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 351 | signed_hash = hashlib.sha256(b'fake-data').digest() |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 352 | self.DoCheckSha256SignatureTest(True, True, sig_data, |
| 353 | common.SIG_ASN1_HEADER, signed_hash, |
| 354 | signed_hash) |
| 355 | |
| 356 | def testCheckSha256Signature_FailBadSignature(self): |
| 357 | """Tests _CheckSha256Signature(); fails due to malformed signature.""" |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 358 | sig_data = 'fake-signature' # Malformed (not 256 bytes in length). |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 359 | signed_hash = hashlib.sha256(b'fake-data').digest() |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 360 | self.DoCheckSha256SignatureTest(False, False, sig_data, |
| 361 | common.SIG_ASN1_HEADER, signed_hash, |
| 362 | signed_hash) |
| 363 | |
| 364 | def testCheckSha256Signature_FailBadOutputLength(self): |
| 365 | """Tests _CheckSha256Signature(); fails due to unexpected output length.""" |
| 366 | sig_data = 'fake-signature'.ljust(256) |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 367 | signed_hash = b'fake-hash' # Malformed (not 32 bytes in length). |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 368 | self.DoCheckSha256SignatureTest(False, True, sig_data, |
| 369 | common.SIG_ASN1_HEADER, signed_hash, |
| 370 | signed_hash) |
| 371 | |
| 372 | def testCheckSha256Signature_FailBadAsnHeader(self): |
| 373 | """Tests _CheckSha256Signature(); fails due to bad ASN1 header.""" |
| 374 | sig_data = 'fake-signature'.ljust(256) |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 375 | signed_hash = hashlib.sha256(b'fake-data').digest() |
| 376 | bad_asn1_header = b'bad-asn-header'.ljust(len(common.SIG_ASN1_HEADER)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 377 | self.DoCheckSha256SignatureTest(False, True, sig_data, bad_asn1_header, |
| 378 | signed_hash, signed_hash) |
| 379 | |
| 380 | def testCheckSha256Signature_FailBadHash(self): |
| 381 | """Tests _CheckSha256Signature(); fails due to bad hash returned.""" |
| 382 | sig_data = 'fake-signature'.ljust(256) |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 383 | expected_signed_hash = hashlib.sha256(b'fake-data').digest() |
| 384 | returned_signed_hash = hashlib.sha256(b'bad-fake-data').digest() |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 385 | self.DoCheckSha256SignatureTest(False, True, sig_data, |
| 386 | common.SIG_ASN1_HEADER, |
| 387 | expected_signed_hash, returned_signed_hash) |
| 388 | |
| 389 | def testCheckBlocksFitLength_Pass(self): |
| 390 | """Tests _CheckBlocksFitLength(); pass case.""" |
| 391 | self.assertIsNone(checker.PayloadChecker._CheckBlocksFitLength( |
| 392 | 64, 4, 16, 'foo')) |
| 393 | self.assertIsNone(checker.PayloadChecker._CheckBlocksFitLength( |
| 394 | 60, 4, 16, 'foo')) |
| 395 | self.assertIsNone(checker.PayloadChecker._CheckBlocksFitLength( |
| 396 | 49, 4, 16, 'foo')) |
| 397 | self.assertIsNone(checker.PayloadChecker._CheckBlocksFitLength( |
| 398 | 48, 3, 16, 'foo')) |
| 399 | |
| 400 | def testCheckBlocksFitLength_TooManyBlocks(self): |
| 401 | """Tests _CheckBlocksFitLength(); fails due to excess blocks.""" |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 402 | self.assertRaises(PayloadError, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 403 | checker.PayloadChecker._CheckBlocksFitLength, |
| 404 | 64, 5, 16, 'foo') |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 405 | self.assertRaises(PayloadError, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 406 | checker.PayloadChecker._CheckBlocksFitLength, |
| 407 | 60, 5, 16, 'foo') |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 408 | self.assertRaises(PayloadError, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 409 | checker.PayloadChecker._CheckBlocksFitLength, |
| 410 | 49, 5, 16, 'foo') |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 411 | self.assertRaises(PayloadError, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 412 | checker.PayloadChecker._CheckBlocksFitLength, |
| 413 | 48, 4, 16, 'foo') |
| 414 | |
| 415 | def testCheckBlocksFitLength_TooFewBlocks(self): |
| 416 | """Tests _CheckBlocksFitLength(); fails due to insufficient blocks.""" |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 417 | self.assertRaises(PayloadError, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 418 | checker.PayloadChecker._CheckBlocksFitLength, |
| 419 | 64, 3, 16, 'foo') |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 420 | self.assertRaises(PayloadError, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 421 | checker.PayloadChecker._CheckBlocksFitLength, |
| 422 | 60, 3, 16, 'foo') |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 423 | self.assertRaises(PayloadError, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 424 | checker.PayloadChecker._CheckBlocksFitLength, |
| 425 | 49, 3, 16, 'foo') |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 426 | self.assertRaises(PayloadError, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 427 | checker.PayloadChecker._CheckBlocksFitLength, |
| 428 | 48, 2, 16, 'foo') |
| 429 | |
| 430 | def DoCheckManifestTest(self, fail_mismatched_block_size, fail_bad_sigs, |
| 431 | fail_mismatched_oki_ori, fail_bad_oki, fail_bad_ori, |
Gilad Arnold | 5bc7fbe | 2015-02-05 13:01:09 -0800 | [diff] [blame] | 432 | fail_bad_nki, fail_bad_nri, fail_old_kernel_fs_size, |
| 433 | fail_old_rootfs_fs_size, fail_new_kernel_fs_size, |
| 434 | fail_new_rootfs_fs_size): |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 435 | """Parametric testing of _CheckManifest(). |
| 436 | |
| 437 | Args: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 438 | fail_mismatched_block_size: Simulate a missing block_size field. |
| 439 | fail_bad_sigs: Make signatures descriptor inconsistent. |
| 440 | fail_mismatched_oki_ori: Make old rootfs/kernel info partially present. |
| 441 | fail_bad_oki: Tamper with old kernel info. |
| 442 | fail_bad_ori: Tamper with old rootfs info. |
| 443 | fail_bad_nki: Tamper with new kernel info. |
| 444 | fail_bad_nri: Tamper with new rootfs info. |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 445 | fail_old_kernel_fs_size: Make old kernel fs size too big. |
| 446 | fail_old_rootfs_fs_size: Make old rootfs fs size too big. |
| 447 | fail_new_kernel_fs_size: Make new kernel fs size too big. |
| 448 | fail_new_rootfs_fs_size: Make new rootfs fs size too big. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 449 | """ |
| 450 | # Generate a test payload. For this test, we only care about the manifest |
| 451 | # and don't need any data blobs, hence we can use a plain paylaod generator |
| 452 | # (which also gives us more control on things that can be screwed up). |
| 453 | payload_gen = test_utils.PayloadGenerator() |
| 454 | |
| 455 | # Tamper with block size, if required. |
| 456 | if fail_mismatched_block_size: |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 457 | payload_gen.SetBlockSize(test_utils.KiB(1)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 458 | else: |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 459 | payload_gen.SetBlockSize(test_utils.KiB(4)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 460 | |
| 461 | # Add some operations. |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 462 | payload_gen.AddOperation(common.ROOTFS, common.OpType.SOURCE_COPY, |
Gilad Arnold | 5bc7fbe | 2015-02-05 13:01:09 -0800 | [diff] [blame] | 463 | src_extents=[(0, 16), (16, 497)], |
| 464 | dst_extents=[(16, 496), (0, 16)]) |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 465 | payload_gen.AddOperation(common.KERNEL, common.OpType.SOURCE_COPY, |
Gilad Arnold | 5bc7fbe | 2015-02-05 13:01:09 -0800 | [diff] [blame] | 466 | src_extents=[(0, 8), (8, 8)], |
| 467 | dst_extents=[(8, 8), (0, 8)]) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 468 | |
| 469 | # Set an invalid signatures block (offset but no size), if required. |
| 470 | if fail_bad_sigs: |
| 471 | payload_gen.SetSignatures(32, None) |
| 472 | |
Gilad Arnold | 382df5c | 2013-05-03 12:49:28 -0700 | [diff] [blame] | 473 | # Set partition / filesystem sizes. |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 474 | rootfs_part_size = test_utils.MiB(8) |
| 475 | kernel_part_size = test_utils.KiB(512) |
Gilad Arnold | 382df5c | 2013-05-03 12:49:28 -0700 | [diff] [blame] | 476 | old_rootfs_fs_size = new_rootfs_fs_size = rootfs_part_size |
| 477 | old_kernel_fs_size = new_kernel_fs_size = kernel_part_size |
| 478 | if fail_old_kernel_fs_size: |
| 479 | old_kernel_fs_size += 100 |
| 480 | if fail_old_rootfs_fs_size: |
| 481 | old_rootfs_fs_size += 100 |
| 482 | if fail_new_kernel_fs_size: |
| 483 | new_kernel_fs_size += 100 |
| 484 | if fail_new_rootfs_fs_size: |
| 485 | new_rootfs_fs_size += 100 |
| 486 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 487 | # Add old kernel/rootfs partition info, as required. |
Gilad Arnold | 382df5c | 2013-05-03 12:49:28 -0700 | [diff] [blame] | 488 | if fail_mismatched_oki_ori or fail_old_kernel_fs_size or fail_bad_oki: |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 489 | oki_hash = (None if fail_bad_oki |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 490 | else hashlib.sha256(b'fake-oki-content').digest()) |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 491 | payload_gen.SetPartInfo(common.KERNEL, False, old_kernel_fs_size, |
| 492 | oki_hash) |
Gilad Arnold | 382df5c | 2013-05-03 12:49:28 -0700 | [diff] [blame] | 493 | if not fail_mismatched_oki_ori and (fail_old_rootfs_fs_size or |
| 494 | fail_bad_ori): |
| 495 | ori_hash = (None if fail_bad_ori |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 496 | else hashlib.sha256(b'fake-ori-content').digest()) |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 497 | payload_gen.SetPartInfo(common.ROOTFS, False, old_rootfs_fs_size, |
| 498 | ori_hash) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 499 | |
| 500 | # Add new kernel/rootfs partition info. |
| 501 | payload_gen.SetPartInfo( |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 502 | common.KERNEL, True, new_kernel_fs_size, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 503 | None if fail_bad_nki else hashlib.sha256(b'fake-nki-content').digest()) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 504 | payload_gen.SetPartInfo( |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 505 | common.ROOTFS, True, new_rootfs_fs_size, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 506 | None if fail_bad_nri else hashlib.sha256(b'fake-nri-content').digest()) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 507 | |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 508 | # Set the minor version. |
| 509 | payload_gen.SetMinorVersion(0) |
| 510 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 511 | # Create the test object. |
| 512 | payload_checker = _GetPayloadChecker(payload_gen.WriteToFile) |
| 513 | report = checker._PayloadReport() |
| 514 | |
| 515 | should_fail = (fail_mismatched_block_size or fail_bad_sigs or |
| 516 | fail_mismatched_oki_ori or fail_bad_oki or fail_bad_ori or |
Gilad Arnold | 5bc7fbe | 2015-02-05 13:01:09 -0800 | [diff] [blame] | 517 | fail_bad_nki or fail_bad_nri or fail_old_kernel_fs_size or |
| 518 | fail_old_rootfs_fs_size or fail_new_kernel_fs_size or |
| 519 | fail_new_rootfs_fs_size) |
Tudor Brindus | 8d05a7e | 2018-06-14 11:18:18 -0700 | [diff] [blame] | 520 | part_sizes = { |
| 521 | common.ROOTFS: rootfs_part_size, |
| 522 | common.KERNEL: kernel_part_size |
| 523 | } |
| 524 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 525 | if should_fail: |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 526 | self.assertRaises(PayloadError, payload_checker._CheckManifest, report, |
Tudor Brindus | 8d05a7e | 2018-06-14 11:18:18 -0700 | [diff] [blame] | 527 | part_sizes) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 528 | else: |
Tudor Brindus | 8d05a7e | 2018-06-14 11:18:18 -0700 | [diff] [blame] | 529 | self.assertIsNone(payload_checker._CheckManifest(report, part_sizes)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 530 | |
| 531 | def testCheckLength(self): |
| 532 | """Tests _CheckLength().""" |
| 533 | payload_checker = checker.PayloadChecker(self.MockPayload()) |
| 534 | block_size = payload_checker.block_size |
| 535 | |
| 536 | # Passes. |
| 537 | self.assertIsNone(payload_checker._CheckLength( |
| 538 | int(3.5 * block_size), 4, 'foo', 'bar')) |
| 539 | # Fails, too few blocks. |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 540 | self.assertRaises(PayloadError, payload_checker._CheckLength, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 541 | int(3.5 * block_size), 3, 'foo', 'bar') |
| 542 | # Fails, too many blocks. |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 543 | self.assertRaises(PayloadError, payload_checker._CheckLength, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 544 | int(3.5 * block_size), 5, 'foo', 'bar') |
| 545 | |
| 546 | def testCheckExtents(self): |
| 547 | """Tests _CheckExtents().""" |
| 548 | payload_checker = checker.PayloadChecker(self.MockPayload()) |
| 549 | block_size = payload_checker.block_size |
| 550 | |
| 551 | # Passes w/ all real extents. |
| 552 | extents = self.NewExtentList((0, 4), (8, 3), (1024, 16)) |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 553 | self.assertEqual( |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 554 | 23, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 555 | payload_checker._CheckExtents(extents, (1024 + 16) * block_size, |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 556 | collections.defaultdict(int), 'foo')) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 557 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 558 | # Fails, extent missing a start block. |
| 559 | extents = self.NewExtentList((-1, 4), (8, 3), (1024, 16)) |
| 560 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 561 | PayloadError, payload_checker._CheckExtents, extents, |
| 562 | (1024 + 16) * block_size, collections.defaultdict(int), 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 563 | |
| 564 | # Fails, extent missing block count. |
| 565 | extents = self.NewExtentList((0, -1), (8, 3), (1024, 16)) |
| 566 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 567 | PayloadError, payload_checker._CheckExtents, extents, |
| 568 | (1024 + 16) * block_size, collections.defaultdict(int), 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 569 | |
| 570 | # Fails, extent has zero blocks. |
| 571 | extents = self.NewExtentList((0, 4), (8, 3), (1024, 0)) |
| 572 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 573 | PayloadError, payload_checker._CheckExtents, extents, |
| 574 | (1024 + 16) * block_size, collections.defaultdict(int), 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 575 | |
| 576 | # Fails, extent exceeds partition boundaries. |
| 577 | extents = self.NewExtentList((0, 4), (8, 3), (1024, 16)) |
| 578 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 579 | PayloadError, payload_checker._CheckExtents, extents, |
| 580 | (1024 + 15) * block_size, collections.defaultdict(int), 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 581 | |
| 582 | def testCheckReplaceOperation(self): |
| 583 | """Tests _CheckReplaceOperation() where op.type == REPLACE.""" |
| 584 | payload_checker = checker.PayloadChecker(self.MockPayload()) |
| 585 | block_size = payload_checker.block_size |
| 586 | data_length = 10000 |
| 587 | |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 588 | op = mock.create_autospec(update_metadata_pb2.InstallOperation) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 589 | op.type = common.OpType.REPLACE |
| 590 | |
| 591 | # Pass. |
| 592 | op.src_extents = [] |
| 593 | self.assertIsNone( |
| 594 | payload_checker._CheckReplaceOperation( |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 595 | op, data_length, (data_length + block_size - 1) // block_size, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 596 | 'foo')) |
| 597 | |
| 598 | # Fail, src extents founds. |
| 599 | op.src_extents = ['bar'] |
| 600 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 601 | PayloadError, payload_checker._CheckReplaceOperation, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 602 | op, data_length, (data_length + block_size - 1) // block_size, 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 603 | |
| 604 | # Fail, missing data. |
| 605 | op.src_extents = [] |
| 606 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 607 | PayloadError, payload_checker._CheckReplaceOperation, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 608 | op, None, (data_length + block_size - 1) // block_size, 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 609 | |
| 610 | # Fail, length / block number mismatch. |
| 611 | op.src_extents = ['bar'] |
| 612 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 613 | PayloadError, payload_checker._CheckReplaceOperation, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 614 | op, data_length, (data_length + block_size - 1) // block_size + 1, |
| 615 | 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 616 | |
| 617 | def testCheckReplaceBzOperation(self): |
| 618 | """Tests _CheckReplaceOperation() where op.type == REPLACE_BZ.""" |
| 619 | payload_checker = checker.PayloadChecker(self.MockPayload()) |
| 620 | block_size = payload_checker.block_size |
| 621 | data_length = block_size * 3 |
| 622 | |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 623 | op = mock.create_autospec( |
Alex Deymo | 2846677 | 2015-09-11 17:16:44 -0700 | [diff] [blame] | 624 | update_metadata_pb2.InstallOperation) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 625 | op.type = common.OpType.REPLACE_BZ |
| 626 | |
| 627 | # Pass. |
| 628 | op.src_extents = [] |
| 629 | self.assertIsNone( |
| 630 | payload_checker._CheckReplaceOperation( |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 631 | op, data_length, (data_length + block_size - 1) // block_size + 5, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 632 | 'foo')) |
| 633 | |
| 634 | # Fail, src extents founds. |
| 635 | op.src_extents = ['bar'] |
| 636 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 637 | PayloadError, payload_checker._CheckReplaceOperation, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 638 | op, data_length, (data_length + block_size - 1) // block_size + 5, |
| 639 | 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 640 | |
| 641 | # Fail, missing data. |
| 642 | op.src_extents = [] |
| 643 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 644 | PayloadError, payload_checker._CheckReplaceOperation, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 645 | op, None, (data_length + block_size - 1) // block_size, 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 646 | |
| 647 | # Fail, too few blocks to justify BZ. |
| 648 | op.src_extents = [] |
| 649 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 650 | PayloadError, payload_checker._CheckReplaceOperation, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 651 | op, data_length, (data_length + block_size - 1) // block_size, 'foo') |
| 652 | |
| 653 | # Fail, total_dst_blocks is a floating point value. |
| 654 | op.src_extents = [] |
| 655 | self.assertRaises( |
| 656 | PayloadError, payload_checker._CheckReplaceOperation, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 657 | op, data_length, (data_length + block_size - 1) / block_size, 'foo') |
| 658 | |
Amin Hassani | 0de7f78 | 2017-12-07 12:13:03 -0800 | [diff] [blame] | 659 | def testCheckReplaceXzOperation(self): |
| 660 | """Tests _CheckReplaceOperation() where op.type == REPLACE_XZ.""" |
| 661 | payload_checker = checker.PayloadChecker(self.MockPayload()) |
| 662 | block_size = payload_checker.block_size |
| 663 | data_length = block_size * 3 |
| 664 | |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 665 | op = mock.create_autospec( |
Amin Hassani | 0de7f78 | 2017-12-07 12:13:03 -0800 | [diff] [blame] | 666 | update_metadata_pb2.InstallOperation) |
| 667 | op.type = common.OpType.REPLACE_XZ |
| 668 | |
| 669 | # Pass. |
| 670 | op.src_extents = [] |
| 671 | self.assertIsNone( |
| 672 | payload_checker._CheckReplaceOperation( |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 673 | op, data_length, (data_length + block_size - 1) // block_size + 5, |
Amin Hassani | 0de7f78 | 2017-12-07 12:13:03 -0800 | [diff] [blame] | 674 | 'foo')) |
| 675 | |
| 676 | # Fail, src extents founds. |
| 677 | op.src_extents = ['bar'] |
| 678 | self.assertRaises( |
| 679 | PayloadError, payload_checker._CheckReplaceOperation, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 680 | op, data_length, (data_length + block_size - 1) // block_size + 5, |
| 681 | 'foo') |
Amin Hassani | 0de7f78 | 2017-12-07 12:13:03 -0800 | [diff] [blame] | 682 | |
| 683 | # Fail, missing data. |
| 684 | op.src_extents = [] |
| 685 | self.assertRaises( |
| 686 | PayloadError, payload_checker._CheckReplaceOperation, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 687 | op, None, (data_length + block_size - 1) // block_size, 'foo') |
Amin Hassani | 0de7f78 | 2017-12-07 12:13:03 -0800 | [diff] [blame] | 688 | |
| 689 | # Fail, too few blocks to justify XZ. |
| 690 | op.src_extents = [] |
| 691 | self.assertRaises( |
| 692 | PayloadError, payload_checker._CheckReplaceOperation, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 693 | op, data_length, (data_length + block_size - 1) // block_size, 'foo') |
| 694 | |
| 695 | # Fail, total_dst_blocks is a floating point value. |
| 696 | op.src_extents = [] |
| 697 | self.assertRaises( |
| 698 | PayloadError, payload_checker._CheckReplaceOperation, |
Amin Hassani | 0de7f78 | 2017-12-07 12:13:03 -0800 | [diff] [blame] | 699 | op, data_length, (data_length + block_size - 1) / block_size, 'foo') |
| 700 | |
Sen Jiang | 92161a7 | 2016-06-28 16:09:38 -0700 | [diff] [blame] | 701 | def testCheckAnyDiff(self): |
| 702 | """Tests _CheckAnyDiffOperation().""" |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 703 | payload_checker = checker.PayloadChecker(self.MockPayload()) |
Amin Hassani | efa62d9 | 2017-11-09 13:46:56 -0800 | [diff] [blame] | 704 | op = update_metadata_pb2.InstallOperation() |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 705 | |
| 706 | # Pass. |
| 707 | self.assertIsNone( |
Amin Hassani | efa62d9 | 2017-11-09 13:46:56 -0800 | [diff] [blame] | 708 | payload_checker._CheckAnyDiffOperation(op, 10000, 3, 'foo')) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 709 | |
| 710 | # Fail, missing data blob. |
| 711 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 712 | PayloadError, payload_checker._CheckAnyDiffOperation, |
Amin Hassani | efa62d9 | 2017-11-09 13:46:56 -0800 | [diff] [blame] | 713 | op, None, 3, 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 714 | |
| 715 | # Fail, too big of a diff blob (unjustified). |
| 716 | self.assertRaises( |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 717 | PayloadError, payload_checker._CheckAnyDiffOperation, |
Amin Hassani | efa62d9 | 2017-11-09 13:46:56 -0800 | [diff] [blame] | 718 | op, 10000, 2, 'foo') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 719 | |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 720 | def testCheckSourceCopyOperation_Pass(self): |
| 721 | """Tests _CheckSourceCopyOperation(); pass case.""" |
| 722 | payload_checker = checker.PayloadChecker(self.MockPayload()) |
| 723 | self.assertIsNone( |
| 724 | payload_checker._CheckSourceCopyOperation(None, 134, 134, 'foo')) |
| 725 | |
| 726 | def testCheckSourceCopyOperation_FailContainsData(self): |
| 727 | """Tests _CheckSourceCopyOperation(); message contains data.""" |
| 728 | payload_checker = checker.PayloadChecker(self.MockPayload()) |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 729 | self.assertRaises(PayloadError, payload_checker._CheckSourceCopyOperation, |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 730 | 134, 0, 0, 'foo') |
| 731 | |
| 732 | def testCheckSourceCopyOperation_FailBlockCountsMismatch(self): |
| 733 | """Tests _CheckSourceCopyOperation(); src and dst block totals not equal.""" |
| 734 | payload_checker = checker.PayloadChecker(self.MockPayload()) |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 735 | self.assertRaises(PayloadError, payload_checker._CheckSourceCopyOperation, |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 736 | None, 0, 1, 'foo') |
| 737 | |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 738 | def DoCheckOperationTest(self, op_type_name, allow_unhashed, |
| 739 | fail_src_extents, fail_dst_extents, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 740 | fail_mismatched_data_offset_length, |
| 741 | fail_missing_dst_extents, fail_src_length, |
| 742 | fail_dst_length, fail_data_hash, |
Allie Wood | 7cf9f13 | 2015-02-26 14:28:19 -0800 | [diff] [blame] | 743 | fail_prev_data_offset, fail_bad_minor_version): |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 744 | """Parametric testing of _CheckOperation(). |
| 745 | |
| 746 | Args: |
Amin Hassani | 0f59a9a | 2019-09-27 10:24:31 -0700 | [diff] [blame] | 747 | op_type_name: 'REPLACE', 'REPLACE_BZ', 'REPLACE_XZ', |
Amin Hassani | 0de7f78 | 2017-12-07 12:13:03 -0800 | [diff] [blame] | 748 | 'SOURCE_COPY', 'SOURCE_BSDIFF', BROTLI_BSDIFF or 'PUFFDIFF'. |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 749 | allow_unhashed: Whether we're allowing to not hash the data. |
| 750 | fail_src_extents: Tamper with src extents. |
| 751 | fail_dst_extents: Tamper with dst extents. |
| 752 | fail_mismatched_data_offset_length: Make data_{offset,length} |
| 753 | inconsistent. |
| 754 | fail_missing_dst_extents: Do not include dst extents. |
| 755 | fail_src_length: Make src length inconsistent. |
| 756 | fail_dst_length: Make dst length inconsistent. |
| 757 | fail_data_hash: Tamper with the data blob hash. |
| 758 | fail_prev_data_offset: Make data space uses incontiguous. |
Allie Wood | 7cf9f13 | 2015-02-26 14:28:19 -0800 | [diff] [blame] | 759 | fail_bad_minor_version: Make minor version incompatible with op. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 760 | """ |
| 761 | op_type = _OpTypeByName(op_type_name) |
| 762 | |
| 763 | # Create the test object. |
| 764 | payload = self.MockPayload() |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 765 | payload_checker = checker.PayloadChecker(payload, |
| 766 | allow_unhashed=allow_unhashed) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 767 | block_size = payload_checker.block_size |
| 768 | |
| 769 | # Create auxiliary arguments. |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 770 | old_part_size = test_utils.MiB(4) |
| 771 | new_part_size = test_utils.MiB(8) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 772 | old_block_counters = array.array( |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 773 | 'B', [0] * ((old_part_size + block_size - 1) // block_size)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 774 | new_block_counters = array.array( |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 775 | 'B', [0] * ((new_part_size + block_size - 1) // block_size)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 776 | prev_data_offset = 1876 |
| 777 | blob_hash_counts = collections.defaultdict(int) |
| 778 | |
| 779 | # Create the operation object for the test. |
Alex Deymo | 2846677 | 2015-09-11 17:16:44 -0700 | [diff] [blame] | 780 | op = update_metadata_pb2.InstallOperation() |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 781 | op.type = op_type |
| 782 | |
| 783 | total_src_blocks = 0 |
Amin Hassani | 0f59a9a | 2019-09-27 10:24:31 -0700 | [diff] [blame] | 784 | if op_type in (common.OpType.SOURCE_COPY, common.OpType.SOURCE_BSDIFF, |
Amin Hassani | efa62d9 | 2017-11-09 13:46:56 -0800 | [diff] [blame] | 785 | common.OpType.PUFFDIFF, common.OpType.BROTLI_BSDIFF): |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 786 | if fail_src_extents: |
| 787 | self.AddToMessage(op.src_extents, |
Allie Wood | b065e13 | 2015-04-24 10:20:27 -0700 | [diff] [blame] | 788 | self.NewExtentList((1, 0))) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 789 | else: |
| 790 | self.AddToMessage(op.src_extents, |
Allie Wood | b065e13 | 2015-04-24 10:20:27 -0700 | [diff] [blame] | 791 | self.NewExtentList((1, 16))) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 792 | total_src_blocks = 16 |
| 793 | |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 794 | payload_checker.major_version = common.BRILLO_MAJOR_PAYLOAD_VERSION |
Allie Wood | 7cf9f13 | 2015-02-26 14:28:19 -0800 | [diff] [blame] | 795 | if op_type in (common.OpType.REPLACE, common.OpType.REPLACE_BZ): |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 796 | payload_checker.minor_version = 0 |
Allie Wood | 7cf9f13 | 2015-02-26 14:28:19 -0800 | [diff] [blame] | 797 | elif op_type in (common.OpType.SOURCE_COPY, common.OpType.SOURCE_BSDIFF): |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 798 | payload_checker.minor_version = 1 if fail_bad_minor_version else 2 |
Amin Hassani | 0de7f78 | 2017-12-07 12:13:03 -0800 | [diff] [blame] | 799 | if op_type == common.OpType.REPLACE_XZ: |
| 800 | payload_checker.minor_version = 2 if fail_bad_minor_version else 3 |
Amin Hassani | cdeb6e6 | 2017-10-11 10:15:11 -0700 | [diff] [blame] | 801 | elif op_type in (common.OpType.ZERO, common.OpType.DISCARD, |
Amin Hassani | 77d7cbc | 2018-02-07 16:21:33 -0800 | [diff] [blame] | 802 | common.OpType.BROTLI_BSDIFF): |
Amin Hassani | 8ad22ba | 2017-10-11 10:15:11 -0700 | [diff] [blame] | 803 | payload_checker.minor_version = 3 if fail_bad_minor_version else 4 |
Amin Hassani | 77d7cbc | 2018-02-07 16:21:33 -0800 | [diff] [blame] | 804 | elif op_type == common.OpType.PUFFDIFF: |
| 805 | payload_checker.minor_version = 4 if fail_bad_minor_version else 5 |
Allie Wood | 7cf9f13 | 2015-02-26 14:28:19 -0800 | [diff] [blame] | 806 | |
Amin Hassani | 0f59a9a | 2019-09-27 10:24:31 -0700 | [diff] [blame] | 807 | if op_type != common.OpType.SOURCE_COPY: |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 808 | if not fail_mismatched_data_offset_length: |
| 809 | op.data_length = 16 * block_size - 8 |
| 810 | if fail_prev_data_offset: |
| 811 | op.data_offset = prev_data_offset + 16 |
| 812 | else: |
| 813 | op.data_offset = prev_data_offset |
| 814 | |
| 815 | fake_data = 'fake-data'.ljust(op.data_length) |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 816 | if not allow_unhashed and not fail_data_hash: |
| 817 | # Create a valid data blob hash. |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 818 | op.data_sha256_hash = hashlib.sha256(fake_data.encode('utf-8')).digest() |
| 819 | payload.ReadDataBlob.return_value = fake_data.encode('utf-8') |
Amin Hassani | efa62d9 | 2017-11-09 13:46:56 -0800 | [diff] [blame] | 820 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 821 | elif fail_data_hash: |
| 822 | # Create an invalid data blob hash. |
| 823 | op.data_sha256_hash = hashlib.sha256( |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 824 | fake_data.replace(' ', '-').encode('utf-8')).digest() |
| 825 | payload.ReadDataBlob.return_value = fake_data.encode('utf-8') |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 826 | |
| 827 | total_dst_blocks = 0 |
| 828 | if not fail_missing_dst_extents: |
| 829 | total_dst_blocks = 16 |
| 830 | if fail_dst_extents: |
| 831 | self.AddToMessage(op.dst_extents, |
| 832 | self.NewExtentList((4, 16), (32, 0))) |
| 833 | else: |
| 834 | self.AddToMessage(op.dst_extents, |
| 835 | self.NewExtentList((4, 8), (64, 8))) |
| 836 | |
| 837 | if total_src_blocks: |
| 838 | if fail_src_length: |
| 839 | op.src_length = total_src_blocks * block_size + 8 |
Amin Hassani | 0f59a9a | 2019-09-27 10:24:31 -0700 | [diff] [blame] | 840 | elif (op_type == common.OpType.SOURCE_BSDIFF and |
Amin Hassani | efa62d9 | 2017-11-09 13:46:56 -0800 | [diff] [blame] | 841 | payload_checker.minor_version <= 3): |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 842 | op.src_length = total_src_blocks * block_size |
| 843 | elif fail_src_length: |
| 844 | # Add an orphaned src_length. |
| 845 | op.src_length = 16 |
| 846 | |
| 847 | if total_dst_blocks: |
| 848 | if fail_dst_length: |
| 849 | op.dst_length = total_dst_blocks * block_size + 8 |
Amin Hassani | 0f59a9a | 2019-09-27 10:24:31 -0700 | [diff] [blame] | 850 | elif (op_type == common.OpType.SOURCE_BSDIFF and |
Amin Hassani | efa62d9 | 2017-11-09 13:46:56 -0800 | [diff] [blame] | 851 | payload_checker.minor_version <= 3): |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 852 | op.dst_length = total_dst_blocks * block_size |
| 853 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 854 | should_fail = (fail_src_extents or fail_dst_extents or |
| 855 | fail_mismatched_data_offset_length or |
| 856 | fail_missing_dst_extents or fail_src_length or |
Allie Wood | 7cf9f13 | 2015-02-26 14:28:19 -0800 | [diff] [blame] | 857 | fail_dst_length or fail_data_hash or fail_prev_data_offset or |
| 858 | fail_bad_minor_version) |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 859 | args = (op, 'foo', old_block_counters, new_block_counters, |
| 860 | old_part_size, new_part_size, prev_data_offset, |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 861 | blob_hash_counts) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 862 | if should_fail: |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 863 | self.assertRaises(PayloadError, payload_checker._CheckOperation, *args) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 864 | else: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 865 | self.assertEqual(op.data_length if op.HasField('data_length') else 0, |
| 866 | payload_checker._CheckOperation(*args)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 867 | |
| 868 | def testAllocBlockCounters(self): |
| 869 | """Tests _CheckMoveOperation().""" |
| 870 | payload_checker = checker.PayloadChecker(self.MockPayload()) |
| 871 | block_size = payload_checker.block_size |
| 872 | |
| 873 | # Check allocation for block-aligned partition size, ensure it's integers. |
| 874 | result = payload_checker._AllocBlockCounters(16 * block_size) |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 875 | self.assertEqual(16, len(result)) |
| 876 | self.assertEqual(int, type(result[0])) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 877 | |
| 878 | # Check allocation of unaligned partition sizes. |
| 879 | result = payload_checker._AllocBlockCounters(16 * block_size - 1) |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 880 | self.assertEqual(16, len(result)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 881 | result = payload_checker._AllocBlockCounters(16 * block_size + 1) |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 882 | self.assertEqual(17, len(result)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 883 | |
Allie Wood | fb04d30 | 2015-04-03 14:25:48 -0700 | [diff] [blame] | 884 | def DoCheckOperationsTest(self, fail_nonexhaustive_full_update): |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 885 | """Tests _CheckOperations().""" |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 886 | # Generate a test payload. For this test, we only care about one |
| 887 | # (arbitrary) set of operations, so we'll only be generating kernel and |
| 888 | # test with them. |
| 889 | payload_gen = test_utils.PayloadGenerator() |
| 890 | |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 891 | block_size = test_utils.KiB(4) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 892 | payload_gen.SetBlockSize(block_size) |
| 893 | |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 894 | rootfs_part_size = test_utils.MiB(8) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 895 | |
| 896 | # Fake rootfs operations in a full update, tampered with as required. |
| 897 | rootfs_op_type = common.OpType.REPLACE |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 898 | rootfs_data_length = rootfs_part_size |
| 899 | if fail_nonexhaustive_full_update: |
| 900 | rootfs_data_length -= block_size |
| 901 | |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 902 | payload_gen.AddOperation(common.ROOTFS, rootfs_op_type, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 903 | dst_extents= |
| 904 | [(0, rootfs_data_length // block_size)], |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 905 | data_offset=0, |
| 906 | data_length=rootfs_data_length) |
| 907 | |
| 908 | # Create the test object. |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 909 | payload_checker = _GetPayloadChecker(payload_gen.WriteToFile, |
| 910 | checker_init_dargs={ |
| 911 | 'allow_unhashed': True}) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 912 | payload_checker.payload_type = checker._TYPE_FULL |
| 913 | report = checker._PayloadReport() |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 914 | partition = next((p for p in payload_checker.payload.manifest.partitions |
| 915 | if p.partition_name == common.ROOTFS), None) |
| 916 | args = (partition.operations, report, 'foo', |
| 917 | 0, rootfs_part_size, rootfs_part_size, rootfs_part_size, 0) |
Allie Wood | fb04d30 | 2015-04-03 14:25:48 -0700 | [diff] [blame] | 918 | if fail_nonexhaustive_full_update: |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 919 | self.assertRaises(PayloadError, payload_checker._CheckOperations, *args) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 920 | else: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 921 | self.assertEqual(rootfs_data_length, |
| 922 | payload_checker._CheckOperations(*args)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 923 | |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 924 | def DoCheckSignaturesTest(self, fail_empty_sigs_blob, fail_sig_missing_fields, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 925 | fail_unknown_sig_version, fail_incorrect_sig): |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 926 | """Tests _CheckSignatures().""" |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 927 | # Generate a test payload. For this test, we only care about the signature |
| 928 | # block and how it relates to the payload hash. Therefore, we're generating |
| 929 | # a random (otherwise useless) payload for this purpose. |
| 930 | payload_gen = test_utils.EnhancedPayloadGenerator() |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 931 | block_size = test_utils.KiB(4) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 932 | payload_gen.SetBlockSize(block_size) |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 933 | rootfs_part_size = test_utils.MiB(2) |
| 934 | kernel_part_size = test_utils.KiB(16) |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 935 | payload_gen.SetPartInfo(common.ROOTFS, True, rootfs_part_size, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 936 | hashlib.sha256(b'fake-new-rootfs-content').digest()) |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 937 | payload_gen.SetPartInfo(common.KERNEL, True, kernel_part_size, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 938 | hashlib.sha256(b'fake-new-kernel-content').digest()) |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 939 | payload_gen.SetMinorVersion(0) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 940 | payload_gen.AddOperationWithData( |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 941 | common.ROOTFS, common.OpType.REPLACE, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 942 | dst_extents=[(0, rootfs_part_size // block_size)], |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 943 | data_blob=os.urandom(rootfs_part_size)) |
| 944 | |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 945 | do_forge_sigs_data = (fail_empty_sigs_blob or fail_sig_missing_fields or |
| 946 | fail_unknown_sig_version or fail_incorrect_sig) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 947 | |
| 948 | sigs_data = None |
| 949 | if do_forge_sigs_data: |
| 950 | sigs_gen = test_utils.SignaturesGenerator() |
| 951 | if not fail_empty_sigs_blob: |
| 952 | if fail_sig_missing_fields: |
| 953 | sig_data = None |
| 954 | else: |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 955 | sig_data = test_utils.SignSha256(b'fake-payload-content', |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 956 | test_utils._PRIVKEY_FILE_NAME) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 957 | sigs_gen.AddSig(5 if fail_unknown_sig_version else 1, sig_data) |
| 958 | |
| 959 | sigs_data = sigs_gen.ToBinary() |
| 960 | payload_gen.SetSignatures(payload_gen.curr_offset, len(sigs_data)) |
| 961 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 962 | # Generate payload (complete w/ signature) and create the test object. |
| 963 | payload_checker = _GetPayloadChecker( |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 964 | payload_gen.WriteToFileWithData, |
| 965 | payload_gen_dargs={ |
| 966 | 'sigs_data': sigs_data, |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 967 | 'privkey_file_name': test_utils._PRIVKEY_FILE_NAME}) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 968 | payload_checker.payload_type = checker._TYPE_FULL |
| 969 | report = checker._PayloadReport() |
| 970 | |
| 971 | # We have to check the manifest first in order to set signature attributes. |
Tudor Brindus | 8d05a7e | 2018-06-14 11:18:18 -0700 | [diff] [blame] | 972 | payload_checker._CheckManifest(report, { |
| 973 | common.ROOTFS: rootfs_part_size, |
| 974 | common.KERNEL: kernel_part_size |
| 975 | }) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 976 | |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 977 | should_fail = (fail_empty_sigs_blob or fail_sig_missing_fields or |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 978 | fail_unknown_sig_version or fail_incorrect_sig) |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 979 | args = (report, test_utils._PUBKEY_FILE_NAME) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 980 | if should_fail: |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 981 | self.assertRaises(PayloadError, payload_checker._CheckSignatures, *args) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 982 | else: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 983 | self.assertIsNone(payload_checker._CheckSignatures(*args)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 984 | |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 985 | def DoCheckManifestMinorVersionTest(self, minor_version, payload_type): |
| 986 | """Parametric testing for CheckManifestMinorVersion(). |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 987 | |
| 988 | Args: |
| 989 | minor_version: The payload minor version to test with. |
| 990 | payload_type: The type of the payload we're testing, delta or full. |
| 991 | """ |
| 992 | # Create the test object. |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 993 | payload = self.MockPayload() |
| 994 | payload.manifest.minor_version = minor_version |
| 995 | payload_checker = checker.PayloadChecker(payload) |
| 996 | payload_checker.payload_type = payload_type |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 997 | report = checker._PayloadReport() |
| 998 | |
| 999 | should_succeed = ( |
| 1000 | (minor_version == 0 and payload_type == checker._TYPE_FULL) or |
Sen Jiang | 912c4df | 2015-12-10 12:17:13 -0800 | [diff] [blame] | 1001 | (minor_version == 2 and payload_type == checker._TYPE_DELTA) or |
Sen Jiang | 92161a7 | 2016-06-28 16:09:38 -0700 | [diff] [blame] | 1002 | (minor_version == 3 and payload_type == checker._TYPE_DELTA) or |
Amin Hassani | 77d7cbc | 2018-02-07 16:21:33 -0800 | [diff] [blame] | 1003 | (minor_version == 4 and payload_type == checker._TYPE_DELTA) or |
| 1004 | (minor_version == 5 and payload_type == checker._TYPE_DELTA)) |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 1005 | args = (report,) |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 1006 | |
| 1007 | if should_succeed: |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 1008 | self.assertIsNone(payload_checker._CheckManifestMinorVersion(*args)) |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 1009 | else: |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 1010 | self.assertRaises(PayloadError, |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 1011 | payload_checker._CheckManifestMinorVersion, *args) |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 1012 | |
Gilad Arnold | 06eea33 | 2015-07-13 18:06:33 -0700 | [diff] [blame] | 1013 | def DoRunTest(self, rootfs_part_size_provided, kernel_part_size_provided, |
| 1014 | fail_wrong_payload_type, fail_invalid_block_size, |
Amin Hassani | a86b108 | 2018-03-08 15:48:59 -0800 | [diff] [blame] | 1015 | fail_mismatched_metadata_size, fail_mismatched_block_size, |
| 1016 | fail_excess_data, fail_rootfs_part_size_exceeded, |
Gilad Arnold | 06eea33 | 2015-07-13 18:06:33 -0700 | [diff] [blame] | 1017 | fail_kernel_part_size_exceeded): |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 1018 | """Tests Run().""" |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1019 | # Generate a test payload. For this test, we generate a full update that |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 1020 | # has sample kernel and rootfs operations. Since most testing is done with |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1021 | # internal PayloadChecker methods that are tested elsewhere, here we only |
| 1022 | # tamper with what's actually being manipulated and/or tested in the Run() |
| 1023 | # method itself. Note that the checker doesn't verify partition hashes, so |
| 1024 | # they're safe to fake. |
| 1025 | payload_gen = test_utils.EnhancedPayloadGenerator() |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 1026 | block_size = test_utils.KiB(4) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1027 | payload_gen.SetBlockSize(block_size) |
Gilad Arnold | 06eea33 | 2015-07-13 18:06:33 -0700 | [diff] [blame] | 1028 | kernel_filesystem_size = test_utils.KiB(16) |
| 1029 | rootfs_filesystem_size = test_utils.MiB(2) |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 1030 | payload_gen.SetPartInfo(common.ROOTFS, True, rootfs_filesystem_size, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 1031 | hashlib.sha256(b'fake-new-rootfs-content').digest()) |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 1032 | payload_gen.SetPartInfo(common.KERNEL, True, kernel_filesystem_size, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 1033 | hashlib.sha256(b'fake-new-kernel-content').digest()) |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 1034 | payload_gen.SetMinorVersion(0) |
Gilad Arnold | 06eea33 | 2015-07-13 18:06:33 -0700 | [diff] [blame] | 1035 | |
| 1036 | rootfs_part_size = 0 |
| 1037 | if rootfs_part_size_provided: |
| 1038 | rootfs_part_size = rootfs_filesystem_size + block_size |
| 1039 | rootfs_op_size = rootfs_part_size or rootfs_filesystem_size |
| 1040 | if fail_rootfs_part_size_exceeded: |
| 1041 | rootfs_op_size += block_size |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1042 | payload_gen.AddOperationWithData( |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 1043 | common.ROOTFS, common.OpType.REPLACE, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 1044 | dst_extents=[(0, rootfs_op_size // block_size)], |
Gilad Arnold | 06eea33 | 2015-07-13 18:06:33 -0700 | [diff] [blame] | 1045 | data_blob=os.urandom(rootfs_op_size)) |
| 1046 | |
| 1047 | kernel_part_size = 0 |
| 1048 | if kernel_part_size_provided: |
| 1049 | kernel_part_size = kernel_filesystem_size + block_size |
| 1050 | kernel_op_size = kernel_part_size or kernel_filesystem_size |
| 1051 | if fail_kernel_part_size_exceeded: |
| 1052 | kernel_op_size += block_size |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1053 | payload_gen.AddOperationWithData( |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 1054 | common.KERNEL, common.OpType.REPLACE, |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 1055 | dst_extents=[(0, kernel_op_size // block_size)], |
Gilad Arnold | 06eea33 | 2015-07-13 18:06:33 -0700 | [diff] [blame] | 1056 | data_blob=os.urandom(kernel_op_size)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1057 | |
| 1058 | # Generate payload (complete w/ signature) and create the test object. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1059 | if fail_invalid_block_size: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 1060 | use_block_size = block_size + 5 # Not a power of two. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1061 | elif fail_mismatched_block_size: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 1062 | use_block_size = block_size * 2 # Different that payload stated. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1063 | else: |
| 1064 | use_block_size = block_size |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1065 | |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 1066 | # For the unittests 237 is the value that generated for the payload. |
| 1067 | metadata_size = 237 |
Amin Hassani | a86b108 | 2018-03-08 15:48:59 -0800 | [diff] [blame] | 1068 | if fail_mismatched_metadata_size: |
| 1069 | metadata_size += 1 |
| 1070 | |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 1071 | kwargs = { |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 1072 | 'payload_gen_dargs': { |
Gilad Arnold | 18f4f9f | 2013-04-02 16:24:41 -0700 | [diff] [blame] | 1073 | 'privkey_file_name': test_utils._PRIVKEY_FILE_NAME, |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 1074 | 'padding': os.urandom(1024) if fail_excess_data else None}, |
| 1075 | 'checker_init_dargs': { |
| 1076 | 'assert_type': 'delta' if fail_wrong_payload_type else 'full', |
| 1077 | 'block_size': use_block_size}} |
| 1078 | if fail_invalid_block_size: |
Amin Hassani | b05a65a | 2017-12-18 15:15:32 -0800 | [diff] [blame] | 1079 | self.assertRaises(PayloadError, _GetPayloadChecker, |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 1080 | payload_gen.WriteToFileWithData, **kwargs) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1081 | else: |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 1082 | payload_checker = _GetPayloadChecker(payload_gen.WriteToFileWithData, |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 1083 | **kwargs) |
Gilad Arnold | 06eea33 | 2015-07-13 18:06:33 -0700 | [diff] [blame] | 1084 | |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 1085 | kwargs2 = { |
Tudor Brindus | 2d22c1a | 2018-06-15 13:07:13 -0700 | [diff] [blame] | 1086 | 'pubkey_file_name': test_utils._PUBKEY_FILE_NAME, |
| 1087 | 'metadata_size': metadata_size, |
| 1088 | 'part_sizes': { |
| 1089 | common.KERNEL: kernel_part_size, |
| 1090 | common.ROOTFS: rootfs_part_size}} |
| 1091 | |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 1092 | should_fail = (fail_wrong_payload_type or fail_mismatched_block_size or |
Amin Hassani | a86b108 | 2018-03-08 15:48:59 -0800 | [diff] [blame] | 1093 | fail_mismatched_metadata_size or fail_excess_data or |
Gilad Arnold | 06eea33 | 2015-07-13 18:06:33 -0700 | [diff] [blame] | 1094 | fail_rootfs_part_size_exceeded or |
| 1095 | fail_kernel_part_size_exceeded) |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 1096 | if should_fail: |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 1097 | self.assertRaises(PayloadError, payload_checker.Run, **kwargs2) |
Gilad Arnold | eaed0d1 | 2013-04-30 15:38:22 -0700 | [diff] [blame] | 1098 | else: |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 1099 | self.assertIsNone(payload_checker.Run(**kwargs2)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1100 | |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 1101 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1102 | # This implements a generic API, hence the occasional unused args. |
| 1103 | # pylint: disable=W0613 |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 1104 | def ValidateCheckOperationTest(op_type_name, allow_unhashed, |
| 1105 | fail_src_extents, fail_dst_extents, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1106 | fail_mismatched_data_offset_length, |
| 1107 | fail_missing_dst_extents, fail_src_length, |
| 1108 | fail_dst_length, fail_data_hash, |
Allie Wood | 7cf9f13 | 2015-02-26 14:28:19 -0800 | [diff] [blame] | 1109 | fail_prev_data_offset, fail_bad_minor_version): |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1110 | """Returns True iff the combination of arguments represents a valid test.""" |
| 1111 | op_type = _OpTypeByName(op_type_name) |
| 1112 | |
Amin Hassani | 0de7f78 | 2017-12-07 12:13:03 -0800 | [diff] [blame] | 1113 | # REPLACE/REPLACE_BZ/REPLACE_XZ operations don't read data from src |
| 1114 | # partition. They are compatible with all valid minor versions, so we don't |
| 1115 | # need to check that. |
| 1116 | if (op_type in (common.OpType.REPLACE, common.OpType.REPLACE_BZ, |
| 1117 | common.OpType.REPLACE_XZ) and (fail_src_extents or |
| 1118 | fail_src_length or |
| 1119 | fail_bad_minor_version)): |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1120 | return False |
| 1121 | |
Amin Hassani | 0f59a9a | 2019-09-27 10:24:31 -0700 | [diff] [blame] | 1122 | # SOURCE_COPY operation does not carry data. |
| 1123 | if (op_type == common.OpType.SOURCE_COPY and ( |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1124 | fail_mismatched_data_offset_length or fail_data_hash or |
| 1125 | fail_prev_data_offset)): |
| 1126 | return False |
| 1127 | |
| 1128 | return True |
| 1129 | |
| 1130 | |
| 1131 | def TestMethodBody(run_method_name, run_dargs): |
| 1132 | """Returns a function that invokes a named method with named arguments.""" |
| 1133 | return lambda self: getattr(self, run_method_name)(**run_dargs) |
| 1134 | |
| 1135 | |
| 1136 | def AddParametricTests(tested_method_name, arg_space, validate_func=None): |
| 1137 | """Enumerates and adds specific parametric tests to PayloadCheckerTest. |
| 1138 | |
| 1139 | This function enumerates a space of test parameters (defined by arg_space), |
| 1140 | then binds a new, unique method name in PayloadCheckerTest to a test function |
| 1141 | that gets handed the said parameters. This is a preferable approach to doing |
| 1142 | the enumeration and invocation during the tests because this way each test is |
| 1143 | treated as a complete run by the unittest framework, and so benefits from the |
| 1144 | usual setUp/tearDown mechanics. |
| 1145 | |
| 1146 | Args: |
Gilad Arnold | cb63891 | 2013-06-24 04:57:11 -0700 | [diff] [blame] | 1147 | tested_method_name: Name of the tested PayloadChecker method. |
| 1148 | arg_space: A dictionary containing variables (keys) and lists of values |
| 1149 | (values) associated with them. |
| 1150 | validate_func: A function used for validating test argument combinations. |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1151 | """ |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 1152 | for value_tuple in itertools.product(*iter(arg_space.values())): |
| 1153 | run_dargs = dict(zip(iter(arg_space.keys()), value_tuple)) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1154 | if validate_func and not validate_func(**run_dargs): |
| 1155 | continue |
| 1156 | run_method_name = 'Do%sTest' % tested_method_name |
| 1157 | test_method_name = 'test%s' % tested_method_name |
Andrew Lassalle | 165843c | 2019-11-05 13:30:34 -0800 | [diff] [blame] | 1158 | for arg_key, arg_val in run_dargs.items(): |
Amin Hassani | 55c7541 | 2019-10-07 11:20:39 -0700 | [diff] [blame] | 1159 | if arg_val or isinstance(arg_val, int): |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1160 | test_method_name += '__%s=%s' % (arg_key, arg_val) |
| 1161 | setattr(PayloadCheckerTest, test_method_name, |
| 1162 | TestMethodBody(run_method_name, run_dargs)) |
| 1163 | |
| 1164 | |
| 1165 | def AddAllParametricTests(): |
| 1166 | """Enumerates and adds all parametric tests to PayloadCheckerTest.""" |
| 1167 | # Add all _CheckElem() test cases. |
| 1168 | AddParametricTests('AddElem', |
| 1169 | {'linebreak': (True, False), |
| 1170 | 'indent': (0, 1, 2), |
| 1171 | 'convert': (str, lambda s: s[::-1]), |
| 1172 | 'is_present': (True, False), |
| 1173 | 'is_mandatory': (True, False), |
| 1174 | 'is_submsg': (True, False)}) |
| 1175 | |
| 1176 | # Add all _Add{Mandatory,Optional}Field tests. |
| 1177 | AddParametricTests('AddField', |
| 1178 | {'is_mandatory': (True, False), |
| 1179 | 'linebreak': (True, False), |
| 1180 | 'indent': (0, 1, 2), |
| 1181 | 'convert': (str, lambda s: s[::-1]), |
| 1182 | 'is_present': (True, False)}) |
| 1183 | |
| 1184 | # Add all _Add{Mandatory,Optional}SubMsg tests. |
| 1185 | AddParametricTests('AddSubMsg', |
| 1186 | {'is_mandatory': (True, False), |
| 1187 | 'is_present': (True, False)}) |
| 1188 | |
| 1189 | # Add all _CheckManifest() test cases. |
| 1190 | AddParametricTests('CheckManifest', |
| 1191 | {'fail_mismatched_block_size': (True, False), |
| 1192 | 'fail_bad_sigs': (True, False), |
| 1193 | 'fail_mismatched_oki_ori': (True, False), |
| 1194 | 'fail_bad_oki': (True, False), |
| 1195 | 'fail_bad_ori': (True, False), |
| 1196 | 'fail_bad_nki': (True, False), |
| 1197 | 'fail_bad_nri': (True, False), |
Gilad Arnold | 382df5c | 2013-05-03 12:49:28 -0700 | [diff] [blame] | 1198 | 'fail_old_kernel_fs_size': (True, False), |
| 1199 | 'fail_old_rootfs_fs_size': (True, False), |
| 1200 | 'fail_new_kernel_fs_size': (True, False), |
| 1201 | 'fail_new_rootfs_fs_size': (True, False)}) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1202 | |
| 1203 | # Add all _CheckOperation() test cases. |
| 1204 | AddParametricTests('CheckOperation', |
Amin Hassani | 0de7f78 | 2017-12-07 12:13:03 -0800 | [diff] [blame] | 1205 | {'op_type_name': ('REPLACE', 'REPLACE_BZ', 'REPLACE_XZ', |
Amin Hassani | 0f59a9a | 2019-09-27 10:24:31 -0700 | [diff] [blame] | 1206 | 'SOURCE_COPY', 'SOURCE_BSDIFF', |
| 1207 | 'PUFFDIFF', 'BROTLI_BSDIFF'), |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1208 | 'allow_unhashed': (True, False), |
| 1209 | 'fail_src_extents': (True, False), |
| 1210 | 'fail_dst_extents': (True, False), |
| 1211 | 'fail_mismatched_data_offset_length': (True, False), |
| 1212 | 'fail_missing_dst_extents': (True, False), |
| 1213 | 'fail_src_length': (True, False), |
| 1214 | 'fail_dst_length': (True, False), |
| 1215 | 'fail_data_hash': (True, False), |
Allie Wood | 7cf9f13 | 2015-02-26 14:28:19 -0800 | [diff] [blame] | 1216 | 'fail_prev_data_offset': (True, False), |
| 1217 | 'fail_bad_minor_version': (True, False)}, |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1218 | validate_func=ValidateCheckOperationTest) |
| 1219 | |
| 1220 | # Add all _CheckOperations() test cases. |
| 1221 | AddParametricTests('CheckOperations', |
Allie Wood | fb04d30 | 2015-04-03 14:25:48 -0700 | [diff] [blame] | 1222 | {'fail_nonexhaustive_full_update': (True, False)}) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1223 | |
| 1224 | # Add all _CheckOperations() test cases. |
| 1225 | AddParametricTests('CheckSignatures', |
| 1226 | {'fail_empty_sigs_blob': (True, False), |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1227 | 'fail_sig_missing_fields': (True, False), |
| 1228 | 'fail_unknown_sig_version': (True, False), |
| 1229 | 'fail_incorrect_sig': (True, False)}) |
| 1230 | |
Gilad Arnold | 0d575cd | 2015-07-13 17:29:21 -0700 | [diff] [blame] | 1231 | # Add all _CheckManifestMinorVersion() test cases. |
| 1232 | AddParametricTests('CheckManifestMinorVersion', |
Amin Hassani | 0f59a9a | 2019-09-27 10:24:31 -0700 | [diff] [blame] | 1233 | {'minor_version': (None, 0, 2, 3, 4, 5, 555), |
Allie Wood | f5c4f3e | 2015-02-20 16:57:46 -0800 | [diff] [blame] | 1234 | 'payload_type': (checker._TYPE_FULL, |
| 1235 | checker._TYPE_DELTA)}) |
| 1236 | |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1237 | # Add all Run() test cases. |
| 1238 | AddParametricTests('Run', |
Gilad Arnold | 06eea33 | 2015-07-13 18:06:33 -0700 | [diff] [blame] | 1239 | {'rootfs_part_size_provided': (True, False), |
| 1240 | 'kernel_part_size_provided': (True, False), |
| 1241 | 'fail_wrong_payload_type': (True, False), |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1242 | 'fail_invalid_block_size': (True, False), |
Amin Hassani | a86b108 | 2018-03-08 15:48:59 -0800 | [diff] [blame] | 1243 | 'fail_mismatched_metadata_size': (True, False), |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1244 | 'fail_mismatched_block_size': (True, False), |
Gilad Arnold | 06eea33 | 2015-07-13 18:06:33 -0700 | [diff] [blame] | 1245 | 'fail_excess_data': (True, False), |
| 1246 | 'fail_rootfs_part_size_exceeded': (True, False), |
| 1247 | 'fail_kernel_part_size_exceeded': (True, False)}) |
Gilad Arnold | 5502b56 | 2013-03-08 13:22:31 -0800 | [diff] [blame] | 1248 | |
| 1249 | |
| 1250 | if __name__ == '__main__': |
| 1251 | AddAllParametricTests() |
| 1252 | unittest.main() |