def test_register_commands(self):
"""register subcommands."""
registry = CommandRegistry()
registry.register_commands(globals().values(), parent=MockSubcommand)
self.assertItemsEqual(registry.commands.keys(), ["one", "two", "help"])
self.assertIsInstance(registry.commands['one'], One)
self.assertIsInstance(registry.commands['two'], Two)
def test_register_commands(self):
"""register subcommands."""
registry = CommandRegistry()
registry.register_commands(globals().values(),
parent=MockSubcommand)
self.assertItemsEqual(registry.commands.keys(),
["one", "two", "help"])
self.assertIsInstance(registry.commands['one'], One)
self.assertIsInstance(registry.commands['two'], Two)
def setUp(self):
self.registry = CommandRegistry()
self.one = local_subclass(One)
self.two = local_subclass(Two)
self.registry.register_command(self.one)
self.registry.register_command(self.two)
self.result = argparse.Namespace()
Bcfg2.Options.Subcommands.master_setup = self.result
new_parser()
self.parser = get_parser(namespace=self.result, components=[self])
self.parser.add_options(self.registry.subcommand_options)
def setUp(self):
self.registry = CommandRegistry()
self.one = local_subclass(One)
self.two = local_subclass(Two)
self.registry.register_command(self.one)
self.registry.register_command(self.two)
self.result = argparse.Namespace()
Bcfg2.Options.Subcommands.master_setup = self.result
new_parser()
self.parser = get_parser(namespace=self.result,
components=[self])
self.parser.add_options(self.registry.subcommand_options)
class TestSubcommands(OptionTestCase):
"""tests for subcommands and subparsers."""
def setUp(self):
self.registry = CommandRegistry()
self.one = local_subclass(One)
self.two = local_subclass(Two)
self.registry.register_command(self.one)
self.registry.register_command(self.two)
self.result = argparse.Namespace()
Bcfg2.Options.Subcommands.master_setup = self.result
new_parser()
self.parser = get_parser(namespace=self.result, components=[self])
self.parser.add_options(self.registry.subcommand_options)
def test_register_commands(self):
"""register subcommands."""
registry = CommandRegistry()
registry.register_commands(globals().values(), parent=MockSubcommand)
self.assertItemsEqual(registry.commands.keys(), ["one", "two", "help"])
self.assertIsInstance(registry.commands['one'], One)
self.assertIsInstance(registry.commands['two'], Two)
@make_config()
def test_get_subcommand(self, config_file):
"""parse simple subcommands."""
self.parser.parse(["-C", config_file, "localone"])
self.assertEqual(self.result.subcommand, "localone")
def test_subcommand_usage(self):
"""sane usage message from subcommands."""
self.assertEqual(
One().usage(),
"one [--test-one TEST_ONE] - fake subcommand for testing.")
# subclasses do not inherit the docstring from the parent, so
# this tests a command subclass without a docstring, even
# though that should never happen due to the pylint tests.
self.assertEqual(self.one().usage().strip(),
"localone [--test-one TEST_ONE]")
def _get_subcommand_output(self, args):
self.parser.parse(args)
old_stdout = sys.stdout
sys.stdout = StringIO()
rv = self.registry.runcommand()
output = [
l for l in sys.stdout.getvalue().splitlines()
if not l.startswith("DEBUG: ")
]
sys.stdout = old_stdout
return (rv, output)
@make_config()
def test_help(self, config_file):
"""sane help message from subcommand registry."""
rv, output = self._get_subcommand_output(["-C", config_file, "help"])
self.assertIn(rv, [0, None])
# the help message will look like:
#
# localhelp [<command>]
# localone [--test-one TEST_ONE]
# localtwo [--test-two TEST_TWO]
commands = []
command_help = {
"help": self.registry.help.usage(),
"localone": self.one().usage(),
"localtwo": self.two().usage()
}
for line in output:
command = line.split()[0]
commands.append(command)
if command not in command_help:
self.fail("Got help for unknown command %s: %s" %
(command, line))
self.assertEqual(line, command_help[command])
self.assertItemsEqual(commands, command_help.keys())
@make_config()
def test_subcommand_help(self, config_file):
"""get help message on a single command."""
rv, output = self._get_subcommand_output(
["-C", config_file, "help", "localone"])
self.assertIn(rv, [0, None])
self.assertEqual(output[0].strip(),
"usage: %s" % self.one().usage().strip())
@make_config()
def test_nonexistent_subcommand_help(self, config_file):
"""get help message on a nonexistent command."""
rv, output = self._get_subcommand_output(
["-C", config_file, "help", "blargle"])
self.assertNotEqual(rv, 0)
self.assertIn("No such command", output[0])
class TestSubcommands(OptionTestCase):
"""tests for subcommands and subparsers."""
def setUp(self):
self.registry = CommandRegistry()
self.one = local_subclass(One)
self.two = local_subclass(Two)
self.registry.register_command(self.one)
self.registry.register_command(self.two)
self.result = argparse.Namespace()
Bcfg2.Options.Subcommands.master_setup = self.result
new_parser()
self.parser = get_parser(namespace=self.result,
components=[self])
self.parser.add_options(self.registry.subcommand_options)
def test_register_commands(self):
"""register subcommands."""
registry = CommandRegistry()
registry.register_commands(globals().values(),
parent=MockSubcommand)
self.assertItemsEqual(registry.commands.keys(),
["one", "two", "help"])
self.assertIsInstance(registry.commands['one'], One)
self.assertIsInstance(registry.commands['two'], Two)
@make_config()
def test_get_subcommand(self, config_file):
"""parse simple subcommands."""
self.parser.parse(["-C", config_file, "localone"])
self.assertEqual(self.result.subcommand, "localone")
def test_subcommand_usage(self):
"""sane usage message from subcommands."""
self.assertEqual(
One().usage(),
"one [--test-one TEST_ONE] - fake subcommand for testing.")
# subclasses do not inherit the docstring from the parent, so
# this tests a command subclass without a docstring, even
# though that should never happen due to the pylint tests.
self.assertEqual(self.one().usage().strip(),
"localone [--test-one TEST_ONE]")
def _get_subcommand_output(self, args):
self.parser.parse(args)
old_stdout = sys.stdout
sys.stdout = StringIO()
rv = self.registry.runcommand()
output = [l for l in sys.stdout.getvalue().splitlines()
if not l.startswith("DEBUG: ")]
sys.stdout = old_stdout
return (rv, output)
@make_config()
def test_help(self, config_file):
"""sane help message from subcommand registry."""
rv, output = self._get_subcommand_output(["-C", config_file, "help"])
self.assertIn(rv, [0, None])
# the help message will look like:
#
# localhelp [<command>]
# localone [--test-one TEST_ONE]
# localtwo [--test-two TEST_TWO]
commands = []
command_help = {
"help": self.registry.help.usage(),
"localone": self.one().usage(),
"localtwo": self.two().usage()}
for line in output:
command = line.split()[0]
commands.append(command)
if command not in command_help:
self.fail("Got help for unknown command %s: %s" %
(command, line))
self.assertEqual(line, command_help[command])
self.assertItemsEqual(commands, command_help.keys())
@make_config()
def test_subcommand_help(self, config_file):
"""get help message on a single command."""
rv, output = self._get_subcommand_output(
["-C", config_file, "help", "localone"])
self.assertIn(rv, [0, None])
self.assertEqual(output[0].strip(),
"usage: %s" % self.one().usage().strip())
@make_config()
def test_nonexistent_subcommand_help(self, config_file):
"""get help message on a nonexistent command."""
rv, output = self._get_subcommand_output(
["-C", config_file, "help", "blargle"])
self.assertNotEqual(rv, 0)
self.assertIn("No such command", output[0])
