443 lines
16 KiB
Python
443 lines
16 KiB
Python
from __future__ import unicode_literals
|
|
|
|
import argparse
|
|
import mock
|
|
import unittest
|
|
|
|
from mopidy.utils import command
|
|
|
|
|
|
class CommandParsingTest(unittest.TestCase):
|
|
def test_command_parsing_returns_namespace(self):
|
|
cmd = command.Command()
|
|
self.assertIsInstance(cmd.parse([]), argparse.Namespace)
|
|
|
|
def test_command_parsing_does_not_contain_args(self):
|
|
cmd = command.Command()
|
|
result = cmd.parse([])
|
|
self.assertFalse(hasattr(result, '_args'))
|
|
|
|
def test_unknown_options_raises_error(self):
|
|
cmd = command.Command()
|
|
with self.assertRaises(command.CommandError):
|
|
cmd.parse(['--foobar'])
|
|
|
|
def test_invalid_sub_command_raises_error(self):
|
|
cmd = command.Command()
|
|
with self.assertRaises(command.CommandError):
|
|
cmd.parse(['foo'])
|
|
|
|
def test_command_arguments(self):
|
|
cmd = command.Command()
|
|
cmd.add_argument('--bar')
|
|
|
|
result = cmd.parse(['--bar', 'baz'])
|
|
self.assertEqual(result.bar, 'baz')
|
|
|
|
def test_command_arguments_and_sub_command(self):
|
|
child = command.Command()
|
|
child.add_argument('--baz')
|
|
|
|
cmd = command.Command()
|
|
cmd.add_argument('--bar')
|
|
cmd.add_child('foo', child)
|
|
|
|
result = cmd.parse(['--bar', 'baz', 'foo'])
|
|
self.assertEqual(result.bar, 'baz')
|
|
self.assertEqual(result.baz, None)
|
|
|
|
def test_subcommand_may_have_positional(self):
|
|
child = command.Command()
|
|
child.add_argument('bar')
|
|
|
|
cmd = command.Command()
|
|
cmd.add_child('foo', child)
|
|
|
|
result = cmd.parse(['foo', 'baz'])
|
|
self.assertEqual(result.bar, 'baz')
|
|
|
|
def test_subcommand_may_have_remainder(self):
|
|
child = command.Command()
|
|
child.add_argument('bar', nargs=argparse.REMAINDER)
|
|
|
|
cmd = command.Command()
|
|
cmd.add_child('foo', child)
|
|
|
|
result = cmd.parse(['foo', 'baz', 'bep', 'bop'])
|
|
self.assertEqual(result.bar, ['baz', 'bep', 'bop'])
|
|
|
|
def test_result_stores_choosen_command(self):
|
|
child = command.Command()
|
|
|
|
cmd = command.Command()
|
|
cmd.add_child('foo', child)
|
|
|
|
result = cmd.parse(['foo'])
|
|
self.assertEqual(result.command, child)
|
|
|
|
result = cmd.parse([])
|
|
self.assertEqual(result.command, cmd)
|
|
|
|
child2 = command.Command()
|
|
cmd.add_child('bar', child2)
|
|
|
|
subchild = command.Command()
|
|
child.add_child('baz', subchild)
|
|
|
|
result = cmd.parse(['bar'])
|
|
self.assertEqual(result.command, child2)
|
|
|
|
result = cmd.parse(['foo', 'baz'])
|
|
self.assertEqual(result.command, subchild)
|
|
|
|
def test_invalid_type(self):
|
|
cmd = command.Command()
|
|
cmd.add_argument('--bar', type=int)
|
|
|
|
with self.assertRaises(command.CommandError) as cm:
|
|
cmd.parse(['--bar', b'zero'], prog='foo')
|
|
|
|
self.assertEqual(cm.exception.message,
|
|
"argument --bar: invalid int value: 'zero'")
|
|
self.assertEqual(cm.exception.usage, 'usage: foo [--bar BAR]')
|
|
|
|
@mock.patch('sys.argv')
|
|
def test_command_error_usage_prog(self, argv_mock):
|
|
argv_mock.__getitem__.return_value = '/usr/bin/foo'
|
|
|
|
cmd = command.Command()
|
|
cmd.add_argument('--bar', required=True)
|
|
|
|
with self.assertRaises(command.CommandError) as cm:
|
|
cmd.parse([])
|
|
self.assertEqual(cm.exception.usage, 'usage: foo --bar BAR')
|
|
|
|
with self.assertRaises(command.CommandError) as cm:
|
|
cmd.parse([], prog='baz')
|
|
self.assertEqual(cm.exception.usage, 'usage: baz --bar BAR')
|
|
|
|
def test_missing_required(self):
|
|
cmd = command.Command()
|
|
cmd.add_argument('--bar', required=True)
|
|
|
|
with self.assertRaises(command.CommandError) as cm:
|
|
cmd.parse([], prog='foo')
|
|
|
|
self.assertEqual(cm.exception.message, 'argument --bar is required')
|
|
self.assertEqual(cm.exception.usage, 'usage: foo --bar BAR')
|
|
|
|
def test_missing_positionals(self):
|
|
cmd = command.Command()
|
|
cmd.add_argument('bar')
|
|
|
|
with self.assertRaises(command.CommandError) as cm:
|
|
cmd.parse([], prog='foo')
|
|
|
|
self.assertEqual(cm.exception.message, 'too few arguments')
|
|
self.assertEqual(cm.exception.usage, 'usage: foo bar')
|
|
|
|
def test_missing_positionals_subcommand(self):
|
|
child = command.Command()
|
|
child.add_argument('baz')
|
|
|
|
cmd = command.Command()
|
|
cmd.add_child('bar', child)
|
|
|
|
with self.assertRaises(command.CommandError) as cm:
|
|
cmd.parse(['bar'], prog='foo')
|
|
|
|
self.assertEqual(cm.exception.message, 'too few arguments')
|
|
self.assertEqual(cm.exception.usage, 'usage: foo bar baz')
|
|
|
|
def test_unknown_command(self):
|
|
cmd = command.Command()
|
|
|
|
with self.assertRaises(command.CommandError) as cm:
|
|
cmd.parse(['--help'], prog='foo')
|
|
|
|
self.assertEqual(
|
|
cm.exception.message, 'unrecognized arguments: --help')
|
|
self.assertEqual(cm.exception.usage, 'usage: foo')
|
|
|
|
def test_invalid_subcommand(self):
|
|
cmd = command.Command()
|
|
cmd.add_child('baz', command.Command())
|
|
|
|
with self.assertRaises(command.CommandError) as cm:
|
|
cmd.parse(['bar'], prog='foo')
|
|
|
|
self.assertEqual(cm.exception.message, 'unrecognized command: bar')
|
|
self.assertEqual(cm.exception.usage, 'usage: foo')
|
|
|
|
def test_set_defaults(self):
|
|
cmd = command.Command()
|
|
cmd.set_defaults(foo='bar')
|
|
|
|
result = cmd.parse([])
|
|
self.assertEqual(result.foo, 'bar')
|
|
|
|
def test_defaults_propegate(self):
|
|
child = command.Command()
|
|
|
|
cmd = command.Command()
|
|
cmd.set_defaults(foo='bar')
|
|
cmd.add_child('command', child)
|
|
|
|
result = cmd.parse(['command'])
|
|
self.assertEqual(result.foo, 'bar')
|
|
|
|
def test_innermost_defaults_wins(self):
|
|
child = command.Command()
|
|
child.set_defaults(foo='bar')
|
|
|
|
cmd = command.Command()
|
|
cmd.set_defaults(foo='baz')
|
|
cmd.add_child('command', child)
|
|
|
|
result = cmd.parse(['command'])
|
|
self.assertEqual(result.foo, 'bar')
|
|
|
|
|
|
class UsageTest(unittest.TestCase):
|
|
@mock.patch('sys.argv')
|
|
def test_prog_name_default_and_override(self, argv_mock):
|
|
argv_mock.__getitem__.return_value = '/usr/bin/foo'
|
|
cmd = command.Command()
|
|
self.assertEqual('usage: foo', cmd.format_usage().strip())
|
|
self.assertEqual('usage: baz', cmd.format_usage('baz').strip())
|
|
|
|
def test_basic_usage(self):
|
|
cmd = command.Command()
|
|
self.assertEqual('usage: foo', cmd.format_usage('foo').strip())
|
|
|
|
cmd.add_argument('-h', '--help', action='store_true')
|
|
self.assertEqual('usage: foo [-h]', cmd.format_usage('foo').strip())
|
|
|
|
cmd.add_argument('bar')
|
|
self.assertEqual('usage: foo [-h] bar',
|
|
cmd.format_usage('foo').strip())
|
|
|
|
def test_nested_usage(self):
|
|
child = command.Command()
|
|
cmd = command.Command()
|
|
cmd.add_child('bar', child)
|
|
|
|
self.assertEqual('usage: foo', cmd.format_usage('foo').strip())
|
|
self.assertEqual('usage: foo bar', cmd.format_usage('foo bar').strip())
|
|
|
|
cmd.add_argument('-h', '--help', action='store_true')
|
|
self.assertEqual('usage: foo bar',
|
|
child.format_usage('foo bar').strip())
|
|
|
|
child.add_argument('-h', '--help', action='store_true')
|
|
self.assertEqual('usage: foo bar [-h]',
|
|
child.format_usage('foo bar').strip())
|
|
|
|
|
|
class HelpTest(unittest.TestCase):
|
|
@mock.patch('sys.argv')
|
|
def test_prog_name_default_and_override(self, argv_mock):
|
|
argv_mock.__getitem__.return_value = '/usr/bin/foo'
|
|
cmd = command.Command()
|
|
self.assertEqual('usage: foo', cmd.format_help().strip())
|
|
self.assertEqual('usage: bar', cmd.format_help('bar').strip())
|
|
|
|
def test_command_without_documenation_or_options(self):
|
|
cmd = command.Command()
|
|
self.assertEqual('usage: bar', cmd.format_help('bar').strip())
|
|
|
|
def test_command_with_option(self):
|
|
cmd = command.Command()
|
|
cmd.add_argument('-h', '--help', action='store_true',
|
|
help='show this message')
|
|
|
|
expected = ('usage: foo [-h]\n\n'
|
|
'OPTIONS:\n\n'
|
|
' -h, --help show this message')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_command_with_option_and_positional(self):
|
|
cmd = command.Command()
|
|
cmd.add_argument('-h', '--help', action='store_true',
|
|
help='show this message')
|
|
cmd.add_argument('bar', help='some help text')
|
|
|
|
expected = ('usage: foo [-h] bar\n\n'
|
|
'OPTIONS:\n\n'
|
|
' -h, --help show this message\n'
|
|
' bar some help text')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_command_with_documentation(self):
|
|
cmd = command.Command()
|
|
cmd.__doc__ = 'some text about everything this command does.'
|
|
|
|
expected = ('usage: foo\n\n'
|
|
'some text about everything this command does.')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_command_with_documentation_and_option(self):
|
|
cmd = command.Command()
|
|
cmd.__doc__ = 'some text about everything this command does.'
|
|
cmd.add_argument('-h', '--help', action='store_true',
|
|
help='show this message')
|
|
|
|
expected = ('usage: foo [-h]\n\n'
|
|
'some text about everything this command does.\n\n'
|
|
'OPTIONS:\n\n'
|
|
' -h, --help show this message')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_subcommand_without_documentation_or_options(self):
|
|
child = command.Command()
|
|
cmd = command.Command()
|
|
cmd.add_child('bar', child)
|
|
|
|
self.assertEqual('usage: foo', cmd.format_help('foo').strip())
|
|
|
|
def test_subcommand_with_documentation_shown(self):
|
|
child = command.Command()
|
|
child.__doc__ = 'some text about everything this command does.'
|
|
|
|
cmd = command.Command()
|
|
cmd.add_child('bar', child)
|
|
expected = ('usage: foo\n\n'
|
|
'COMMANDS:\n\n'
|
|
'bar\n\n'
|
|
' some text about everything this command does.')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_subcommand_with_options_shown(self):
|
|
child = command.Command()
|
|
child.add_argument('-h', '--help', action='store_true',
|
|
help='show this message')
|
|
|
|
cmd = command.Command()
|
|
cmd.add_child('bar', child)
|
|
|
|
expected = ('usage: foo\n\n'
|
|
'COMMANDS:\n\n'
|
|
'bar [-h]\n\n'
|
|
' -h, --help show this message')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_subcommand_with_positional_shown(self):
|
|
child = command.Command()
|
|
child.add_argument('baz', help='the great and wonderful')
|
|
|
|
cmd = command.Command()
|
|
cmd.add_child('bar', child)
|
|
|
|
expected = ('usage: foo\n\n'
|
|
'COMMANDS:\n\n'
|
|
'bar baz\n\n'
|
|
' baz the great and wonderful')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_subcommand_with_options_and_documentation(self):
|
|
child = command.Command()
|
|
child.__doc__ = ' some text about everything this command does.'
|
|
child.add_argument('-h', '--help', action='store_true',
|
|
help='show this message')
|
|
|
|
cmd = command.Command()
|
|
cmd.add_child('bar', child)
|
|
|
|
expected = ('usage: foo\n\n'
|
|
'COMMANDS:\n\n'
|
|
'bar [-h]\n\n'
|
|
' some text about everything this command does.\n\n'
|
|
' -h, --help show this message')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_nested_subcommands_with_options(self):
|
|
subchild = command.Command()
|
|
subchild.add_argument('--test', help='the great and wonderful')
|
|
|
|
child = command.Command()
|
|
child.add_child('baz', subchild)
|
|
child.add_argument('-h', '--help', action='store_true',
|
|
help='show this message')
|
|
|
|
cmd = command.Command()
|
|
cmd.add_child('bar', child)
|
|
|
|
expected = ('usage: foo\n\n'
|
|
'COMMANDS:\n\n'
|
|
'bar [-h]\n\n'
|
|
' -h, --help show this message\n\n'
|
|
'bar baz [--test TEST]\n\n'
|
|
' --test TEST the great and wonderful')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_nested_subcommands_skipped_intermediate(self):
|
|
subchild = command.Command()
|
|
subchild.add_argument('--test', help='the great and wonderful')
|
|
|
|
child = command.Command()
|
|
child.add_child('baz', subchild)
|
|
|
|
cmd = command.Command()
|
|
cmd.add_child('bar', child)
|
|
|
|
expected = ('usage: foo\n\n'
|
|
'COMMANDS:\n\n'
|
|
'bar baz [--test TEST]\n\n'
|
|
' --test TEST the great and wonderful')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_command_with_option_and_subcommand_with_option(self):
|
|
child = command.Command()
|
|
child.add_argument('--test', help='the great and wonderful')
|
|
|
|
cmd = command.Command()
|
|
cmd.add_argument('-h', '--help', action='store_true',
|
|
help='show this message')
|
|
cmd.add_child('bar', child)
|
|
|
|
expected = ('usage: foo [-h]\n\n'
|
|
'OPTIONS:\n\n'
|
|
' -h, --help show this message\n\n'
|
|
'COMMANDS:\n\n'
|
|
'bar [--test TEST]\n\n'
|
|
' --test TEST the great and wonderful')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
def test_command_with_options_doc_and_subcommand_with_option_and_doc(self):
|
|
child = command.Command()
|
|
child.__doc__ = 'some text about this sub-command.'
|
|
child.add_argument('--test', help='the great and wonderful')
|
|
|
|
cmd = command.Command()
|
|
cmd.__doc__ = 'some text about everything this command does.'
|
|
cmd.add_argument('-h', '--help', action='store_true',
|
|
help='show this message')
|
|
cmd.add_child('bar', child)
|
|
|
|
expected = ('usage: foo [-h]\n\n'
|
|
'some text about everything this command does.\n\n'
|
|
'OPTIONS:\n\n'
|
|
' -h, --help show this message\n\n'
|
|
'COMMANDS:\n\n'
|
|
'bar [--test TEST]\n\n'
|
|
' some text about this sub-command.\n\n'
|
|
' --test TEST the great and wonderful')
|
|
self.assertEqual(expected, cmd.format_help('foo').strip())
|
|
|
|
|
|
class CommandErrorTest(unittest.TestCase):
|
|
def test_args_get_stored(self):
|
|
error = command.CommandError('message', usage='usage: foo')
|
|
self.assertEqual(error.message, 'message')
|
|
self.assertEqual(error.usage, 'usage: foo')
|
|
|
|
def test_str_command_error(self):
|
|
error = command.CommandError('message', usage='usage: foo')
|
|
self.assertEqual(str(error), 'usage: foo\n\nerror: message\n')
|
|
|
|
|
|
class RunTest(unittest.TestCase):
|
|
def test_default_implmentation_raises_error(self):
|
|
with self.assertRaises(NotImplementedError):
|
|
command.Command().run()
|