summaryrefslogtreecommitdiff
path: root/tests/test_pyscript.py
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2019-03-02 12:54:30 -0500
committerTodd Leonhardt <todd.leonhardt@gmail.com>2019-03-02 12:54:30 -0500
commit46df1c127e11ac59706e6656543d06621fd7bc1e (patch)
treeba8e057450e426db76b1398bb288ba0c2cc7c23c /tests/test_pyscript.py
parentfe4b3fd6718963ce9fa2352b013d7f9c912059c3 (diff)
parentde701086ff832bad0f0d97ffb10c2159d56ede7d (diff)
downloadcmd2-git-46df1c127e11ac59706e6656543d06621fd7bc1e.tar.gz
Merged from master and resolved conflicts in cmd2.py
Diffstat (limited to 'tests/test_pyscript.py')
-rw-r--r--tests/test_pyscript.py244
1 files changed, 10 insertions, 234 deletions
diff --git a/tests/test_pyscript.py b/tests/test_pyscript.py
index 692a498b..78500185 100644
--- a/tests/test_pyscript.py
+++ b/tests/test_pyscript.py
@@ -1,255 +1,31 @@
# coding=utf-8
# flake8: noqa E302
"""
-Unit/functional testing for argparse completer in cmd2
-
-Copyright 2018 Eric Lin <anselor@gmail.com>
-Released under MIT license, see LICENSE file
+Unit/functional testing for pytest in cmd2
"""
import os
-import pytest
-from cmd2.cmd2 import Cmd, with_argparser
-from cmd2 import argparse_completer
-from .conftest import run_cmd, normalize
-from cmd2.utils import namedtuple_with_defaults, StdSim
-
-
-class PyscriptExample(Cmd):
- ratings_types = ['G', 'PG', 'PG-13', 'R', 'NC-17']
-
- def _do_media_movies(self, args) -> None:
- if not args.command:
- self.do_help('media movies')
- else:
- self.poutput('media movies ' + str(args.__dict__))
-
- def _do_media_shows(self, args) -> None:
- if not args.command:
- self.do_help('media shows')
-
- if not args.command:
- self.do_help('media shows')
- else:
- self.poutput('media shows ' + str(args.__dict__))
-
- media_parser = argparse_completer.ACArgumentParser(prog='media')
-
- media_types_subparsers = media_parser.add_subparsers(title='Media Types', dest='type')
-
- movies_parser = media_types_subparsers.add_parser('movies')
- movies_parser.set_defaults(func=_do_media_movies)
-
- movies_commands_subparsers = movies_parser.add_subparsers(title='Commands', dest='command')
-
- movies_list_parser = movies_commands_subparsers.add_parser('list')
-
- movies_list_parser.add_argument('-t', '--title', help='Title Filter')
- movies_list_parser.add_argument('-r', '--rating', help='Rating Filter', nargs='+',
- choices=ratings_types)
- movies_list_parser.add_argument('-d', '--director', help='Director Filter')
- movies_list_parser.add_argument('-a', '--actor', help='Actor Filter', action='append')
-
- movies_add_parser = movies_commands_subparsers.add_parser('add')
- movies_add_parser.add_argument('title', help='Movie Title')
- movies_add_parser.add_argument('rating', help='Movie Rating', choices=ratings_types)
- movies_add_parser.add_argument('-d', '--director', help='Director', nargs=(1, 2), required=True)
- movies_add_parser.add_argument('actor', help='Actors', nargs='*')
-
- movies_delete_parser = movies_commands_subparsers.add_parser('delete')
-
- shows_parser = media_types_subparsers.add_parser('shows')
- shows_parser.set_defaults(func=_do_media_shows)
-
- shows_commands_subparsers = shows_parser.add_subparsers(title='Commands', dest='command')
-
- shows_list_parser = shows_commands_subparsers.add_parser('list')
-
- @with_argparser(media_parser)
- def do_media(self, args):
- """Media management command demonstrates multiple layers of sub-commands being handled by AutoCompleter"""
- func = getattr(args, 'func', None)
- if func is not None:
- # Call whatever subcommand function was selected
- func(self, args)
- else:
- # No subcommand was provided, so call help
- self.do_help('media')
-
- foo_parser = argparse_completer.ACArgumentParser(prog='foo')
- foo_parser.add_argument('-c', dest='counter', action='count')
- foo_parser.add_argument('-t', dest='trueval', action='store_true')
- foo_parser.add_argument('-n', dest='constval', action='store_const', const=42)
- foo_parser.add_argument('variable', nargs=(2, 3))
- foo_parser.add_argument('optional', nargs='?')
- foo_parser.add_argument('zeroormore', nargs='*')
-
- @with_argparser(foo_parser)
- def do_foo(self, args):
- self.poutput('foo ' + str(sorted(args.__dict__)))
- if self._in_py:
- FooResult = namedtuple_with_defaults('FooResult',
- ['counter', 'trueval', 'constval',
- 'variable', 'optional', 'zeroormore'])
- self._last_result = FooResult(**{'counter': args.counter,
- 'trueval': args.trueval,
- 'constval': args.constval,
- 'variable': args.variable,
- 'optional': args.optional,
- 'zeroormore': args.zeroormore})
-
- bar_parser = argparse_completer.ACArgumentParser(prog='bar')
- bar_parser.add_argument('first')
- bar_parser.add_argument('oneormore', nargs='+')
- bar_parser.add_argument('-a', dest='aaa')
-
- @with_argparser(bar_parser)
- def do_bar(self, args):
- out = 'bar '
- arg_dict = args.__dict__
- keys = list(arg_dict.keys())
- keys.sort()
- out += '{'
- for key in keys:
- out += "'{}':'{}'".format(key, arg_dict[key])
- self.poutput(out)
-
-
-@pytest.fixture
-def ps_app():
- c = PyscriptExample()
- c.stdout = StdSim(c.stdout)
- return c
-
-
-class PyscriptCustomNameExample(Cmd):
- def __init__(self):
- super().__init__()
- self.pyscript_name = 'custom'
- def do_echo(self, out):
- self.poutput(out)
+from .conftest import run_cmd
-@pytest.fixture
-def ps_echo():
- c = PyscriptCustomNameExample()
- c.stdout = StdSim(c.stdout)
- return c
-
-
-@pytest.mark.parametrize('command, pyscript_file', [
- ('help', 'help.py'),
- ('help media', 'help_media.py'),
-])
-def test_pyscript_help(ps_app, request, command, pyscript_file):
+def test_pyscript_help(base_app, request):
test_dir = os.path.dirname(request.module.__file__)
- python_script = os.path.join(test_dir, 'pyscript', pyscript_file)
- expected = run_cmd(ps_app, command)
+ python_script = os.path.join(test_dir, 'pyscript', 'help.py')
+ expected = run_cmd(base_app, 'help')
assert len(expected) > 0
assert len(expected[0]) > 0
- out = run_cmd(ps_app, 'pyscript {}'.format(python_script))
+ out = run_cmd(base_app, 'pyscript {}'.format(python_script))
assert len(out) > 0
assert out == expected
-@pytest.mark.parametrize('command, pyscript_file', [
- ('media movies list', 'media_movies_list1.py'),
- ('media movies list', 'media_movies_list2.py'),
- ('media movies list', 'media_movies_list3.py'),
- ('media movies list -a "Mark Hamill"', 'media_movies_list4.py'),
- ('media movies list -a "Mark Hamill" -a "Carrie Fisher"', 'media_movies_list5.py'),
- ('media movies list -r PG', 'media_movies_list6.py'),
- ('media movies list -r PG PG-13', 'media_movies_list7.py'),
- ('media movies add "My Movie" PG-13 --director "George Lucas" "J. J. Abrams"',
- 'media_movies_add1.py'),
- ('media movies add "My Movie" PG-13 --director "George Lucas" "J. J. Abrams" "Mark Hamill"',
- 'media_movies_add2.py'),
- ('foo aaa bbb -ccc -t -n', 'foo1.py'),
- ('foo 11 22 33 44 -ccc -t -n', 'foo2.py'),
- ('foo 11 22 33 44 55 66 -ccc', 'foo3.py'),
- ('bar 11 22', 'bar1.py'),
-])
-def test_pyscript_out(ps_app, request, command, pyscript_file):
+def test_pyscript_dir(base_app, capsys, request):
test_dir = os.path.dirname(request.module.__file__)
- python_script = os.path.join(test_dir, 'pyscript', pyscript_file)
- expected = run_cmd(ps_app, command)
- assert expected
-
- out = run_cmd(ps_app, 'pyscript {}'.format(python_script))
- assert out
- assert out == expected
-
-
-@pytest.mark.parametrize('command, error', [
- ('app.noncommand', 'AttributeError'),
- ('app.media.noncommand', 'AttributeError'),
- ('app.media.movies.list(artist="Invalid Keyword")', 'TypeError'),
- ('app.foo(counter="a")', 'TypeError'),
- ('app.foo("aaa")', 'ValueError'),
-])
-def test_pyscript_errors(ps_app, capsys, command, error):
- run_cmd(ps_app, 'py {}'.format(command))
- _, err = capsys.readouterr()
-
- assert len(err) > 0
- assert 'Traceback' in err
- assert error in err
-
-
-@pytest.mark.parametrize('pyscript_file, exp_out', [
- ('foo4.py', 'Success'),
-])
-def test_pyscript_results(ps_app, capsys, request, pyscript_file, exp_out):
- test_dir = os.path.dirname(request.module.__file__)
- python_script = os.path.join(test_dir, 'pyscript', pyscript_file)
-
- run_cmd(ps_app, 'pyscript {}'.format(python_script))
- expected, _ = capsys.readouterr()
- assert len(expected) > 0
- assert exp_out in expected
-
+ python_script = os.path.join(test_dir, 'pyscript', 'pyscript_dir.py')
-@pytest.mark.parametrize('expected, pyscript_file', [
- ("['_relative_load', 'alias', 'bar', 'cmd_echo', 'edit', 'eof', 'eos', 'foo', 'help', 'history', 'load', 'macro', 'media', 'py', 'pyscript', 'quit', 'set', 'shell', 'shortcuts']",
- 'pyscript_dir1.py'),
- ("['movies', 'shows']", 'pyscript_dir2.py')
-])
-def test_pyscript_dir(ps_app, capsys, request, expected, pyscript_file):
- test_dir = os.path.dirname(request.module.__file__)
- python_script = os.path.join(test_dir, 'pyscript', pyscript_file)
-
- run_cmd(ps_app, 'pyscript {}'.format(python_script))
+ run_cmd(base_app, 'pyscript {}'.format(python_script))
out, _ = capsys.readouterr()
out = out.strip()
assert len(out) > 0
- assert out == expected
-
-
-def test_pyscript_custom_name(ps_echo, request):
- message = 'blah!'
-
- test_dir = os.path.dirname(request.module.__file__)
- python_script = os.path.join(test_dir, 'pyscript', 'custom_echo.py')
-
- out = run_cmd(ps_echo, 'pyscript {}'.format(python_script))
- assert out
- assert message == out[0]
-
-
-def test_pyscript_argparse_checks(ps_app, capsys):
- # Test command that has nargs.REMAINDER and make sure all tokens are accepted
- # Include a flag in the REMAINDER section to show that they are processed as literals in that section
- run_cmd(ps_app, 'py app.alias.create("my_alias", "alias_command", "command_arg1", "-h")')
- out = run_cmd(ps_app, 'alias list my_alias')
- assert out == normalize('alias create my_alias alias_command command_arg1 -h')
-
- # Specify flag outside of keyword argument
- run_cmd(ps_app, 'py app.help("-h")')
- _, err = capsys.readouterr()
- assert '-h appears to be a flag' in err
-
- # Specify list with flag outside of keyword argument
- run_cmd(ps_app, 'py app.help(["--help"])')
- _, err = capsys.readouterr()
- assert '--help appears to be a flag' in err
+ assert out == "['cmd_echo']"