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
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Tests for the output and formatting multi-processing engine."""
import io
import os
import unittest
from plaso.engine import configurations
from plaso.lib import definitions
from plaso.multi_process import output_engine
from plaso.output import dynamic
from plaso.output import interface as output_interface
from plaso.output import mediator as output_mediator
from plaso.storage import factory as storage_factory
from tests import test_lib as shared_test_lib
from tests.containers import test_lib as containers_test_lib
from tests.multi_process import test_lib
class TestOutputModule(output_interface.OutputModule):
"""Output module for testing.
Attributes:
events (list[tuple[EventObject, EventData]]): event written to the output.
macb_groups (list[list[tuple[EventObject, EventData]]]): MACB groups of
events written to the output.
"""
# pylint: disable=arguments-renamed,unused-argument
NAME = 'psort_test'
def __init__(self):
"""Initializes an output module."""
super(TestOutputModule, self).__init__()
self.events = []
self.macb_groups = []
def GetFieldValues(
self, output_mediator_object, event, event_data, event_data_stream,
event_tag):
"""Retrieves the output field values.
Args:
output_mediator_object (OutputMediator): mediates interactions between
output modules and other components, such as storage and dfVFS.
event (EventObject): event.
event_data (EventData): event data.
event_data_stream (EventDataStream): event data stream.
event_tag (EventTag): event tag.
Returns:
dict[str, str]: output field values per name.
"""
return {}
def WriteFieldValues(self, output_mediator_object, field_values):
"""Writes field values to the output.
Args:
output_mediator_object (OutputMediator): mediates interactions between
output modules and other components, such as storage and dfVFS.
field_values (dict[str, str]): output field values per name.
"""
self.events.append(field_values)
def WriteFieldValuesOfMACBGroup(self, output_mediator_object, macb_group):
"""Writes field values of a MACB group to the output.
Args:
output_mediator_object (OutputMediator): mediates interactions between
output modules and other components, such as storage and dfVFS.
macb_group (list[dict[str, str]]): group of output field values per name
with identical timestamps, attributes and values.
"""
self.events.extend(macb_group)
self.macb_groups.append(macb_group)
def WriteHeader(self, output_mediator_object):
"""Writes the header to the output.
Args:
output_mediator_object (OutputMediator): mediates interactions between
output modules and other components, such as storage and dfVFS.
"""
return
class PsortEventHeapTest(test_lib.MultiProcessingTestCase):
"""Tests for the psort events heap."""
# pylint: disable=protected-access
_TEST_EVENTS = [
{'data_type': 'test:event',
'timestamp': 5134324321,
'timestamp_desc': definitions.TIME_DESCRIPTION_METADATA_MODIFICATION},
{'_parser_chain': 'test_parser',
'data_type': 'test:event',
'display_name': '/dev/none',
'filename': '/dev/none',
'text': 'text',
'timestamp': 2345871286,
'timestamp_desc': definitions.TIME_DESCRIPTION_METADATA_MODIFICATION,
'var': 'Issue: False, Closed: True'}]
def testNumberOfEvents(self):
"""Tests the number_of_events property."""
event_heap = output_engine.PsortEventHeap()
self.assertEqual(event_heap.number_of_events, 0)
def testPopEvent(self):
"""Tests the PopEvent function."""
event_heap = output_engine.PsortEventHeap()
self.assertEqual(len(event_heap._heap), 0)
test_event = event_heap.PopEvent()
self.assertIsNone(test_event)
for event, event_data, event_data_stream in (
containers_test_lib.CreateEventsFromValues(self._TEST_EVENTS)):
event_heap.PushEvent(event, event_data, event_data_stream)
self.assertEqual(len(event_heap._heap), 2)
test_event = event_heap.PopEvent()
self.assertIsNotNone(test_event)
self.assertEqual(len(event_heap._heap), 1)
def testPopEvents(self):
"""Tests the PopEvents function."""
event_heap = output_engine.PsortEventHeap()
self.assertEqual(len(event_heap._heap), 0)
test_events = list(event_heap.PopEvents())
self.assertEqual(len(test_events), 0)
for event, event_data, event_data_stream in (
containers_test_lib.CreateEventsFromValues(self._TEST_EVENTS)):
event_heap.PushEvent(event, event_data, event_data_stream)
self.assertEqual(len(event_heap._heap), 2)
test_events = list(event_heap.PopEvents())
self.assertEqual(len(test_events), 2)
self.assertEqual(len(event_heap._heap), 0)
def testPushEvent(self):
"""Tests the PushEvent function."""
event_heap = output_engine.PsortEventHeap()
self.assertEqual(len(event_heap._heap), 0)
event, event_data, event_data_stream = (
containers_test_lib.CreateEventFromValues(self._TEST_EVENTS[0]))
event_heap.PushEvent(event, event_data, event_data_stream)
self.assertEqual(len(event_heap._heap), 1)
class OutputAndFormattingMultiProcessEngineTest(
test_lib.MultiProcessingTestCase):
"""Tests for the multi-processing engine."""
# pylint: disable=protected-access
_TEST_EVENTS = [
{'data_type': 'test:event',
'timestamp': 5134324321,
'timestamp_desc': definitions.TIME_DESCRIPTION_WRITTEN},
{'data_type': 'test:event',
'timestamp': 5134324321,
'timestamp_desc': definitions.TIME_DESCRIPTION_LAST_ACCESS},
{'data_type': 'test:event',
'timestamp': 2134324321,
'timestamp_desc': definitions.TIME_DESCRIPTION_UNKNOWN},
{'data_type': 'test:event',
'timestamp': 9134324321,
'timestamp_desc': definitions.TIME_DESCRIPTION_UNKNOWN},
{'data_type': 'test:event',
'timestamp': 5134324321,
'timestamp_desc': definitions.TIME_DESCRIPTION_METADATA_MODIFICATION},
{'data_type': 'test:event',
'timestamp': 5134324321,
'timestamp_desc': definitions.TIME_DESCRIPTION_CREATION},
{'data_type': 'test:event',
'timestamp': 15134324321,
'timestamp_desc': definitions.TIME_DESCRIPTION_UNKNOWN},
{'data_type': 'test:event',
'timestamp': 5134324322,
'timestamp_desc': definitions.TIME_DESCRIPTION_CREATION},
{'data_type': 'test:event',
'timestamp': 5134324322,
'timestamp_desc': definitions.TIME_DESCRIPTION_LAST_ACCESS},
{'data_type': 'test:event',
'timestamp': 5134324322,
'timestamp_desc': definitions.TIME_DESCRIPTION_METADATA_MODIFICATION},
{'data_type': 'test:event',
'timestamp': 5134324322,
'timestamp_desc': definitions.TIME_DESCRIPTION_WRITTEN},
{'data_type': 'test:event',
'timestamp': 5134324322,
'timestamp_desc': definitions.TIME_DESCRIPTION_WRITTEN},
{'data_type': 'test:event',
'timestamp': 5134324322,
'text': 'Another text',
'timestamp_desc': definitions.TIME_DESCRIPTION_LAST_ACCESS},
{'data_type': 'test:event',
'timestamp': 5134324322,
'text': 'Another text',
'timestamp_desc': definitions.TIME_DESCRIPTION_METADATA_MODIFICATION},
{'data_type': 'test:event',
'text': 'Another text',
'timestamp': 5134324322,
'timestamp_desc': definitions.TIME_DESCRIPTION_WRITTEN},
{'data_type': 'test:event',
'timestamp': 5134024321,
'timestamp_desc': definitions.TIME_DESCRIPTION_UNKNOWN},
{'data_type': 'test:event',
'timestamp': 5134024321,
'timestamp_desc': definitions.TIME_DESCRIPTION_UNKNOWN}]
def _CreateTestStorageFile(self, path):
"""Creates a storage file for testing.
Args:
path (str): path.
"""
storage_file = storage_factory.StorageFactory.CreateStorageFile(
definitions.DEFAULT_STORAGE_FORMAT)
storage_file.Open(path=path, read_only=False)
# TODO: add preprocessing information.
for event, event_data, event_data_stream in (
containers_test_lib.CreateEventsFromValues(self._TEST_EVENTS)):
storage_file.AddAttributeContainer(event_data_stream)
event_data.SetEventDataStreamIdentifier(event_data_stream.GetIdentifier())
storage_file.AddAttributeContainer(event_data)
event.SetEventDataIdentifier(event_data.GetIdentifier())
storage_file.AddAttributeContainer(event)
storage_file.Close()
# TODO: add test for _ExportEvent.
def testInternalExportEvents(self):
"""Tests the _ExportEvents function."""
formatters_directory_path = self._GetDataFilePath(['formatters'])
output_module = TestOutputModule()
test_engine = output_engine.OutputAndFormattingMultiProcessEngine()
with shared_test_lib.TempDirectory() as temp_directory:
temp_file = os.path.join(temp_directory, 'storage.plaso')
self._CreateTestStorageFile(temp_file)
storage_reader = (
storage_factory.StorageFactory.CreateStorageReaderForFile(temp_file))
output_mediator_object = output_mediator.OutputMediator(
storage_reader, data_location=shared_test_lib.TEST_DATA_PATH)
output_mediator_object.ReadMessageFormattersFromDirectory(
formatters_directory_path)
test_engine._ExportEvents(
storage_reader, output_module, deduplicate_events=False)
self.assertEqual(len(output_module.events), 17)
self.assertEqual(len(output_module.macb_groups), 3)
def testInternalExportEventsDeduplicate(self):
"""Tests the _ExportEvents function with deduplication."""
formatters_directory_path = self._GetDataFilePath(['formatters'])
output_module = TestOutputModule()
test_engine = output_engine.OutputAndFormattingMultiProcessEngine()
with shared_test_lib.TempDirectory() as temp_directory:
temp_file = os.path.join(temp_directory, 'storage.plaso')
self._CreateTestStorageFile(temp_file)
storage_reader = (
storage_factory.StorageFactory.CreateStorageReaderForFile(temp_file))
output_mediator_object = output_mediator.OutputMediator(
storage_reader, data_location=shared_test_lib.TEST_DATA_PATH)
output_mediator_object.ReadMessageFormattersFromDirectory(
formatters_directory_path)
test_engine._ExportEvents(storage_reader, output_module)
self.assertEqual(len(output_module.events), 15)
self.assertEqual(len(output_module.macb_groups), 3)
# TODO: add test for _FlushExportBuffer.
def testExportEvents(self):
"""Tests the ExportEvents function."""
test_file_path = self._GetTestFilePath(['psort_test.plaso'])
self._SkipIfPathNotExists(test_file_path)
test_file_object = io.StringIO()
storage_reader = storage_factory.StorageFactory.CreateStorageReaderForFile(
test_file_path)
output_module = dynamic.DynamicOutputModule()
output_module._file_object = test_file_object
configuration = configurations.ProcessingConfiguration()
configuration.data_location = shared_test_lib.DATA_PATH
configuration.preferred_language = 'en-US'
test_engine = output_engine.OutputAndFormattingMultiProcessEngine()
test_engine.ExportEvents(storage_reader, output_module, configuration)
output = test_file_object.getvalue()
lines = output.split('\n')
self.assertEqual(len(lines), 22)
expected_line = (
'2014-11-18T01:15:43.000000+00:00,'
'Content Modification Time,'
'LOG,'
'Log File,'
'[---] last message repeated 5 times ---,'
'text/syslog_traditional,'
'OS:/tmp/test/test_data/syslog,'
'repeated')
self.assertEqual(lines[14], expected_line)
if __name__ == '__main__':
unittest.main()
|
