starred/certbot-certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-07-28 00:35:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

Added better error messages on redirect failure

Browse Source
This commit is contained in:
Brad Warren
2015-11-10 16:59:22 -08:00
parent 553592b2c8
commit 7d4beacce8
2 changed files with 34 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
letsencrypt/client.py
+26 -9
View File
@@ -120,6 +120,12 @@ class Client(object):
"""
# Message to show if enabling a redirect fails, but recovery is successful
_SUCCESSFUL_REDIRECT_RECOVERY_MSG = (
"We were unable to setup a redirect for your server, however, we "
"successfully installed your certificate. If you'd like to revert "
"these changes as well, run 'letsencrypt rollback'.")
def __init__(self, config, account_, dv_auth, installer, acme=None):
"""Initialize a client."""
self.config = config
@@ -378,7 +384,10 @@ class Client(object):
:type vhost: :class:`letsencrypt.interfaces.IInstaller`
"""
with error_handler.ErrorHandler(self.installer.recovery_routine):
enhance_error_handler = error_handler.ErrorHandler(
functools.partial(self._recovery_routine_with_msg,
self._SUCCESSFUL_REDIRECT_RECOVERY_MSG))
with enhance_error_handler:
for dom in domains:
try:
self.installer.enhance(dom, "redirect")
@@ -388,18 +397,26 @@ class Client(object):
self.installer.save("Add Redirects")
restart_error_handler = error_handler.ErrorHandler(functools.partial(
self._rollback_and_restart,
"We were unable to setup a redirect for your server, however, we "
"successfully installed your certificate. If you'd like to revert "
"these changes as well, run 'letsencrypt rollback'."))
restart_error_handler = error_handler.ErrorHandler(
functools.partial(self._rollback_and_restart,
self._SUCCESSFUL_REDIRECT_RECOVERY_MSG))
with restart_error_handler:
self.installer.restart()
def _rollback_and_restart(self, reporter_msg):
def _recovery_routine_with_msg(self, success_msg):
"""Calls the installer's recovery routine and prints success_msg
:param str success_msg: message to show on successful recovery
"""
self.installer.recovery_routine()
reporter = zope.component.getUtility(interfaces.IReporter)
reporter.add_message(success_msg, reporter.HIGH_PRIORITY)
def _rollback_and_restart(self, success_msg):
"""Rollback the most recent checkpoint and restart the webserver
:param str reporter_msg: message to show on successful rollback
:param str success_msg: message to show on successful rollback
"""
logger.critical("Rolling back to previous server configuration...")
@@ -415,7 +432,7 @@ class Client(object):
"https://github.com/letsencrypt/letsencrypt",
reporter.HIGH_PRIORITY)
raise
reporter.add_message(reporter_msg, reporter.HIGH_PRIORITY)
reporter.add_message(success_msg, reporter.HIGH_PRIORITY)
def validate_key_csr(privkey, csr=None):
letsencrypt/tests/client_test.py
+8 -2
View File
@@ -227,8 +227,10 @@ class ClientTest(unittest.TestCase):
self.assertRaises(errors.Error,
self.client.enhance_config, ["foo.bar"])
@mock.patch("letsencrypt.client.zope.component.getUtility")
@mock.patch("letsencrypt.client.enhancements")
def test_enhance_config_enhance_failure(self, mock_enhancements):
def test_enhance_config_enhance_failure(self, mock_enhancements,
mock_get_utility):
mock_enhancements.ask.return_value = True
installer = mock.MagicMock()
self.client.installer = installer
@@ -237,9 +239,12 @@ class ClientTest(unittest.TestCase):
self.assertRaises(errors.PluginError,
self.client.enhance_config, ["foo.bar"], True)
installer.recovery_routine.assert_called_once_with()
self.assertEqual(mock_get_utility().add_message.call_count, 1)
@mock.patch("letsencrypt.client.zope.component.getUtility")
@mock.patch("letsencrypt.client.enhancements")
def test_enhance_config_save_failure(self, mock_enhancements):
def test_enhance_config_save_failure(self, mock_enhancements,
mock_get_utility):
mock_enhancements.ask.return_value = True
installer = mock.MagicMock()
self.client.installer = installer
@@ -248,6 +253,7 @@ class ClientTest(unittest.TestCase):
self.assertRaises(errors.PluginError,
self.client.enhance_config, ["foo.bar"], True)
installer.recovery_routine.assert_called_once_with()
self.assertEqual(mock_get_utility().add_message.call_count, 1)
@mock.patch("letsencrypt.client.zope.component.getUtility")
@mock.patch("letsencrypt.client.enhancements")