1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
## @file
# Unit tests for the Firmware Module Management Tool.
#
# Copyright (c) Microsoft Corporation.
#
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
import logging
import os
import sys
import tempfile
import unittest
import uuid
from pathlib import Path
from types import SimpleNamespace
from unittest import mock
import TestTools
_TESTS_DIR = Path(__file__).resolve().parent
_PYTHON_SOURCE = _TESTS_DIR.parent / "Source" / "Python"
_FMMT_SOURCE = _PYTHON_SOURCE / "FMMT"
sys.path.insert(0, str(_FMMT_SOURCE))
sys.path.insert(0, str(_PYTHON_SOURCE))
os.environ.setdefault("FmmtConfPath", "")
# FMMT opens a build log when imported. Unit tests do not need a persistent log.
with mock.patch("logging.FileHandler", return_value=logging.NullHandler()):
import core.FMMTOperation as FMMTOperation
from core.BiosTree import BIOSTREE
from core.BiosTree import FFS_FREE_SPACE
from core.BiosTree import FFS_TREE
from core.BiosTree import SEC_FV_TREE
from core.BiosTreeNode import FreeSpaceNode
from core.FvHandler import FvHandler
from FirmwareStorageFormat.Common import ModifyGuidFormat
from FirmwareStorageFormat.FfsFileHeader import EFI_FFS_FILE_HEADER
class _FirmwareVolumeData:
def __init__(self, size, free_space=0, block_size=0x40):
self.Data = b""
self.Free_Space = free_space
self.Header = SimpleNamespace(
Attributes=0,
BlockMap=[SimpleNamespace(Length=block_size)],
ExtHeaderOffset=0,
FileSystemGuid=ModifyGuidFormat(
"00000000-0000-0000-0000-000000000000"
),
FvLength=size,
)
self.Size = size
def ModCheckSum(self):
pass
def ModExtHeaderData(self):
pass
def ModFvExt(self):
pass
def ModFvSize(self):
pass
class _TestFvHandler(FvHandler):
def CompressData(self, target_tree):
self.Status = True
def ModifyTest(self, parent_tree, needed_space):
self.Status = True
class _TestRecursiveFvHandler(FvHandler):
def CompressData(self, target_tree):
self.Status = True
def _create_ffs(name, size, data=b""):
node = BIOSTREE(name)
node.type = FFS_TREE
header = EFI_FFS_FILE_HEADER()
header.Name = ModifyGuidFormat(str(name))
header.Size[0] = size & 0xFF
header.Size[1] = (size >> 8) & 0xFF
header.Size[2] = (size >> 16) & 0xFF
node.Data = SimpleNamespace(
Data=data,
Header=header,
Name=name,
PadData=b"",
Size=size,
)
return node
class FmmtReplaceTests(unittest.TestCase):
def test_replace_multiple_matches_uses_independent_ffs_trees(self):
target_guid = uuid.UUID("11111111-2222-3333-4444-555555555555")
targets = [SimpleNamespace(), SimpleNamespace()]
replacement = SimpleNamespace(
Data=SimpleNamespace(PadData=b"", Size=0x20),
Parent=None,
)
class _Root:
def __init__(self):
self.Findlist = []
def FindNode(self, name, matches):
matches.extend(targets)
class _Parser:
def __init__(self, root):
self.FinalData = b"output"
self.WholeFvTree = root
def Encapsulation(self, root, compress_status):
pass
def ParserFromRoot(self, root, data):
pass
input_parser = _Parser(_Root())
replacement_parser = _Parser(SimpleNamespace(Child=[replacement]))
replacements = []
class _Handler:
def __init__(self, new_ffs, target_ffs):
replacements.append(new_ffs)
new_ffs.Parent = target_ffs
def ReplaceFfs(self):
return True
with tempfile.TemporaryDirectory() as directory:
input_path = Path(directory) / "input.fd"
new_ffs_path = Path(directory) / "new.ffs"
output_path = Path(directory) / "output.fd"
input_path.write_bytes(b"input")
new_ffs_path.write_bytes(b"replacement")
with mock.patch.object(
FMMTOperation,
"FMMTParser",
side_effect=[input_parser, replacement_parser],
), mock.patch.object(FMMTOperation, "FvHandler", _Handler):
FMMTOperation.ReplaceFfs(
str(input_path),
target_guid,
str(new_ffs_path),
str(output_path),
)
self.assertEqual(2, len(replacements))
self.assertIsNot(replacements[0], replacements[1])
self.assertIs(targets[0], replacements[0].Parent)
self.assertIs(targets[1], replacements[1].Parent)
def test_smaller_replacement_creates_free_space_node(self):
prefix = _create_ffs(
uuid.UUID("10000000-0000-0000-0000-000000000001"), 0x18
)
target = _create_ffs(
uuid.UUID("20000000-0000-0000-0000-000000000002"), 0x40
)
replacement = _create_ffs(target.Data.Name, 0x18)
volume = BIOSTREE("FV")
volume.type = SEC_FV_TREE
volume.Data = _FirmwareVolumeData(0x80)
volume.insertChild(prefix)
volume.insertChild(target)
self.assertTrue(_TestFvHandler(replacement, target).ReplaceFfs())
self.assertIs(replacement, volume.Child[1])
free_space = volume.Child[-1]
self.assertEqual(FFS_FREE_SPACE, free_space.type)
self.assertIsInstance(free_space.Data, FreeSpaceNode)
self.assertEqual(b"\xFF" * 0x28, free_space.Data.Data)
def test_growing_nested_fv_preserves_final_ffs(self):
prefix = _create_ffs(
uuid.UUID("10000000-0000-0000-0000-000000000001"), 0x18, b"prefix"
)
target = _create_ffs(
uuid.UUID("20000000-0000-0000-0000-000000000002"), 0x20, b"target"
)
trailing = _create_ffs(
uuid.UUID("30000000-0000-0000-0000-000000000003"),
0x18,
b"trailing",
)
replacement = _create_ffs(target.Data.Name, 0x30, b"replacement")
volume = BIOSTREE("FV")
volume.type = SEC_FV_TREE
volume.Data = _FirmwareVolumeData(0x80)
volume.insertChild(prefix)
volume.insertChild(target)
volume.insertChild(trailing)
self.assertTrue(_TestFvHandler(replacement, target).ReplaceFfs())
self.assertEqual(b"trailing", trailing.Data.Data)
self.assertIn(trailing, volume.Child)
self.assertIs(replacement, volume.Child[1])
free_space = volume.Child[-1]
self.assertEqual(FFS_FREE_SPACE, free_space.type)
self.assertIsInstance(free_space.Data, FreeSpaceNode)
self.assertEqual(b"\xFF" * 0x30, free_space.Data.Data)
def test_block_aligned_growth_of_only_ffs_does_not_crash(self):
target = _create_ffs(
uuid.UUID("20000000-0000-0000-0000-000000000002"), 0x20, b"target"
)
replacement = _create_ffs(target.Data.Name, 0x60, b"replacement")
volume = BIOSTREE("FV")
volume.type = SEC_FV_TREE
volume.Data = _FirmwareVolumeData(0x40)
volume.insertChild(target)
self.assertTrue(_TestFvHandler(replacement, target).ReplaceFfs())
self.assertEqual([replacement], volume.Child)
self.assertEqual(0, volume.Data.Free_Space)
def test_block_aligned_growth_preserves_ffs_order(self):
prefix = _create_ffs(
uuid.UUID("10000000-0000-0000-0000-000000000001"), 0x18, b"prefix"
)
target = _create_ffs(
uuid.UUID("20000000-0000-0000-0000-000000000002"), 0x20, b"target"
)
trailing = _create_ffs(
uuid.UUID("30000000-0000-0000-0000-000000000003"),
0x18,
b"trailing",
)
replacement = _create_ffs(target.Data.Name, 0x60, b"replacement")
volume = BIOSTREE("FV")
volume.type = SEC_FV_TREE
volume.Data = _FirmwareVolumeData(0x80)
volume.insertChild(prefix)
volume.insertChild(target)
volume.insertChild(trailing)
self.assertTrue(_TestFvHandler(replacement, target).ReplaceFfs())
self.assertEqual([prefix, replacement, trailing], volume.Child)
self.assertEqual(0, volume.Data.Free_Space)
def test_growing_ancestor_fv_preserves_final_ffs(self):
prefix = _create_ffs(
uuid.UUID("10000000-0000-0000-0000-000000000001"), 0x18, b"prefix"
)
trailing = _create_ffs(
uuid.UUID("30000000-0000-0000-0000-000000000003"),
0x18,
b"trailing",
)
volume = BIOSTREE("FV")
volume.type = SEC_FV_TREE
volume.Data = _FirmwareVolumeData(0x80)
volume.insertChild(prefix)
volume.insertChild(trailing)
parent = BIOSTREE("ROOT")
parent.type = FMMTOperation.ROOT_TREE
parent.insertChild(volume)
_TestRecursiveFvHandler(None).ModifyTest(volume, 0x10)
self.assertEqual(b"trailing", trailing.Data.Data)
self.assertIn(trailing, volume.Child)
free_space = volume.Child[-1]
self.assertEqual(FFS_FREE_SPACE, free_space.type)
self.assertIsInstance(free_space.Data, FreeSpaceNode)
self.assertEqual(b"\xFF" * 0x30, free_space.Data.Data)
TheTestSuite = TestTools.MakeTheTestSuite(locals())
if __name__ == "__main__":
unittest.TextTestRunner(verbosity=2).run(TheTestSuite())
|
