tools/tryselect/cli.py

   1 # This Source Code Form is subject to the terms of the Mozilla Public
   2 # License, v. 2.0. If a copy of the MPL was not distributed with this
   3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   4
   5
   6 import os
   7 import subprocess
   8 import tempfile
   9 from argparse import ArgumentParser
  10
  11 from .task_config import all_task_configs
  12
  13
  14 COMMON_ARGUMENT_GROUPS = {
  15     "push": [
  16         [
  17             ["-m", "--message"],
  18             {
  19                 "const": "editor",
  20                 "default": "{msg}",
  21                 "nargs": "?",
  22                 "help": "Use the specified commit message, or create it in your "
  23                 "$EDITOR if blank. Defaults to computed message.",
  24             },
  25         ],
  26         [
  27             ["--no-push"],
  28             {
  29                 "dest": "push",
  30                 "action": "store_false",
  31                 "help": "Do not push to try as a result of running this command (if "
  32                 "specified this command will only print calculated try "
  33                 "syntax and selection info).",
  34             },
  35         ],
  36         [
  37             ["--closed-tree"],
  38             {
  39                 "action": "store_true",
  40                 "default": False,
  41                 "help": "Push despite a closed try tree",
  42             },
  43         ],
  44     ],
  45     "preset": [
  46         [
  47             ["--save"],
  48             {
  49                 "default": None,
  50                 "help": "Save selection for future use with --preset.",
  51             },
  52         ],
  53         [
  54             ["--preset"],
  55             {
  56                 "default": None,
  57                 "help": "Load a saved selection.",
  58             },
  59         ],
  60         [
  61             ["--list-presets"],
  62             {
  63                 "action": "store_const",
  64                 "dest": "preset_action",
  65                 "const": "list",
  66                 "default": None,
  67                 "help": "List available preset selections.",
  68             },
  69         ],
  70         [
  71             ["--edit-presets"],
  72             {
  73                 "action": "store_const",
  74                 "dest": "preset_action",
  75                 "const": "edit",
  76                 "default": None,
  77                 "help": "Edit the preset file.",
  78             },
  79         ],
  80     ],
  81     "task": [
  82         [
  83             ["--full"],
  84             {
  85                 "action": "store_true",
  86                 "default": False,
  87                 "help": "Use the full set of tasks as input to fzf (instead of "
  88                 "target tasks).",
  89             },
  90         ],
  91         [
  92             ["-p", "--parameters"],
  93             {
  94                 "default": None,
  95                 "help": "Use the given parameters.yml to generate tasks, "
  96                 "defaults to a default set of parameters",
  97             },
  98         ],
  99     ],
 100 }
 101
 102
 103 class BaseTryParser(ArgumentParser):
 104     name = "try"
 105     common_groups = ["push", "preset"]
 106     arguments = []
 107     task_configs = []
 108
 109     def __init__(self, *args, **kwargs):
 110         ArgumentParser.__init__(self, *args, **kwargs)
 111
 112         group = self.add_argument_group("{} arguments".format(self.name))
 113         for cli, kwargs in self.arguments:
 114             group.add_argument(*cli, **kwargs)
 115
 116         for name in self.common_groups:
 117             group = self.add_argument_group("{} arguments".format(name))
 118             arguments = COMMON_ARGUMENT_GROUPS[name]
 119
 120             # Preset arguments are all mutually exclusive.
 121             if name == "preset":
 122                 group = group.add_mutually_exclusive_group()
 123
 124             for cli, kwargs in arguments:
 125                 group.add_argument(*cli, **kwargs)
 126
 127         group = self.add_argument_group("task configuration arguments")
 128         self.task_configs = {c: all_task_configs[c]() for c in self.task_configs}
 129         for cfg in self.task_configs.values():
 130             cfg.add_arguments(group)
 131
 132     def validate(self, args):
 133         if hasattr(args, "message"):
 134             if args.message == "editor":
 135                 if "EDITOR" not in os.environ:
 136                     self.error(
 137                         "must set the $EDITOR environment variable to use blank --message"
 138                     )
 139
 140                 with tempfile.NamedTemporaryFile(mode="r") as fh:
 141                     subprocess.call([os.environ["EDITOR"], fh.name])
 142                     args.message = fh.read().strip()
 143
 144             if "{msg}" not in args.message:
 145                 args.message = "{}\n\n{}".format(args.message, "{msg}")
 146
 147     def parse_known_args(self, *args, **kwargs):
 148         args, remainder = ArgumentParser.parse_known_args(self, *args, **kwargs)
 149         self.validate(args)
 150         return args, remainder