mirror of
https://github.com/certbot/certbot.git
synced 2026-06-05 06:42:10 -04:00
315ddb247f
This is part of https://github.com/certbot/certbot/issues/8782. I took it on now because the currently pinned version of `pylint` doesn't work with newer versions of `poetry` which I wanted to upgrade as part of https://github.com/certbot/certbot/issues/8787. To say a bit more about the specific changes in this PR: * Newer versions of `pylint` complain if `Popen` isn't used as a context manager. Instead of making this change, I switched to using `subprocess.run` which is simpler and [recommended in the Python docs](https://docs.python.org/3/library/subprocess.html#using-the-subprocess-module). I also disabled this check in a few places where no longer using `Popen` would require significant refactoring. * The deleted code in `certbot/certbot/_internal/renewal.py` is cruft since https://github.com/certbot/certbot/pull/8685. * The unused argument to `enable_mod` in the Apache plugin is used in some over the override classes that subclass that class. * unpin pylint and repin dependencies * disable raise-missing-from * disable wrong-input-order * remove unused code * misc lint fixes * remove unused import * various lint fixes
64 lines
2.5 KiB
Python
64 lines
2.5 KiB
Python
"""Module to handle the context of nginx integration tests."""
|
|
import os
|
|
import subprocess
|
|
|
|
from certbot_integration_tests.certbot_tests import context as certbot_context
|
|
from certbot_integration_tests.nginx_tests import nginx_config as config
|
|
from certbot_integration_tests.utils import certbot_call
|
|
from certbot_integration_tests.utils import misc
|
|
|
|
|
|
class IntegrationTestsContext(certbot_context.IntegrationTestsContext):
|
|
"""General fixture describing a certbot-nginx integration tests context"""
|
|
def __init__(self, request):
|
|
super().__init__(request)
|
|
|
|
self.nginx_root = os.path.join(self.workspace, 'nginx')
|
|
os.mkdir(self.nginx_root)
|
|
|
|
self.webroot = os.path.join(self.nginx_root, 'webroot')
|
|
os.mkdir(self.webroot)
|
|
with open(os.path.join(self.webroot, 'index.html'), 'w') as file_handler:
|
|
file_handler.write('Hello World!')
|
|
|
|
self.nginx_config_path = os.path.join(self.nginx_root, 'nginx.conf')
|
|
self.nginx_config = None
|
|
|
|
default_server = request.param['default_server']
|
|
self.process = self._start_nginx(default_server)
|
|
|
|
def cleanup(self):
|
|
self._stop_nginx()
|
|
super().cleanup()
|
|
|
|
def certbot_test_nginx(self, args):
|
|
"""
|
|
Main command to execute certbot using the nginx plugin.
|
|
:param list args: list of arguments to pass to nginx
|
|
:param bool force_renew: set to False to not renew by default
|
|
"""
|
|
command = ['--authenticator', 'nginx', '--installer', 'nginx',
|
|
'--nginx-server-root', self.nginx_root]
|
|
command.extend(args)
|
|
return certbot_call.certbot_test(
|
|
command, self.directory_url, self.http_01_port, self.tls_alpn_01_port,
|
|
self.config_dir, self.workspace, force_renew=True)
|
|
|
|
def _start_nginx(self, default_server):
|
|
self.nginx_config = config.construct_nginx_config(
|
|
self.nginx_root, self.webroot, self.http_01_port, self.tls_alpn_01_port,
|
|
self.other_port, default_server, wtf_prefix=self.worker_id)
|
|
with open(self.nginx_config_path, 'w') as file:
|
|
file.write(self.nginx_config)
|
|
|
|
# pylint: disable=consider-using-with
|
|
process = subprocess.Popen(['nginx', '-c', self.nginx_config_path, '-g', 'daemon off;'])
|
|
|
|
assert process.poll() is None
|
|
misc.check_until_timeout('http://localhost:{0}'.format(self.http_01_port))
|
|
return process
|
|
|
|
def _stop_nginx(self):
|
|
assert self.process.poll() is None
|
|
self.process.terminate()
|
|
self.process.wait()
|