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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Tests for the SQLite-based storage."""
import os
import unittest
from plaso.containers import events
from plaso.lib import definitions
from plaso.storage.sqlite import sqlite_file
from tests import test_lib as shared_test_lib
from tests.containers import test_lib as containers_test_lib
from tests.storage import test_lib
class _TestSQLiteStorageFileV20220716(sqlite_file.SQLiteStorageFile):
"""Test class for testing format compatibility checks."""
_FORMAT_VERSION = 20220716
_APPEND_COMPATIBLE_FORMAT_VERSION = 20211121
_UPGRADE_COMPATIBLE_FORMAT_VERSION = 20211121
_READ_COMPATIBLE_FORMAT_VERSION = 20211121
class _TestSQLiteStorageFileV20221023(sqlite_file.SQLiteStorageFile):
"""Test class for testing format compatibility checks."""
_FORMAT_VERSION = 20221023
_APPEND_COMPATIBLE_FORMAT_VERSION = 20221023
_UPGRADE_COMPATIBLE_FORMAT_VERSION = 20221023
_READ_COMPATIBLE_FORMAT_VERSION = 20211121
class SQLiteStorageFileTest(test_lib.StorageTestCase):
"""Tests for the SQLite-based storage file object."""
# pylint: disable=protected-access
def testInitialization(self):
"""Tests the __init__ function."""
test_store = sqlite_file.SQLiteStorageFile()
self.assertIsNotNone(test_store)
def testCacheAttributeContainerByIndex(self):
"""Tests the _CacheAttributeContainerByIndex function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory():
test_store = sqlite_file.SQLiteStorageFile()
self.assertEqual(len(test_store._attribute_container_cache), 0)
test_store._CacheAttributeContainerByIndex(event_data_stream, 0)
self.assertEqual(len(test_store._attribute_container_cache), 1)
def testCheckStorageMetadata(self):
"""Tests the _CheckStorageMetadata function."""
with shared_test_lib.TempDirectory():
test_store = sqlite_file.SQLiteStorageFile()
metadata_values = {
'compression_format': definitions.COMPRESSION_FORMAT_ZLIB,
'format_version': '{0:d}'.format(test_store._FORMAT_VERSION),
'serialization_format': definitions.SERIALIZER_FORMAT_JSON}
test_store._CheckStorageMetadata(metadata_values)
metadata_values['format_version'] = 'bogus'
with self.assertRaises(IOError):
test_store._CheckStorageMetadata(metadata_values)
metadata_values['format_version'] = '1'
with self.assertRaises(IOError):
test_store._CheckStorageMetadata(metadata_values)
metadata_values['format_version'] = '{0:d}'.format(
test_store._FORMAT_VERSION)
metadata_values['compression_format'] = None
with self.assertRaises(IOError):
test_store._CheckStorageMetadata(metadata_values)
metadata_values['compression_format'] = (
definitions.COMPRESSION_FORMAT_ZLIB)
metadata_values['serialization_format'] = None
with self.assertRaises(IOError):
test_store._CheckStorageMetadata(metadata_values)
metadata_values['serialization_format'] = (
definitions.SERIALIZER_FORMAT_JSON)
with self.assertRaises(IOError):
test_store._CheckStorageMetadata(metadata_values)
def testCreateAttributeContainerTable(self):
"""Tests the _CreateAttributeContainerTable function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
test_store._CreateAttributeContainerTable(
event_data_stream.CONTAINER_TYPE)
with self.assertRaises(IOError):
test_store._CreateAttributeContainerTable(
event_data_stream.CONTAINER_TYPE)
finally:
test_store.Close()
# TODO: add tests for _CreateAttributeContainerFromRow
# TODO: add tests for _DeserializeAttributeContainer
def testGetAttributeContainersWithFilter(self):
"""Tests the _GetAttributeContainersWithFilter function."""
event_data_stream = events.EventDataStream()
event_data_stream.md5_hash = '8f0bf95a7959baad9666b21a7feed79d'
column_names = ['md5_hash']
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
containers = list(test_store._GetAttributeContainersWithFilter(
event_data_stream.CONTAINER_TYPE, column_names=column_names))
self.assertEqual(len(containers), 0)
test_store.AddAttributeContainer(event_data_stream)
containers = list(test_store._GetAttributeContainersWithFilter(
event_data_stream.CONTAINER_TYPE, column_names=column_names))
self.assertEqual(len(containers), 1)
filter_expression = 'md5_hash == "8f0bf95a7959baad9666b21a7feed79d"'
containers = list(test_store._GetAttributeContainersWithFilter(
event_data_stream.CONTAINER_TYPE, column_names=column_names,
filter_expression=filter_expression))
self.assertEqual(len(containers), 1)
filter_expression = 'md5_hash != "8f0bf95a7959baad9666b21a7feed79d"'
containers = list(test_store._GetAttributeContainersWithFilter(
event_data_stream.CONTAINER_TYPE, column_names=column_names,
filter_expression=filter_expression))
self.assertEqual(len(containers), 0)
containers = list(test_store._GetAttributeContainersWithFilter(
'bogus', column_names=column_names))
self.assertEqual(len(containers), 0)
finally:
test_store.Close()
def testGetCachedAttributeContainer(self):
"""Tests the _GetCachedAttributeContainer function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory():
test_store = sqlite_file.SQLiteStorageFile()
attribute_container = test_store._GetCachedAttributeContainer(
event_data_stream.CONTAINER_TYPE, 1)
self.assertIsNone(attribute_container)
test_store._CacheAttributeContainerByIndex(event_data_stream, 1)
attribute_container = test_store._GetCachedAttributeContainer(
event_data_stream.CONTAINER_TYPE, 1)
self.assertIsNotNone(attribute_container)
def testHasTable(self):
"""Tests the _HasTable function."""
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
test_store._CreateAttributeContainerTable(
events.EventDataStream.CONTAINER_TYPE)
result = test_store._HasTable(
events.EventDataStream.CONTAINER_TYPE)
self.assertTrue(result)
result = test_store._HasTable('bogus')
self.assertFalse(result)
finally:
test_store.Close()
# TODO: add tests for _RaiseIfNotReadable
# TODO: add tests for _RaiseIfNotWritable
# TODO: add tests for _ReadAndCheckStorageMetadata
# TODO: add tests for _SerializeAttributeContainer
# TODO: add tests for _UpdateEventAfterDeserialize
# TODO: add tests for _UpdateEventBeforeSerialize
# TODO: add tests for _UpdateEventDataAfterDeserialize
# TODO: add tests for _UpdateEventDataBeforeSerialize
# TODO: add tests for _UpdateEventTagAfterDeserialize
# TODO: add tests for _UpdateEventTagBeforeSerialize
# TODO: add tests for _UpdateStorageMetadataFormatVersion
def testWriteExistingAttributeContainer(self):
"""Tests the _WriteExistingAttributeContainer function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
number_of_containers = test_store._GetNumberOfAttributeContainerRows(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 0)
test_store._WriteNewAttributeContainer(event_data_stream)
number_of_containers = test_store._GetNumberOfAttributeContainerRows(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 1)
test_store._WriteExistingAttributeContainer(event_data_stream)
number_of_containers = test_store._GetNumberOfAttributeContainerRows(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 1)
finally:
test_store.Close()
# TODO: add tests for _WriteMetadata
# TODO: add tests for _WriteMetadataValue
def testWriteNewAttributeContainer(self):
"""Tests the _WriteNewAttributeContainer function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
number_of_containers = test_store._GetNumberOfAttributeContainerRows(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 0)
test_store._WriteNewAttributeContainer(event_data_stream)
number_of_containers = test_store._GetNumberOfAttributeContainerRows(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 1)
finally:
test_store.Close()
def testAddAttributeContainer(self):
"""Tests the AddAttributeContainer function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
number_of_containers = test_store.GetNumberOfAttributeContainers(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 0)
test_store.AddAttributeContainer(event_data_stream)
number_of_containers = test_store.GetNumberOfAttributeContainers(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 1)
finally:
test_store.Close()
with self.assertRaises(IOError):
test_store.AddAttributeContainer(event_data_stream)
# TODO: add tests for CheckSupportedFormat
def testGetAttributeContainers(self):
"""Tests the GetAttributeContainers function."""
event_data_stream = events.EventDataStream()
event_data_stream.md5_hash = '8f0bf95a7959baad9666b21a7feed79d'
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
containers = list(test_store.GetAttributeContainers(
event_data_stream.CONTAINER_TYPE))
self.assertEqual(len(containers), 0)
test_store.AddAttributeContainer(event_data_stream)
containers = list(test_store.GetAttributeContainers(
event_data_stream.CONTAINER_TYPE))
self.assertEqual(len(containers), 1)
filter_expression = 'md5_hash == "8f0bf95a7959baad9666b21a7feed79d"'
containers = list(test_store.GetAttributeContainers(
event_data_stream.CONTAINER_TYPE,
filter_expression=filter_expression))
self.assertEqual(len(containers), 1)
filter_expression = 'md5_hash != "8f0bf95a7959baad9666b21a7feed79d"'
containers = list(test_store.GetAttributeContainers(
event_data_stream.CONTAINER_TYPE,
filter_expression=filter_expression))
self.assertEqual(len(containers), 0)
containers = list(test_store.GetAttributeContainers('bogus'))
self.assertEqual(len(containers), 0)
finally:
test_store.Close()
def testGetAttributeContainerByIdentifier(self):
"""Tests the GetAttributeContainerByIdentifier function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
test_store.AddAttributeContainer(event_data_stream)
identifier = event_data_stream.GetIdentifier()
container = test_store.GetAttributeContainerByIdentifier(
event_data_stream.CONTAINER_TYPE, identifier)
self.assertIsNotNone(container)
identifier.sequence_number = 99
container = test_store.GetAttributeContainerByIdentifier(
event_data_stream.CONTAINER_TYPE, identifier)
self.assertIsNone(container)
finally:
test_store.Close()
def testGetAttributeContainerByIndex(self):
"""Tests the GetAttributeContainerByIndex function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
container = test_store.GetAttributeContainerByIndex(
event_data_stream.CONTAINER_TYPE, 0)
self.assertIsNone(container)
test_store.AddAttributeContainer(event_data_stream)
container = test_store.GetAttributeContainerByIndex(
event_data_stream.CONTAINER_TYPE, 0)
self.assertIsNotNone(container)
container = test_store.GetAttributeContainerByIndex('bogus', 0)
self.assertIsNone(container)
finally:
test_store.Close()
def testGetNumberOfAttributeContainers(self):
"""Tests the GetNumberOfAttributeContainers function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
number_of_containers = test_store.GetNumberOfAttributeContainers(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 0)
test_store.AddAttributeContainer(event_data_stream)
number_of_containers = test_store.GetNumberOfAttributeContainers(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 1)
number_of_containers = test_store.GetNumberOfAttributeContainers(
'bogus')
self.assertEqual(number_of_containers, 0)
finally:
test_store.Close()
def testGetSortedEvents(self):
"""Tests the GetSortedEvents function."""
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
for event, event_data, event_data_stream in (
containers_test_lib.CreateEventsFromValues(self._TEST_EVENTS)):
test_store.AddAttributeContainer(event_data_stream)
event_data.SetEventDataStreamIdentifier(
event_data_stream.GetIdentifier())
test_store.AddAttributeContainer(event_data)
event.SetEventDataIdentifier(event_data.GetIdentifier())
test_store.AddAttributeContainer(event)
finally:
test_store.Close()
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path)
try:
test_events = list(test_store.GetSortedEvents())
self.assertEqual(len(test_events), 4)
finally:
test_store.Close()
# TODO: add test with time range.
def testHasAttributeContainers(self):
"""Tests the HasAttributeContainers function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
result = test_store.HasAttributeContainers(
event_data_stream.CONTAINER_TYPE)
self.assertFalse(result)
test_store.AddAttributeContainer(event_data_stream)
result = test_store.HasAttributeContainers(
event_data_stream.CONTAINER_TYPE)
self.assertTrue(result)
result = test_store.HasAttributeContainers('bogus')
self.assertFalse(result)
finally:
test_store.Close()
# TODO: add tests for Open and Close
def testUpdateAttributeContainer(self):
"""Tests the UpdateAttributeContainer function."""
event_data_stream = events.EventDataStream()
with shared_test_lib.TempDirectory() as temp_directory:
test_path = os.path.join(temp_directory, 'plaso.sqlite')
test_store = sqlite_file.SQLiteStorageFile()
test_store.Open(path=test_path, read_only=False)
try:
number_of_containers = test_store.GetNumberOfAttributeContainers(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 0)
test_store.AddAttributeContainer(event_data_stream)
number_of_containers = test_store.GetNumberOfAttributeContainers(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 1)
test_store.UpdateAttributeContainer(event_data_stream)
number_of_containers = test_store.GetNumberOfAttributeContainers(
event_data_stream.CONTAINER_TYPE)
self.assertEqual(number_of_containers, 1)
finally:
test_store.Close()
def testVersionCompatibility(self):
"""Tests the version compatibility methods."""
with shared_test_lib.TempDirectory() as temp_directory:
v1_storage_path = os.path.join(temp_directory, 'v20220716.sqlite')
v1_test_store = _TestSQLiteStorageFileV20220716()
v1_test_store.Open(path=v1_storage_path, read_only=False)
v1_test_store.Close()
v2_test_store_rw = _TestSQLiteStorageFileV20221023()
with self.assertRaises((IOError, OSError)):
v2_test_store_rw.Open(path=v1_storage_path, read_only=False)
v2_test_store_ro = _TestSQLiteStorageFileV20221023()
v2_test_store_ro.Open(path=v1_storage_path, read_only=True)
v2_test_store_ro.Close()
if __name__ == '__main__':
unittest.main()
|
