mirror of
https://github.com/certbot/certbot.git
synced 2026-06-05 23:04:39 -04:00
9e5bca4bbf
Part of #7550 This PR makes appropriate corrections to run pylint on Python 3. Why not keeping the dependencies unchanged and just run pylint on Python 3? Because the old version of pylint breaks horribly on Python 3 because of unsupported version of astroid. Why updating pylint + astroid to the latest version ? Because this version only fixes some internal errors occuring during the lint of Certbot code, and is also ready to run gracefully on Python 3.8. Why upgrading mypy ? Because the old version does not support the new version of astroid required to run pylint correctly. Why not upgrading mypy to its latest version ? Because this latest version includes a new typshed version, that adds a lot of new type definitions, and brings dozens of new errors on the Certbot codebase. I would like to fix that in a future PR. That said so, the work has been to find the correct set of new dependency versions, then configure pylint for sane configuration errors in our situation, disable irrelevant lintings errors, then fixing (or ignoring for good reason) the remaining mypy errors. I also made PyLint and MyPy checks run correctly on Windows. * Start configuration * Reconfigure travis * Suspend a check specific to python 3. Start fixing code. * Repair call_args * Fix return + elif lints * Reconfigure development to run mainly on python3 * Remove incompatible Python 3.4 jobs * Suspend pylint in some assertions * Remove pylint in dev * Take first mypy that supports typed-ast>=1.4.0 to limit the migration path * Various return + else lint errors * Find a set of deps that is working with current mypy version * Update local oldest requirements * Remove all current pylint errors * Rebuild letsencrypt-auto * Update mypy to fix pylint with new astroid version, and fix mypy issues * Explain type: ignore * Reconfigure tox, fix none path * Simplify pinning * Remove useless directive * Remove debugging code * Remove continue * Update requirements * Disable unsubscriptable-object check * Disable one check, enabling two more * Plug certbot dev version for oldest requirements * Remove useless disable directives * Remove useless no-member disable * Remove no-else-* checks. Use elif in symetric branches. * Add back assertion * Add new line * Remove unused pylint disable * Remove other pylint disable
98 lines
3.5 KiB
Python
98 lines
3.5 KiB
Python
"""Provides a common base for configurator proxies"""
|
|
import logging
|
|
import os
|
|
import shutil
|
|
import tempfile
|
|
|
|
from certbot._internal import constants
|
|
from certbot_compatibility_test import errors
|
|
from certbot_compatibility_test import util
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class Proxy(object):
|
|
"""A common base for compatibility test configurators"""
|
|
|
|
@classmethod
|
|
def add_parser_arguments(cls, parser):
|
|
"""Adds command line arguments needed by the plugin"""
|
|
|
|
def __init__(self, args):
|
|
"""Initializes the plugin with the given command line args"""
|
|
self._temp_dir = tempfile.mkdtemp()
|
|
# tempfile.mkdtemp() creates folders with too restrictive permissions to be accessible
|
|
# to an Apache worker, leading to HTTP challenge failures. Let's fix that.
|
|
os.chmod(self._temp_dir, 0o755)
|
|
self.le_config = util.create_le_config(self._temp_dir)
|
|
config_dir = util.extract_configs(args.configs, self._temp_dir)
|
|
self._configs = [
|
|
os.path.join(config_dir, config)
|
|
for config in os.listdir(config_dir)]
|
|
|
|
self.args = args
|
|
self.http_port = 80
|
|
self.https_port = 443
|
|
self._configurator = self._all_names = self._test_names = None
|
|
|
|
def __getattr__(self, name):
|
|
"""Wraps the configurator methods"""
|
|
if self._configurator is None:
|
|
raise AttributeError()
|
|
|
|
method = getattr(self._configurator, name, None)
|
|
if callable(method):
|
|
return method
|
|
raise AttributeError()
|
|
|
|
def has_more_configs(self):
|
|
"""Returns true if there are more configs to test"""
|
|
return bool(self._configs)
|
|
|
|
def cleanup_from_tests(self):
|
|
"""Performs any necessary cleanup from running plugin tests"""
|
|
|
|
def load_config(self):
|
|
"""Returns the next config directory to be tested"""
|
|
shutil.rmtree(self.le_config.work_dir, ignore_errors=True)
|
|
backup = os.path.join(self.le_config.work_dir, constants.BACKUP_DIR)
|
|
os.makedirs(backup)
|
|
return self._configs.pop()
|
|
|
|
def copy_certs_and_keys(self, cert_path, key_path, chain_path=None):
|
|
"""Copies certs and keys into the temporary directory"""
|
|
cert_and_key_dir = os.path.join(self._temp_dir, "certs_and_keys")
|
|
if not os.path.isdir(cert_and_key_dir):
|
|
os.mkdir(cert_and_key_dir)
|
|
|
|
cert = os.path.join(cert_and_key_dir, "cert")
|
|
shutil.copy(cert_path, cert)
|
|
key = os.path.join(cert_and_key_dir, "key")
|
|
shutil.copy(key_path, key)
|
|
if chain_path:
|
|
chain = os.path.join(cert_and_key_dir, "chain")
|
|
shutil.copy(chain_path, chain)
|
|
else:
|
|
chain = None
|
|
|
|
return cert, key, chain
|
|
|
|
def get_all_names_answer(self):
|
|
"""Returns the set of domain names that the plugin should find"""
|
|
if self._all_names:
|
|
return self._all_names
|
|
raise errors.Error("No configuration file loaded")
|
|
|
|
def get_testable_domain_names(self):
|
|
"""Returns the set of domain names that can be tested against"""
|
|
if self._test_names:
|
|
return self._test_names
|
|
return {"example.com"}
|
|
|
|
def deploy_cert(self, domain, cert_path, key_path, chain_path=None,
|
|
fullchain_path=None):
|
|
"""Installs cert"""
|
|
cert_path, key_path, chain_path = self.copy_certs_and_keys(
|
|
cert_path, key_path, chain_path)
|
|
self._configurator.deploy_cert(
|
|
domain, cert_path, key_path, chain_path, fullchain_path)
|