-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathtest_kdump_file_header.py
403 lines (352 loc) · 16.7 KB
/
test_kdump_file_header.py
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
#!/usr/bin/env python3
"""`hotkdump` class unit tests.
Copyright 2023 Canonical Limited.
SPDX-License-Identifier: GPL-3.0
"""
import os
from unittest import mock, TestCase
from io import BytesIO
import struct
from hotkdump.core.exceptions import ExceptionWithLog
from hotkdump.core.kdumpfile import (
KdumpFile,
VMCoreInfo,
DiskDumpHeader,
BinaryFileReader,
KdumpSubHeader,
NotAKernelCrashDumpException,
)
from hotkdump.core.hotkdump import Hotkdump, HotkdumpParameters
from tests.utils import MockFileCtx, pad, MOCK_HDR
MOCK_HDR_INVALID_NO_SIG = os.urandom(4096)
MOCK_VMCOREINFO = b"""key=value
this is a key=value value
$$=@@
"""
class TestBinaryFileReader(TestCase):
"""Test BinaryFileReader class."""
def test_file_size(self):
fake_file = BytesIO(b"1234567890")
self.assertEqual(BinaryFileReader.file_size(fake_file), 10)
def test_seek_to_first_non_nul(self):
fake_file = BytesIO(b"\x00\x00\x00ABC")
BinaryFileReader.seek_to_first_non_nul(fake_file)
self.assertEqual(fake_file.read(3), b"ABC")
def test_read_int32_le(self):
fake_file = BytesIO(b"\x01\x00\x00\x00")
self.assertEqual(BinaryFileReader.read_int(fake_file, "<i"), 1)
def test_read_int64_le(self):
fake_file = BytesIO(b"\x01\x00\x00\x00\x00\x00\x00\x00")
self.assertEqual(BinaryFileReader.read_int(fake_file, "<q"), 1)
def test_read_int32_be(self):
fake_file = BytesIO(b"\x00\x00\x00\x01")
self.assertEqual(BinaryFileReader.read_int(fake_file, ">i"), 1)
def test_read_int64_be(self):
fake_file = BytesIO(b"\x00\x00\x00\x00\x00\x00\x00\x01")
self.assertEqual(BinaryFileReader.read_int(fake_file, ">q"), 1)
def test_read_str(self):
fake_file = BytesIO(b"Hello\x00\x00")
self.assertEqual(BinaryFileReader.read_str(fake_file, 5), "Hello")
def test_read_cstr(self):
fake_file = BytesIO(b"Hello\x00\x00\x00World\x00")
self.assertEqual(BinaryFileReader.read_cstr(fake_file), "Hello")
self.assertEqual(BinaryFileReader.read_cstr(fake_file), "World")
@mock.patch.multiple(
"os",
remove=lambda x: True,
listdir=lambda x: [],
stat=lambda x: "a",
makedirs=lambda *a, **kw: None,
)
@mock.patch.multiple(
"os.path", dirname=lambda x: x, realpath=lambda x: x, exists=lambda x: True
)
@mock.patch.multiple("shutil", which=lambda x: x)
class KdumpDiskDumpHeaderTest(TestCase):
"""kdump header parsing tests"""
@mock.patch("builtins.open", MockFileCtx(file_bytes=MOCK_HDR, name="name"))
def test_kdump_hdr(self):
"""Test kdump file header parsing with
a correct header.
"""
with open("a", "rb") as f:
uut = DiskDumpHeader.from_fd(f)
self.assertEqual(uut.header_version, 67305985)
self.assertEqual(uut.utsname.domain, "domain")
self.assertEqual(uut.utsname.machine, "machine")
self.assertEqual(uut.utsname.node, "node")
self.assertEqual(uut.utsname.release, "release")
self.assertEqual(uut.utsname.system, "sys")
self.assertEqual(uut.utsname.version, "#version-443")
self.assertEqual(uut.utsname.normalized_version, "version")
@mock.patch("builtins.open", new_callable=mock.mock_open, read_data=b"")
def test_from_bytes_io(self, mfile):
# 6 bytes padding after utsname
fake_file_content = (
b"KDUMP " # signature
+ b"\x01\x00\x00\x00" # header_version
+ pad(b"Linux", 65) # system
+ pad(b"node", 65) # node
+ pad(b"release", 65) # release
+ pad(b"version", 65) # version
+ pad(b"machine", 65) # machine
+ pad(b"domain", 65) # domain
+ b"\0" * 6 # padding
+ b"\x01\x00\x00\x00\x00\x00\x00\x00" # timestamp_sec
+ b"\x02\x00\x00\x00\x00\x00\x00\x00" # timestamp_usec
+ b"\x03\x00\x00\x00" # status
+ b"\x04\x00\x00\x00" # block_size
)
fake_file = MockFileCtx(fake_file_content, "test")
mfile.return_value = fake_file
with fake_file as fd:
header = DiskDumpHeader.from_fd(fd)
self.assertEqual(header.signature, "KDUMP ")
self.assertEqual(header.header_version, 1)
self.assertEqual(header.utsname.system, "Linux")
self.assertEqual(header.utsname.node, "node")
self.assertEqual(header.utsname.release, "release")
self.assertEqual(header.utsname.version, "version")
self.assertEqual(header.utsname.machine, "machine")
self.assertEqual(header.utsname.domain, "domain")
self.assertEqual(header.timestamp_sec, 1)
self.assertEqual(header.timestamp_usec, 2)
self.assertEqual(header.status, 3)
self.assertEqual(header.block_size, 4)
class TestKdumpSubHeader(TestCase):
def setUp(self):
self.fake_file_content = (
b"\x01\x00\x00\x00\x00\x00\x00\x00" # phys_base
+ b"\x02\x00\x00\x00" # dump_level
+ b"\x03\x00\x00\x00" # split
+ b"\x04\x00\x00\x00\x00\x00\x00\x00" # start_pfn
+ b"\x05\x00\x00\x00\x00\x00\x00\x00" # end_pfn
+ b"\x06\x00\x00\x00\x00\x00\x00\x00" # offset_vmcoreinfo
+ b"\x07\x00\x00\x00\x00\x00\x00\x00" # size_vmcoreinfo
+ b"\x08\x00\x00\x00\x00\x00\x00\x00" # offset_note
+ b"\x09\x00\x00\x00\x00\x00\x00\x00" # size_note
+ b"\x0a\x00\x00\x00\x00\x00\x00\x00" # offset_eraseinfo
+ b"\x0b\x00\x00\x00\x00\x00\x00\x00" # size_eraseinfo
+ b"\x0c\x00\x00\x00\x00\x00\x00\x00" # start_pfn_64
+ b"\x0d\x00\x00\x00\x00\x00\x00\x00" # end_pfn_64
+ b"\x0e\x00\x00\x00\x00\x00\x00\x00" # max_mapnr_64
)
@mock.patch("builtins.open", new_callable=mock.mock_open, read_data=b"")
def test_from_fd(self, mfile):
fake_file = BytesIO(self.fake_file_content)
mfile.return_value = fake_file
sub_header = KdumpSubHeader.from_fd(fake_file)
self.assertEqual(sub_header.phys_base, 1)
self.assertEqual(sub_header.dump_level, 2)
self.assertEqual(sub_header.split, 3)
self.assertEqual(sub_header.start_pfn, 4)
self.assertEqual(sub_header.end_pfn, 5)
self.assertEqual(sub_header.offset_vmcoreinfo, 6)
self.assertEqual(sub_header.size_vmcoreinfo, 7)
self.assertEqual(sub_header.offset_note, 8)
self.assertEqual(sub_header.size_note, 9)
self.assertEqual(sub_header.offset_eraseinfo, 10)
self.assertEqual(sub_header.size_eraseinfo, 11)
self.assertEqual(sub_header.start_pfn_64, 12)
self.assertEqual(sub_header.end_pfn_64, 13)
self.assertEqual(sub_header.max_mapnr_64, 14)
class VMCoreInfoTest(TestCase):
"""VMCoreInfo class unit tests"""
def test_vmcoreinfo_parse(self):
"""Check if VMCoreInfo class can parse the multiline
key-value string properly."""
data = """TEST(ABCD)=EFGHI
KEY=VALUE
"""
v = VMCoreInfo(data)
self.assertEqual(v.get("TEST(ABCD)"), "EFGHI")
self.assertEqual(v.get("KEY"), "VALUE")
@mock.patch("builtins.open", MockFileCtx(file_bytes=MOCK_VMCOREINFO, name="name"))
def test_vmcoreinfo_from_file(self):
"""Check if VMCoreInfo class can read from a file."""
with open("a", "rb") as f:
v = VMCoreInfo.from_fd(f, 0, len(MOCK_VMCOREINFO))
self.assertEqual(v.get("key"), "value")
self.assertEqual(v.get("this is a key"), "value value")
self.assertEqual(v.get("$$"), "@@")
class TestKdumpFile(TestCase):
"""Unit tests for KDumpFile class."""
@mock.patch("builtins.open", new_callable=mock.mock_open, read_data=b"")
def test_init_valid_kdump_file_flattened(self, mfile):
fake_vmcoreinfo = b"""key=value
this is a key=value value
$$=@@
"""
fake_file_content = (
pad(b"makedumpfile\0\0\0\0", 4096)
# makedumpfile_data_header
+ struct.pack(">q", 0) # offset
+ struct.pack(">q", 464) # size
+ pad(
b"KDUMP " # signature
+ struct.pack("<i", 242526) # header_version
+ pad(b"Linux", 65) # system
+ pad(b"node", 65) # node
+ pad(b"release", 65) # release
+ pad(b"version", 65) # version
+ pad(b"machine", 65) # machine
+ pad(b"domain", 65) # domain
+ b"\x02" * 6 # padding
+ struct.pack("<q", 1234) # timestamp_sec
+ struct.pack("<q", 5678) # timestamp_usec
+ struct.pack("<i", 91011) # status
+ struct.pack("<i", 4096), # block_size
464,
)
# makedumpfile_data_header
+ struct.pack(">q", 4096) # offsert
+ struct.pack(">q", 4096) # size
+ pad(
struct.pack("<q", 1111) # phys_base
+ struct.pack("<i", 2222) # dump_level
+ struct.pack("<i", 3333) # split
+ struct.pack("<q", 4444) # start_pfn
+ struct.pack("<q", 5555) # end_pfn
+ struct.pack("<q", 8192) # offset_vmcoreinfo
+ struct.pack("<q", 42) # size_vmcoreinfo
+ struct.pack("<q", 8) # offset_note
+ struct.pack("<q", 9) # size_note
+ struct.pack("<q", 10) # offset_eraseinfo
+ struct.pack("<q", 11) # size_eraseinfo
+ struct.pack("<q", 12) # start_pfn_64
+ struct.pack("<q", 13) # end_pfn_64
+ struct.pack("<q", 14), # max_mapnr_64
4096,
)
+ struct.pack(">q", 8192) # offset
+ struct.pack(">q", 42) # size
+ fake_vmcoreinfo
)
fake_file = MockFileCtx(fake_file_content, "test")
mfile.return_value = fake_file
kdump_file = KdumpFile("dummy_path")
self.assertIsInstance(kdump_file.ddhdr, DiskDumpHeader)
self.assertEqual(kdump_file.ddhdr.signature, "KDUMP ")
self.assertEqual(kdump_file.ddhdr.header_version, 242526)
self.assertEqual(kdump_file.ddhdr.utsname.system, "Linux")
self.assertEqual(kdump_file.ddhdr.utsname.node, "node")
self.assertEqual(kdump_file.ddhdr.utsname.release, "release")
self.assertEqual(kdump_file.ddhdr.utsname.version, "version")
self.assertEqual(kdump_file.ddhdr.utsname.machine, "machine")
self.assertEqual(kdump_file.ddhdr.utsname.domain, "domain")
self.assertEqual(kdump_file.ddhdr.timestamp_sec, 1234)
self.assertEqual(kdump_file.ddhdr.timestamp_usec, 5678)
self.assertEqual(kdump_file.ddhdr.status, 91011)
self.assertEqual(kdump_file.ddhdr.block_size, 4096)
self.assertIsInstance(kdump_file.ksubhdr, KdumpSubHeader)
self.assertEqual(kdump_file.ksubhdr.phys_base, 1111)
self.assertEqual(kdump_file.ksubhdr.dump_level, 2222)
self.assertEqual(kdump_file.ksubhdr.split, 3333)
self.assertEqual(kdump_file.ksubhdr.start_pfn, 4444)
self.assertEqual(kdump_file.ksubhdr.end_pfn, 5555)
self.assertEqual(kdump_file.ksubhdr.offset_vmcoreinfo, 8192)
self.assertEqual(kdump_file.ksubhdr.size_vmcoreinfo, 42)
self.assertEqual(kdump_file.ksubhdr.offset_note, 8)
self.assertEqual(kdump_file.ksubhdr.size_note, 9)
self.assertEqual(kdump_file.ksubhdr.offset_eraseinfo, 10)
self.assertEqual(kdump_file.ksubhdr.size_eraseinfo, 11)
self.assertEqual(kdump_file.ksubhdr.start_pfn_64, 12)
self.assertEqual(kdump_file.ksubhdr.end_pfn_64, 13)
self.assertEqual(kdump_file.ksubhdr.max_mapnr_64, 14)
self.assertIsInstance(kdump_file.vmcoreinfo, VMCoreInfo)
self.assertEqual(kdump_file.vmcoreinfo.get("key"), "value")
self.assertEqual(kdump_file.vmcoreinfo.get("this is a key"), "value value")
self.assertEqual(kdump_file.vmcoreinfo.get("$$"), "@@")
@mock.patch("builtins.open", new_callable=mock.mock_open, read_data=b"")
def test_init_valid_kdump_file_compressed(self, mfile):
fake_vmcoreinfo = b"""key=value
this is a key=value value
$$=@@
"""
fake_file_content = (
# 1 page diskdump_header
pad(
b"KDUMP " # signature
+ struct.pack("<i", 242526) # header_version
+ pad(b"Linux", 65) # system
+ pad(b"node", 65) # node
+ pad(b"release", 65) # release
+ pad(b"version", 65) # version
+ pad(b"machine", 65) # machine
+ pad(b"domain", 65) # domain
+ b"\x02" * 6 # padding
+ struct.pack("<q", 1234) # timestamp_sec
+ struct.pack("<q", 5678) # timestamp_usec
+ struct.pack("<i", 91011) # status
+ struct.pack("<i", 4096), # block_size
4096,
)
# kdump_sub_header
+ struct.pack("<q", 1111) # phys_base
+ struct.pack("<i", 2222) # dump_level
+ struct.pack("<i", 3333) # split
+ struct.pack("<q", 4444) # start_pfn
+ struct.pack("<q", 5555) # end_pfn
+ struct.pack("<q", 4200) # offset_vmcoreinfo
+ struct.pack("<q", 42) # size_vmcoreinfo
+ struct.pack("<q", 8) # offset_note
+ struct.pack("<q", 9) # size_note
+ struct.pack("<q", 10) # offset_eraseinfo
+ struct.pack("<q", 11) # size_eraseinfo
+ struct.pack("<q", 12) # start_pfn_64
+ struct.pack("<q", 13) # end_pfn_64
+ struct.pack("<q", 14) # max_mapnr_64
+ fake_vmcoreinfo
)
fake_file = MockFileCtx(fake_file_content, "test")
mfile.return_value = fake_file
kdump_file = KdumpFile("dummy_path")
self.assertIsInstance(kdump_file.ddhdr, DiskDumpHeader)
self.assertEqual(kdump_file.ddhdr.signature, "KDUMP ")
self.assertEqual(kdump_file.ddhdr.header_version, 242526)
self.assertEqual(kdump_file.ddhdr.utsname.system, "Linux")
self.assertEqual(kdump_file.ddhdr.utsname.node, "node")
self.assertEqual(kdump_file.ddhdr.utsname.release, "release")
self.assertEqual(kdump_file.ddhdr.utsname.version, "version")
self.assertEqual(kdump_file.ddhdr.utsname.machine, "machine")
self.assertEqual(kdump_file.ddhdr.utsname.domain, "domain")
self.assertEqual(kdump_file.ddhdr.timestamp_sec, 1234)
self.assertEqual(kdump_file.ddhdr.timestamp_usec, 5678)
self.assertEqual(kdump_file.ddhdr.status, 91011)
self.assertEqual(kdump_file.ddhdr.block_size, 4096)
self.assertIsInstance(kdump_file.ksubhdr, KdumpSubHeader)
self.assertEqual(kdump_file.ksubhdr.phys_base, 1111)
self.assertEqual(kdump_file.ksubhdr.dump_level, 2222)
self.assertEqual(kdump_file.ksubhdr.split, 3333)
self.assertEqual(kdump_file.ksubhdr.start_pfn, 4444)
self.assertEqual(kdump_file.ksubhdr.end_pfn, 5555)
self.assertEqual(kdump_file.ksubhdr.offset_vmcoreinfo, 4200)
self.assertEqual(kdump_file.ksubhdr.size_vmcoreinfo, 42)
self.assertEqual(kdump_file.ksubhdr.offset_note, 8)
self.assertEqual(kdump_file.ksubhdr.size_note, 9)
self.assertEqual(kdump_file.ksubhdr.offset_eraseinfo, 10)
self.assertEqual(kdump_file.ksubhdr.size_eraseinfo, 11)
self.assertEqual(kdump_file.ksubhdr.start_pfn_64, 12)
self.assertEqual(kdump_file.ksubhdr.end_pfn_64, 13)
self.assertEqual(kdump_file.ksubhdr.max_mapnr_64, 14)
self.assertIsInstance(kdump_file.vmcoreinfo, VMCoreInfo)
self.assertEqual(kdump_file.vmcoreinfo.get("key"), "value")
self.assertEqual(kdump_file.vmcoreinfo.get("this is a key"), "value value")
self.assertEqual(kdump_file.vmcoreinfo.get("$$"), "@@")
@mock.patch("builtins.open", new_callable=mock.mock_open, read_data=b"")
def test_init_invalid_signature(self, mfile):
fake_file_content = b"fakefile\0\0\0"
fake_file = MockFileCtx(fake_file_content, "test")
mfile.return_value = fake_file
with self.assertRaises(NotAKernelCrashDumpException):
_ = KdumpFile("dummy_path")
@mock.patch(
"builtins.open", MockFileCtx(file_bytes=MOCK_HDR_INVALID_NO_SIG, name="name")
)
def test_kdump_hdr_no_sig(self):
"""Test kdump file header parsing with
garbage input.
"""
self.assertRaises(
ExceptionWithLog, Hotkdump, HotkdumpParameters(dump_file_path="dump")
)