Added unit tests

Author: kmvanbrunt

cmd2/cmd2.py

@@ -3553,11 +3553,13 @@ def do_history(self, args: argparse.Namespace) -> Optional[bool]:
                     else:
                         fobj.write('{}\n'.format(command.raw))
             try:
+                quoted_fname = utils.quote_string(fname)
+
                 # noinspection PyTypeChecker
-                self.do_edit(utils.quote_string(fname))
+                self.do_edit(quoted_fname)
 
                 # noinspection PyTypeChecker
-                self.do_run_script(utils.quote_string(fname))
+                self.do_run_script(quoted_fname)
             finally:
                 os.remove(fname)
         elif args.output_file:

tests/test_cmd2.py

@@ -656,6 +656,36 @@ def test_edit_file(base_app, request, monkeypatch):
     # We think we have an editor, so should expect a Popen call
     m.assert_called_once()
 
+def test_edit_file_with_odd_file_names(base_app, monkeypatch):
+    """Test editor and file names with various patterns"""
+    # Mock out the do_shell call to see what args are passed
+    shell_mock = mock.MagicMock(name='do_shell')
+    monkeypatch.setattr("cmd2.Cmd.do_shell", shell_mock)
+
+    base_app.editor = 'fooedit'
+    python_script = utils.quote_string('nothingweird.py')
+    out, err = run_cmd(base_app, "edit {}".format(python_script))
+    shell_mock.assert_called_once_with('"fooedit" "nothingweird.py"')
+    shell_mock.reset_mock()
+
+    base_app.editor = 'foo edit'
+    python_script = utils.quote_string('has   spaces.py')
+    out, err = run_cmd(base_app, "edit {}".format(python_script))
+    shell_mock.assert_called_once_with('"foo edit" "has   spaces.py"')
+    shell_mock.reset_mock()
+
+    base_app.editor = '"fooedit"'
+    python_script = utils.quote_string('"is_double_quoted.py"')
+    out, err = run_cmd(base_app, "edit {}".format(python_script))
+    shell_mock.assert_called_once_with('\'"fooedit"\' \'"is_double_quoted.py"\'')
+    shell_mock.reset_mock()
+
+    base_app.editor = "'fooedit'"
+    python_script = utils.quote_string("'is_single_quoted.py'")
+    out, err = run_cmd(base_app, "edit {}".format(python_script))
+    shell_mock.assert_called_once_with('"\'fooedit\'" "\'is_single_quoted.py\'"')
+    shell_mock.reset_mock()
+
 def test_edit_file_with_spaces(base_app, request, monkeypatch):
     # Set a fake editor just to make sure we have one.  We aren't really going to call it due to the mock
     base_app.editor = 'fooedit'
@@ -986,7 +1016,7 @@ def do_study(self, arg):
     def do_procrastinate(self, arg):
         """Waste time in your manner of choice."""
         # Pass in a list of tuples for selections
-        leisure_activity = self.select([('Netflix and chill', 'Netflix'), ('Porn', 'WebSurfing')],
+        leisure_activity = self.select([('Netflix and chill', 'Netflix'), ('YouTube', 'WebSurfing')],
                                        'How would you like to procrastinate? ')
         result = 'Have fun procrasinating with {}!\n'.format(leisure_activity)
         self.stdout.write(result)
@@ -1098,7 +1128,7 @@ def test_select_list_of_tuples(select_app):
    1. Netflix
    2. WebSurfing
 Have fun procrasinating with {}!
-""".format('Porn'))
+""".format('YouTube'))
 
     # Make sure our mock was called with the expected arguments
     m.assert_called_once_with('How would you like to procrastinate? ')

tests/test_run_pyscript.py

@@ -6,7 +6,7 @@
 import builtins
 import os
 
-from cmd2 import plugin
+from cmd2 import plugin, utils
 from .conftest import run_cmd
 
 # Python 3.5 had some regressions in the unitest.mock module, so use 3rd party mock if available
@@ -52,6 +52,27 @@ def test_run_pyscript_with_non_python_file(base_app, request):
     out, err = run_cmd(base_app, 'run_pyscript {}'.format(filename))
     assert "does not have a .py extension" in err[0]
 
+def test_run_pyscript_with_odd_file_names(base_app):
+    """
+    Pass in file names with various patterns. Since these files don't exist, we will rely
+    on the error text to make sure the file names were processed correctly.
+    """
+    python_script = utils.quote_string('nothingweird.py')
+    out, err = run_cmd(base_app, "run_pyscript {}".format(python_script))
+    assert "'nothingweird.py'" in err[0]
+
+    python_script = utils.quote_string('has   spaces.py')
+    out, err = run_cmd(base_app, "run_pyscript {}".format(python_script))
+    assert "'has   spaces.py'" in err[0]
+
+    python_script = utils.quote_string('"is_double_quoted.py"')
+    out, err = run_cmd(base_app, "run_pyscript {}".format(python_script))
+    assert "'\"is_double_quoted.py\"'" in err[0]
+
+    python_script = utils.quote_string("'is_single_quoted.py'")
+    out, err = run_cmd(base_app, "run_pyscript {}".format(python_script))
+    assert "''is_single_quoted.py''" 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, 'pyscript', 'raises_exception.py')
@@ -107,4 +128,4 @@ def test_run_pyscript_run(base_app, request):
     expected = 'I have been run'
 
     out, err = run_cmd(base_app, "run_pyscript {}".format(python_script))
-    assert expected in out
+    assert expected in out

tests/test_utils.py

@@ -93,6 +93,16 @@ def test_is_quoted_no():
     simple_str = "hello world"
     assert not cu.is_quoted(simple_str)
 
+def test_quote_string():
+    my_str = "Hello World"
+    assert cu.quote_string(my_str) == '"' + my_str + '"'
+
+    my_str = "'Hello World'"
+    assert cu.quote_string(my_str) == '"' + my_str + '"'
+
+    my_str = '"Hello World"'
+    assert cu.quote_string(my_str) == "'" + my_str + "'"
+
 def test_quote_string_if_needed_yes():
     my_str = "Hello World"
     assert cu.quote_string_if_needed(my_str) == '"' + my_str + '"'