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
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Tests for the CLI tool options mix-ins."""
from __future__ import unicode_literals
import unittest
from plaso.cli import tool_options
from plaso.cli import tools
from plaso.output import manager as output_manager
from plaso.parsers import manager as parsers_manager
from tests import test_lib as shared_test_lib
from tests.cli import test_lib
class TestToolWithAnalysisPluginOptions(
tools.CLITool, tool_options.AnalysisPluginOptions):
"""Tool to test the analysis plugin options."""
def __init__(self, input_reader=None, output_writer=None):
"""Initializes the CLI tool object.
Args:
input_reader (Optional[InputReader]): input reader, where None indicates
that the stdin input reader should be used.
output_writer (Optional[OutputWriter]): output writer, where None
indicates that the stdout output writer should be used.
"""
super(TestToolWithAnalysisPluginOptions, self).__init__(
input_reader=input_reader, output_writer=output_writer)
self._analysis_plugins = None
class AnalysisPluginOptionsTest(test_lib.CLIToolTestCase):
"""Tests for the analysis plugin options."""
# pylint: disable=protected-access
@shared_test_lib.skipUnlessHasTestFile(['tagging_file', 'valid.txt'])
def testCreateAnalysisPlugins(self):
"""Tests the _CreateAnalysisPlugins function."""
output_writer = test_lib.TestOutputWriter(encoding='utf-8')
test_tool = TestToolWithAnalysisPluginOptions(output_writer=output_writer)
options = test_lib.TestOptions()
options.tagging_file = self._GetTestFilePath(['tagging_file', 'valid.txt'])
test_tool._analysis_plugins = 'tagging'
plugins = test_tool._CreateAnalysisPlugins(options)
self.assertIn('tagging', plugins.keys())
test_tool._analysis_plugins = 'bogus'
plugins = test_tool._CreateAnalysisPlugins(options)
self.assertEqual(plugins, {})
test_tool._analysis_plugins = ''
plugins = test_tool._CreateAnalysisPlugins(options)
self.assertEqual(plugins, {})
def testListAnalysisPlugins(self):
"""Tests the ListAnalysisPlugins function."""
output_writer = test_lib.TestOutputWriter(encoding='utf-8')
test_tool = TestToolWithAnalysisPluginOptions(output_writer=output_writer)
test_tool.ListAnalysisPlugins()
output = output_writer.ReadOutput()
number_of_tables = 0
lines = []
for line in output.split('\n'):
line = line.strip()
lines.append(line)
if line.startswith('*****') and line.endswith('*****'):
number_of_tables += 1
self.assertIn('Analysis Plugins', lines[1])
lines = frozenset(lines)
self.assertEqual(number_of_tables, 1)
expected_line = (
'browser_search : Analyze browser search entries from events.')
self.assertIn(expected_line, lines)
class TestToolWithHashersOptions(
tools.CLITool, tool_options.HashersOptions):
"""Tool to test the hashers options."""
class HashersOptionsTest(test_lib.CLIToolTestCase):
"""Tests for the hashers options."""
def testListHashers(self):
"""Tests the ListHashers function."""
output_writer = test_lib.TestOutputWriter(encoding='utf-8')
test_tool = TestToolWithHashersOptions(output_writer=output_writer)
test_tool.ListHashers()
output = output_writer.ReadOutput()
number_of_tables = 0
lines = []
for line in output.split('\n'):
line = line.strip()
lines.append(line)
if line.startswith('*****') and line.endswith('*****'):
number_of_tables += 1
self.assertIn('Hashers', lines[1])
lines = frozenset(lines)
self.assertEqual(number_of_tables, 1)
expected_line = 'md5 : Calculates an MD5 digest hash over input data.'
self.assertIn(expected_line, lines)
class TestToolWithOutputModuleOptions(
tools.CLITool, tool_options.OutputModuleOptions):
"""Tool to test the output module options."""
class OutputModuleOptionsTest(test_lib.CLIToolTestCase):
"""Tests for the output module options."""
# pylint: disable=protected-access
def testGetOutputModulesInformation(self):
"""Tests the _GetOutputModulesInformation function."""
test_tool = TestToolWithOutputModuleOptions()
modules_info = test_tool._GetOutputModulesInformation()
self.assertIsNotNone(modules_info)
available_module_names = [name for name, _ in modules_info]
self.assertIn('dynamic', available_module_names)
self.assertIn('json', available_module_names)
def testListOutputModules(self):
"""Tests the ListOutputModules function."""
output_writer = test_lib.TestOutputWriter(encoding='utf-8')
test_tool = TestToolWithOutputModuleOptions(output_writer=output_writer)
test_tool.ListOutputModules()
output = output_writer.ReadOutput()
number_of_tables = 0
lines = []
for line in output.split('\n'):
line = line.strip()
lines.append(line)
if line.startswith('*****') and line.endswith('*****'):
number_of_tables += 1
self.assertIn('Output Modules', lines[1])
lines = frozenset(lines)
disabled_outputs = list(
output_manager.OutputManager.GetDisabledOutputClasses())
enabled_outputs = list(output_manager.OutputManager.GetOutputClasses())
expected_number_of_tables = 0
if disabled_outputs:
expected_number_of_tables += 1
if enabled_outputs:
expected_number_of_tables += 1
self.assertEqual(number_of_tables, expected_number_of_tables)
expected_line = 'rawpy : "raw" (or native) Python output.'
self.assertIn(expected_line, lines)
class TestToolWithParsersOptions(
tools.CLITool, tool_options.ParsersOptions):
"""Tool to test the parsers options."""
@shared_test_lib.skipUnlessHasTestFile(['presets.yaml'])
class ParsersOptionsTest(test_lib.CLIToolTestCase):
"""Tests for the parsers options."""
# pylint: disable=protected-access
def testGetParserPresetsInformation(self):
"""Tests the _GetParserPresetsInformation function."""
test_tool = TestToolWithParsersOptions()
presets_file = self._GetTestFilePath(['presets.yaml'])
parsers_manager.ParsersManager.ReadPresetsFromFile(presets_file)
parser_presets_information = test_tool._GetParserPresetsInformation()
self.assertGreaterEqual(len(parser_presets_information), 1)
available_parser_names = [name for name, _ in parser_presets_information]
self.assertIn('linux', available_parser_names)
def testListParsersAndPlugins(self):
"""Tests the ListParsersAndPlugins function."""
output_writer = test_lib.TestOutputWriter(encoding='utf-8')
test_tool = TestToolWithParsersOptions(output_writer=output_writer)
presets_file = self._GetTestFilePath(['presets.yaml'])
parsers_manager.ParsersManager.ReadPresetsFromFile(presets_file)
test_tool.ListParsersAndPlugins()
output = output_writer.ReadOutput()
number_of_tables = 0
lines = []
for line in output.split('\n'):
line = line.strip()
lines.append(line)
if line.startswith('*****') and line.endswith('*****'):
number_of_tables += 1
self.assertIn('Parsers', lines[1])
lines = frozenset(lines)
self.assertEqual(number_of_tables, 10)
expected_line = 'filestat : Parser for file system stat information.'
self.assertIn(expected_line, lines)
expected_line = 'bencode_utorrent : Parser for uTorrent bencoded files.'
self.assertIn(expected_line, lines)
expected_line = (
'msie_webcache : Parser for MSIE WebCache ESE database files.')
self.assertIn(expected_line, lines)
expected_line = 'olecf_default : Parser for a generic OLECF item.'
self.assertIn(expected_line, lines)
expected_line = 'plist_default : Parser for plist files.'
self.assertIn(expected_line, lines)
# Note that the expected line is truncated by the cell wrapping in
# the table.
expected_line = (
'chrome_27_history : Parser for Google Chrome 27 and up history SQLite')
self.assertIn(expected_line, lines)
expected_line = 'ssh : Parser for SSH syslog entries.'
self.assertIn(expected_line, lines)
expected_line = 'winreg_default : Parser for Registry data.'
self.assertIn(expected_line, lines)
class TestToolWithProfilingOptions(
tools.CLITool, tool_options.ProfilingOptions):
"""Tool to test the profiling options."""
class ProfilingOptionsTest(test_lib.CLIToolTestCase):
"""Tests for the profiling options."""
# pylint: disable=protected-access
def testListProfilers(self):
"""Tests the ListProfilers function."""
output_writer = test_lib.TestOutputWriter(encoding='utf-8')
test_tool = TestToolWithProfilingOptions(output_writer=output_writer)
test_tool.ListProfilers()
string = output_writer.ReadOutput()
expected_string = (
'\n'
'********************************** Profilers '
'***********************************\n'
' Name : Description\n'
'----------------------------------------'
'----------------------------------------\n')
self.assertTrue(string.startswith(expected_string))
class TestToolWithStorageFileOptions(
tools.CLITool, tool_options.StorageFileOptions):
"""Tool to test the storage file options."""
class StorageFileOptionsTest(test_lib.CLIToolTestCase):
"""Tests for the storage file options."""
# TODO: add test for _CheckStorageFile
if __name__ == '__main__':
unittest.main()
|
