diff --git a/certbot/cli.py b/certbot/cli.py index bb29a43ec..fe80a8cdf 100644 --- a/certbot/cli.py +++ b/certbot/cli.py @@ -11,6 +11,9 @@ import sys import configargparse import six +import zope.component + +from zope.interface import interfaces as zope_interfaces from acme import challenges @@ -23,6 +26,7 @@ from certbot import hooks from certbot import interfaces from certbot import util +from certbot.display import util as display_util from certbot.plugins import disco as plugins_disco import certbot.plugins.selection as plugin_selection @@ -439,6 +443,15 @@ class HelpfulArgumentParser(object): "delete": main.delete, } + # Get notification function for printing + try: + self.notify = zope.component.getUtility( + interfaces.IDisplay).notification + except zope_interfaces.ComponentLookupError: + self.notify = display_util.NoninteractiveDisplay( + sys.stdout).notification + + # List of topics for which additional help can be provided HELP_TOPICS = ["all", "security", "paths", "automation", "testing"] HELP_TOPICS += list(self.VERBS) + self.COMMANDS_TOPICS + ["manage"] @@ -510,10 +523,10 @@ class HelpfulArgumentParser(object): usage = SHORT_USAGE if help_arg == True: - print(usage + COMMAND_OVERVIEW % (apache_doc, nginx_doc) + HELP_USAGE) + self.notify(usage + COMMAND_OVERVIEW % (apache_doc, nginx_doc) + HELP_USAGE) sys.exit(0) elif help_arg in self.COMMANDS_TOPICS: - print(usage + self._list_subcommands()) + self.notify(usage + self._list_subcommands()) sys.exit(0) elif help_arg == "all": # if we're doing --help all, the OVERVIEW is part of the SHORT_USAGE at diff --git a/certbot/tests/cli_test.py b/certbot/tests/cli_test.py index 108e07eb3..1a3742348 100644 --- a/certbot/tests/cli_test.py +++ b/certbot/tests/cli_test.py @@ -15,6 +15,8 @@ from certbot import constants from certbot import errors from certbot.plugins import disco +import certbot.tests.util as test_util + from certbot.tests.util import TempDirTestCase PLUGINS = disco.PluginsRegistry.find_all() @@ -49,17 +51,30 @@ class ParseTest(unittest.TestCase): # pylint: disable=too-many-public-methods reload_module(cli) @staticmethod - def parse(*args, **kwargs): + def _unmocked_parse(*args, **kwargs): """Get result of cli.prepare_and_parse_args.""" return cli.prepare_and_parse_args(PLUGINS, *args, **kwargs) + @staticmethod + def parse(*args, **kwargs): + """Mocks zope.component.getUtility and calls _unmocked_parse.""" + with test_util.patch_get_utility(): + return ParseTest._unmocked_parse(*args, **kwargs) + def _help_output(self, args): "Run a command, and return the output string for scrutiny" output = six.StringIO() + + def write_msg(message, *args, **kwargs): # pylint: disable=missing-docstring,unused-argument + output.write(message) + with mock.patch('certbot.main.sys.stdout', new=output): - with mock.patch('certbot.main.sys.stderr'): - self.assertRaises(SystemExit, self.parse, args, output) + with test_util.patch_get_utility() as mock_get_utility: + mock_get_utility().notification.side_effect = write_msg + with mock.patch('certbot.main.sys.stderr'): + self.assertRaises(SystemExit, self._unmocked_parse, args, output) + return output.getvalue() @mock.patch("certbot.cli.flag_default") @@ -450,9 +465,10 @@ class SetByCliTest(unittest.TestCase): def _call_set_by_cli(var, args, verb): with mock.patch('certbot.cli.helpful_parser') as mock_parser: - mock_parser.args = args - mock_parser.verb = verb - return cli.set_by_cli(var) + with test_util.patch_get_utility(): + mock_parser.args = args + mock_parser.verb = verb + return cli.set_by_cli(var) if __name__ == '__main__':