summaryrefslogtreecommitdiff
path: root/tests/test_plugin.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test_plugin.py')
-rw-r--r--tests/test_plugin.py59
1 files changed, 58 insertions, 1 deletions
diff --git a/tests/test_plugin.py b/tests/test_plugin.py
index 132361a6..e49cbbfc 100644
--- a/tests/test_plugin.py
+++ b/tests/test_plugin.py
@@ -222,11 +222,24 @@ class Plugin:
self.called_cmdfinalization += 1
raise ValueError
+ def cmdfinalization_hook_system_exit(self, data: cmd2.plugin.CommandFinalizationData) -> \
+ cmd2.plugin.CommandFinalizationData:
+ """A command finalization hook which raises a SystemExit"""
+ self.called_cmdfinalization += 1
+ raise SystemExit
+
+ def cmdfinalization_hook_keyboard_interrupt(self, data: cmd2.plugin.CommandFinalizationData) -> \
+ cmd2.plugin.CommandFinalizationData:
+ """A command finalization hook which raises a KeyboardInterrupt"""
+ self.called_cmdfinalization += 1
+ raise KeyboardInterrupt
+
def cmdfinalization_hook_not_enough_parameters(self) -> plugin.CommandFinalizationData:
"""A command finalization hook with no parameters."""
pass
- def cmdfinalization_hook_too_many_parameters(self, one: plugin.CommandFinalizationData, two: str) -> plugin.CommandFinalizationData:
+ def cmdfinalization_hook_too_many_parameters(self, one: plugin.CommandFinalizationData, two: str) -> \
+ plugin.CommandFinalizationData:
"""A command finalization hook with too many parameters."""
return one
@@ -256,6 +269,10 @@ class PluggedApp(Plugin, cmd2.Cmd):
"""Repeat back the arguments"""
self.poutput(statement)
+ def do_skip_postcmd_hooks(self, _):
+ self.poutput("In do_skip_postcmd_hooks")
+ raise exceptions.SkipPostcommandHooks
+
parser = Cmd2ArgumentParser(description="Test parser")
parser.add_argument("my_arg", help="some help text")
@@ -847,6 +864,46 @@ def test_cmdfinalization_hook_exception(capsys):
assert err
assert app.called_cmdfinalization == 1
+def test_cmdfinalization_hook_system_exit(capsys):
+ app = PluggedApp()
+ app.register_cmdfinalization_hook(app.cmdfinalization_hook_system_exit)
+ stop = app.onecmd_plus_hooks('say hello')
+ assert stop
+ assert app.called_cmdfinalization == 1
+
+def test_cmdfinalization_hook_keyboard_interrupt(capsys):
+ app = PluggedApp()
+ app.register_cmdfinalization_hook(app.cmdfinalization_hook_keyboard_interrupt)
+
+ # First make sure KeyboardInterrupt isn't raised unless told to
+ stop = app.onecmd_plus_hooks('say hello', raise_keyboard_interrupt=False)
+ assert not stop
+ assert app.called_cmdfinalization == 1
+
+ # Now enable raising the KeyboardInterrupt
+ app.reset_counters()
+ with pytest.raises(KeyboardInterrupt):
+ stop = app.onecmd_plus_hooks('say hello', raise_keyboard_interrupt=True)
+ assert not stop
+ assert app.called_cmdfinalization == 1
+
+ # Now make sure KeyboardInterrupt isn't raised if stop is already True
+ app.reset_counters()
+ stop = app.onecmd_plus_hooks('quit', raise_keyboard_interrupt=True)
+ assert stop
+ assert app.called_cmdfinalization == 1
+
+def test_skip_postcmd_hooks(capsys):
+ app = PluggedApp()
+ app.register_postcmd_hook(app.postcmd_hook)
+ app.register_cmdfinalization_hook(app.cmdfinalization_hook)
+
+ # Cause a SkipPostcommandHooks exception and verify no postcmd stuff runs but cmdfinalization_hook still does
+ app.onecmd_plus_hooks('skip_postcmd_hooks')
+ out, err = capsys.readouterr()
+ assert "In do_skip_postcmd_hooks" in out
+ assert app.called_postcmd == 0
+ assert app.called_cmdfinalization == 1
def test_cmd2_argparse_exception(capsys):
"""