From 5dce1e15abb99aa5b08260b9f1b1dc1a63cd7a57 Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Sun, 22 Nov 2015 01:39:57 -0800 Subject: [PATCH] If we're going to have --webroot-map, make integrate it fully [tests broken] * -d is implied for things included in it * if --webroot-path and -w are both used, the later does not override explicit entries in the former --- letsencrypt/cli.py | 28 ++++++++++++++++------------ letsencrypt/tests/cli_test.py | 3 +++ 2 files changed, 19 insertions(+), 12 deletions(-) diff --git a/letsencrypt/cli.py b/letsencrypt/cli.py index 9c4c4a5f5..19cfc76f9 100644 --- a/letsencrypt/cli.py +++ b/letsencrypt/cli.py @@ -101,7 +101,13 @@ def usage_strings(plugins): def _find_domains(args, installer): - if args.domains is None: + # we get domains from -d, but also from the webroot map... + if args.webroot_map: + for domain in args.webroot_map.keys(): + if domain not in args.domains: + args.domains.append(domain) + + if not args.domains: domains = display_ops.choose_names(installer) else: domains = args.domains @@ -474,7 +480,7 @@ def run(args, config, plugins): # pylint: disable=too-many-branches,too-many-lo def obtain_cert(args, config, plugins): - """Authenticate & obtain cert, but do not install it.""" + """Implements "certonly": authenticate & obtain cert, but do not install it.""" if args.domains is not None and args.csr is not None: # TODO: --csr could have a priority, when --domains is @@ -839,7 +845,7 @@ def prepare_and_parse_args(plugins, args): # --domains is useful, because it can be stored in config #for subparser in parser_run, parser_auth, parser_install: # subparser.add_argument("domains", nargs="*", metavar="domain") - helpful.add(None, "-d", "--domains", dest="domains", + helpful.add(None, "-d", "--domains", dest="domains", default=[], metavar="DOMAIN", action=DomainFlagProcessor, help="Domain names to apply. For multiple domains you can use " "multiple -d flags or enter a comma separated list of domains " @@ -1038,7 +1044,7 @@ def _plugins_parsing(helpful, plugins): help="public_html / webroot path") parse_dict = lambda s: dict(json.loads(s)) helpful.add("webroot", "--webroot-map", default={}, type=parse_dict, - help="Mapping from domains to webroot paths") + help="JSON dictionary mapping domains to webroot paths; this implies -d for each entry.") class WebrootPathProcessor(argparse.Action): # pylint: disable=missing-docstring @@ -1047,15 +1053,15 @@ class WebrootPathProcessor(argparse.Action): # pylint: disable=missing-docstring Keep a record of --webroot-path / -w flags during processing, so that we know which apply to which -d flags """ - if not config.webroot_path: + if config.webroot_path is None: # first -w flag encountered config.webroot_path = [] # if any --domain flags preceded the first --webroot-path flag, # apply that webroot path to those; subsequent entries in # config.webroot_map are filled in by cli.DomainFlagProcessor if config.domains: - config.webroot_map = dict([(d, webroot) for d in config.domains]) - else: - config.webroot_map = {} + for d in config.domains: + config.webroot_map.setdefault(d, webroot) + config.webroot_path.append(webroot) @@ -1065,15 +1071,13 @@ class DomainFlagProcessor(argparse.Action): # pylint: disable=missing-docstring Process a new -d flag, helping the webroot plugin construct a map of {domain : webrootpath} if -w / --webroot-path is in use """ - if not config.domains: - config.domains = [] - for d in map(string.strip, domain_arg.split(",")): # pylint: disable=bad-builtin if d not in config.domains: config.domains.append(d) # Each domain has a webroot_path of the most recent -w flag + # unless it was explicitly included in webroot_map if config.webroot_path: - config.webroot_map[d] = config.webroot_path[-1] + config.webroot_map.setdefault(d, config.webroot_path[-1]) def setup_log_file_handler(args, logfile, fmt): diff --git a/letsencrypt/tests/cli_test.py b/letsencrypt/tests/cli_test.py index 853109636..60f3c245a 100644 --- a/letsencrypt/tests/cli_test.py +++ b/letsencrypt/tests/cli_test.py @@ -341,6 +341,7 @@ class CLITest(unittest.TestCase): # pylint: disable=too-many-public-methods namespace = cli.prepare_and_parse_args(plugins, long_args) self.assertEqual(namespace.domains, ['example.com', 'another.net']) + def test_parse_webroot(self): plugins = disco.PluginsRegistry.find_all() webroot_args = ['--webroot', '-d', 'stray.example.com', '-w', @@ -356,7 +357,9 @@ class CLITest(unittest.TestCase): # pylint: disable=too-many-public-methods webroot_map_args = ['--webroot-map', '{"eg.com" : "/tmp"}'] namespace = cli.prepare_and_parse_args(plugins, webroot_map_args) + domains = cli._find_domains(namespace, mock.MagicMock()) self.assertEqual(namespace.webroot_map, {u"eg.com": u"/tmp"}) + self.assertEqual(domains, ["eg.com"]) @mock.patch('letsencrypt.crypto_util.notAfter') @mock.patch('letsencrypt.cli.zope.component.getUtility')