summaryrefslogtreecommitdiff
path: root/tests/conftest.py
diff options
context:
space:
mode:
authorEric Lin <anselor@gmail.com>2020-06-12 20:44:10 -0400
committeranselor <anselor@gmail.com>2020-08-04 13:38:08 -0400
commit6da2cf30311f97d23a7121f8c02f9123674194b4 (patch)
tree9d6780afcb0742b94f86b6f8f775220691896cd3 /tests/conftest.py
parente1087b8f29341397b09e9a0722a77c025ab20d23 (diff)
downloadcmd2-git-6da2cf30311f97d23a7121f8c02f9123674194b4.tar.gz
Some minor cleanup of how imports work. Fixed issue with help documentation for CommandSet commands.
Issue #943
Diffstat (limited to 'tests/conftest.py')
-rw-r--r--tests/conftest.py12
1 files changed, 9 insertions, 3 deletions
diff --git a/tests/conftest.py b/tests/conftest.py
index 60074f5c..c07f7083 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -4,13 +4,14 @@ Cmd2 unit/functional testing
"""
import sys
from contextlib import redirect_stderr, redirect_stdout
-from typing import List, Optional, Union
+from typing import Dict, List, Optional, Union
from unittest import mock
from pytest import fixture
import cmd2
from cmd2.utils import StdSim
+from cmd2.constants import COMMAND_FUNC_PREFIX, CMD_ATTR_HELP_CATEGORY
# Prefer statically linked gnureadline if available (for macOS compatibility due to issues with libedit)
try:
@@ -25,11 +26,14 @@ except ImportError:
pass
-def verify_help_text(cmd2_app: cmd2.Cmd, help_output: Union[str, List[str]]) -> None:
+def verify_help_text(cmd2_app: cmd2.Cmd,
+ help_output: Union[str, List[str]],
+ verbose_strings: Optional[List[str]] = None) -> None:
"""This function verifies that all expected commands are present in the help text.
:param cmd2_app: instance of cmd2.Cmd
:param help_output: output of help, either as a string or list of strings
+ :param verbose_strings: optional list of verbose strings to search for
"""
if isinstance(help_output, str):
help_text = help_output
@@ -39,7 +43,9 @@ def verify_help_text(cmd2_app: cmd2.Cmd, help_output: Union[str, List[str]]) ->
for command in commands:
assert command in help_text
- # TODO: Consider adding checks for categories and for verbose history
+ if verbose_strings:
+ for verbose_string in verbose_strings:
+ assert verbose_string in help_text
# Help text for the history command