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
|
# -*- coding: utf-8 -*-
"""CLI related functions and classes for testing."""
from __future__ import unicode_literals
import argparse
import io
import operator
import os
from plaso.cli import tools
from tests import test_lib as shared_test_lib
class SortedArgumentsHelpFormatter(argparse.HelpFormatter):
"""Class that implements an argparse help formatter with sorted arguments."""
def add_arguments(self, actions):
"""Adds arguments.
Args:
actions (list[argparse._StoreAction]): command line actions.
"""
actions = sorted(actions, key=operator.attrgetter('option_strings'))
super(SortedArgumentsHelpFormatter, self).add_arguments(actions)
class TestOptions(object):
"""Class to define test options."""
class TestOutputWriter(tools.FileObjectOutputWriter):
"""Test output writer that reads and writes strings."""
def __init__(self, encoding='utf-8'):
"""Initializes the output writer object.
Args:
encoding (Optional[str]): output encoding.
"""
file_object = io.StringIO()
super(TestOutputWriter, self).__init__(file_object, encoding=encoding)
self._read_offset = 0
def Write(self, string):
"""Writes a string to the output.
Args:
string (str): output.
"""
# To mimic the behavior of the parent FileObjectOutputWriter, we encode the
# provided string into the specified encoding, replacing invalid characters.
byte_stream = string.encode(self._encoding, errors='replace')
string = byte_stream.decode(self._encoding, errors='strict')
self._file_object.write(string)
def ReadOutput(self):
"""Reads all output added since the last call to ReadOutput.
Returns:
str: output data.
"""
self._file_object.seek(self._read_offset, os.SEEK_SET)
output_data = self._file_object.read()
self._read_offset = self._file_object.tell()
return output_data
class TestBinaryOutputWriter(tools.FileObjectOutputWriter):
"""Test output writer that reads and writes bytes."""
def __init__(self, encoding='utf-8'):
"""Initializes the output writer object.
Args:
encoding (Optional[str]): output encoding.
"""
file_object = io.BytesIO()
super(TestBinaryOutputWriter, self).__init__(file_object, encoding=encoding)
self._read_offset = 0
def ReadOutput(self):
"""Reads all output added since the last call to ReadOutput.
Returns:
bytes: output data.
"""
self._file_object.seek(self._read_offset, os.SEEK_SET)
output_data = self._file_object.read()
self._read_offset = self._file_object.tell()
return output_data
class CLIToolTestCase(shared_test_lib.BaseTestCase):
"""The unit test case for a CLI tool."""
def _RunArgparseFormatHelp(self, argument_parser):
"""Runs argparse.format_help() with test conditions.
Args:
argument_parser (argparse.ArgumentParser): argument parser.
Returns:
bytes: output of argparse.format_help().
"""
columns_environment_variable = os.environ.get('COLUMNS', None)
os.environ['COLUMNS'] = '80'
try:
output = argument_parser.format_help()
finally:
if columns_environment_variable:
os.environ['COLUMNS'] = columns_environment_variable
else:
del os.environ['COLUMNS']
return output
|
