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
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Tests for the database configuration CLI arguments helper."""
from __future__ import unicode_literals
import argparse
import unittest
from plaso.cli.helpers import database_config
from plaso.lib import errors
from tests.cli import test_lib as cli_test_lib
class MockPartialOutputModule(object):
"""Mock of a partial output module for testing.
Attributes:
hostname (str): hostname or IP address of the database server.
password (str): password to access the database.
port (int): port number of the database server.
username (str): username to access the database.
"""
def __init__(self):
"""Initializes a partial mock output module."""
super(MockPartialOutputModule, self).__init__()
self.hostname = None
self.password = None
self.port = None
self.username = None
def SetCredentials(self, password=None, username=None):
"""Sets the database credentials.
Args:
password (Optional[str]): password to access the database.
username (Optional[str]): username to access the database.
"""
self.password = password
self.username = username
def SetServerInformation(self, server, port):
"""Sets the server information.
Args:
server (str): hostname or IP address of the database server.
port (int): port number of the database server.
"""
self.hostname = server
self.port = port
class MockOutputModule(MockPartialOutputModule):
"""Mock output module for testing.
Attributes:
database_name (str): name of the database.
"""
def __init__(self):
"""Initializes a mock output module."""
super(MockOutputModule, self).__init__()
self.database_name = None
def SetDatabaseName(self, name):
"""Sets the database name.
Args:
name (str): name of the database.
"""
self.database_name = name
class DatabaseArgumentsHelperTest(cli_test_lib.CLIToolTestCase):
"""Tests the database configuration CLI arguments helper."""
# pylint: disable=no-member,protected-access
_EXPECTED_OUTPUT = """\
usage: cli_helper.py [--user USERNAME] [--password PASSWORD]
[--db_name DB_NAME] [--server HOSTNAME] [--port PORT]
Test argument parser.
optional arguments:
--db_name DB_NAME, --db-name DB_NAME
The name of the database to connect to.
--password PASSWORD The password for the database user.
--port PORT The port number of the server.
--server HOSTNAME The hostname or server IP address of the server.
--user USERNAME The username used to connect to the database.
"""
def testAddArguments(self):
"""Tests the AddArguments function."""
argument_parser = argparse.ArgumentParser(
prog='cli_helper.py',
description='Test argument parser.', add_help=False,
formatter_class=cli_test_lib.SortedArgumentsHelpFormatter)
database_config.DatabaseArgumentsHelper.AddArguments(argument_parser)
output = self._RunArgparseFormatHelp(argument_parser)
self.assertEqual(output, self._EXPECTED_OUTPUT)
def testParseOptions(self):
"""Tests the ParseOptions function."""
options = cli_test_lib.TestOptions()
output_module = MockOutputModule()
database_config.DatabaseArgumentsHelper.ParseOptions(options, output_module)
with self.assertRaises(errors.BadConfigObject):
database_config.DatabaseArgumentsHelper.ParseOptions(options, None)
output_module = MockPartialOutputModule()
with self.assertRaises(errors.BadConfigObject):
database_config.DatabaseArgumentsHelper.ParseOptions(
options, output_module)
if __name__ == '__main__':
unittest.main()
|