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
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Tests for the status view."""
from __future__ import unicode_literals
import unittest
try:
import mock # pylint: disable=import-error
except ImportError:
from unittest import mock
import sys
from dfvfs.lib import definitions as dfvfs_definitions
import plaso
from plaso.cli import status_view
from plaso.engine import processing_status
from tests.cli import test_lib
class StatusViewTest(test_lib.CLIToolTestCase):
"""Tests for the status view."""
# pylint: disable=protected-access
def _MockTime(self):
"""Mock function to simulate time.time()
Returns:
int: stored time via self._mocked_time"""
return self._mocked_time
def setUp(self):
"""Makes preparations before running an individual test."""
self.mock_time = mock.patch(
'plaso.cli.status_view.time.time', self._MockTime)
self._mocked_time = 0
self.mock_time.start()
def tearDown(self):
"""Cleans up after running an individual test."""
self.mock_time.stop()
def _CheckOutput(self, output, expected_output):
"""Compares the output against the expected output.
The actual processing time is ignored, since it can vary.
Args:
output (str): tool output.
expected_output (list[str]): expected tool output.
"""
output = output.split('\n')
self.assertEqual(output[:4], expected_output[:4])
self.assertTrue(output[4].startswith('Processing time\t\t: '))
self.assertEqual(output[5:], expected_output[5:])
# TODO: add tests for _ClearScreen
# TODO: add tests for _FormatAnalysisStatusTableRow
# TODO: add tests for _FormatExtractionStatusTableRow
# TODO: add tests for _FormatSizeInUnitsOf1024
# TODO: add tests for _PrintAnalysisStatusHeader
# TODO: add tests for _PrintAnalysisStatusUpdateLinear
# TODO: add tests for _PrintAnalysisStatusUpdateWindow
# TODO: add tests for _PrintEventsStatus
def testPrintExtractionStatusUpdateLinear(self):
"""Tests the PrintExtractionStatusUpdateLinear function."""
output_writer = test_lib.TestOutputWriter()
test_view = status_view.StatusView(output_writer, 'test_tool')
test_view.SetSourceInformation(
'/test/source/path', dfvfs_definitions.SOURCE_TYPE_DIRECTORY)
process_status = processing_status.ProcessingStatus()
process_status.UpdateForemanStatus(
'f_identifier', 'f_status', 123, 0,
'f_test_file', 1, 29, 3, 456, 5, 6, 9, 10, 7, 8)
test_view._PrintExtractionStatusUpdateLinear(process_status)
expected_output = (
'Processing time: 00:00:00\n'
'f_identifier (PID: 123) status: f_status, events produced: 456, '
'file: f_test_file\n'
'\n')
output = output_writer.ReadOutput()
self.assertEqual(output, expected_output)
process_status.UpdateWorkerStatus(
'w_identifier', 'w_status', 123, 0,
'w_test_file', 1, 2, 3, 4, 5, 6, 9, 10, 7, 8)
test_view._PrintExtractionStatusUpdateLinear(process_status)
expected_output = (
'Processing time: 00:00:00\n'
'f_identifier (PID: 123) status: f_status, events produced: 456, '
'file: f_test_file\n'
'w_identifier (PID: 123) status: w_status, events produced: 4, '
'file: w_test_file\n'
'\n')
output = output_writer.ReadOutput()
self.assertEqual(output, expected_output)
def testPrintExtractionStatusUpdateWindow(self):
"""Tests the _PrintExtractionStatusUpdateWindow function."""
output_writer = test_lib.TestOutputWriter()
test_view = status_view.StatusView(output_writer, 'test_tool')
test_view.SetSourceInformation(
'/test/source/path', dfvfs_definitions.SOURCE_TYPE_DIRECTORY)
process_status = processing_status.ProcessingStatus()
process_status.UpdateForemanStatus(
'f_identifier', 'f_status', 123, 0,
'f_test_file', 1, 29, 3, 456, 5, 6, 9, 10, 7, 8)
test_view._PrintExtractionStatusUpdateWindow(process_status)
table_header = (
'Identifier '
'PID '
'Status '
'Memory '
'Sources '
'Events '
'File')
if not sys.platform.startswith('win'):
table_header = '\x1b[1m{0:s}\x1b[0m'.format(table_header)
expected_output = [
'plaso - test_tool version {0:s}'.format(plaso.__version__),
'',
'Source path\t\t: /test/source/path',
'Source type\t\t: directory',
'Processing time\t\t: 00:00:00',
'',
table_header,
('f_identifier '
'123 '
'f_status '
'0 B '
'29 (29) '
'456 (456) '
'f_test_file'),
'',
'']
output = output_writer.ReadOutput()
self._CheckOutput(output, expected_output)
process_status.UpdateWorkerStatus(
'w_identifier', 'w_status', 123, 0,
'w_test_file', 1, 2, 3, 4, 5, 6, 9, 10, 7, 8)
test_view._PrintExtractionStatusUpdateWindow(process_status)
expected_output = [
'plaso - test_tool version {0:s}'.format(plaso.__version__),
'',
'Source path\t\t: /test/source/path',
'Source type\t\t: directory',
'Processing time\t\t: 00:00:00',
'',
table_header,
('f_identifier '
'123 '
'f_status '
'0 B '
'29 (29) '
'456 (456) '
'f_test_file'),
('w_identifier '
'123 '
'w_status '
'0 B '
'2 (2) '
'4 (4) '
'w_test_file'),
'',
'']
output = output_writer.ReadOutput()
self._CheckOutput(output, expected_output)
def testFormatProcessingTime(self):
"""Tests the _FormatProcessingTime function."""
output_writer = test_lib.TestOutputWriter()
process_status = processing_status.ProcessingStatus()
test_view = status_view.StatusView(output_writer, 'test_tool')
test_view.SetSourceInformation(
'/test/source/path', dfvfs_definitions.SOURCE_TYPE_DIRECTORY)
process_status.start_time = 0
processing_time = test_view._FormatProcessingTime(process_status)
self.assertEqual(processing_time, '00:00:00')
self._mocked_time = 12 * 60 * 60 + 31 * 60 +15
processing_time = test_view._FormatProcessingTime(process_status)
self.assertEqual(processing_time, '12:31:15')
self._mocked_time = 24 * 60 * 60
processing_time = test_view._FormatProcessingTime(process_status)
self.assertEqual(processing_time, '1 day, 00:00:00')
self._mocked_time = 5 * 24 * 60 * 60 + 5 * 60 * 60 + 61
processing_time = test_view._FormatProcessingTime(process_status)
self.assertEqual(processing_time, '5 days, 05:01:01')
# TODO: add tests for _PrintTasksStatus
# TODO: add tests for GetAnalysisStatusUpdateCallback
# TODO: add tests for GetExtractionStatusUpdateCallback
# TODO: add tests for PrintAnalysisReportsDetails
def testPrintExtractionStatusHeader(self):
"""Tests the PrintExtractionStatusHeader function."""
output_writer = test_lib.TestOutputWriter()
test_view = status_view.StatusView(output_writer, 'test_tool')
test_view.SetSourceInformation(
'/test/source/path', dfvfs_definitions.SOURCE_TYPE_DIRECTORY)
test_view.PrintExtractionStatusHeader(None)
# TODO: add tests for PrintExtractionSummary
# TODO: add tests for SetMode
# TODO: add tests for SetSourceInformation
# TODO: add tests for SetStorageFileInformation
if __name__ == '__main__':
unittest.main()
|
