mirror of
https://github.com/certbot/certbot.git
synced 2026-06-07 15:52:08 -04:00
9e3c348dff
Fixes #7350. This PR changes the parsed modules from a `set` to a `dict`, with the filepath argument as the value. Accordingly, after calling `enable_mod` to enable `ssl_module`, modules now need to be re-parsed, so call `reset_modules`. * Add mechanism for selecting apache config file, based on work done in #7191. * Check OpenSSL version * Remove os imports * debian override still needs os * Reformat remaining apache tests with modules dict syntax * Clean up more apache tests * Switch from property to method for openssl and add tests for coverage. * Sometimes the dict location will be None in which case we should in fact return None * warn thoroughly and consistently in openssl_version function * update tests for new warnings * read file as bytes, and factor out the open for testing * normalize ssl_module_location path to account for being relative to server root * Use byte literals in a python 2 and 3 compatible way * string does need to be a literal * patch builtins open * add debug, remove space * Add test to check if OpenSSL detection is working on different systems * fix relative test location for cwd * put </IfModule> on its own line in test case * Revert test file to status in master. * Call augeas load before reparsing modules to pick up the changes * fix grep, tail, and mod_ssl location on centos * strip the trailing whitespace from fedora * just use LooseVersion in test * call apache2ctl on debian systems * Use sudo for apache2ctl command * add check to make sure we're getting a version * Add boolean so we don't warn on debian/ubuntu before trying to enable mod_ssl * Reduce warnings while testing by setting mock _openssl_version. * Make sure we're not throwing away any unwritten changes to the config * test last warning case for coverage * text changes for clarity
194 lines
8.2 KiB
Python
194 lines
8.2 KiB
Python
"""Test for certbot_apache._internal.configurator for Fedora 29+ overrides"""
|
|
import unittest
|
|
|
|
import mock
|
|
|
|
from certbot import errors
|
|
from certbot.compat import filesystem
|
|
from certbot.compat import os
|
|
from certbot_apache._internal import obj
|
|
from certbot_apache._internal import override_fedora
|
|
import util
|
|
|
|
|
|
def get_vh_truth(temp_dir, config_name):
|
|
"""Return the ground truth for the specified directory."""
|
|
prefix = os.path.join(
|
|
temp_dir, config_name, "httpd/conf.d")
|
|
|
|
aug_pre = "/files" + prefix
|
|
# TODO: eventually, these tests should have a dedicated configuration instead
|
|
# of reusing the ones from centos_test
|
|
vh_truth = [
|
|
obj.VirtualHost(
|
|
os.path.join(prefix, "centos.example.com.conf"),
|
|
os.path.join(aug_pre, "centos.example.com.conf/VirtualHost"),
|
|
{obj.Addr.fromstring("*:80")},
|
|
False, True, "centos.example.com"),
|
|
obj.VirtualHost(
|
|
os.path.join(prefix, "ssl.conf"),
|
|
os.path.join(aug_pre, "ssl.conf/VirtualHost"),
|
|
{obj.Addr.fromstring("_default_:443")},
|
|
True, True, None)
|
|
]
|
|
return vh_truth
|
|
|
|
|
|
class FedoraRestartTest(util.ApacheTest):
|
|
"""Tests for Fedora specific self-signed certificate override"""
|
|
|
|
# TODO: eventually, these tests should have a dedicated configuration instead
|
|
# of reusing the ones from centos_test
|
|
def setUp(self): # pylint: disable=arguments-differ
|
|
test_dir = "centos7_apache/apache"
|
|
config_root = "centos7_apache/apache/httpd"
|
|
vhost_root = "centos7_apache/apache/httpd/conf.d"
|
|
super(FedoraRestartTest, self).setUp(test_dir=test_dir,
|
|
config_root=config_root,
|
|
vhost_root=vhost_root)
|
|
self.config = util.get_apache_configurator(
|
|
self.config_path, self.vhost_path, self.config_dir, self.work_dir,
|
|
os_info="fedora")
|
|
self.vh_truth = get_vh_truth(
|
|
self.temp_dir, "centos7_apache/apache")
|
|
|
|
def _run_fedora_test(self):
|
|
self.assertIsInstance(self.config, override_fedora.FedoraConfigurator)
|
|
self.config.config_test()
|
|
|
|
def test_fedora_restart_error(self):
|
|
c_test = "certbot_apache._internal.configurator.ApacheConfigurator.config_test"
|
|
with mock.patch(c_test) as mock_test:
|
|
# First call raises error, second doesn't
|
|
mock_test.side_effect = [errors.MisconfigurationError, '']
|
|
with mock.patch("certbot.util.run_script") as mock_run:
|
|
mock_run.side_effect = errors.SubprocessError
|
|
self.assertRaises(errors.MisconfigurationError,
|
|
self._run_fedora_test)
|
|
|
|
def test_fedora_restart(self):
|
|
c_test = "certbot_apache._internal.configurator.ApacheConfigurator.config_test"
|
|
with mock.patch(c_test) as mock_test:
|
|
with mock.patch("certbot.util.run_script") as mock_run:
|
|
# First call raises error, second doesn't
|
|
mock_test.side_effect = [errors.MisconfigurationError, '']
|
|
self._run_fedora_test()
|
|
self.assertEqual(mock_test.call_count, 2)
|
|
self.assertEqual(mock_run.call_args[0][0],
|
|
['systemctl', 'restart', 'httpd'])
|
|
|
|
|
|
class MultipleVhostsTestFedora(util.ApacheTest):
|
|
"""Multiple vhost tests for CentOS / RHEL family of distros"""
|
|
|
|
_multiprocess_can_split_ = True
|
|
|
|
def setUp(self): # pylint: disable=arguments-differ
|
|
test_dir = "centos7_apache/apache"
|
|
config_root = "centos7_apache/apache/httpd"
|
|
vhost_root = "centos7_apache/apache/httpd/conf.d"
|
|
super(MultipleVhostsTestFedora, self).setUp(test_dir=test_dir,
|
|
config_root=config_root,
|
|
vhost_root=vhost_root)
|
|
|
|
self.config = util.get_apache_configurator(
|
|
self.config_path, self.vhost_path, self.config_dir, self.work_dir,
|
|
os_info="fedora")
|
|
self.vh_truth = get_vh_truth(
|
|
self.temp_dir, "centos7_apache/apache")
|
|
|
|
def test_get_parser(self):
|
|
self.assertIsInstance(self.config.parser, override_fedora.FedoraParser)
|
|
|
|
@mock.patch("certbot_apache._internal.apache_util._get_runtime_cfg")
|
|
def test_opportunistic_httpd_runtime_parsing(self, mock_get):
|
|
define_val = (
|
|
'Define: TEST1\n'
|
|
'Define: TEST2\n'
|
|
'Define: DUMP_RUN_CFG\n'
|
|
)
|
|
mod_val = (
|
|
'Loaded Modules:\n'
|
|
' mock_module (static)\n'
|
|
' another_module (static)\n'
|
|
)
|
|
def mock_get_cfg(command):
|
|
"""Mock httpd process stdout"""
|
|
if command == ['httpd', '-t', '-D', 'DUMP_RUN_CFG']:
|
|
return define_val
|
|
elif command == ['httpd', '-t', '-D', 'DUMP_MODULES']:
|
|
return mod_val
|
|
return ""
|
|
mock_get.side_effect = mock_get_cfg
|
|
self.config.parser.modules = {}
|
|
self.config.parser.variables = {}
|
|
|
|
with mock.patch("certbot.util.get_os_info") as mock_osi:
|
|
# Make sure we have the have the CentOS httpd constants
|
|
mock_osi.return_value = ("fedora", "29")
|
|
self.config.parser.update_runtime_variables()
|
|
|
|
self.assertEqual(mock_get.call_count, 3)
|
|
self.assertEqual(len(self.config.parser.modules), 4)
|
|
self.assertEqual(len(self.config.parser.variables), 2)
|
|
self.assertTrue("TEST2" in self.config.parser.variables.keys())
|
|
self.assertTrue("mod_another.c" in self.config.parser.modules)
|
|
|
|
@mock.patch("certbot_apache._internal.configurator.util.run_script")
|
|
def test_get_version(self, mock_run_script):
|
|
mock_run_script.return_value = ('', None)
|
|
self.assertRaises(errors.PluginError, self.config.get_version)
|
|
self.assertEqual(mock_run_script.call_args[0][0][0], 'httpd')
|
|
|
|
def test_get_virtual_hosts(self):
|
|
"""Make sure all vhosts are being properly found."""
|
|
vhs = self.config.get_virtual_hosts()
|
|
self.assertEqual(len(vhs), 2)
|
|
found = 0
|
|
|
|
for vhost in vhs:
|
|
for centos_truth in self.vh_truth:
|
|
if vhost == centos_truth:
|
|
found += 1
|
|
break
|
|
else:
|
|
raise Exception("Missed: %s" % vhost) # pragma: no cover
|
|
self.assertEqual(found, 2)
|
|
|
|
@mock.patch("certbot_apache._internal.apache_util._get_runtime_cfg")
|
|
def test_get_sysconfig_vars(self, mock_cfg):
|
|
"""Make sure we read the sysconfig OPTIONS variable correctly"""
|
|
# Return nothing for the process calls
|
|
mock_cfg.return_value = ""
|
|
self.config.parser.sysconfig_filep = filesystem.realpath(
|
|
os.path.join(self.config.parser.root, "../sysconfig/httpd"))
|
|
self.config.parser.variables = {}
|
|
|
|
with mock.patch("certbot.util.get_os_info") as mock_osi:
|
|
# Make sure we have the have the CentOS httpd constants
|
|
mock_osi.return_value = ("fedora", "29")
|
|
self.config.parser.update_runtime_variables()
|
|
|
|
self.assertTrue("mock_define" in self.config.parser.variables.keys())
|
|
self.assertTrue("mock_define_too" in self.config.parser.variables.keys())
|
|
self.assertTrue("mock_value" in self.config.parser.variables.keys())
|
|
self.assertEqual("TRUE", self.config.parser.variables["mock_value"])
|
|
self.assertTrue("MOCK_NOSEP" in self.config.parser.variables.keys())
|
|
self.assertEqual("NOSEP_VAL", self.config.parser.variables["NOSEP_TWO"])
|
|
|
|
@mock.patch("certbot_apache._internal.configurator.util.run_script")
|
|
def test_alt_restart_works(self, mock_run_script):
|
|
mock_run_script.side_effect = [None, errors.SubprocessError, None]
|
|
self.config.restart()
|
|
self.assertEqual(mock_run_script.call_count, 3)
|
|
|
|
@mock.patch("certbot_apache._internal.configurator.util.run_script")
|
|
def test_alt_restart_errors(self, mock_run_script):
|
|
mock_run_script.side_effect = [None,
|
|
errors.SubprocessError,
|
|
errors.SubprocessError]
|
|
self.assertRaises(errors.MisconfigurationError, self.config.restart)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main() # pragma: no cover
|