mirror of
https://github.com/certbot/certbot.git
synced 2026-08-03 08:03:10 +02:00
Adrien FerrandandBrad Warren
821bec6997
This PR is a part of the tls-sni-01 removal plan described in #6849. This PR removes --tls-sni-01-port, --tls-sni-01-address and tls-sni-01/tls-sni options from --preferred-challenges. They are replace by deprecation warning, indicating that these options will be removed soon. This deprecation, instead of complete removal, is done to avoid certbot instances to hard fail if some automated scripts still use these flags for some users. Once this PR lands, we can remove completely theses flags in one or two release. * Remove tls-sni related flags in cli. Add a deprecation warning instead. * Adapt tests to cli and renewal towards tls-sni flags deprecation * Add https_port option. Make tls_sni_01_port show a deprecation warning, but silently modify https_port if set * Migrate last items * Fix lint * Update certbot/cli.py Co-Authored-By: adferrand <adferrand@users.noreply.github.com> * Ensure to remove all occurences of tls-sni-01 * Remove unused parameter * Revert modifications on cli-help.txt * Use logger.warning instead of sys.stderr * Update the logger warning message * Remove standalone_supported_challenges option. * Fix order of preferred-challenges * Remove supported_challenges property * Fix some tests * Fix lint * Fix tests * Add a changelog * Clean code, fix test * Update CI * Reload * No hard date for tls-sni removal * Remove useless cast to list * Update certbot/tests/renewal_test.py Co-Authored-By: adferrand <adferrand@users.noreply.github.com> * Add entry to the changelog * Add entry to the changelog
163 lines
6.8 KiB
Python
163 lines
6.8 KiB
Python
"""Tests for certbot.configuration."""
|
|
import os
|
|
import unittest
|
|
|
|
import mock
|
|
|
|
from certbot import compat
|
|
from certbot import constants
|
|
from certbot import errors
|
|
|
|
from certbot.tests import util as test_util
|
|
|
|
class NamespaceConfigTest(test_util.ConfigTestCase):
|
|
"""Tests for certbot.configuration.NamespaceConfig."""
|
|
|
|
def setUp(self):
|
|
super(NamespaceConfigTest, self).setUp()
|
|
self.config.foo = 'bar'
|
|
self.config.server = 'https://acme-server.org:443/new'
|
|
self.config.https_port = 1234
|
|
self.config.http01_port = 4321
|
|
|
|
def test_init_same_ports(self):
|
|
self.config.namespace.https_port = 4321
|
|
from certbot.configuration import NamespaceConfig
|
|
self.assertRaises(errors.Error, NamespaceConfig, self.config.namespace)
|
|
|
|
def test_proxy_getattr(self):
|
|
self.assertEqual(self.config.foo, 'bar')
|
|
self.assertEqual(self.config.work_dir, os.path.join(self.tempdir, 'work'))
|
|
|
|
def test_server_path(self):
|
|
self.assertEqual(['acme-server.org:443', 'new'],
|
|
self.config.server_path.split(os.path.sep))
|
|
|
|
self.config.namespace.server = ('http://user:pass@acme.server:443'
|
|
'/p/a/t/h;parameters?query#fragment')
|
|
self.assertEqual(['user:pass@acme.server:443', 'p', 'a', 't', 'h'],
|
|
self.config.server_path.split(os.path.sep))
|
|
|
|
@mock.patch('certbot.configuration.constants')
|
|
def test_dynamic_dirs(self, mock_constants):
|
|
mock_constants.ACCOUNTS_DIR = 'acc'
|
|
mock_constants.BACKUP_DIR = 'backups'
|
|
mock_constants.CSR_DIR = 'csr'
|
|
|
|
mock_constants.IN_PROGRESS_DIR = '../p'
|
|
mock_constants.KEY_DIR = 'keys'
|
|
mock_constants.TEMP_CHECKPOINT_DIR = 't'
|
|
|
|
ref_path = compat.underscores_for_unsupported_characters_in_path(
|
|
'acc/acme-server.org:443/new')
|
|
self.assertEqual(
|
|
os.path.normpath(self.config.accounts_dir),
|
|
os.path.normpath(os.path.join(self.config.config_dir, ref_path)))
|
|
self.assertEqual(
|
|
os.path.normpath(self.config.backup_dir),
|
|
os.path.normpath(os.path.join(self.config.work_dir, 'backups')))
|
|
self.assertEqual(
|
|
os.path.normpath(self.config.csr_dir),
|
|
os.path.normpath(os.path.join(self.config.config_dir, 'csr')))
|
|
self.assertEqual(
|
|
os.path.normpath(self.config.in_progress_dir),
|
|
os.path.normpath(os.path.join(self.config.work_dir, '../p')))
|
|
self.assertEqual(
|
|
os.path.normpath(self.config.key_dir),
|
|
os.path.normpath(os.path.join(self.config.config_dir, 'keys')))
|
|
self.assertEqual(
|
|
os.path.normpath(self.config.temp_checkpoint_dir),
|
|
os.path.normpath(os.path.join(self.config.work_dir, 't')))
|
|
|
|
def test_absolute_paths(self):
|
|
from certbot.configuration import NamespaceConfig
|
|
|
|
config_base = "foo"
|
|
work_base = "bar"
|
|
logs_base = "baz"
|
|
server = "mock.server"
|
|
|
|
mock_namespace = mock.MagicMock(spec=['config_dir', 'work_dir',
|
|
'logs_dir', 'http01_port',
|
|
'https_port',
|
|
'domains', 'server'])
|
|
mock_namespace.config_dir = config_base
|
|
mock_namespace.work_dir = work_base
|
|
mock_namespace.logs_dir = logs_base
|
|
mock_namespace.server = server
|
|
config = NamespaceConfig(mock_namespace)
|
|
|
|
self.assertTrue(os.path.isabs(config.config_dir))
|
|
self.assertEqual(config.config_dir,
|
|
os.path.join(os.getcwd(), config_base))
|
|
self.assertTrue(os.path.isabs(config.work_dir))
|
|
self.assertEqual(config.work_dir,
|
|
os.path.join(os.getcwd(), work_base))
|
|
self.assertTrue(os.path.isabs(config.logs_dir))
|
|
self.assertEqual(config.logs_dir,
|
|
os.path.join(os.getcwd(), logs_base))
|
|
self.assertTrue(os.path.isabs(config.accounts_dir))
|
|
self.assertTrue(os.path.isabs(config.backup_dir))
|
|
self.assertTrue(os.path.isabs(config.csr_dir))
|
|
self.assertTrue(os.path.isabs(config.in_progress_dir))
|
|
self.assertTrue(os.path.isabs(config.key_dir))
|
|
self.assertTrue(os.path.isabs(config.temp_checkpoint_dir))
|
|
|
|
@mock.patch('certbot.configuration.constants')
|
|
def test_renewal_dynamic_dirs(self, mock_constants):
|
|
mock_constants.ARCHIVE_DIR = 'a'
|
|
mock_constants.LIVE_DIR = 'l'
|
|
mock_constants.RENEWAL_CONFIGS_DIR = 'renewal_configs'
|
|
|
|
self.assertEqual(
|
|
self.config.default_archive_dir, os.path.join(self.config.config_dir, 'a'))
|
|
self.assertEqual(
|
|
self.config.live_dir, os.path.join(self.config.config_dir, 'l'))
|
|
self.assertEqual(
|
|
self.config.renewal_configs_dir, os.path.join(
|
|
self.config.config_dir, 'renewal_configs'))
|
|
|
|
def test_renewal_absolute_paths(self):
|
|
from certbot.configuration import NamespaceConfig
|
|
|
|
config_base = "foo"
|
|
work_base = "bar"
|
|
logs_base = "baz"
|
|
|
|
mock_namespace = mock.MagicMock(spec=['config_dir', 'work_dir',
|
|
'logs_dir', 'http01_port',
|
|
'https_port',
|
|
'domains', 'server'])
|
|
mock_namespace.config_dir = config_base
|
|
mock_namespace.work_dir = work_base
|
|
mock_namespace.logs_dir = logs_base
|
|
config = NamespaceConfig(mock_namespace)
|
|
|
|
self.assertTrue(os.path.isabs(config.default_archive_dir))
|
|
self.assertTrue(os.path.isabs(config.live_dir))
|
|
self.assertTrue(os.path.isabs(config.renewal_configs_dir))
|
|
|
|
def test_get_and_set_attr(self):
|
|
self.config.foo = 42
|
|
self.assertEqual(self.config.namespace.foo, 42)
|
|
self.config.namespace.bar = 1337
|
|
self.assertEqual(self.config.bar, 1337)
|
|
|
|
def test_hook_directories(self):
|
|
self.assertEqual(self.config.renewal_hooks_dir,
|
|
os.path.join(self.config.config_dir,
|
|
constants.RENEWAL_HOOKS_DIR))
|
|
self.assertEqual(self.config.renewal_pre_hooks_dir,
|
|
os.path.join(self.config.renewal_hooks_dir,
|
|
constants.RENEWAL_PRE_HOOKS_DIR))
|
|
self.assertEqual(self.config.renewal_deploy_hooks_dir,
|
|
os.path.join(self.config.renewal_hooks_dir,
|
|
constants.RENEWAL_DEPLOY_HOOKS_DIR))
|
|
self.assertEqual(self.config.renewal_post_hooks_dir,
|
|
os.path.join(self.config.renewal_hooks_dir,
|
|
constants.RENEWAL_POST_HOOKS_DIR))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main() # pragma: no cover
|