mirror of
https://github.com/certbot/certbot.git
synced 2026-06-05 14:54:24 -04:00
2564566e1c
interfaces.GenericUpdater and new enhancement interface updater functions get run on every invocation of Certbot with "renew" verb for every lineage. This causes performance problems for users with large configurations, because of plugin plumbing and preparsing happening in prepare() method of installer plugins. This PR moves the responsibility to call prepare() to the plugin (possibly) implementing a new style enhancement interface. Fixes: #6153 * Do not call IPlugin.prepare() for updaters when running renew * Check prepare called in tests * Refine pydoc and make the function name more informative * Verify the plugin type
122 lines
3.9 KiB
Python
122 lines
3.9 KiB
Python
"""Updaters run at renewal"""
|
|
import logging
|
|
|
|
from certbot import errors
|
|
from certbot import interfaces
|
|
|
|
from certbot.plugins import selection as plug_sel
|
|
import certbot.plugins.enhancements as enhancements
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
def run_generic_updaters(config, lineage, plugins):
|
|
"""Run updaters that the plugin supports
|
|
|
|
:param config: Configuration object
|
|
:type config: interfaces.IConfig
|
|
|
|
:param lineage: Certificate lineage object
|
|
:type lineage: storage.RenewableCert
|
|
|
|
:param plugins: List of plugins
|
|
:type plugins: `list` of `str`
|
|
|
|
:returns: `None`
|
|
:rtype: None
|
|
"""
|
|
if config.dry_run:
|
|
logger.debug("Skipping updaters in dry-run mode.")
|
|
return
|
|
try:
|
|
installer = plug_sel.get_unprepared_installer(config, plugins)
|
|
except errors.Error as e:
|
|
logger.warning("Could not choose appropriate plugin for updaters: %s", e)
|
|
return
|
|
if installer:
|
|
_run_updaters(lineage, installer, config)
|
|
_run_enhancement_updaters(lineage, installer, config)
|
|
|
|
def run_renewal_deployer(config, lineage, installer):
|
|
"""Helper function to run deployer interface method if supported by the used
|
|
installer plugin.
|
|
|
|
:param config: Configuration object
|
|
:type config: interfaces.IConfig
|
|
|
|
:param lineage: Certificate lineage object
|
|
:type lineage: storage.RenewableCert
|
|
|
|
:param installer: Installer object
|
|
:type installer: interfaces.IInstaller
|
|
|
|
:returns: `None`
|
|
:rtype: None
|
|
"""
|
|
if config.dry_run:
|
|
logger.debug("Skipping renewal deployer in dry-run mode.")
|
|
return
|
|
|
|
if not config.disable_renew_updates and isinstance(installer,
|
|
interfaces.RenewDeployer):
|
|
installer.renew_deploy(lineage)
|
|
_run_enhancement_deployers(lineage, installer, config)
|
|
|
|
def _run_updaters(lineage, installer, config):
|
|
"""Helper function to run the updater interface methods if supported by the
|
|
used installer plugin.
|
|
|
|
:param lineage: Certificate lineage object
|
|
:type lineage: storage.RenewableCert
|
|
|
|
:param installer: Installer object
|
|
:type installer: interfaces.IInstaller
|
|
|
|
:returns: `None`
|
|
:rtype: None
|
|
"""
|
|
if not config.disable_renew_updates:
|
|
if isinstance(installer, interfaces.GenericUpdater):
|
|
installer.generic_updates(lineage)
|
|
|
|
def _run_enhancement_updaters(lineage, installer, config):
|
|
"""Iterates through known enhancement interfaces. If the installer implements
|
|
an enhancement interface and the enhance interface has an updater method, the
|
|
updater method gets run.
|
|
|
|
:param lineage: Certificate lineage object
|
|
:type lineage: storage.RenewableCert
|
|
|
|
:param installer: Installer object
|
|
:type installer: interfaces.IInstaller
|
|
|
|
:param config: Configuration object
|
|
:type config: interfaces.IConfig
|
|
"""
|
|
|
|
if config.disable_renew_updates:
|
|
return
|
|
for enh in enhancements._INDEX: # pylint: disable=protected-access
|
|
if isinstance(installer, enh["class"]) and enh["updater_function"]:
|
|
getattr(installer, enh["updater_function"])(lineage)
|
|
|
|
|
|
def _run_enhancement_deployers(lineage, installer, config):
|
|
"""Iterates through known enhancement interfaces. If the installer implements
|
|
an enhancement interface and the enhance interface has an deployer method, the
|
|
deployer method gets run.
|
|
|
|
:param lineage: Certificate lineage object
|
|
:type lineage: storage.RenewableCert
|
|
|
|
:param installer: Installer object
|
|
:type installer: interfaces.IInstaller
|
|
|
|
:param config: Configuration object
|
|
:type config: interfaces.IConfig
|
|
"""
|
|
|
|
if config.disable_renew_updates:
|
|
return
|
|
for enh in enhancements._INDEX: # pylint: disable=protected-access
|
|
if isinstance(installer, enh["class"]) and enh["deployer_function"]:
|
|
getattr(installer, enh["deployer_function"])(lineage)
|