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
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Tests for the output module interface."""
from __future__ import unicode_literals
import unittest
from plaso.lib import definitions
from plaso.lib import timelib
from plaso.output import formatting_helper
from plaso.output import interface
from plaso.output import manager
from tests.cli import test_lib as cli_test_lib
from tests.containers import test_lib as containers_test_lib
from tests.output import test_lib
class TestXMLEventFormattingHelper(formatting_helper.EventFormattingHelper):
"""XML output module event formatting helper for testing."""
def GetFormattedEvent(self, event, event_data, event_data_stream, event_tag):
"""Retrieves a string representation of the event.
Args:
event (EventObject): event.
event_data (EventData): event data.
event_data_stream (EventDataStream): event data stream.
event_tag (EventTag): event tag.
Returns:
str: string representation of the event.
"""
date_time = timelib.Timestamp.CopyToIsoFormat(
event.timestamp, timezone=self._output_mediator.timezone,
raise_error=False)
return (
'<Event>\n'
'\t<DateTime>{0:s}</DateTime>\n'
'\t<Entry>{1:s}</Entry>\n'
'</Event>').format(date_time, event_data.entry)
class TestXMLOutputModule(interface.LinearOutputModule):
"""XML output module for testing."""
NAME = 'test_xml'
DESCRIPTION = 'Test output that provides a simple mocked XML.'
def WriteFooter(self):
"""Writes the footer to the output."""
self._output_writer.Write('</EventFile>\n')
def WriteHeader(self):
"""Writes the header to the output."""
self._output_writer.Write('<EventFile>\n')
class LinearOutputModuleTest(test_lib.OutputModuleTestCase):
"""Tests the linear output module."""
_TEST_EVENTS = [
{'data_type': 'test:event',
'entry': 'My Event Is Now!',
'timestamp': '2012-06-27 18:17:01',
'timestamp_desc': definitions.TIME_DESCRIPTION_UNKNOWN},
{'data_type': 'test:event',
'entry': 'There is no tomorrow.',
'timestamp': '2012-06-27 18:18:23',
'timestamp_desc': definitions.TIME_DESCRIPTION_UNKNOWN},
{'data_type': 'test:event',
'entry': 'Tomorrow is now.',
'timestamp': '2012-06-27 19:11:54',
'timestamp_desc': definitions.TIME_DESCRIPTION_UNKNOWN},
{'data_type': 'test:event',
'entry': 'This is just some stuff to fill the line.',
'timestamp': '2012-06-27 19:12:03',
'timestamp_desc': definitions.TIME_DESCRIPTION_UNKNOWN}]
def testOutput(self):
"""Tests an implementation of output module."""
output_mediator = self._CreateOutputMediator()
event_formatting_helper = TestXMLEventFormattingHelper(output_mediator)
output_module = TestXMLOutputModule(
output_mediator, event_formatting_helper)
output_writer = cli_test_lib.TestOutputWriter()
output_module.SetOutputWriter(output_writer)
output_module.WriteHeader()
for event_values in self._TEST_EVENTS:
event, event_data, event_data_stream = (
containers_test_lib.CreateEventFromValues(event_values))
output_module.WriteEvent(event, event_data, event_data_stream, None)
output_module.WriteFooter()
expected_output = (
'<EventFile>\n'
'<Event>\n'
'\t<DateTime>2012-06-27T18:17:01+00:00</DateTime>\n'
'\t<Entry>My Event Is Now!</Entry>\n'
'</Event>\n'
'<Event>\n'
'\t<DateTime>2012-06-27T18:18:23+00:00</DateTime>\n'
'\t<Entry>There is no tomorrow.</Entry>\n'
'</Event>\n'
'<Event>\n'
'\t<DateTime>2012-06-27T19:11:54+00:00</DateTime>\n'
'\t<Entry>Tomorrow is now.</Entry>\n'
'</Event>\n'
'<Event>\n'
'\t<DateTime>2012-06-27T19:12:03+00:00</DateTime>\n'
'\t<Entry>This is just some stuff to fill the line.</Entry>\n'
'</Event>\n'
'</EventFile>\n')
output = output_writer.ReadOutput()
self.assertEqual(output, expected_output)
def testOutputList(self):
"""Test listing up all available registered modules."""
manager.OutputManager.RegisterOutput(TestXMLOutputModule)
test_output_class = None
for name, output_class in manager.OutputManager.GetOutputClasses():
if name == 'test_xml':
test_output_class = output_class
expected_description = 'Test output that provides a simple mocked XML.'
self.assertIsNotNone(test_output_class)
self.assertEqual(test_output_class.DESCRIPTION, expected_description)
manager.OutputManager.DeregisterOutput(TestXMLOutputModule)
if __name__ == '__main__':
unittest.main()
|
