summaryrefslogtreecommitdiff
path: root/tests/test_run_pyscript.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test_run_pyscript.py')
-rw-r--r--tests/test_run_pyscript.py91
1 files changed, 91 insertions, 0 deletions
diff --git a/tests/test_run_pyscript.py b/tests/test_run_pyscript.py
new file mode 100644
index 00000000..9eb33b31
--- /dev/null
+++ b/tests/test_run_pyscript.py
@@ -0,0 +1,91 @@
+# coding=utf-8
+# flake8: noqa E302
+"""
+Unit/functional testing for run_pytest in cmd2
+"""
+import os
+from cmd2 import plugin
+
+from .conftest import run_cmd
+
+HOOK_OUTPUT = "TEST_OUTPUT"
+
+def cmdfinalization_hook(data: plugin.CommandFinalizationData) -> plugin.CommandFinalizationData:
+ """A cmdfinalization_hook hook which requests application exit"""
+ print(HOOK_OUTPUT)
+ return data
+
+def test_run_pyscript(base_app, request):
+ test_dir = os.path.dirname(request.module.__file__)
+ python_script = os.path.join(test_dir, 'script.py')
+ expected = 'This is a python script running ...'
+
+ out, err = run_cmd(base_app, "run_pyscript {}".format(python_script))
+ assert expected in out
+
+def test_run_pyscript_recursive_not_allowed(base_app, request):
+ test_dir = os.path.dirname(request.module.__file__)
+ python_script = os.path.join(test_dir, 'scripts', 'recursive.py')
+ expected = 'Recursively entering interactive Python consoles is not allowed.'
+
+ out, err = run_cmd(base_app, "run_pyscript {}".format(python_script))
+ assert err[0] == expected
+
+def test_run_pyscript_with_nonexist_file(base_app):
+ python_script = 'does_not_exist.py'
+ out, err = run_cmd(base_app, "run_pyscript {}".format(python_script))
+ assert "Error opening script file" in err[0]
+
+def test_run_pyscript_with_exception(base_app, request):
+ test_dir = os.path.dirname(request.module.__file__)
+ python_script = os.path.join(test_dir, 'scripts', 'raises_exception.py')
+ out, err = run_cmd(base_app, "run_pyscript {}".format(python_script))
+ assert err[0].startswith('Traceback')
+ assert "TypeError: unsupported operand type(s) for +: 'int' and 'str'" in err[-1]
+
+def test_run_pyscript_requires_an_argument(base_app):
+ out, err = run_cmd(base_app, "run_pyscript")
+ assert "the following arguments are required: script_path" in err[1]
+
+def test_run_pyscript_help(base_app, request):
+ test_dir = os.path.dirname(request.module.__file__)
+ python_script = os.path.join(test_dir, 'pyscript', 'help.py')
+ out1, err1 = run_cmd(base_app, 'help')
+ out2, err2 = run_cmd(base_app, 'run_pyscript {}'.format(python_script))
+ assert out1 and out1 == out2
+
+def test_run_pyscript_dir(base_app, request):
+ test_dir = os.path.dirname(request.module.__file__)
+ python_script = os.path.join(test_dir, 'pyscript', 'pyscript_dir.py')
+
+ out, err = run_cmd(base_app, 'run_pyscript {}'.format(python_script))
+ assert out
+ assert out[0] == "['cmd_echo']"
+
+def test_run_pyscript_stdout_capture(base_app, request):
+ base_app.register_cmdfinalization_hook(cmdfinalization_hook)
+ test_dir = os.path.dirname(request.module.__file__)
+ python_script = os.path.join(test_dir, 'pyscript', 'stdout_capture.py')
+ out, err = run_cmd(base_app, 'run_pyscript {} {}'.format(python_script, HOOK_OUTPUT))
+
+ assert out[0] == "PASSED"
+ assert out[1] == "PASSED"
+
+def test_run_pyscript_stop(base_app, request):
+ # Verify onecmd_plus_hooks() returns True if any commands in a pyscript return True for stop
+ test_dir = os.path.dirname(request.module.__file__)
+
+ # help.py doesn't run any commands that returns True for stop
+ python_script = os.path.join(test_dir, 'pyscript', 'help.py')
+ stop = base_app.onecmd_plus_hooks('run_pyscript {}'.format(python_script))
+ assert not stop
+
+ # stop.py runs the quit command which does return True for stop
+ python_script = os.path.join(test_dir, 'pyscript', 'stop.py')
+ stop = base_app.onecmd_plus_hooks('run_pyscript {}'.format(python_script))
+ assert stop
+
+def test_pyscript_deprecated(base_app):
+ """Delete this when pyscript alias is removed"""
+ _, err = run_cmd(base_app, "pyscript fake")
+ assert "pyscript has been renamed and will be removed" in err[-1]