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
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Tests for the view classes."""
from __future__ import unicode_literals
import sys
import unittest
from plaso.cli import views
from tests import test_lib as shared_test_lib
from tests.cli import test_lib
class TestBaseTableView(views.BaseTableView):
"""Class that implements a table view for testing."""
# pylint: disable=unused-argument
def Write(self, output_writer):
"""Writes the table to the output writer.
Args:
output_writer (OutputWriter): output writer.
"""
return
class BaseTableViewTests(shared_test_lib.BaseTestCase):
"""Tests for the table view interface class."""
def testAddRow(self):
"""Tests the AddRow function."""
table_view = TestBaseTableView(
column_names=['one', 'two', 'three'])
# Adding rows with the same number of values as columns is permitted.
table_view.AddRow(['1', '2', '3'])
# Adding rows with a different number of values as columns is not permitted.
with self.assertRaises(ValueError):
table_view.AddRow(['4', '5'])
table_view.AddRow(['4', '5', '6'])
table_view = TestBaseTableView()
table_view.AddRow(['1', '2', '3'])
# Adding rows with the same number of values is permitted.
table_view.AddRow(['4', '5', '6'])
# Adding rows with a different number of values is not permitted.
with self.assertRaises(ValueError):
table_view.AddRow(['7', '8'])
class CLITableViewTests(shared_test_lib.BaseTestCase):
"""Tests for the command line table view class."""
def testWrite(self):
"""Tests the Write function."""
output_writer = test_lib.TestBinaryOutputWriter()
# Table with columns.
table_view = views.CLITableView(
column_names=['Name', 'Description'], title='Title')
table_view.AddRow(['First name', 'The first name in the table'])
table_view.AddRow(['Second name', 'The second name in the table'])
table_view.Write(output_writer)
string = output_writer.ReadOutput()
expected_string = (
b'\n'
b'************************************ '
b'Title '
b'*************************************\n'
b' Name : Description\n'
b'----------------------------------------'
b'----------------------------------------\n'
b' First name : The first name in the table\n'
b'Second name : The second name in the table\n'
b'----------------------------------------'
b'----------------------------------------\n')
# Splitting the string makes it easier to see differences.
self.assertEqual(string.split(b'\n'), expected_string.split(b'\n'))
# Table without columns.
table_view = views.CLITableView(title='Title')
table_view.AddRow(['Name', 'The name in the table'])
table_view.AddRow(['Description', 'The description in the table'])
table_view.Write(output_writer)
string = output_writer.ReadOutput()
expected_string = (
b'\n'
b'************************************ '
b'Title '
b'*************************************\n'
b' Name : The name in the table\n'
b'Description : The description in the table\n'
b'----------------------------------------'
b'----------------------------------------\n')
# Splitting the string makes it easier to see differences.
self.assertEqual(string.split(b'\n'), expected_string.split(b'\n'))
# TODO: add test without title.
# Table with a too large title.
# TODO: determine if this is the desired behavior.
title = (
'In computer programming, a string is traditionally a sequence '
'of characters, either as a literal constant or as some kind of '
'variable.')
table_view = views.CLITableView(
column_names=['Name', 'Description'], title=title)
table_view.AddRow(['First name', 'The first name in the table'])
table_view.AddRow(['Second name', 'The second name in the table'])
with self.assertRaises(RuntimeError):
table_view.Write(output_writer)
class CLITabularTableView(shared_test_lib.BaseTestCase):
"""Tests for the command line tabular table view class."""
def testWrite(self):
"""Tests the Write function."""
output_writer = test_lib.TestBinaryOutputWriter()
table_view = views.CLITabularTableView(
column_names=['Name', 'Description'])
table_view.AddRow(['First name', 'The first name in the table'])
table_view.AddRow(['Second name', 'The second name in the table'])
table_view.Write(output_writer)
string = output_writer.ReadOutput()
expected_strings = [
b'Name Description',
b'First name The first name in the table',
b'Second name The second name in the table',
b'']
if not sys.platform.startswith('win'):
expected_strings[0] = b'\x1b[1mName Description\x1b[0m'
self.assertEqual(string.split(b'\n'), expected_strings)
class MarkdownTableViewTests(shared_test_lib.BaseTestCase):
"""Tests for the Markdown table view class."""
def testWrite(self):
"""Tests the Write function."""
output_writer = test_lib.TestBinaryOutputWriter()
# Table with columns.
table_view = views.MarkdownTableView(
column_names=['Name', 'Description'], title='Title')
table_view.AddRow(['First name', 'The first name in the table'])
table_view.AddRow(['Second name', 'The second name in the table'])
table_view.Write(output_writer)
string = output_writer.ReadOutput()
expected_string = (
b'### Title\n'
b'\n'
b'Name | Description\n'
b'--- | ---\n'
b'First name | The first name in the table\n'
b'Second name | The second name in the table\n'
b'\n')
# Splitting the string makes it easier to see differences.
self.assertEqual(string.split(b'\n'), expected_string.split(b'\n'))
# Table without columns.
table_view = views.MarkdownTableView(title='Title')
table_view.AddRow(['Name', 'The name in the table'])
table_view.AddRow(['Description', 'The description in the table'])
table_view.Write(output_writer)
string = output_writer.ReadOutput()
expected_string = (
b'### Title\n'
b'\n'
b' | \n'
b'--- | ---\n'
b'Name | The name in the table\n'
b'Description | The description in the table\n'
b'\n')
# Splitting the string makes it easier to see differences.
self.assertEqual(string.split(b'\n'), expected_string.split(b'\n'))
# TODO: add test without title.
if __name__ == '__main__':
unittest.main()
|
