Most of the tests we have check if the server does the right thing with
XML-RPC calls. How the commandline is converted to command arguments,
including interactive prompting, is untested.
This patch adds some tests in this area. To do that I had to break up
cli.run into more manageable pieces, and initialize the CLI plugins in
test mode.
Also I added nose's --nocapture option to the make-test script. With
this it's possible to use pdb.set_trace() to drop into a debugger while
running the tests.
I went ahead and added a test for ticket 2484, fixed in Martin's patch
231 (Ignore case in yes/no prompts).
--
Petr³
From 440f2abc1636c42d30ba18ac677ec00aa31294e9 Mon Sep 17 00:00:00 2001
From: Petr Viktorin <pvikt...@redhat.com>
Date: Tue, 6 Mar 2012 07:01:53 -0500
Subject: [PATCH 21/22] Add CLI parsing tests
These test that command lines are parsed to correct Command arguments.
Includes some tests for interactive prompts.
To make this possible cli.run is broken up into several pieces.
Also, ./make-test now passes the --nocapture option to nose, which allows
debugging using pdb.set_trace().
---
ipalib/__init__.py | 3 +
ipalib/backend.py | 1 -
ipalib/cli.py | 24 ++++++-
make-test | 27 +++++---
tests/test_cmdline/test_cli.py | 142 ++++++++++++++++++++++++++++++++++++++++
5 files changed, 182 insertions(+), 15 deletions(-)
create mode 100644 tests/test_cmdline/test_cli.py
diff --git a/ipalib/__init__.py b/ipalib/__init__.py
index 1efeeab4a6c5cef8f625c3964be253baf208dd29..dd861a8266614d63a81289672ce2235275c356c0 100644
--- a/ipalib/__init__.py
+++ b/ipalib/__init__.py
@@ -916,5 +916,8 @@ def create_api(mode='dummy'):
api = create_api(mode=None)
if os.environ.get('IPA_UNIT_TEST_MODE', None) == 'cli_test':
+ from cli import cli_plugins
+ for klass in cli_plugins:
+ api.register(klass)
api.bootstrap(context='cli', in_server=False, in_tree=True)
api.finalize()
diff --git a/ipalib/backend.py b/ipalib/backend.py
index 0232fa536ed83273d1c6510ee442915bb8c0c8c1..7be38ecc80faf03e735813fb1e2d0eba5c347800 100644
--- a/ipalib/backend.py
+++ b/ipalib/backend.py
@@ -102,7 +102,6 @@ class Connectible(Backend):
class Executioner(Backend):
-
def create_context(self, ccache=None, client_ip=None):
"""
client_ip: The IP address of the remote client.
diff --git a/ipalib/cli.py b/ipalib/cli.py
index 737ae001573af0f614783fe69add5711362da21e..332c51a181a2c1318e203ffea86e9a7e95445e89 100644
--- a/ipalib/cli.py
+++ b/ipalib/cli.py
@@ -123,7 +123,7 @@ class textui(backend.Backend):
def __get_encoding(self, stream):
assert stream in (sys.stdin, sys.stdout)
- if stream.encoding is None:
+ if getattr(stream, 'encoding', None) is None:
return 'UTF-8'
return stream.encoding
@@ -1007,7 +1007,11 @@ class cli(backend.Executioner):
Backend plugin for executing from command line interface.
"""
- def run(self, argv):
+ def get_command(self, argv):
+ """Given CLI arguments, return the Command to use
+
+ On incorrect invocation, prints out a help message and returns None
+ """
if len(argv) == 0:
self.Command.help()
return
@@ -1022,14 +1026,26 @@ class cli(backend.Executioner):
if name not in self.Command or self.Command[name].NO_CLI:
raise CommandError(name=key)
cmd = self.Command[name]
- if not isinstance(cmd, frontend.Local):
- self.create_context()
+ return cmd
+
+ def argv_to_keyword_arguments(self, cmd, argv):
+ """Get the keyword arguments for a Command"""
kw = self.parse(cmd, argv)
kw['version'] = API_VERSION
if self.env.interactive:
self.prompt_interactively(cmd, kw)
self.load_files(cmd, kw)
+ return kw
+
+ def run(self, argv):
+ cmd = self.get_command(argv)
+ if cmd is None:
+ return
+ name = cmd.name
+ if not isinstance(cmd, frontend.Local):
+ self.create_context()
try:
+ kw = self.argv_to_keyword_arguments(cmd, argv[1:])
result = self.execute(name, **kw)
if callable(cmd.output_for_cli):
for param in cmd.params():
diff --git a/make-test b/make-test
index b429a7162f4f5c0121355f0fcfff8ba1039ba90a..b6b0c72e0d62d732f296e8364211a0c838d558f8 100755
--- a/make-test
+++ b/make-test
@@ -17,22 +17,27 @@ ran = []
fail = []
parser = optparse.OptionParser(
- usage='usage: %prog [MODULE...]',
+ usage='usage: %prog [MODULE...]',
)
parser.add_option('--stop',
- action='store_true',
- default=False,
- help='Stop running tests after the first error or failure',
+ action='store_true',
+ default=False,
+ help='Stop running tests after the first error or failure',
)
parser.add_option('--pdb',
- action='store_true',
- default=False,
- help='Drop into debugger on errors',
+ action='store_true',
+ default=False,
+ help='Drop into debugger on errors',
)
parser.add_option('--pdb-failures',
- action='store_true',
- default=False,
- help='Drop into debugger on failures',
+ action='store_true',
+ default=False,
+ help='Drop into debugger on failures',
+)
+parser.add_option('--nocapture',
+ action='store_true',
+ default=False,
+ help='Do not capture stdout',
)
(options, args) = parser.parse_args()
@@ -48,6 +53,8 @@ if options.pdb:
cmd.append('--pdb')
if options.pdb_failures:
cmd.append('--pdb-failures')
+if options.nocapture:
+ cmd.append('--nocapture')
# This must be set so ipalib.api gets initialized property for tests:
diff --git a/tests/test_cmdline/test_cli.py b/tests/test_cmdline/test_cli.py
new file mode 100644
index 0000000000000000000000000000000000000000..b80fc4be89a36ced1f8ed94da02c2718dff2cc5c
--- /dev/null
+++ b/tests/test_cmdline/test_cli.py
@@ -0,0 +1,142 @@
+import pprint
+import shlex
+import sys
+import contextlib
+import StringIO
+
+from tests import util
+from ipalib import api
+from ipapython.version import API_VERSION
+
+
+class TestCLIParsing(object):
+ """Tests that commandlines are correctly parsed to Command keyword args
+ """
+ def check_command(self, commandline, expected_command_name, **kw_expected):
+ argv = shlex.split(commandline)
+ executioner = api.Backend.cli
+
+ cmd = executioner.get_command(argv)
+ kw_got = executioner.argv_to_keyword_arguments(cmd, argv[1:])
+ pprint.pprint(kw_got)
+ util.assert_deepequal(expected_command_name, cmd.name, 'Command name')
+ util.assert_deepequal(kw_expected, kw_got)
+
+ def run_command(self, command_name, **kw):
+ """Run a command on the server"""
+ if not api.Backend.xmlclient.isconnected():
+ api.Backend.xmlclient.connect(fallback=False)
+ api.Command[command_name](**kw)
+
+ @contextlib.contextmanager
+ def fake_stdin(self, string_in):
+ """Context manager that temporarily replaces stdin to read a string"""
+ old_stdin = sys.stdin
+ sys.stdin = StringIO.StringIO(string_in)
+ yield
+ sys.stdin = old_stdin
+
+ def test_ping(self):
+ self.check_command('ping', 'ping',
+ version=API_VERSION)
+
+ def test_user_show(self):
+ self.check_command('user-show admin', 'user_show',
+ uid=u'admin',
+ rights=False,
+ raw=False,
+ all=False,
+ version=API_VERSION)
+
+ def test_user_show_underscore(self):
+ self.check_command('user_show admin', 'user_show',
+ uid=u'admin',
+ rights=False,
+ raw=False,
+ all=False,
+ version=API_VERSION)
+
+ def test_group_add(self):
+ self.check_command('group-add tgroup1 --desc="Test group"',
+ 'group_add',
+ cn=u'tgroup1',
+ description=u'Test group',
+ nonposix=False,
+ raw=False,
+ all=False,
+ version=API_VERSION)
+
+ def test_group_add_nonposix(self):
+ self.check_command('group-add tgroup1 --desc="Test group" --nonposix',
+ 'group_add',
+ cn=u'tgroup1',
+ description=u'Test group',
+ nonposix=True,
+ raw=False,
+ all=False,
+ version=API_VERSION)
+
+ def test_group_add_gid(self):
+ self.check_command('group-add tgroup1 --desc="Test group" --gid=1234',
+ 'group_add',
+ cn=u'tgroup1',
+ description=u'Test group',
+ gidnumber=u'1234',
+ nonposix=False,
+ raw=False,
+ all=False,
+ version=API_VERSION)
+
+ def test_group_add_interactive(self):
+ with self.fake_stdin('Test group\n'):
+ self.check_command('group-add tgroup1', 'group_add',
+ cn=u'tgroup1',
+ description=u'Test group',
+ nonposix=False,
+ raw=False,
+ all=False,
+ version=API_VERSION)
+
+ def test_dnsrecord_add(self):
+ self.check_command('dnsrecord-add test-example.com ns --a-rec=1.2.3.4',
+ 'dnsrecord_add',
+ dnszoneidnsname=u'test-example.com',
+ idnsname=u'ns',
+ arecord=u'1.2.3.4',
+ structured=False,
+ force=False,
+ raw=False,
+ all=False,
+ version=API_VERSION)
+
+ def test_dnsrecord_del_all(self):
+ try:
+ self.run_command('dnszone_add', idnsname=u'test-example.com',
+ idnssoamname=u'ns.test-example.com',
+ admin_email=u'devn...@test-example.com', force=True)
+ self.run_command('dnsrecord_add',
+ dnszoneidnsname=u'test-example.com',
+ idnsname=u'ns', arecord=u'1.2.3.4')
+ with self.fake_stdin('yes\n'):
+ self.check_command('dnsrecord_del test-example.com ns',
+ 'dnsrecord_del',
+ dnszoneidnsname=u'test-example.com',
+ idnsname=u'ns',
+ del_all=True,
+ structured=False,
+ raw=False,
+ all=False,
+ version=API_VERSION)
+ with self.fake_stdin('YeS\n'):
+ self.check_command('dnsrecord_del test-example.com ns',
+ 'dnsrecord_del',
+ dnszoneidnsname=u'test-example.com',
+ idnsname=u'ns',
+ del_all=True,
+ structured=False,
+ raw=False,
+ all=False,
+ version=API_VERSION)
+ finally:
+ self.run_command('dnszone_del', idnsname=u'test-example.com')
--
1.7.7.6
_______________________________________________
Freeipa-devel mailing list
Freeipa-devel@redhat.com
https://www.redhat.com/mailman/listinfo/freeipa-devel
