Fixed unit tests

Updated unit tests due to changes in how help is output for commands decorated with an argparse ArgumentParser.

Author: tleonhardt

CHANGELOG.md

@@ -11,6 +11,8 @@
             * **do_*** commands get two arguments, the output of argparse.parse_known_args()
     *  See the **Argument Processing** section of the documentation for more information on these decorators
         * Alternatively, see the **argparse_example.py** and **arg_print.py** examples
+    * Added support for Argpasre sub-commands when using the **with_argument_parser** or **with_argparser_and_unknown_args** decorators
+        * See [subcommands.py](https://github.com/python-cmd2/cmd2/blob/master/examples/subcommands.py) for an example of how to use subcommands
     * The **__relative_load** command is now hidden from the help menu by default
         * This command is not intended to be called from the command line, only from within scripts
     * The **set** command now has an additional **-a/--all** option to also display read-only settings

tests/conftest.py

@@ -37,7 +37,6 @@
   -o FILE, --output-file FILE
                         output to file
   -s, --script          script format; no separation lines
-
 """
 
 # Output from the shortcuts command with default built-in shortcuts

tests/test_argparse.py

@@ -138,20 +138,26 @@ def test_argparse_quoted_arguments_posix_multiple(argparse_app):
     out = run_cmd(argparse_app, 'tag strong this "should  be" loud')
     assert out == ['<strong>this should  be loud</strong>']
 
-def test_argparse_help_docstring(argparse_app):
-    out = run_cmd(argparse_app, 'help say')
+def test_argparse_help_docstring(argparse_app, capsys):
+    run_cmd(argparse_app, 'help say')
+    out, err = capsys.readouterr()
+    out = out.splitlines()
     assert out[0].startswith('usage: say')
     assert out[1] == ''
     assert out[2] == 'Repeat what you tell me to.'
 
-def test_argparse_help_description(argparse_app):
-    out = run_cmd(argparse_app, 'help tag')
+def test_argparse_help_description(argparse_app, capsys):
+    run_cmd(argparse_app, 'help tag')
+    out, err = capsys.readouterr()
+    out = out.splitlines()
     assert out[0].startswith('usage: tag')
     assert out[1] == ''
     assert out[2] == 'create a html tag'
 
-def test_argparse_prog(argparse_app):
-    out = run_cmd(argparse_app, 'help tag')
+def test_argparse_prog(argparse_app, capsys):
+    run_cmd(argparse_app, 'help tag')
+    out, err = capsys.readouterr()
+    out = out.splitlines()
     progname = out[0].split(' ')[1]
     assert progname == 'tag'
 

tests/test_cmd2.py

@@ -39,21 +39,30 @@ def test_base_help(base_app):
     assert out == expected
 
 
-def test_base_help_history(base_app):
-    out = run_cmd(base_app, 'help history')
-    expected = normalize(HELP_HISTORY)
-    assert out == expected
+def test_base_help_history(base_app, capsys):
+    run_cmd(base_app, 'help history')
+    out, err = capsys.readouterr()
+    assert out == HELP_HISTORY
+    assert err == ''
 
 def test_base_argparse_help(base_app, capsys):
+    # Verify that "set -h" gives the same output as "help set" and that it starts in a way that makes sense
     run_cmd(base_app, 'set -h')
-    out, err = capsys.readouterr()
-    expected = run_cmd(base_app, 'help set')
-    assert normalize(base_app.do_set.__doc__ + str(err)) == expected
+    out1, err1 = capsys.readouterr()
+
+    run_cmd(base_app, 'help set')
+    out2, err2 = capsys.readouterr()
+
+    assert out1 == out2
+    assert err1 == err2
+    out = out1.splitlines()
+    assert out[0].startswith('usage: set')
+    assert out[1] == ''
+    assert out[2].startswith('Sets a settable parameter')
 
 def test_base_invalid_option(base_app, capsys):
     run_cmd(base_app, 'set -z')
     out, err = capsys.readouterr()
-    run_cmd(base_app, 'help set')
     expected = ['usage: set [-h] [-a] [-l] [settable [settable ...]]', 'set: error: unrecognized arguments: -z']
     assert normalize(str(err)) == expected
 
@@ -597,16 +606,17 @@ def test_allow_redirection(base_app):
     assert not os.path.exists(filename)
 
 
-def test_input_redirection(base_app, request):
+def test_input_redirection(base_app, request, capsys):
     test_dir = os.path.dirname(request.module.__file__)
     filename = os.path.join(test_dir, 'redirect.txt')
 
     # NOTE: File 'redirect.txt" contains 1 word "history"
 
     # Verify that redirecting input ffom a file works
-    out = run_cmd(base_app, 'help < {}'.format(filename))
-    expected = normalize(HELP_HISTORY)
-    assert out == expected
+    run_cmd(base_app, 'help < {}'.format(filename))
+    out, err = capsys.readouterr()
+    assert out == HELP_HISTORY
+    assert err == ''
 
 
 def test_pipe_to_shell(base_app, capsys):